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
@ -124,60 +124,65 @@ $(document).ready(function(){initNavTree('iterateGeometry_8cpp_source.html','');
|
||||
<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="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "<a class="code" href="systemControl_8hpp.html">systemControl.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include "<a class="code" href="geometryMotion_8hpp.html">geometryMotion.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include "<a class="code" href="commandLine_8hpp.html">commandLine.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include "<a class="code" href="readControlDict_8hpp.html">readControlDict.hpp</a>"</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="keyword">using</span> <a class="code" href="classpFlow_1_1commandLine.html">pFlow::commandLine</a>;</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="iterateGeometry_8cpp.html#a0ddf1224851353fc92bfbff6f499fa97"> 39</a></span> <span class="keywordtype">int</span> <a class="code" href="iterateGeometry_8cpp.html#a0ddf1224851353fc92bfbff6f499fa97">main</a>( <span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>* argv[] )</div>
|
||||
<div class="line"><a name="l00040"></a><span class="lineno"> 40</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="classpFlow_1_1commandLine.html">commandLine</a> cmds(</div>
|
||||
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="stringliteral">"iterateGeometry"</span>,</div>
|
||||
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="stringliteral">"Performs simulation without particles, only geometry is solved"</span>);</div>
|
||||
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "<a class="code" href="vocabs_8hpp.html">vocabs.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#include "<a class="code" href="systemControl_8hpp.html">systemControl.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#include "<a class="code" href="geometry_8hpp.html">geometry.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include "<a class="code" href="commandLine_8hpp.html">commandLine.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">//#include "readControlDict.hpp"</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"><a class="line" href="iterateGeometry_8cpp.html#a0ddf1224851353fc92bfbff6f499fa97"> 38</a></span> <span class="keywordtype">int</span> <a class="code" href="iterateGeometry_8cpp.html#a0ddf1224851353fc92bfbff6f499fa97">main</a>( <span class="keywordtype">int</span> argc, <span class="keywordtype">char</span>* argv[] )</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>  </div>
|
||||
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <a class="code" href="classpFlow_1_1commandLine.html">pFlow::commandLine</a> cmds(</div>
|
||||
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="stringliteral">"iterateGeometry"</span>,</div>
|
||||
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="stringliteral">"Performs simulation without particles, only geometry is solved"</span>);</div>
|
||||
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </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="keywordtype">bool</span> isCoupling = <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  cmds.add_flag(</div>
|
||||
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="stringliteral">"-c,--coupling"</span>,</div>
|
||||
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  isCoupling,</div>
|
||||
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="stringliteral">"Is this a fluid-particle coupling simulation?"</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">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="l00054"></a><span class="lineno"> 54</span>  </div>
|
||||
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  </div>
|
||||
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment">// this should be palced in each main </span></div>
|
||||
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#include "<a class="code" href="initialize__Control_8hpp.html">initialize_Control.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div>
|
||||
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor"> #include "<a class="code" href="setProperty_8hpp.html">setProperty.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="preprocessor"> #include "<a class="code" href="setSurfaceGeometry_8hpp.html">setSurfaceGeometry.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div>
|
||||
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div>
|
||||
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keywordflow">do</span></div>
|
||||
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  {</div>
|
||||
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <a class="code" href="setSurfaceGeometry_8hpp.html#a195e279064ba2595c36f5f8d504822cb">surfGeometry</a>.iterate();</div>
|
||||
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div>
|
||||
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  }<span class="keywordflow">while</span>( <a class="code" href="initialize__Control_8hpp.html#a4f5e4e852648762473ecd75a907417ca">Control</a>++);</div>
|
||||
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div>
|
||||
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment">// this should be palced in each main </span></div>
|
||||
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="preprocessor">#include "<a class="code" href="finalize_8hpp.html">finalize.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  </div>
|
||||
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> }</div>
|
||||
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keywordtype">bool</span> isCoupling = <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  cmds.add_flag(</div>
|
||||
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="stringliteral">"-c,--coupling"</span>,</div>
|
||||
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  isCoupling,</div>
|
||||
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="stringliteral">"Is this a fluid-particle coupling simulation?"</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"> 52</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="l00053"></a><span class="lineno"> 53</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"> 55</span> <span class="comment">// this should be palced in each main </span></div>
|
||||
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <a class="code" href="classpFlow_1_1processors.html#af906dbdefab1fa8e20574cfe3624a1b6">pFlow::processors::initProcessors</a>(argc, argv);</div>
|
||||
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <a class="code" href="namespacepFlow.html#a56ba5dd1e49ff3384363db392fb1c770">pFlow::initialize_pFlowProcessors</a>();</div>
|
||||
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#include "<a class="code" href="initialize__Control_8hpp.html">initialize_Control.hpp</a>"</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> <span class="preprocessor"> #include "<a class="code" href="setProperty_8hpp.html">setProperty.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor"> #include "<a class="code" href="setSurfaceGeometry_8hpp.html">setSurfaceGeometry.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div>
|
||||
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
|
||||
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">do</span></div>
|
||||
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  {</div>
|
||||
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <a class="code" href="setSurfaceGeometry_8hpp.html#a195e279064ba2595c36f5f8d504822cb">surfGeometry</a>.iterate();</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="keywordflow">while</span>( <a class="code" href="initialize__Control_8hpp.html#a4f5e4e852648762473ecd75a907417ca">Control</a>++);</div>
|
||||
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  </div>
|
||||
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">// this should be palced in each main </span></div>
|
||||
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="preprocessor">#include "<a class="code" href="finalize_8hpp.html">finalize.hpp</a>"</span></div>
|
||||
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <a class="code" href="classpFlow_1_1processors.html#af07b65f79644dae88cfa7a956f6c0fca">pFlow::processors::finalizeProcessors</a>();</div>
|
||||
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  </div>
|
||||
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> }</div>
|
||||
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  </div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<div class="ttc" id="ainitialize__Control_8hpp_html"><div class="ttname"><a href="initialize__Control_8hpp.html">initialize_Control.hpp</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1processors_html_af906dbdefab1fa8e20574cfe3624a1b6"><div class="ttname"><a href="classpFlow_1_1processors.html#af906dbdefab1fa8e20574cfe3624a1b6">pFlow::processors::initProcessors</a></div><div class="ttdeci">static void initProcessors(int argc, char *argv[])</div><div class="ttdoc">Initialize MPI processors.</div><div class="ttdef"><b>Definition:</b> <a href="processors_8cpp_source.html#l00042">processors.cpp:42</a></div></div>
|
||||
<div class="ttc" id="asetProperty_8hpp_html"><div class="ttname"><a href="setProperty_8hpp.html">setProperty.hpp</a></div></div>
|
||||
<div class="ttc" id="asetSurfaceGeometry_8hpp_html"><div class="ttname"><a href="setSurfaceGeometry_8hpp.html">setSurfaceGeometry.hpp</a></div></div>
|
||||
<div class="ttc" id="aclasspFlow_1_1processors_html_af07b65f79644dae88cfa7a956f6c0fca"><div class="ttname"><a href="classpFlow_1_1processors.html#af07b65f79644dae88cfa7a956f6c0fca">pFlow::processors::finalizeProcessors</a></div><div class="ttdeci">static void finalizeProcessors()</div><div class="ttdoc">Finalize MPI processors.</div><div class="ttdef"><b>Definition:</b> <a href="processors_8cpp_source.html#l00088">processors.cpp:88</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="aiterateGeometry_8cpp_html_a0ddf1224851353fc92bfbff6f499fa97"><div class="ttname"><a href="iterateGeometry_8cpp.html#a0ddf1224851353fc92bfbff6f499fa97">main</a></div><div class="ttdeci">int main(int argc, char *argv[])</div><div class="ttdef"><b>Definition:</b> <a href="iterateGeometry_8cpp_source.html#l00039">iterateGeometry.cpp:39</a></div></div>
|
||||
<div class="ttc" id="aiterateGeometry_8cpp_html_a0ddf1224851353fc92bfbff6f499fa97"><div class="ttname"><a href="iterateGeometry_8cpp.html#a0ddf1224851353fc92bfbff6f499fa97">main</a></div><div class="ttdeci">int main(int argc, char *argv[])</div><div class="ttdef"><b>Definition:</b> <a href="iterateGeometry_8cpp_source.html#l00038">iterateGeometry.cpp:38</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="ageometryMotion_8hpp_html"><div class="ttname"><a href="geometryMotion_8hpp.html">geometryMotion.hpp</a></div></div>
|
||||
<div class="ttc" id="asetSurfaceGeometry_8hpp_html_a195e279064ba2595c36f5f8d504822cb"><div class="ttname"><a href="setSurfaceGeometry_8hpp.html#a195e279064ba2595c36f5f8d504822cb">surfGeometry</a></div><div class="ttdeci">auto & surfGeometry</div><div class="ttdef"><b>Definition:</b> <a href="setSurfaceGeometry_8hpp_source.html#l00026">setSurfaceGeometry.hpp:26</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="areadControlDict_8hpp_html"><div class="ttname"><a href="readControlDict_8hpp.html">readControlDict.hpp</a></div></div>
|
||||
<div class="ttc" id="ageometry_8hpp_html"><div class="ttname"><a href="geometry_8hpp.html">geometry.hpp</a></div></div>
|
||||
<div class="ttc" id="anamespacepFlow_html_a56ba5dd1e49ff3384363db392fb1c770"><div class="ttname"><a href="namespacepFlow.html#a56ba5dd1e49ff3384363db392fb1c770">pFlow::initialize_pFlowProcessors</a></div><div class="ttdeci">void initialize_pFlowProcessors()</div><div class="ttdef"><b>Definition:</b> <a href="pFlowProcessors_8cpp_source.html#l00010">pFlowProcessors.cpp:10</a></div></div>
|
||||
<div class="ttc" id="avocabs_8hpp_html"><div class="ttname"><a href="vocabs_8hpp.html">vocabs.hpp</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="ainitialize__Control_8hpp_html_a4f5e4e852648762473ecd75a907417ca"><div class="ttname"><a href="initialize__Control_8hpp.html#a4f5e4e852648762473ecd75a907417ca">Control</a></div><div class="ttdeci">auto & Control</div><div class="ttdef"><b>Definition:</b> <a href="initialize__Control_8hpp_source.html#l00047">initialize_Control.hpp:47</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