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

199 lines
22 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/commandLine/commandLine.cpp 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&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('commandLine_8cpp_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">commandLine.cpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="commandLine_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*------------------------------- phasicFlow ---------------------------------</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> O C enter of</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> O O E ngineering and</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> O O M ultiscale modeling of</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> OOOOOOO F luid flow </span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">------------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> Copyright (C): www.cemf.ir</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> email: hamid.r.norouzi AT gmail.com</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">------------------------------------------------------------------------------ </span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">Licence:</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<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>&#160;<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>&#160;<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>&#160;<span class="comment"> </span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<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>&#160;<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>&#160;<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>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="comment">-----------------------------------------------------------------------------*/</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="commandLine_8hpp.html">commandLine.hpp</a>&quot;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="classpFlow_1_1commandLine.html#abaf8950d8dfd816efcbf7d1fac3864cf"> 24</a></span>&#160;<a class="code" href="classpFlow_1_1commandLine.html#abaf8950d8dfd816efcbf7d1fac3864cf">pFlow::commandLine::commandLine</a>(<a class="code" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> appName)</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;:</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; CLI::App(description),</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; appName_(appName)</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;{</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; CLI::App::set_help_flag(<span class="stringliteral">&quot;-h,--help&quot;</span>, <span class="stringliteral">&quot;Help for using &quot;</span>+<a class="code" href="classpFlow_1_1commandLine.html#a7f04090943d139b6d697f4a194a3641d">appName_</a>+ <span class="stringliteral">&quot; of &quot;</span>+<a class="code" href="classpFlow_1_1commandLine.html#a6432f1237593152a2ca882342fb3abba">versionName</a>);</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; CLI::App::set_version_flag(<span class="stringliteral">&quot;-v,--version&quot;</span>, <a class="code" href="classpFlow_1_1commandLine.html#a6432f1237593152a2ca882342fb3abba">versionName</a>, <span class="stringliteral">&quot;Program version information&quot;</span>);</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;}</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; </div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="classpFlow_1_1commandLine.html#ac91c659a0deaa02d39d2c20dbf13e569"> 33</a></span>&#160;<a class="code" href="classpFlow_1_1commandLine.html#abaf8950d8dfd816efcbf7d1fac3864cf">pFlow::commandLine::commandLine</a>(<a class="code" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> appName, <a class="code" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> disptn)</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;:</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <a class="code" href="classpFlow_1_1commandLine.html">commandLine</a>(appName)</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;{</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; CLI::App::add_flag_callback(</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <span class="stringliteral">&quot;--description&quot;</span>,</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; [disptn, appName]() {</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <a class="code" href="namespacepFlow.html#a3b4a2b317fde2e633c19612003db8859">mOutput</a>&lt;&lt;<span class="stringliteral">&quot;\n&quot;</span>&lt;&lt;<a class="code" href="iOstream_8hpp.html#a06734f691d48f8796526b96cd58b982c">Yellow_Text</a>(<a class="code" href="classpFlow_1_1commandLine.html#aea06e98469774a68c6962a88b0bb89ce">versoinCopyright</a>)&lt;&lt;<a class="code" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">endl</a>;</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <a class="code" href="namespacepFlow.html#a3b4a2b317fde2e633c19612003db8859">mOutput</a>&lt;&lt;<a class="code" href="iOstream_8hpp.html#a06734f691d48f8796526b96cd58b982c">Yellow_Text</a>(<a class="code" href="namespacepFlow.html#a6db03e44eeb9661c768aec3ea58484c7">floatingPointDescription</a>())&lt;&lt;<a class="code" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">endl</a>&lt;&lt;<a class="code" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">endl</a>;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; <a class="code" href="namespacepFlow.html#a3b4a2b317fde2e633c19612003db8859">mOutput</a>&lt;&lt;<span class="stringliteral">&quot;Description for &quot;</span>&lt;&lt; <a class="code" href="iOstream_8hpp.html#a1d2aa4542eb9ce3820d6bb9a89ed3cdb">Bold_Text</a>(appName)&lt;&lt;<span class="stringliteral">&quot;:\n&quot;</span>;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; <a class="code" href="namespacepFlow.html#a3b4a2b317fde2e633c19612003db8859">mOutput</a>&lt;&lt;<span class="stringliteral">&quot; &quot;</span>&lt;&lt;disptn&lt;&lt;<a class="code" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">endl</a>;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; },</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="stringliteral">&quot;What does this app do?&quot;</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; )-&gt;configurable(<span class="keyword">false</span>);</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;}</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; </div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="classpFlow_1_1commandLine.html#af199716992f3f8bb51c89ddcca847062"> 50</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="classpFlow_1_1commandLine.html#af199716992f3f8bb51c89ddcca847062">pFlow::commandLine::parse</a>(</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keywordtype">int</span> argc,</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordtype">char</span>** argv)</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;{</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordflow">try</span> { </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; CLI::App::parse(argc, argv);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordflow">if</span>(<a class="code" href="VectorFwd_8hpp.html#a3557595cfa50bcbd2098e44fe7da1bbd">CLI::App::count</a>(<span class="stringliteral">&quot;--description&quot;</span>)) <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; } <span class="keywordflow">catch</span>(<span class="keyword">const</span> <a class="code" href="classpFlow_1_1commandLine.html#adc698d020468722ea41a083f9ac491ed">ParseError</a> &amp;e) { </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160; CLI::App::exit(e);</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; }</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; </div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; <span class="comment">//if()</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;}</div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<div class="ttc" id="aVectorFwd_8hpp_html_a3557595cfa50bcbd2098e44fe7da1bbd"><div class="ttname"><a href="VectorFwd_8hpp.html#a3557595cfa50bcbd2098e44fe7da1bbd">count</a></div><div class="ttdeci">auto count(const Vector&lt; T, Allocator &gt; &amp;vec, const T &amp;val)</div></div>
<div class="ttc" id="anamespacepFlow_html_a3b4a2b317fde2e633c19612003db8859"><div class="ttname"><a href="namespacepFlow.html#a3b4a2b317fde2e633c19612003db8859">pFlow::mOutput</a></div><div class="ttdeci">masterOstream mOutput</div></div>
<div class="ttc" id="aclasspFlow_1_1commandLine_html_a7f04090943d139b6d697f4a194a3641d"><div class="ttname"><a href="classpFlow_1_1commandLine.html#a7f04090943d139b6d697f4a194a3641d">pFlow::commandLine::appName_</a></div><div class="ttdeci">word appName_</div><div class="ttdef"><b>Definition:</b> <a href="commandLine_8hpp_source.html#l00050">commandLine.hpp:50</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#l00064">builtinTypes.hpp:64</a></div></div>
<div class="ttc" id="aclasspFlow_1_1commandLine_html"><div class="ttname"><a href="classpFlow_1_1commandLine.html">pFlow::commandLine</a></div><div class="ttdef"><b>Definition:</b> <a href="commandLine_8hpp_source.html#l00036">commandLine.hpp:36</a></div></div>
<div class="ttc" id="anamespacepFlow_html_aba8f0c455a3fdb4b05ad33a25b13b189"><div class="ttname"><a href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">pFlow::endl</a></div><div class="ttdeci">iOstream &amp; endl(iOstream &amp;os)</div><div class="ttdoc">Add newline and flush stream.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00341">iOstream.hpp:341</a></div></div>
<div class="ttc" id="aiOstream_8hpp_html_a06734f691d48f8796526b96cd58b982c"><div class="ttname"><a href="iOstream_8hpp.html#a06734f691d48f8796526b96cd58b982c">Yellow_Text</a></div><div class="ttdeci">#define Yellow_Text(text)</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00040">iOstream.hpp:40</a></div></div>
<div class="ttc" id="aclasspFlow_1_1commandLine_html_af199716992f3f8bb51c89ddcca847062"><div class="ttname"><a href="classpFlow_1_1commandLine.html#af199716992f3f8bb51c89ddcca847062">pFlow::commandLine::parse</a></div><div class="ttdeci">bool parse(int argc, char **argv)</div><div class="ttdef"><b>Definition:</b> <a href="commandLine_8cpp_source.html#l00050">commandLine.cpp:50</a></div></div>
<div class="ttc" id="aclasspFlow_1_1commandLine_html_aea06e98469774a68c6962a88b0bb89ce"><div class="ttname"><a href="classpFlow_1_1commandLine.html#aea06e98469774a68c6962a88b0bb89ce">pFlow::commandLine::versoinCopyright</a></div><div class="ttdeci">static word versoinCopyright</div><div class="ttdef"><b>Definition:</b> <a href="commandLine_8hpp_source.html#l00062">commandLine.hpp:62</a></div></div>
<div class="ttc" id="aclasspFlow_1_1commandLine_html_abaf8950d8dfd816efcbf7d1fac3864cf"><div class="ttname"><a href="classpFlow_1_1commandLine.html#abaf8950d8dfd816efcbf7d1fac3864cf">pFlow::commandLine::commandLine</a></div><div class="ttdeci">commandLine(word appName)</div><div class="ttdef"><b>Definition:</b> <a href="commandLine_8cpp_source.html#l00024">commandLine.cpp:24</a></div></div>
<div class="ttc" id="aclasspFlow_1_1commandLine_html_a6432f1237593152a2ca882342fb3abba"><div class="ttname"><a href="classpFlow_1_1commandLine.html#a6432f1237593152a2ca882342fb3abba">pFlow::commandLine::versionName</a></div><div class="ttdeci">static word versionName</div><div class="ttdef"><b>Definition:</b> <a href="commandLine_8hpp_source.html#l00060">commandLine.hpp:60</a></div></div>
<div class="ttc" id="aclasspFlow_1_1commandLine_html_adc698d020468722ea41a083f9ac491ed"><div class="ttname"><a href="classpFlow_1_1commandLine.html#adc698d020468722ea41a083f9ac491ed">pFlow::commandLine::ParseError</a></div><div class="ttdeci">CLI::ParseError ParseError</div><div class="ttdef"><b>Definition:</b> <a href="commandLine_8hpp_source.html#l00044">commandLine.hpp:44</a></div></div>
<div class="ttc" id="aiOstream_8hpp_html_a1d2aa4542eb9ce3820d6bb9a89ed3cdb"><div class="ttname"><a href="iOstream_8hpp.html#a1d2aa4542eb9ce3820d6bb9a89ed3cdb">Bold_Text</a></div><div class="ttdeci">#define Bold_Text(text)</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00045">iOstream.hpp:45</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a6db03e44eeb9661c768aec3ea58484c7"><div class="ttname"><a href="namespacepFlow.html#a6db03e44eeb9661c768aec3ea58484c7">pFlow::floatingPointDescription</a></div><div class="ttdeci">word floatingPointDescription()</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00069">builtinTypes.hpp:69</a></div></div>
<div class="ttc" id="acommandLine_8hpp_html"><div class="ttname"><a href="commandLine_8hpp.html">commandLine.hpp</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_3e34f9c05fd0d7f6d87a3ac222c49464.html">commandLine</a></li><li class="navelem"><a class="el" href="commandLine_8cpp.html">commandLine.cpp</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>