phasicFlow/doc/code-documentation/html/error_8hpp.html

735 lines
42 KiB
HTML

<!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"/>
<meta name="description" content="PhasicFlow is an open-source parallel DEM (discrete element method) package for simulating granular flow. It is developed in C++ and can be exectued on both GPU (like CUDA) and CPU.">
<title>PhasicFlow: src/phasicFlow/globals/error.hpp File Reference</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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></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" >
<tbody>
<tr>
<td id="projectlogo"><a href="https://github.com/PhasicFlow"><img alt="Logo" src="phasicFlow_logo.png"></a></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>
<tr>
<td id="projectbrief">
<a href="https://https://cemf.ir">www.cemf.ir</a>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('error_8hpp.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="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">error.hpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Include dependency graph for error.hpp:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="error_8hpp__incl.png" border="0" usemap="#src_2phasicFlow_2globals_2error_8hpp" alt=""/></div>
</div>
</div><div class="textblock"><div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png" alt="+"/> This graph shows which files directly or indirectly include this file:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="error_8hpp__dep__incl.png" border="0" usemap="#src_2phasicFlow_2globals_2error_8hppdep" alt=""/></div>
</div>
</div>
<p><a href="error_8hpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacepFlow"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacepFlow.html">pFlow</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:adfe9ae1313e6913aca3f96d3eb67906e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error_8hpp.html#adfe9ae1313e6913aca3f96d3eb67906e">fatalError</a>&#160;&#160;&#160;<a class="el" href="error_8hpp.html#a0ed43bbcfae7ab9b70cd23a82db23c43">fatalErrorMessage</a>(__FILE__, __LINE__)</td></tr>
<tr class="memdesc:adfe9ae1313e6913aca3f96d3eb67906e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Report a fatal error and exit the applicaiton. <a href="error_8hpp.html#adfe9ae1313e6913aca3f96d3eb67906e">More...</a><br /></td></tr>
<tr class="separator:adfe9ae1313e6913aca3f96d3eb67906e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af6c6984e23cb04e9a23cbffaddfdeb31"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error_8hpp.html#af6c6984e23cb04e9a23cbffaddfdeb31">fatalErrorIn</a>(functionName)&#160;&#160;&#160;<a class="el" href="error_8hpp.html#a653033f027c35c016ad647d303a53846">fatalErrorInMessage</a>((functionName), __FILE__, __LINE__)</td></tr>
<tr class="memdesc:af6c6984e23cb04e9a23cbffaddfdeb31"><td class="mdescLeft">&#160;</td><td class="mdescRight">Report a fatal error and supplied function name and exit the application. <a href="error_8hpp.html#af6c6984e23cb04e9a23cbffaddfdeb31">More...</a><br /></td></tr>
<tr class="separator:af6c6984e23cb04e9a23cbffaddfdeb31"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aca9aa547c8441e4410a65a2ce7c21554"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error_8hpp.html#aca9aa547c8441e4410a65a2ce7c21554">fatalErrorInFunction</a>&#160;&#160;&#160;<a class="el" href="error_8hpp.html#af6c6984e23cb04e9a23cbffaddfdeb31">fatalErrorIn</a>(<a class="el" href="pFlowMacros_8hpp.html#a922d2784284e8f6ee4009c3d92ba48b6">FUNCTION_NAME</a>)</td></tr>
<tr class="memdesc:aca9aa547c8441e4410a65a2ce7c21554"><td class="mdescLeft">&#160;</td><td class="mdescRight">Report a fatal error and function name and exit the application. <a href="error_8hpp.html#aca9aa547c8441e4410a65a2ce7c21554">More...</a><br /></td></tr>
<tr class="separator:aca9aa547c8441e4410a65a2ce7c21554"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c0f77a1055614c58dcf89322035dcfb"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error_8hpp.html#a8c0f77a1055614c58dcf89322035dcfb">Not_Implemented</a>(functionName)&#160;&#160;&#160;<a class="el" href="error_8hpp.html#a760a332a5ee6b584fb927d3dd452f6d6">notImplementedErrorMessage</a>((functionName), __FILE__, __LINE__)</td></tr>
<tr class="memdesc:a8c0f77a1055614c58dcf89322035dcfb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Report that a function is yet not implemented with supplied function name. <a href="error_8hpp.html#a8c0f77a1055614c58dcf89322035dcfb">More...</a><br /></td></tr>
<tr class="separator:a8c0f77a1055614c58dcf89322035dcfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6d29ef74f19f6d5a225841705985eb8b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error_8hpp.html#a6d29ef74f19f6d5a225841705985eb8b">notImplementedFunction</a>&#160;&#160;&#160;<a class="el" href="error_8hpp.html#a8c0f77a1055614c58dcf89322035dcfb">Not_Implemented</a>(<a class="el" href="pFlowMacros_8hpp.html#a922d2784284e8f6ee4009c3d92ba48b6">FUNCTION_NAME</a>)</td></tr>
<tr class="memdesc:a6d29ef74f19f6d5a225841705985eb8b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Report that a function is yet not implemented. <a href="error_8hpp.html#a6d29ef74f19f6d5a225841705985eb8b">More...</a><br /></td></tr>
<tr class="separator:a6d29ef74f19f6d5a225841705985eb8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83efa053dfcfcef04cc0e721c0314ff3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error_8hpp.html#a83efa053dfcfcef04cc0e721c0314ff3">ioErrorInFile</a>(fileName, lineNumber)&#160;&#160;&#160;<a class="el" href="error_8hpp.html#a1eea9cba7dd30e9c608ddf28b295810f">ioErrorMessage</a>(fileName, lineNumber, <a class="el" href="pFlowMacros_8hpp.html#a922d2784284e8f6ee4009c3d92ba48b6">FUNCTION_NAME</a>, __FILE__, __LINE__)</td></tr>
<tr class="memdesc:a83efa053dfcfcef04cc0e721c0314ff3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Report an error in file operation with supplied fileName and lineNumber. <a href="error_8hpp.html#a83efa053dfcfcef04cc0e721c0314ff3">More...</a><br /></td></tr>
<tr class="separator:a83efa053dfcfcef04cc0e721c0314ff3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05bf53f02e547e2984101062aa87f595"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error_8hpp.html#a05bf53f02e547e2984101062aa87f595">warningIn</a>(functionName)&#160;&#160;&#160;<a class="el" href="error_8hpp.html#a76fb1cfa092a4635166f1a5b72b3b1e4">warningMessage</a>((functionName), __FILE__, __LINE__)</td></tr>
<tr class="memdesc:a05bf53f02e547e2984101062aa87f595"><td class="mdescLeft">&#160;</td><td class="mdescRight">Report a warning with supplied function name. <a href="error_8hpp.html#a05bf53f02e547e2984101062aa87f595">More...</a><br /></td></tr>
<tr class="separator:a05bf53f02e547e2984101062aa87f595"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a889d5e8bf195a24964ffb883bcb2fc3b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error_8hpp.html#a889d5e8bf195a24964ffb883bcb2fc3b">warningInFunction</a>&#160;&#160;&#160;<a class="el" href="error_8hpp.html#a05bf53f02e547e2984101062aa87f595">warningIn</a>(<a class="el" href="pFlowMacros_8hpp.html#a922d2784284e8f6ee4009c3d92ba48b6">FUNCTION_NAME</a>)</td></tr>
<tr class="memdesc:a889d5e8bf195a24964ffb883bcb2fc3b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Report a warning. <a href="error_8hpp.html#a889d5e8bf195a24964ffb883bcb2fc3b">More...</a><br /></td></tr>
<tr class="separator:a889d5e8bf195a24964ffb883bcb2fc3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad22a1cd3b45a97ac8cd195f06fe61fe"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error_8hpp.html#aad22a1cd3b45a97ac8cd195f06fe61fe">fatalExit</a>&#160;&#160;&#160;<a class="el" href="error_8hpp.html#a10962b7eb0b0232a01564fd7b6024745">reportAndExit</a>()</td></tr>
<tr class="memdesc:aad22a1cd3b45a97ac8cd195f06fe61fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fatal exit. <a href="error_8hpp.html#aad22a1cd3b45a97ac8cd195f06fe61fe">More...</a><br /></td></tr>
<tr class="separator:aad22a1cd3b45a97ac8cd195f06fe61fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ae15c9223dabc8b93eb4ce62aaf27c203"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error_8hpp.html#ae15c9223dabc8b93eb4ce62aaf27c203">fatalExitPhasicFlow</a> (int errorCode=EXIT_FAILURE)</td></tr>
<tr class="memdesc:ae15c9223dabc8b93eb4ce62aaf27c203"><td class="mdescLeft">&#160;</td><td class="mdescRight">Take actions to fatal exit phasicFlow. <a href="error_8hpp.html#ae15c9223dabc8b93eb4ce62aaf27c203">More...</a><br /></td></tr>
<tr class="separator:ae15c9223dabc8b93eb4ce62aaf27c203"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ed43bbcfae7ab9b70cd23a82db23c43"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1iOstream.html">pFlow::iOstream</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error_8hpp.html#a0ed43bbcfae7ab9b70cd23a82db23c43">fatalErrorMessage</a> (const char *fileName, int linNumber)</td></tr>
<tr class="separator:a0ed43bbcfae7ab9b70cd23a82db23c43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a653033f027c35c016ad647d303a53846"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1iOstream.html">pFlow::iOstream</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error_8hpp.html#a653033f027c35c016ad647d303a53846">fatalErrorInMessage</a> (const char *fnName, const char *fileName, int linNumber)</td></tr>
<tr class="separator:a653033f027c35c016ad647d303a53846"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a760a332a5ee6b584fb927d3dd452f6d6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1iOstream.html">pFlow::iOstream</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error_8hpp.html#a760a332a5ee6b584fb927d3dd452f6d6">notImplementedErrorMessage</a> (const char *fnName, const char *fileName, int lineNumber)</td></tr>
<tr class="separator:a760a332a5ee6b584fb927d3dd452f6d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1512f8ce86f161bd65dead74084e075e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1iOstream.html">pFlow::iOstream</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error_8hpp.html#a1512f8ce86f161bd65dead74084e075e">ioErrorMessage</a> (const <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">pFlow::word</a> &amp;fileName, int fileLineNumber, const char *fnName, const char *fName, int lNumber)</td></tr>
<tr class="separator:a1512f8ce86f161bd65dead74084e075e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1eea9cba7dd30e9c608ddf28b295810f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1iOstream.html">pFlow::iOstream</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error_8hpp.html#a1eea9cba7dd30e9c608ddf28b295810f">ioErrorMessage</a> (const char *fileName, int fileLineNumber, const char *fnName, const char *fName, int lNumber)</td></tr>
<tr class="separator:a1eea9cba7dd30e9c608ddf28b295810f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a76fb1cfa092a4635166f1a5b72b3b1e4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1iOstream.html">pFlow::iOstream</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error_8hpp.html#a76fb1cfa092a4635166f1a5b72b3b1e4">warningMessage</a> (const char *fnName, const char *fileName, int linNumber)</td></tr>
<tr class="separator:a76fb1cfa092a4635166f1a5b72b3b1e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10962b7eb0b0232a01564fd7b6024745"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1iOstream.html">pFlow::iOstream</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="error_8hpp.html#a10962b7eb0b0232a01564fd7b6024745">reportAndExit</a> (int errorCode=EXIT_FAILURE)</td></tr>
<tr class="separator:a10962b7eb0b0232a01564fd7b6024745"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="adfe9ae1313e6913aca3f96d3eb67906e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfe9ae1313e6913aca3f96d3eb67906e">&#9670;&nbsp;</a></span>fatalError</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define fatalError&#160;&#160;&#160;<a class="el" href="error_8hpp.html#a0ed43bbcfae7ab9b70cd23a82db23c43">fatalErrorMessage</a>(__FILE__, __LINE__)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Report a fatal error and exit the applicaiton. </p>
<p class="definition">Definition at line <a class="el" href="error_8hpp_source.html#l00070">70</a> of file <a class="el" href="error_8hpp_source.html">error.hpp</a>.</p>
</div>
</div>
<a id="af6c6984e23cb04e9a23cbffaddfdeb31"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af6c6984e23cb04e9a23cbffaddfdeb31">&#9670;&nbsp;</a></span>fatalErrorIn</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define fatalErrorIn</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">functionName</td><td>)</td>
<td>&#160;&#160;&#160;<a class="el" href="error_8hpp.html#a653033f027c35c016ad647d303a53846">fatalErrorInMessage</a>((functionName), __FILE__, __LINE__)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Report a fatal error and supplied function name and exit the application. </p>
<p class="definition">Definition at line <a class="el" href="error_8hpp_source.html#l00073">73</a> of file <a class="el" href="error_8hpp_source.html">error.hpp</a>.</p>
</div>
</div>
<a id="aca9aa547c8441e4410a65a2ce7c21554"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aca9aa547c8441e4410a65a2ce7c21554">&#9670;&nbsp;</a></span>fatalErrorInFunction</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define fatalErrorInFunction&#160;&#160;&#160;<a class="el" href="error_8hpp.html#af6c6984e23cb04e9a23cbffaddfdeb31">fatalErrorIn</a>(<a class="el" href="pFlowMacros_8hpp.html#a922d2784284e8f6ee4009c3d92ba48b6">FUNCTION_NAME</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Report a fatal error and function name and exit the application. </p>
<p class="definition">Definition at line <a class="el" href="error_8hpp_source.html#l00077">77</a> of file <a class="el" href="error_8hpp_source.html">error.hpp</a>.</p>
</div>
</div>
<a id="a8c0f77a1055614c58dcf89322035dcfb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c0f77a1055614c58dcf89322035dcfb">&#9670;&nbsp;</a></span>Not_Implemented</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define Not_Implemented</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">functionName</td><td>)</td>
<td>&#160;&#160;&#160;<a class="el" href="error_8hpp.html#a760a332a5ee6b584fb927d3dd452f6d6">notImplementedErrorMessage</a>((functionName), __FILE__, __LINE__)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Report that a function is yet not implemented with supplied function name. </p>
<p class="definition">Definition at line <a class="el" href="error_8hpp_source.html#l00080">80</a> of file <a class="el" href="error_8hpp_source.html">error.hpp</a>.</p>
</div>
</div>
<a id="a6d29ef74f19f6d5a225841705985eb8b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6d29ef74f19f6d5a225841705985eb8b">&#9670;&nbsp;</a></span>notImplementedFunction</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define notImplementedFunction&#160;&#160;&#160;<a class="el" href="error_8hpp.html#a8c0f77a1055614c58dcf89322035dcfb">Not_Implemented</a>(<a class="el" href="pFlowMacros_8hpp.html#a922d2784284e8f6ee4009c3d92ba48b6">FUNCTION_NAME</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Report that a function is yet not implemented. </p>
<p class="definition">Definition at line <a class="el" href="error_8hpp_source.html#l00084">84</a> of file <a class="el" href="error_8hpp_source.html">error.hpp</a>.</p>
</div>
</div>
<a id="a83efa053dfcfcef04cc0e721c0314ff3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83efa053dfcfcef04cc0e721c0314ff3">&#9670;&nbsp;</a></span>ioErrorInFile</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define ioErrorInFile</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">fileName, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">lineNumber&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>&#160;&#160;&#160;<a class="el" href="error_8hpp.html#a1eea9cba7dd30e9c608ddf28b295810f">ioErrorMessage</a>(fileName, lineNumber, <a class="el" href="pFlowMacros_8hpp.html#a922d2784284e8f6ee4009c3d92ba48b6">FUNCTION_NAME</a>, __FILE__, __LINE__)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Report an error in file operation with supplied fileName and lineNumber. </p>
<p class="definition">Definition at line <a class="el" href="error_8hpp_source.html#l00087">87</a> of file <a class="el" href="error_8hpp_source.html">error.hpp</a>.</p>
</div>
</div>
<a id="a05bf53f02e547e2984101062aa87f595"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a05bf53f02e547e2984101062aa87f595">&#9670;&nbsp;</a></span>warningIn</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define warningIn</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">functionName</td><td>)</td>
<td>&#160;&#160;&#160;<a class="el" href="error_8hpp.html#a76fb1cfa092a4635166f1a5b72b3b1e4">warningMessage</a>((functionName), __FILE__, __LINE__)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Report a warning with supplied function name. </p>
<p class="definition">Definition at line <a class="el" href="error_8hpp_source.html#l00091">91</a> of file <a class="el" href="error_8hpp_source.html">error.hpp</a>.</p>
</div>
</div>
<a id="a889d5e8bf195a24964ffb883bcb2fc3b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a889d5e8bf195a24964ffb883bcb2fc3b">&#9670;&nbsp;</a></span>warningInFunction</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define warningInFunction&#160;&#160;&#160;<a class="el" href="error_8hpp.html#a05bf53f02e547e2984101062aa87f595">warningIn</a>(<a class="el" href="pFlowMacros_8hpp.html#a922d2784284e8f6ee4009c3d92ba48b6">FUNCTION_NAME</a>)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Report a warning. </p>
<p class="definition">Definition at line <a class="el" href="error_8hpp_source.html#l00095">95</a> of file <a class="el" href="error_8hpp_source.html">error.hpp</a>.</p>
</div>
</div>
<a id="aad22a1cd3b45a97ac8cd195f06fe61fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad22a1cd3b45a97ac8cd195f06fe61fe">&#9670;&nbsp;</a></span>fatalExit</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define fatalExit&#160;&#160;&#160;<a class="el" href="error_8hpp.html#a10962b7eb0b0232a01564fd7b6024745">reportAndExit</a>()</td>
</tr>
</table>
</div><div class="memdoc">
<p>Fatal exit. </p>
<p class="definition">Definition at line <a class="el" href="error_8hpp_source.html#l00098">98</a> of file <a class="el" href="error_8hpp_source.html">error.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ae15c9223dabc8b93eb4ce62aaf27c203"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae15c9223dabc8b93eb4ce62aaf27c203">&#9670;&nbsp;</a></span>fatalExitPhasicFlow()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int fatalExitPhasicFlow </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>errorCode</em> = <code>EXIT_FAILURE</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Take actions to fatal exit phasicFlow. </p>
<p class="definition">Definition at line <a class="el" href="error_8cpp_source.html#l00119">119</a> of file <a class="el" href="error_8cpp_source.html">error.cpp</a>.</p>
<p class="reference">References <a class="el" href="processors_8cpp_source.html#l00147">processors::abort()</a>.</p>
<p class="reference">Referenced by <a class="el" href="error_8cpp_source.html#l00111">reportAndExit()</a>.</p>
<div id="dynsection-2" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-2-trigger" src="closed.png" alt="+"/> Here is the call graph for this function:</div>
<div id="dynsection-2-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-2-content" class="dyncontent" style="display:none;">
<div class="center"><img src="error_8hpp_ae15c9223dabc8b93eb4ce62aaf27c203_cgraph.png" border="0" usemap="#error_8hpp_ae15c9223dabc8b93eb4ce62aaf27c203_cgraph" alt=""/></div>
</div>
<div id="dynsection-3" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-3-trigger" src="closed.png" alt="+"/> Here is the caller graph for this function:</div>
<div id="dynsection-3-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-3-content" class="dyncontent" style="display:none;">
<div class="center"><img src="error_8hpp_ae15c9223dabc8b93eb4ce62aaf27c203_icgraph.png" border="0" usemap="#error_8hpp_ae15c9223dabc8b93eb4ce62aaf27c203_icgraph" alt=""/></div>
</div>
</div>
</div>
<a id="a0ed43bbcfae7ab9b70cd23a82db23c43"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ed43bbcfae7ab9b70cd23a82db23c43">&#9670;&nbsp;</a></span>fatalErrorMessage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpFlow_1_1iOstream.html">pFlow::iOstream</a>&amp; fatalErrorMessage </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>fileName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>linNumber</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="error_8cpp_source.html#l00035">35</a> of file <a class="el" href="error_8cpp_source.html">error.cpp</a>.</p>
<p class="reference">References <a class="el" href="error_8cpp_source.html#l00032">errorStream</a>, and <a class="el" href="iOstream_8hpp_source.html#l00039">Red_Text</a>.</p>
</div>
</div>
<a id="a653033f027c35c016ad647d303a53846"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a653033f027c35c016ad647d303a53846">&#9670;&nbsp;</a></span>fatalErrorInMessage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpFlow_1_1iOstream.html">pFlow::iOstream</a>&amp; fatalErrorInMessage </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>fnName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>fileName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>linNumber</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="error_8cpp_source.html#l00044">44</a> of file <a class="el" href="error_8cpp_source.html">error.cpp</a>.</p>
<p class="reference">References <a class="el" href="error_8cpp_source.html#l00032">errorStream</a>, and <a class="el" href="iOstream_8hpp_source.html#l00039">Red_Text</a>.</p>
<p class="reference">Referenced by <a class="el" href="processors_8cpp_source.html#l00165">pFlow::checkMPI()</a>.</p>
<div id="dynsection-4" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-4-trigger" src="closed.png" alt="+"/> Here is the caller graph for this function:</div>
<div id="dynsection-4-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-4-content" class="dyncontent" style="display:none;">
<div class="center"><img src="error_8hpp_a653033f027c35c016ad647d303a53846_icgraph.png" border="0" usemap="#error_8hpp_a653033f027c35c016ad647d303a53846_icgraph" alt=""/></div>
</div>
</div>
</div>
<a id="a760a332a5ee6b584fb927d3dd452f6d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a760a332a5ee6b584fb927d3dd452f6d6">&#9670;&nbsp;</a></span>notImplementedErrorMessage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpFlow_1_1iOstream.html">pFlow::iOstream</a>&amp; notImplementedErrorMessage </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>fnName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>fileName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>lineNumber</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="error_8cpp_source.html#l00054">54</a> of file <a class="el" href="error_8cpp_source.html">error.cpp</a>.</p>
<p class="reference">References <a class="el" href="error_8cpp_source.html#l00032">errorStream</a>, <a class="el" href="iOstream_8hpp_source.html#l00039">Red_Text</a>, and <a class="el" href="iOstream_8hpp_source.html#l00040">Yellow_Text</a>.</p>
</div>
</div>
<a id="a1512f8ce86f161bd65dead74084e075e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1512f8ce86f161bd65dead74084e075e">&#9670;&nbsp;</a></span>ioErrorMessage() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpFlow_1_1iOstream.html">pFlow::iOstream</a>&amp; ioErrorMessage </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">pFlow::word</a> &amp;&#160;</td>
<td class="paramname"><em>fileName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>fileLineNumber</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>fnName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>fName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>lNumber</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="error_8cpp_source.html#l00087">87</a> of file <a class="el" href="error_8cpp_source.html">error.cpp</a>.</p>
<p class="reference">References <a class="el" href="error_8cpp_source.html#l00069">ioErrorMessage()</a>.</p>
<div id="dynsection-5" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-5-trigger" src="closed.png" alt="+"/> Here is the call graph for this function:</div>
<div id="dynsection-5-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-5-content" class="dyncontent" style="display:none;">
<div class="center"><img src="error_8hpp_a1512f8ce86f161bd65dead74084e075e_cgraph.png" border="0" usemap="#error_8hpp_a1512f8ce86f161bd65dead74084e075e_cgraph" alt=""/></div>
</div>
</div>
</div>
<a id="a1eea9cba7dd30e9c608ddf28b295810f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1eea9cba7dd30e9c608ddf28b295810f">&#9670;&nbsp;</a></span>ioErrorMessage() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpFlow_1_1iOstream.html">pFlow::iOstream</a>&amp; ioErrorMessage </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>fileName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>fileLineNumber</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>fnName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>fName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>lNumber</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="error_8cpp_source.html#l00069">69</a> of file <a class="el" href="error_8cpp_source.html">error.cpp</a>.</p>
<p class="reference">References <a class="el" href="error_8cpp_source.html#l00032">errorStream</a>, and <a class="el" href="iOstream_8hpp_source.html#l00039">Red_Text</a>.</p>
<p class="reference">Referenced by <a class="el" href="error_8cpp_source.html#l00087">ioErrorMessage()</a>.</p>
<div id="dynsection-6" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-6-trigger" src="closed.png" alt="+"/> Here is the caller graph for this function:</div>
<div id="dynsection-6-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-6-content" class="dyncontent" style="display:none;">
<div class="center"><img src="error_8hpp_a1eea9cba7dd30e9c608ddf28b295810f_icgraph.png" border="0" usemap="#error_8hpp_a1eea9cba7dd30e9c608ddf28b295810f_icgraph" alt=""/></div>
</div>
</div>
</div>
<a id="a76fb1cfa092a4635166f1a5b72b3b1e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a76fb1cfa092a4635166f1a5b72b3b1e4">&#9670;&nbsp;</a></span>warningMessage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpFlow_1_1iOstream.html">pFlow::iOstream</a>&amp; warningMessage </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>fnName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>fileName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>linNumber</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="error_8cpp_source.html#l00101">101</a> of file <a class="el" href="error_8cpp_source.html">error.cpp</a>.</p>
<p class="reference">References <a class="el" href="error_8cpp_source.html#l00032">errorStream</a>, and <a class="el" href="iOstream_8hpp_source.html#l00040">Yellow_Text</a>.</p>
</div>
</div>
<a id="a10962b7eb0b0232a01564fd7b6024745"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a10962b7eb0b0232a01564fd7b6024745">&#9670;&nbsp;</a></span>reportAndExit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpFlow_1_1iOstream.html">pFlow::iOstream</a>&amp; reportAndExit </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>errorCode</em> = <code>EXIT_FAILURE</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="error_8cpp_source.html#l00111">111</a> of file <a class="el" href="error_8cpp_source.html">error.cpp</a>.</p>
<p class="reference">References <a class="el" href="iOstream_8hpp_source.html#l00341">pFlow::endl()</a>, <a class="el" href="error_8cpp_source.html#l00032">errorStream</a>, and <a class="el" href="error_8cpp_source.html#l00119">fatalExitPhasicFlow()</a>.</p>
<p class="reference">Referenced by <a class="el" href="processors_8cpp_source.html#l00165">pFlow::checkMPI()</a>.</p>
<div id="dynsection-7" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-7-trigger" src="closed.png" alt="+"/> Here is the call graph for this function:</div>
<div id="dynsection-7-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-7-content" class="dyncontent" style="display:none;">
<div class="center"><img src="error_8hpp_a10962b7eb0b0232a01564fd7b6024745_cgraph.png" border="0" usemap="#error_8hpp_a10962b7eb0b0232a01564fd7b6024745_cgraph" alt=""/></div>
</div>
<div id="dynsection-8" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-8-trigger" src="closed.png" alt="+"/> Here is the caller graph for this function:</div>
<div id="dynsection-8-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-8-content" class="dyncontent" style="display:none;">
<div class="center"><img src="error_8hpp_a10962b7eb0b0232a01564fd7b6024745_icgraph.png" border="0" usemap="#error_8hpp_a10962b7eb0b0232a01564fd7b6024745_icgraph" alt=""/></div>
</div>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<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>