style of documentation changed

This commit is contained in:
Hamidreza Norouzi
2023-04-02 14:53:54 -07:00
parent 57a47752cf
commit f0e9896b26
2266 changed files with 30343 additions and 24130 deletions

View File

@ -37,10 +37,10 @@
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="https://cemf.ir">PhasicFlow</a>
&#160;<span id="projectnumber"><a href="https://cemf.ir">v0.1</a></span>
<div id="projectname"><a href="www.github.com/PhasicFlow">PhasicFlow</a>
&#160;<span id="projectnumber"><a href="www.github.com/PhasicFlow">v0.1</a></span>
</div>
<div id="projectbrief"><a href="www.github.com/PhasicFlow">www.cemf.ir</a></div>
<div id="projectbrief"><a href="https://cemf.ir">www.cemf.ir</a></div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
@ -112,18 +112,22 @@ $(document).ready(function(){initNavTree('classpFlow_1_1sphereParticles.html',''
<p>Class for managing spherical particles.
<a href="classpFlow_1_1sphereParticles.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for sphereParticles:</div>
<div class="dyncontent">
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for sphereParticles:</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="classpFlow_1_1sphereParticles__inherit__graph.png" border="0" usemap="#sphereParticles_inherit__map" alt="Inheritance graph"/></div>
<map name="sphereParticles_inherit__map" id="sphereParticles_inherit__map">
<area shape="rect" title="Class for managing spherical particles." alt="" coords="5,80,127,107"/>
<area shape="rect" href="classpFlow_1_1particles.html" title=" " alt="" coords="27,5,105,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for sphereParticles:</div>
<div class="dyncontent">
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for sphereParticles:</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="classpFlow_1_1sphereParticles__coll__graph.png" border="0" usemap="#sphereParticles_coll__map" alt="Collaboration graph"/></div>
<map name="sphereParticles_coll__map" id="sphereParticles_coll__map">
<area shape="rect" title="Class for managing spherical particles." alt="" coords="720,207,841,233"/>
@ -420,9 +424,11 @@ Protected Attributes</h2></td></tr>
<p class="definition">Definition at line <a class="el" href="sphereParticles_8cpp_source.html#l00219">219</a> of file <a class="el" href="sphereParticles_8cpp_source.html">sphereParticles.cpp</a>.</p>
<p class="reference">References <a class="el" href="integration_8cpp_source.html#l00040">integration::create()</a>, <a class="el" href="streams_8hpp_source.html#l00041">endREPORT</a>, <a class="el" href="error_8hpp_source.html#l00042">fatalErrorInFunction</a>, <a class="el" href="error_8hpp_source.html#l00057">fatalExit</a>, <a class="el" href="streams_8hpp_source.html#l00032">greenText</a>, <a class="el" href="indexContainer_8hpp_source.html#l00153">indexContainer&lt; IndexType &gt;::indicesHost()</a>, <a class="el" href="sphereParticles_8cpp_source.html#l00073">sphereParticles::initializeParticles()</a>, <a class="el" href="particles_8hpp_source.html#l00103">particles::integrationMethod()</a>, <a class="el" href="NBSCrossLoop_8hpp_source.html#l00024">n</a>, <a class="el" href="particles_8hpp_source.html#l00118">particles::pStruct()</a>, <a class="el" href="streams_8hpp_source.html#l00040">REPORT</a>, <a class="el" href="sphereParticles_8hpp_source.html#l00066">sphereParticles::rVelIntegration_</a>, <a class="el" href="sphereParticles_8hpp_source.html#l00060">sphereParticles::rVelocity_</a>, <a class="el" href="indexContainer_8hpp_source.html#l00107">indexContainer&lt; IndexType &gt;::size()</a>, and <a class="el" href="particles_8hpp_source.html#l00095">particles::time()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<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="classpFlow_1_1sphereParticles_af3a0e20c9660776af6f0b8118e89e880_cgraph.png" border="0" usemap="#classpFlow_1_1sphereParticles_af3a0e20c9660776af6f0b8118e89e880_cgraph" alt=""/></div>
<map name="classpFlow_1_1sphereParticles_af3a0e20c9660776af6f0b8118e89e880_cgraph" id="classpFlow_1_1sphereParticles_af3a0e20c9660776af6f0b8118e89e880_cgraph">
<area shape="rect" title="construct from systemControl and property" alt="" coords="5,195,127,222"/>
@ -575,9 +581,11 @@ Here is the call graph for this function:</div>
<p class="definition">Definition at line <a class="el" href="sphereParticles_8cpp_source.html#l00037">37</a> of file <a class="el" href="sphereParticles_8cpp_source.html">sphereParticles.cpp</a>.</p>
<p class="reference">References <a class="el" href="iOstream_8hpp_source.html#l00312">pFlow::endl()</a>, <a class="el" href="error_8hpp_source.html#l00042">fatalErrorInFunction</a>, <a class="el" href="numericConstants_8hpp_source.html#l00032">pFlow::Pi</a>, <a class="el" href="VectorMath_8hpp_source.html#l00109">pFlow::pow()</a>, and <a class="el" href="namespacepFlow.html#a9c4454c5f18c8245eaaebf2b4832eab0">pFlow::printKeys()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<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 call 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="classpFlow_1_1sphereParticles_acdd3b34e25a44bec4f18b95e2440ff9a_cgraph.png" border="0" usemap="#classpFlow_1_1sphereParticles_acdd3b34e25a44bec4f18b95e2440ff9a_cgraph" alt=""/></div>
<map name="classpFlow_1_1sphereParticles_acdd3b34e25a44bec4f18b95e2440ff9a_cgraph" id="classpFlow_1_1sphereParticles_acdd3b34e25a44bec4f18b95e2440ff9a_cgraph">
<area shape="rect" title=" " alt="" coords="5,56,204,83"/>
@ -615,9 +623,11 @@ Here is the call graph for this function:</div>
<p class="definition">Definition at line <a class="el" href="sphereParticles_8cpp_source.html#l00073">73</a> of file <a class="el" href="sphereParticles_8cpp_source.html">sphereParticles.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="sphereParticles_8cpp_source.html#l00219">sphereParticles::sphereParticles()</a>.</p>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<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="classpFlow_1_1sphereParticles_a84343969d723c548f0f20fcd9294d351_icgraph.png" border="0" usemap="#classpFlow_1_1sphereParticles_a84343969d723c548f0f20fcd9294d351_icgraph" alt=""/></div>
<map name="classpFlow_1_1sphereParticles_a84343969d723c548f0f20fcd9294d351_icgraph" id="classpFlow_1_1sphereParticles_a84343969d723c548f0f20fcd9294d351_icgraph">
<area shape="rect" title=" " alt="" coords="175,5,308,32"/>
@ -664,9 +674,11 @@ Here is the caller graph for this function:</div>
<p class="definition">Definition at line <a class="el" href="sphereParticles_8cpp_source.html#l00139">139</a> of file <a class="el" href="sphereParticles_8cpp_source.html">sphereParticles.cpp</a>.</p>
<p class="reference">References <a class="el" href="iOstream_8hpp_source.html#l00312">pFlow::endl()</a>, <a class="el" href="error_8hpp_source.html#l00042">fatalErrorInFunction</a>, <a class="el" href="pFlowMacros_8hpp_source.html#l00071">ForAll</a>, <a class="el" href="NBSCrossLoop_8hpp_source.html#l00022">m</a>, <a class="el" href="indexContainer_8hpp_source.html#l00107">indexContainer&lt; IndexType &gt;::size()</a>, and <a class="el" href="Vector_8hpp_source.html#l00299">Vector&lt; T, Allocator &gt;::size()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<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="classpFlow_1_1sphereParticles_af38e902a6e8867893c7fafaeabf99578_cgraph.png" border="0" usemap="#classpFlow_1_1sphereParticles_af38e902a6e8867893c7fafaeabf99578_cgraph" alt=""/></div>
<map name="classpFlow_1_1sphereParticles_af38e902a6e8867893c7fafaeabf99578_cgraph" id="classpFlow_1_1sphereParticles_af38e902a6e8867893c7fafaeabf99578_cgraph">
<area shape="rect" title=" " alt="" coords="5,64,164,91"/>
@ -706,9 +718,11 @@ Here is the call graph for this function:</div>
<p class="definition">Definition at line <a class="el" href="sphereParticles_8cpp_source.html#l00026">26</a> of file <a class="el" href="sphereParticles_8cpp_source.html">sphereParticles.cpp</a>.</p>
<p class="reference">References <a class="el" href="particles_8cpp_source.html#l00154">particles::getFieldObjectList()</a>, and <a class="el" href="sphereParticles_8hpp_source.html#l00057">sphereParticles::I_</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<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 call 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="classpFlow_1_1sphereParticles_a8a46f36158973e7200555bc769846a8a_cgraph.png" border="0" usemap="#classpFlow_1_1sphereParticles_a8a46f36158973e7200555bc769846a8a_cgraph" alt=""/></div>
<map name="classpFlow_1_1sphereParticles_a8a46f36158973e7200555bc769846a8a_cgraph" id="classpFlow_1_1sphereParticles_a8a46f36158973e7200555bc769846a8a_cgraph">
<area shape="rect" title=" " alt="" coords="5,13,144,39"/>
@ -829,9 +843,11 @@ Here is the call graph for this function:</div>
<p class="definition">Definition at line <a class="el" href="sphereParticles_8cpp_source.html#l00362">362</a> of file <a class="el" href="sphereParticles_8cpp_source.html">sphereParticles.cpp</a>.</p>
<p class="reference">References <a class="el" href="streams_8hpp_source.html#l00034">cyanText</a>, <a class="el" href="streams_8hpp_source.html#l00041">endREPORT</a>, <a class="el" href="error_8hpp_source.html#l00042">fatalErrorInFunction</a>, <a class="el" href="setPointStructure_8hpp_source.html#l00024">pStruct</a>, <a class="el" href="streams_8hpp_source.html#l00040">REPORT</a>, <a class="el" href="Vector_8hpp_source.html#l00299">Vector&lt; T, Allocator &gt;::size()</a>, and <a class="el" href="streams_8hpp_source.html#l00030">yellowText</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<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="classpFlow_1_1sphereParticles_a99cba4c27cdaa229242ccd3b22b04fba_cgraph.png" border="0" usemap="#classpFlow_1_1sphereParticles_a99cba4c27cdaa229242ccd3b22b04fba_cgraph" alt=""/></div>
<map name="classpFlow_1_1sphereParticles_a99cba4c27cdaa229242ccd3b22b04fba_cgraph" id="classpFlow_1_1sphereParticles_a99cba4c27cdaa229242ccd3b22b04fba_cgraph">
<area shape="rect" title="Insert new particles in position with specified shapes." alt="" coords="5,5,120,32"/>
@ -991,9 +1007,11 @@ Here is the call graph for this function:</div>
<p class="definition">Definition at line <a class="el" href="sphereParticles_8hpp_source.html#l00143">143</a> of file <a class="el" href="sphereParticles_8hpp_source.html">sphereParticles.hpp</a>.</p>
<p class="reference">References <a class="el" href="particles_8hpp_source.html#l00180">particles::diameter()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<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 call 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="classpFlow_1_1sphereParticles_add60216947a9a50b285ec92ebc73e8a4_cgraph.png" border="0" usemap="#classpFlow_1_1sphereParticles_add60216947a9a50b285ec92ebc73e8a4_cgraph" alt=""/></div>
<map name="classpFlow_1_1sphereParticles_add60216947a9a50b285ec92ebc73e8a4_cgraph" id="classpFlow_1_1sphereParticles_add60216947a9a50b285ec92ebc73e8a4_cgraph">
<area shape="rect" title=" " alt="" coords="5,5,132,32"/>
@ -1071,9 +1089,11 @@ Here is the call graph for this function:</div>
<p class="definition">Definition at line <a class="el" href="sphereParticles_8hpp_source.html#l00153">153</a> of file <a class="el" href="sphereParticles_8hpp_source.html">sphereParticles.hpp</a>.</p>
<p class="reference">References <a class="el" href="sphereShape_8hpp_source.html#l00146">sphereShape::diameterMinMax()</a>, and <a class="el" href="sphereParticles_8hpp_source.html#l00054">sphereParticles::shapes_</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div id="dynsection-9" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-9-trigger" src="closed.png" alt="+"/> Here is the call graph for this function:</div>
<div id="dynsection-9-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-9-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classpFlow_1_1sphereParticles_a37902e8915b3022d1068391f864a8e59_cgraph.png" border="0" usemap="#classpFlow_1_1sphereParticles_a37902e8915b3022d1068391f864a8e59_cgraph" alt=""/></div>
<map name="classpFlow_1_1sphereParticles_a37902e8915b3022d1068391f864a8e59_cgraph" id="classpFlow_1_1sphereParticles_a37902e8915b3022d1068391f864a8e59_cgraph">
<area shape="rect" title=" " alt="" coords="5,13,184,39"/>
@ -1209,18 +1229,22 @@ Here is the call graph for this function:</div>
<p class="reference">References <a class="el" href="particles_8hpp_source.html#l00244">particles::beforeIteration()</a>.</p>
<p class="reference">Referenced by <a class="el" href="sphereGranFlow_8cpp_source.html#l00063">main()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div id="dynsection-10" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-10-trigger" src="closed.png" alt="+"/> Here is the call graph for this function:</div>
<div id="dynsection-10-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-10-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classpFlow_1_1sphereParticles_ada71b97666fe3f66b31690bf12633c32_cgraph.png" border="0" usemap="#classpFlow_1_1sphereParticles_ada71b97666fe3f66b31690bf12633c32_cgraph" alt=""/></div>
<map name="classpFlow_1_1sphereParticles_ada71b97666fe3f66b31690bf12633c32_cgraph" id="classpFlow_1_1sphereParticles_ada71b97666fe3f66b31690bf12633c32_cgraph">
<area shape="rect" title="before iteration step" alt="" coords="5,13,124,39"/>
<area shape="rect" href="classpFlow_1_1particles.html#ada71b97666fe3f66b31690bf12633c32" title=" " alt="" coords="172,5,347,47"/>
</map>
</div>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div id="dynsection-11" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-11-trigger" src="closed.png" alt="+"/> Here is the caller graph for this function:</div>
<div id="dynsection-11-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-11-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classpFlow_1_1sphereParticles_ada71b97666fe3f66b31690bf12633c32_icgraph.png" border="0" usemap="#classpFlow_1_1sphereParticles_ada71b97666fe3f66b31690bf12633c32_icgraph" alt=""/></div>
<map name="classpFlow_1_1sphereParticles_ada71b97666fe3f66b31690bf12633c32_icgraph" id="classpFlow_1_1sphereParticles_ada71b97666fe3f66b31690bf12633c32_icgraph">
<area shape="rect" title="before iteration step" alt="" coords="108,5,227,32"/>
@ -1262,18 +1286,22 @@ Here is the caller graph for this function:</div>
<p class="reference">References <a class="el" href="sphereParticlesKernels_8hpp_source.html#l00034">pFlow::sphereParticlesKernels::acceleration()</a>, and <a class="el" href="setPointStructure_8hpp_source.html#l00024">pStruct</a>.</p>
<p class="reference">Referenced by <a class="el" href="sphereGranFlow_8cpp_source.html#l00063">main()</a>.</p>
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div id="dynsection-12" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-12-trigger" src="closed.png" alt="+"/> Here is the call graph for this function:</div>
<div id="dynsection-12-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-12-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classpFlow_1_1sphereParticles_afa767bddda52eb71cea18f755e17d559_cgraph.png" border="0" usemap="#classpFlow_1_1sphereParticles_afa767bddda52eb71cea18f755e17d559_cgraph" alt=""/></div>
<map name="classpFlow_1_1sphereParticles_afa767bddda52eb71cea18f755e17d559_cgraph" id="classpFlow_1_1sphereParticles_afa767bddda52eb71cea18f755e17d559_cgraph">
<area shape="rect" title="iterate particles" alt="" coords="5,13,71,39"/>
<area shape="rect" href="namespacepFlow_1_1sphereParticlesKernels.html#aea4493f25ef82d9338f4b7dd1059f675" title=" " alt="" coords="119,5,333,47"/>
</map>
</div>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div id="dynsection-13" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-13-trigger" src="closed.png" alt="+"/> Here is the caller graph for this function:</div>
<div id="dynsection-13-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-13-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classpFlow_1_1sphereParticles_afa767bddda52eb71cea18f755e17d559_icgraph.png" border="0" usemap="#classpFlow_1_1sphereParticles_afa767bddda52eb71cea18f755e17d559_icgraph" alt=""/></div>
<map name="classpFlow_1_1sphereParticles_afa767bddda52eb71cea18f755e17d559_icgraph" id="classpFlow_1_1sphereParticles_afa767bddda52eb71cea18f755e17d559_icgraph">
<area shape="rect" title="iterate particles" alt="" coords="108,5,173,32"/>
@ -1313,9 +1341,11 @@ Here is the caller graph for this function:</div>
<p class="definition">Definition at line <a class="el" href="sphereParticles_8cpp_source.html#l00133">133</a> of file <a class="el" href="sphereParticles_8cpp_source.html">sphereParticles.cpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="sphereGranFlow_8cpp_source.html#l00063">main()</a>.</p>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div id="dynsection-14" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-14-trigger" src="closed.png" alt="+"/> Here is the caller graph for this function:</div>
<div id="dynsection-14-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-14-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classpFlow_1_1sphereParticles_a5ab4b6c611c3256e54f51bbfc484d58e_icgraph.png" border="0" usemap="#classpFlow_1_1sphereParticles_a5ab4b6c611c3256e54f51bbfc484d58e_icgraph" alt=""/></div>
<map name="classpFlow_1_1sphereParticles_a5ab4b6c611c3256e54f51bbfc484d58e_icgraph" id="classpFlow_1_1sphereParticles_a5ab4b6c611c3256e54f51bbfc484d58e_icgraph">
<area shape="rect" title="after iteration step" alt="" coords="108,5,215,32"/>