documentation for v1.0

This commit is contained in:
HRN
2025-01-10 13:02:07 +03:30
parent 53c7b23728
commit 0acd52f1b1
16893 changed files with 448346 additions and 285977 deletions

View File

@ -116,10 +116,6 @@ $(document).ready(function(){initNavTree('classpFlow_1_1cfModels_1_1normalRollin
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classpFlow_1_1cfModels_1_1normalRolling__inherit__graph.png" border="0" usemap="#normalRolling_3_01contactForceModel_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="normalRolling_3_01contactForceModel_01_4_inherit__map" id="normalRolling_3_01contactForceModel_01_4_inherit__map">
<area shape="rect" title=" " alt="" coords="5,80,216,121"/>
<area shape="rect" title=" " alt="" coords="38,5,183,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<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 normalRolling&lt; contactForceModel &gt;:</div>
@ -127,11 +123,6 @@ $(document).ready(function(){initNavTree('classpFlow_1_1cfModels_1_1normalRollin
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classpFlow_1_1cfModels_1_1normalRolling__coll__graph.png" border="0" usemap="#normalRolling_3_01contactForceModel_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="normalRolling_3_01contactForceModel_01_4_coll__map" id="normalRolling_3_01contactForceModel_01_4_coll__map">
<area shape="rect" title=" " alt="" coords="55,95,266,136"/>
<area shape="rect" title=" " alt="" coords="5,5,151,32"/>
<area shape="rect" href="classpFlow_1_1symArray.html" title=" " alt="" coords="175,5,315,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
@ -145,10 +136,10 @@ Public Member Functions</h2></td></tr>
<tr class="separator:a2166bf008f0bcbf975cc66ade88dc53a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeee112538820a87a21009a9b6427632d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1cfModels_1_1normalRolling.html#aeee112538820a87a21009a9b6427632d">TypeInfoNV</a> (<a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>(&quot;normal&lt;&quot;+contactForceModel::TYPENAME()+&quot;&gt;&quot;))</td></tr>
<tr class="separator:aeee112538820a87a21009a9b6427632d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4df25d93b5e00f2289e0b9059c5e1d6f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1cfModels_1_1normalRolling.html#a4df25d93b5e00f2289e0b9059c5e1d6f">normalRolling</a> (<a class="el" href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">int32</a> nMaterial, const <a class="el" href="namespacepFlow.html#aca2b381231776d26ea7431837f78aa24">ViewType1D</a>&lt; <a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> &gt; &amp;rho, const <a class="el" href="classpFlow_1_1dictionary.html">dictionary</a> &amp;dict)</td></tr>
<tr class="memitem:a4df25d93b5e00f2289e0b9059c5e1d6f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1cfModels_1_1normalRolling.html#a4df25d93b5e00f2289e0b9059c5e1d6f">normalRolling</a> (<a class="el" href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">int32</a> nMaterial, const <a class="el" href="namespacepFlow.html#aeac3efd0f623f0010ce6daa6499d8ebe">ViewType1D</a>&lt; <a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> &gt; &amp;rho, const <a class="el" href="classpFlow_1_1dictionary.html">dictionary</a> &amp;dict)</td></tr>
<tr class="separator:a4df25d93b5e00f2289e0b9059c5e1d6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8497077d4e9fdea8f9f8c0419cdee854"><td class="memItemLeft" align="right" valign="top"><a class="el" href="pFlowMacros_8hpp.html#a8e2f73fa5c113f21c9c9edb67a974f5e">INLINE_FUNCTION_HD</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1cfModels_1_1normalRolling.html#a8497077d4e9fdea8f9f8c0419cdee854">rollingFriction</a> (const <a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> dt, const <a class="el" href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">int32</a> i, const <a class="el" href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">int32</a> j, const <a class="el" href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">int32</a> propId_i, const <a class="el" href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">int32</a> propId_j, const <a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> Ri, const <a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> Rj, const <a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a> &amp;wi, const <a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a> &amp;wj, const <a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a> &amp;Nij, const <a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a> &amp;FCn, <a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a> &amp;Mri, <a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a> &amp;Mrj) const</td></tr>
<tr class="separator:a8497077d4e9fdea8f9f8c0419cdee854"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6fa6d92009490d05002c276c65f6f022"><td class="memItemLeft" align="right" valign="top"><a class="el" href="pFlowMacros_8hpp.html#a8e2f73fa5c113f21c9c9edb67a974f5e">INLINE_FUNCTION_HD</a> void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1cfModels_1_1normalRolling.html#a6fa6d92009490d05002c276c65f6f022">rollingFriction</a> (const <a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> dt, const <a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a> i, const <a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a> j, const <a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a> propId_i, const <a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a> propId_j, const <a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> Ri, const <a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> Rj, const <a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a> &amp;wi, const <a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a> &amp;wj, const <a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a> &amp;Nij, const <a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a> &amp;FCn, <a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a> &amp;Mri, <a class="el" href="namespacepFlow.html#a5164661f6974ad24fa90bf19433e6116">realx3</a> &amp;Mrj) const</td></tr>
<tr class="separator:a6fa6d92009490d05002c276c65f6f022"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
@ -197,7 +188,7 @@ class pFlow::cfModels::normalRolling&lt; contactForceModel &gt;</h3>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacepFlow.html#aca2b381231776d26ea7431837f78aa24">ViewType1D</a>&lt; <a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> &gt; &amp;&#160;</td>
<td class="paramtype">const <a class="el" href="namespacepFlow.html#aeac3efd0f623f0010ce6daa6499d8ebe">ViewType1D</a>&lt; <a class="el" href="namespacepFlow.html#a6192191c0e9c178a44ee1ac350fde476">real</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>rho</em>, </td>
</tr>
<tr>
@ -221,17 +212,13 @@ class pFlow::cfModels::normalRolling&lt; contactForceModel &gt;</h3>
<p class="definition">Definition at line <a class="el" href="normalRolling_8hpp_source.html#l00064">64</a> of file <a class="el" href="normalRolling_8hpp_source.html">normalRolling.hpp</a>.</p>
<p class="reference">References <a class="el" href="error_8hpp_source.html#l00057">fatalExit</a>, and <a class="el" href="normalRolling_8hpp_source.html#l00041">normalRolling&lt; contactForceModel &gt;::readNormalDict()</a>.</p>
<p class="reference">References <a class="el" href="error_8hpp_source.html#l00098">fatalExit</a>, and <a class="el" href="normalRolling_8hpp_source.html#l00041">normalRolling&lt; contactForceModel &gt;::readNormalDict()</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="classpFlow_1_1cfModels_1_1normalRolling_a4df25d93b5e00f2289e0b9059c5e1d6f_cgraph.png" border="0" usemap="#classpFlow_1_1cfModels_1_1normalRolling_a4df25d93b5e00f2289e0b9059c5e1d6f_cgraph" alt=""/></div>
<map name="classpFlow_1_1cfModels_1_1normalRolling_a4df25d93b5e00f2289e0b9059c5e1d6f_cgraph" id="classpFlow_1_1cfModels_1_1normalRolling_a4df25d93b5e00f2289e0b9059c5e1d6f_cgraph">
<area shape="rect" title=" " alt="" coords="5,5,119,32"/>
<area shape="rect" href="classpFlow_1_1cfModels_1_1normalRolling.html#a2166bf008f0bcbf975cc66ade88dc53a" title=" " alt="" coords="167,5,292,32"/>
</map>
</div>
</div>
@ -263,7 +250,7 @@ class pFlow::cfModels::normalRolling&lt; contactForceModel &gt;</h3>
<p class="definition">Definition at line <a class="el" href="normalRolling_8hpp_source.html#l00041">41</a> of file <a class="el" href="normalRolling_8hpp_source.html">normalRolling.hpp</a>.</p>
<p class="reference">References <a class="el" href="symArrayHD_8hpp_source.html#l00177">symArray&lt; T, MemorySpace &gt;::assign()</a>, <a class="el" href="error_8hpp_source.html#l00042">fatalErrorInFunction</a>, <a class="el" href="symArrayHD_8hpp_source.html#l00240">symArray&lt; real &gt;::getN()</a>, <a class="el" href="dictionary_8hpp_source.html#l00309">dictionary::getVal()</a>, and <a class="el" href="normalRolling_8hpp_source.html#l00039">normalRolling&lt; contactForceModel &gt;::mur_</a>.</p>
<p class="reference">References <a class="el" href="symArrayHD_8hpp_source.html#l00175">symArray&lt; T, MemorySpace &gt;::assign()</a>, <a class="el" href="error_8hpp_source.html#l00077">fatalErrorInFunction</a>, <a class="el" href="symArrayHD_8hpp_source.html#l00238">symArray&lt; real &gt;::getN()</a>, <a class="el" href="dictionary_8hpp_source.html#l00379">dictionary::getVal()</a>, and <a class="el" href="normalRolling_8hpp_source.html#l00039">normalRolling&lt; contactForceModel &gt;::mur_</a>.</p>
<p class="reference">Referenced by <a class="el" href="normalRolling_8hpp_source.html#l00064">normalRolling&lt; contactForceModel &gt;::normalRolling()</a>.</p>
<div id="dynsection-3" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
@ -272,12 +259,6 @@ class pFlow::cfModels::normalRolling&lt; contactForceModel &gt;</h3>
</div>
<div id="dynsection-3-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classpFlow_1_1cfModels_1_1normalRolling_a2166bf008f0bcbf975cc66ade88dc53a_cgraph.png" border="0" usemap="#classpFlow_1_1cfModels_1_1normalRolling_a2166bf008f0bcbf975cc66ade88dc53a_cgraph" alt=""/></div>
<map name="classpFlow_1_1cfModels_1_1normalRolling_a2166bf008f0bcbf975cc66ade88dc53a_cgraph" id="classpFlow_1_1cfModels_1_1normalRolling_a2166bf008f0bcbf975cc66ade88dc53a_cgraph">
<area shape="rect" title=" " alt="" coords="5,64,131,91"/>
<area shape="rect" href="classpFlow_1_1symArray.html#ac49828e84b4c929c15c813500e280005" title=" " alt="" coords="179,5,359,32"/>
<area shape="rect" href="classpFlow_1_1symArray.html#aaa204e5a9810b8db8dd34cc29ee4c464" title=" " alt="" coords="183,57,354,98"/>
<area shape="rect" href="classpFlow_1_1dictionary.html#a523bcff98ab38f3c5961e56eeb0b1d47" title=" " alt="" coords="199,122,339,163"/>
</map>
</div>
<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>
@ -285,10 +266,6 @@ class pFlow::cfModels::normalRolling&lt; contactForceModel &gt;</h3>
</div>
<div id="dynsection-4-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classpFlow_1_1cfModels_1_1normalRolling_a2166bf008f0bcbf975cc66ade88dc53a_icgraph.png" border="0" usemap="#classpFlow_1_1cfModels_1_1normalRolling_a2166bf008f0bcbf975cc66ade88dc53a_icgraph" alt=""/></div>
<map name="classpFlow_1_1cfModels_1_1normalRolling_a2166bf008f0bcbf975cc66ade88dc53a_icgraph" id="classpFlow_1_1cfModels_1_1normalRolling_a2166bf008f0bcbf975cc66ade88dc53a_icgraph">
<area shape="rect" title=" " alt="" coords="167,5,292,32"/>
<area shape="rect" href="classpFlow_1_1cfModels_1_1normalRolling.html#a4df25d93b5e00f2289e0b9059c5e1d6f" title=" " alt="" coords="5,5,119,32"/>
</map>
</div>
</div>
@ -311,8 +288,8 @@ class pFlow::cfModels::normalRolling&lt; contactForceModel &gt;</h3>
</div>
</div>
<a id="a8497077d4e9fdea8f9f8c0419cdee854"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8497077d4e9fdea8f9f8c0419cdee854">&#9670;&nbsp;</a></span>rollingFriction()</h2>
<a id="a6fa6d92009490d05002c276c65f6f022"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6fa6d92009490d05002c276c65f6f022">&#9670;&nbsp;</a></span>rollingFriction()</h2>
<div class="memitem">
<div class="memproto">
@ -329,25 +306,25 @@ class pFlow::cfModels::normalRolling&lt; contactForceModel &gt;</h3>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">int32</a>&#160;</td>
<td class="paramtype">const <a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a>&#160;</td>
<td class="paramname"><em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">int32</a>&#160;</td>
<td class="paramtype">const <a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a>&#160;</td>
<td class="paramname"><em>j</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">int32</a>&#160;</td>
<td class="paramtype">const <a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a>&#160;</td>
<td class="paramname"><em>propId_i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">int32</a>&#160;</td>
<td class="paramtype">const <a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a>&#160;</td>
<td class="paramname"><em>propId_j</em>, </td>
</tr>
<tr>
@ -413,18 +390,13 @@ class pFlow::cfModels::normalRolling&lt; contactForceModel &gt;</h3>
<p class="definition">Definition at line <a class="el" href="normalRolling_8hpp_source.html#l00077">77</a> of file <a class="el" href="normalRolling_8hpp_source.html">normalRolling.hpp</a>.</p>
<p class="reference">References <a class="el" href="bTypesFunctions_8hpp_source.html#l00188">pFlow::equal()</a>, <a class="el" href="tripleFwd_8hpp.html#ae1449f1d56abab2ec4d0f00b685fc478">length()</a>, and <a class="el" href="normalRolling_8hpp_source.html#l00039">normalRolling&lt; contactForceModel &gt;::mur_</a>.</p>
<p class="reference">References <a class="el" href="box_8hpp_source.html#l00135">pFlow::equal()</a>, <a class="el" href="tripleFwd_8hpp.html#ae1449f1d56abab2ec4d0f00b685fc478">length()</a>, and <a class="el" href="normalRolling_8hpp_source.html#l00039">normalRolling&lt; contactForceModel &gt;::mur_</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="classpFlow_1_1cfModels_1_1normalRolling_a8497077d4e9fdea8f9f8c0419cdee854_cgraph.png" border="0" usemap="#classpFlow_1_1cfModels_1_1normalRolling_a8497077d4e9fdea8f9f8c0419cdee854_cgraph" alt=""/></div>
<map name="classpFlow_1_1cfModels_1_1normalRolling_a8497077d4e9fdea8f9f8c0419cdee854_cgraph" id="classpFlow_1_1cfModels_1_1normalRolling_a8497077d4e9fdea8f9f8c0419cdee854_cgraph">
<area shape="rect" title=" " alt="" coords="5,31,116,57"/>
<area shape="rect" href="namespacepFlow.html#aaf1dcea055a0402beff3cec1b0849d74" title=" " alt="" coords="164,5,268,32"/>
<area shape="rect" href="tripleFwd_8hpp.html#ae1449f1d56abab2ec4d0f00b685fc478" title=" " alt="" coords="185,56,247,83"/>
</map>
<div class="center"><img src="classpFlow_1_1cfModels_1_1normalRolling_a6fa6d92009490d05002c276c65f6f022_cgraph.png" border="0" usemap="#classpFlow_1_1cfModels_1_1normalRolling_a6fa6d92009490d05002c276c65f6f022_cgraph" alt=""/></div>
</div>
</div>