<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<title>PhasicFlow: src/phasicFlow/globals/error.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="https://cemf.ir">PhasicFlow</a>
 <span id="projectnumber"><a href="https://cemf.ir">v0.1</a></span>
</div>
<div id="projectbrief"><a href="www.github.com/PhasicFlow">www.cemf.ir</a></div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('error_8hpp_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">error.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="error_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*------------------------------- phasicFlow ---------------------------------</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> O C enter of</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> O O E ngineering and</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> O O M ultiscale modeling of</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> OOOOOOO F luid flow </span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">------------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> Copyright (C): www.cemf.ir</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> email: hamid.r.norouzi AT gmail.com</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">------------------------------------------------------------------------------ </span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">Licence:</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> This file is part of phasicFlow code. It is a free software for simulating </span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> granular and multiphase flows. You can redistribute it and/or modify it under</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> the terms of GNU General Public License v3 or any other later versions. </span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> </span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> phasicFlow is distributed to help others in their research in the field of </span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> granular and multiphase flows, but WITHOUT ANY WARRANTY; without even the</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"></span> </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">-----------------------------------------------------------------------------*/</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#ifndef __error_hpp__</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#define __error_hpp__</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "<a class="code" href="builtinTypes_8hpp.html">builtinTypes.hpp</a>"</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">namespace </span><a class="code" href="namespacepFlow.html">pFlow</a></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> {</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keyword">class </span>iOstream; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> }</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// reports a fatal error and exit the applicaiton </span></div>
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="error_8hpp.html#adfe9ae1313e6913aca3f96d3eb67906e"> 36</a></span> <span class="preprocessor">#define fatalError \</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor"> fatalErrorMessage(__FILE__, __LINE__)</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="error_8hpp.html#af6c6984e23cb04e9a23cbffaddfdeb31"> 39</a></span> <span class="preprocessor">#define fatalErrorIn( functionName ) \</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor"> fatalErrorInMessage((functionName), __FILE__, __LINE__ )</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  </div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="error_8hpp.html#aca9aa547c8441e4410a65a2ce7c21554"> 42</a></span> <span class="preprocessor">#define fatalErrorInFunction fatalErrorIn(FUNCTION_NAME)</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div>
<div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="error_8hpp.html#a8c0f77a1055614c58dcf89322035dcfb"> 44</a></span> <span class="preprocessor">#define Not_Implemented(functionName) \</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor"> notImplementedErrorMessage ((functionName), __FILE__, __LINE__ )</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="error_8hpp.html#a6d29ef74f19f6d5a225841705985eb8b"> 47</a></span> <span class="preprocessor">#define notImplementedFunction Not_Implemented(FUNCTION_NAME);</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div>
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="error_8hpp.html#a83efa053dfcfcef04cc0e721c0314ff3"> 49</a></span> <span class="preprocessor">#define ioErrorInFile( fileName, lineNumber) \</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor"> ioErrorMessage( fileName, lineNumber, FUNCTION_NAME, __FILE__, __LINE__ )</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="error_8hpp.html#a05bf53f02e547e2984101062aa87f595"> 52</a></span> <span class="preprocessor">#define warningIn( functionName ) \</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor"> warningMessage((functionName), __FILE__, __LINE__ )</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="error_8hpp.html#a889d5e8bf195a24964ffb883bcb2fc3b"> 55</a></span> <span class="preprocessor">#define warningInFunction warningIn(FUNCTION_NAME)</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="error_8hpp.html#aad22a1cd3b45a97ac8cd195f06fe61fe"> 57</a></span> <span class="preprocessor">#define fatalExit \</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor"> reportAndExit()</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  </div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <a class="code" href="classpFlow_1_1iOstream.html">pFlow::iOstream</a>& <a class="code" href="error_8hpp.html#a0ed43bbcfae7ab9b70cd23a82db23c43">fatalErrorMessage</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* fileName, <span class="keywordtype">int</span> linNumber );</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <a class="code" href="classpFlow_1_1iOstream.html">pFlow::iOstream</a>& <a class="code" href="error_8hpp.html#a653033f027c35c016ad647d303a53846">fatalErrorInMessage</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* fnName, <span class="keyword">const</span> <span class="keywordtype">char</span>* fileName, <span class="keywordtype">int</span> linNumber );</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <a class="code" href="classpFlow_1_1iOstream.html">pFlow::iOstream</a>& <a class="code" href="error_8hpp.html#a760a332a5ee6b584fb927d3dd452f6d6">notImplementedErrorMessage</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>*fnName, <span class="keyword">const</span> <span class="keywordtype">char</span>* fileName, <span class="keywordtype">int</span> lineNumber);</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <a class="code" href="classpFlow_1_1iOstream.html">pFlow::iOstream</a>& <a class="code" href="error_8hpp.html#a1512f8ce86f161bd65dead74084e075e">ioErrorMessage</a>(<span class="keyword">const</span> <a class="code" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">pFlow::word</a>& fileName, <span class="keywordtype">int</span> fileLineNumber, <span class="keyword">const</span> <span class="keywordtype">char</span>* fnName, <span class="keyword">const</span> <span class="keywordtype">char</span>* fName, <span class="keywordtype">int</span> lNumber);</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <a class="code" href="classpFlow_1_1iOstream.html">pFlow::iOstream</a>& <a class="code" href="error_8hpp.html#a1512f8ce86f161bd65dead74084e075e">ioErrorMessage</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* fileName, <span class="keywordtype">int</span> fileLineNumber, <span class="keyword">const</span> <span class="keywordtype">char</span>* fnName, <span class="keyword">const</span> <span class="keywordtype">char</span>* fName, <span class="keywordtype">int</span> lNumber);</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <a class="code" href="classpFlow_1_1iOstream.html">pFlow::iOstream</a>& <a class="code" href="error_8hpp.html#a76fb1cfa092a4635166f1a5b72b3b1e4">warningMessage</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* fnName, <span class="keyword">const</span> <span class="keywordtype">char</span>* fileName, <span class="keywordtype">int</span> linNumber );</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <a class="code" href="classpFlow_1_1iOstream.html">pFlow::iOstream</a>& <a class="code" href="error_8hpp.html#ac2f5cd92e12e534ad9015645f37f0fdf">reportAndExit</a>();</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  </div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aerror_8hpp_html_a0ed43bbcfae7ab9b70cd23a82db23c43"><div class="ttname"><a href="error_8hpp.html#a0ed43bbcfae7ab9b70cd23a82db23c43">fatalErrorMessage</a></div><div class="ttdeci">pFlow::iOstream & fatalErrorMessage(const char *fileName, int linNumber)</div><div class="ttdef"><b>Definition:</b> <a href="error_8cpp_source.html#l00031">error.cpp:31</a></div></div>
<div class="ttc" id="aerror_8hpp_html_ac2f5cd92e12e534ad9015645f37f0fdf"><div class="ttname"><a href="error_8hpp.html#ac2f5cd92e12e534ad9015645f37f0fdf">reportAndExit</a></div><div class="ttdeci">pFlow::iOstream & reportAndExit()</div><div class="ttdef"><b>Definition:</b> <a href="error_8cpp_source.html#l00089">error.cpp:89</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a0ebe792a293e8c717bddf60070c0fe99"><div class="ttname"><a href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">pFlow::word</a></div><div class="ttdeci">std::string word</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00063">builtinTypes.hpp:63</a></div></div>
<div class="ttc" id="aerror_8hpp_html_a1512f8ce86f161bd65dead74084e075e"><div class="ttname"><a href="error_8hpp.html#a1512f8ce86f161bd65dead74084e075e">ioErrorMessage</a></div><div class="ttdeci">pFlow::iOstream & ioErrorMessage(const pFlow::word &fileName, int fileLineNumber, const char *fnName, const char *fName, int lNumber)</div><div class="ttdef"><b>Definition:</b> <a href="error_8cpp_source.html#l00073">error.cpp:73</a></div></div>
<div class="ttc" id="anamespacepFlow_html"><div class="ttname"><a href="namespacepFlow.html">pFlow</a></div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8hpp_source.html#l00028">demComponent.hpp:28</a></div></div>
<div class="ttc" id="aerror_8hpp_html_a653033f027c35c016ad647d303a53846"><div class="ttname"><a href="error_8hpp.html#a653033f027c35c016ad647d303a53846">fatalErrorInMessage</a></div><div class="ttdeci">pFlow::iOstream & fatalErrorInMessage(const char *fnName, const char *fileName, int linNumber)</div><div class="ttdef"><b>Definition:</b> <a href="error_8cpp_source.html#l00041">error.cpp:41</a></div></div>
<div class="ttc" id="aerror_8hpp_html_a76fb1cfa092a4635166f1a5b72b3b1e4"><div class="ttname"><a href="error_8hpp.html#a76fb1cfa092a4635166f1a5b72b3b1e4">warningMessage</a></div><div class="ttdeci">pFlow::iOstream & warningMessage(const char *fnName, const char *fileName, int linNumber)</div><div class="ttdef"><b>Definition:</b> <a href="error_8cpp_source.html#l00079">error.cpp:79</a></div></div>
<div class="ttc" id="aerror_8hpp_html_a760a332a5ee6b584fb927d3dd452f6d6"><div class="ttname"><a href="error_8hpp.html#a760a332a5ee6b584fb927d3dd452f6d6">notImplementedErrorMessage</a></div><div class="ttdeci">pFlow::iOstream & notImplementedErrorMessage(const char *fnName, const char *fileName, int lineNumber)</div><div class="ttdef"><b>Definition:</b> <a href="error_8cpp_source.html#l00051">error.cpp:51</a></div></div>
<div class="ttc" id="abuiltinTypes_8hpp_html"><div class="ttname"><a href="builtinTypes_8hpp.html">builtinTypes.hpp</a></div></div>
<div class="ttc" id="aclasspFlow_1_1iOstream_html"><div class="ttname"><a href="classpFlow_1_1iOstream.html">pFlow::iOstream</a></div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00053">iOstream.hpp:53</a></div></div>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_cd7a5046d028e114fc17b2ebc2bd02d2.html">phasicFlow</a></li><li class="navelem"><a class="el" href="dir_5f6559faa080c0b07ec2a71fd7e912fc.html">globals</a></li><li class="navelem"><a class="el" href="error_8hpp.html">error.hpp</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>