mirror of
https://github.com/PhasicFlow/phasicFlow.git
synced 2025-06-22 16:28:30 +00:00
documentation for v1.0
This commit is contained in:
HRN
@ -127,49 +127,54 @@ $(document).ready(function(){initNavTree('checkPhasicFlow_8cpp_source.html','');
|
||||
<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> <span class="preprocessor">#include "<a class="code" href="KokkosTypes_8hpp.html">KokkosTypes.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include "<a class="code" href="systemControl_8hpp.html">systemControl.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "<a class="code" href="commandLine_8hpp.html">commandLine.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
|
||||
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include "<a class="code" href="localProcessors_8hpp.html">localProcessors.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "<a class="code" href="commandLine_8hpp.html">commandLine.hpp</a>"</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="keyword">using</span> <a class="code" href="namespacepFlow.html#a86ae30c22a4ef4bc487b40ed52f4d2f9">pFlow::output</a>;</div>
|
||||
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">using</span> <a class="code" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">pFlow::endl</a>;</div>
|
||||
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">using</span> <a class="code" href="classpFlow_1_1commandLine.html">pFlow::commandLine</a>;</div>
|
||||
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
|
||||
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="checkPhasicFlow_8cpp.html#a0ddf1224851353fc92bfbff6f499fa97"> 30</a></span> <span class="keywordtype">int</span> <a class="code" href="checkPhasicFlow_8cpp.html#a0ddf1224851353fc92bfbff6f499fa97">main</a>( <span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>* argv[] )</div>
|
||||
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> {</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>  <a class="code" href="classpFlow_1_1commandLine.html">commandLine</a> cmds(</div>
|
||||
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="stringliteral">"checkPhasicFlow"</span>,</div>
|
||||
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="stringliteral">"A utility to check software version, host and device environments and whether it is linked"</span>);</div>
|
||||
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div>
|
||||
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keywordflow">if</span>(!cmds.<a class="code" href="classpFlow_1_1commandLine.html#af199716992f3f8bb51c89ddcca847062">parse</a>(argc, argv)) <span class="keywordflow">return</span> 0;</div>
|
||||
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  </div>
|
||||
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">// this should be palced in each main </span></div>
|
||||
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#include "<a class="code" href="initialize_8hpp.html">initialize.hpp</a>"</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"> 42</span>  <a class="code" href="namespacepFlow.html#a86ae30c22a4ef4bc487b40ed52f4d2f9">output</a><<<a class="code" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">endl</a>;</div>
|
||||
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="streams_8hpp.html#aeb765df06121339620670437d217fec8">REPORT</a>(1)<< <span class="stringliteral">"You are using "</span><<<a class="code" href="streams_8hpp.html#a71e567553baf2a24a11e442683cde599">yellowText</a>(cmds.<a class="code" href="classpFlow_1_1commandLine.html#a14acfb8b26f5fd0e88d6aa2b753223fc">productNameCopyright</a>())<<<a class="code" href="streams_8hpp.html#a04db65a6cb5a45695ea75cce1b5d7a10">endREPORT</a>;</div>
|
||||
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="streams_8hpp.html#aeb765df06121339620670437d217fec8">REPORT</a>(1)<< <a class="code" href="streams_8hpp.html#a71e567553baf2a24a11e442683cde599">yellowText</a>(<a class="code" href="namespacepFlow.html#a8618ad0dd0cc0dda06724d40b728c96e">pFlow::floatingPointDescription</a>())<<<a class="code" href="streams_8hpp.html#a04db65a6cb5a45695ea75cce1b5d7a10">endREPORT</a>;</div>
|
||||
<div class="line"><a name="l00045"></a><span class="lineno"> 45</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"> 47</span> <span class="comment">// this should be palced in each main </span></div>
|
||||
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#include "<a class="code" href="finalize_8hpp.html">finalize.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
||||
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="keyword">using</span> <a class="code" href="namespacepFlow.html#a86ae30c22a4ef4bc487b40ed52f4d2f9">pFlow::output</a>;</div>
|
||||
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="keyword">using</span> <a class="code" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">pFlow::endl</a>;</div>
|
||||
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">using</span> <a class="code" href="classpFlow_1_1commandLine.html">pFlow::commandLine</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"><a class="line" href="checkPhasicFlow_8cpp.html#a0ddf1224851353fc92bfbff6f499fa97"> 31</a></span> <span class="keywordtype">int</span> <a class="code" href="checkPhasicFlow_8cpp.html#a0ddf1224851353fc92bfbff6f499fa97">main</a>( <span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>* argv[] )</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>  <a class="code" href="classpFlow_1_1commandLine.html">commandLine</a> cmds(</div>
|
||||
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <span class="stringliteral">"checkPhasicFlow"</span>,</div>
|
||||
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="stringliteral">"A utility to check software version, host and device environments and whether it is linked"</span>);</div>
|
||||
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div>
|
||||
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="keywordflow">if</span>(!cmds.<a class="code" href="classpFlow_1_1commandLine.html#af199716992f3f8bb51c89ddcca847062">parse</a>(argc, argv)) <span class="keywordflow">return</span> 0;</div>
|
||||
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div>
|
||||
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment">// this should be palced in each main </span></div>
|
||||
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#include "<a class="code" href="initialize_8hpp.html">initialize.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
|
||||
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="namespacepFlow.html#a86ae30c22a4ef4bc487b40ed52f4d2f9">output</a><<<a class="code" href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">endl</a>;</div>
|
||||
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="streams_8hpp.html#aeb765df06121339620670437d217fec8">REPORT</a>(1)<< <span class="stringliteral">"You are using "</span><<<a class="code" href="iOstream_8hpp.html#a06734f691d48f8796526b96cd58b982c">Yellow_Text</a>(cmds.<a class="code" href="classpFlow_1_1commandLine.html#a14acfb8b26f5fd0e88d6aa2b753223fc">productNameCopyright</a>())<<<a class="code" href="streams_8hpp.html#a1861619f2a6e102d0043a98577c8c9e8">END_REPORT</a>;</div>
|
||||
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="streams_8hpp.html#aeb765df06121339620670437d217fec8">REPORT</a>(1)<< <a class="code" href="iOstream_8hpp.html#a06734f691d48f8796526b96cd58b982c">Yellow_Text</a>(<a class="code" href="namespacepFlow.html#a6db03e44eeb9661c768aec3ea58484c7">pFlow::floatingPointDescription</a>())<<<a class="code" href="streams_8hpp.html#a1861619f2a6e102d0043a98577c8c9e8">END_REPORT</a>;</div>
|
||||
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="streams_8hpp.html#aeb765df06121339620670437d217fec8">REPORT</a>(1)<< (<a class="code" href="classpFlow_1_1localProcessors.html#a920c86f8bbb0c9760bdd4b56abaf648a">pFlow::localProcessors::builtForMPI</a>()?</div>
|
||||
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="stringliteral">"This is a built for MPI execution"</span>:</div>
|
||||
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="stringliteral">"This is not a build for MPI execution"</span>)<<<a class="code" href="streams_8hpp.html#a1861619f2a6e102d0043a98577c8c9e8">END_REPORT</a>;</div>
|
||||
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div>
|
||||
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="keywordflow">return</span> 0;</div>
|
||||
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> } </div>
|
||||
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment">// this should be palced in each main </span></div>
|
||||
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#include "<a class="code" href="finalize_8hpp.html">finalize.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  </div>
|
||||
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">return</span> 0;</div>
|
||||
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> } </div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<div class="ttc" id="astreams_8hpp_html_a04db65a6cb5a45695ea75cce1b5d7a10"><div class="ttname"><a href="streams_8hpp.html#a04db65a6cb5a45695ea75cce1b5d7a10">endREPORT</a></div><div class="ttdeci">#define endREPORT</div><div class="ttdef"><b>Definition:</b> <a href="streams_8hpp_source.html#l00041">streams.hpp:41</a></div></div>
|
||||
<div class="ttc" id="astreams_8hpp_html_aeb765df06121339620670437d217fec8"><div class="ttname"><a href="streams_8hpp.html#aeb765df06121339620670437d217fec8">REPORT</a></div><div class="ttdeci">#define REPORT(n)</div><div class="ttdef"><b>Definition:</b> <a href="streams_8hpp_source.html#l00040">streams.hpp:40</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1localProcessors_html_a920c86f8bbb0c9760bdd4b56abaf648a"><div class="ttname"><a href="classpFlow_1_1localProcessors.html#a920c86f8bbb0c9760bdd4b56abaf648a">pFlow::localProcessors::builtForMPI</a></div><div class="ttdeci">static bool builtForMPI()</div><div class="ttdef"><b>Definition:</b> <a href="localProcessors_8hpp_source.html#l00149">localProcessors.hpp:149</a></div></div>
|
||||
<div class="ttc" id="astreams_8hpp_html_aeb765df06121339620670437d217fec8"><div class="ttname"><a href="streams_8hpp.html#aeb765df06121339620670437d217fec8">REPORT</a></div><div class="ttdeci">#define REPORT(n)</div><div class="ttdef"><b>Definition:</b> <a href="streams_8hpp_source.html#l00039">streams.hpp:39</a></div></div>
|
||||
<div class="ttc" id="asystemControl_8hpp_html"><div class="ttname"><a href="systemControl_8hpp.html">systemControl.hpp</a></div></div>
|
||||
<div class="ttc" id="aKokkosTypes_8hpp_html"><div class="ttname"><a href="KokkosTypes_8hpp.html">KokkosTypes.hpp</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 & endl(iOstream &os)</div><div class="ttdoc">Add newline and flush stream.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00320">iOstream.hpp:320</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 & endl(iOstream &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="ainitialize_8hpp_html"><div class="ttname"><a href="initialize_8hpp.html">initialize.hpp</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="anamespacepFlow_html_a86ae30c22a4ef4bc487b40ed52f4d2f9"><div class="ttname"><a href="namespacepFlow.html#a86ae30c22a4ef4bc487b40ed52f4d2f9">pFlow::output</a></div><div class="ttdeci">Ostream output</div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_a8618ad0dd0cc0dda06724d40b728c96e"><div class="ttname"><a href="namespacepFlow.html#a8618ad0dd0cc0dda06724d40b728c96e">pFlow::floatingPointDescription</a></div><div class="ttdeci">auto floatingPointDescription()</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00066">builtinTypes.hpp:66</a></div></div>
|
||||
<div class="ttc" id="astreams_8hpp_html_a71e567553baf2a24a11e442683cde599"><div class="ttname"><a href="streams_8hpp.html#a71e567553baf2a24a11e442683cde599">yellowText</a></div><div class="ttdeci">#define yellowText(text)</div><div class="ttdef"><b>Definition:</b> <a href="streams_8hpp_source.html#l00030">streams.hpp:30</a></div></div>
|
||||
<div class="ttc" id="acheckPhasicFlow_8cpp_html_a0ddf1224851353fc92bfbff6f499fa97"><div class="ttname"><a href="checkPhasicFlow_8cpp.html#a0ddf1224851353fc92bfbff6f499fa97">main</a></div><div class="ttdeci">int main(int argc, char *argv[])</div><div class="ttdef"><b>Definition:</b> <a href="checkPhasicFlow_8cpp_source.html#l00030">checkPhasicFlow.cpp:30</a></div></div>
|
||||
<div class="ttc" id="astreams_8hpp_html_a1861619f2a6e102d0043a98577c8c9e8"><div class="ttname"><a href="streams_8hpp.html#a1861619f2a6e102d0043a98577c8c9e8">END_REPORT</a></div><div class="ttdeci">#define END_REPORT</div><div class="ttdef"><b>Definition:</b> <a href="streams_8hpp_source.html#l00040">streams.hpp:40</a></div></div>
|
||||
<div class="ttc" id="alocalProcessors_8hpp_html"><div class="ttname"><a href="localProcessors_8hpp.html">localProcessors.hpp</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="acheckPhasicFlow_8cpp_html_a0ddf1224851353fc92bfbff6f499fa97"><div class="ttname"><a href="checkPhasicFlow_8cpp.html#a0ddf1224851353fc92bfbff6f499fa97">main</a></div><div class="ttdeci">int main(int argc, char *argv[])</div><div class="ttdef"><b>Definition:</b> <a href="checkPhasicFlow_8cpp_source.html#l00031">checkPhasicFlow.cpp:31</a></div></div>
|
||||
<div class="ttc" id="acommandLine_8hpp_html"><div class="ttname"><a href="commandLine_8hpp.html">commandLine.hpp</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1commandLine_html_a14acfb8b26f5fd0e88d6aa2b753223fc"><div class="ttname"><a href="classpFlow_1_1commandLine.html#a14acfb8b26f5fd0e88d6aa2b753223fc">pFlow::commandLine::productNameCopyright</a></div><div class="ttdeci">word productNameCopyright() const</div><div class="ttdef"><b>Definition:</b> <a href="commandLine_8hpp_source.html#l00096">commandLine.hpp:96</a></div></div>
|
||||
<div class="ttc" id="afinalize_8hpp_html"><div class="ttname"><a href="finalize_8hpp.html">finalize.hpp</a></div></div>
|
||||
|
||||
Reference in New Issue
Block a user