doc: theory and verification manual

fabricix · Dec 27, 2024 · 1674220 · 1674220
1 parent d9ba514
commit 1674220
Show file tree

Hide file tree

Showing 109 changed files with 3,317 additions and 989 deletions.
diff --git a/docs/Boussinesq-problem.png b/docs/Boussinesq-problem.png
diff --git a/docs/Input_8h.html b/docs/Input_8h.html
@@ -280,9 +280,9 @@
 <tr class="memitem:a38dd844d4e499c46c0e7530a83939fb4" id="r_a38dd844d4e499c46c0e7530a83939fb4"><td class="memItemLeft" align="right" valign="top">vector&lt; <a class="el" href="structLoads_1_1LoadDistributedBox.html">Loads::LoadDistributedBox</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceInput.html#a38dd844d4e499c46c0e7530a83939fb4">Input::getLoadDistributedBox</a> ()</td></tr>
 <tr class="memdesc:a38dd844d4e499c46c0e7530a83939fb4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return loads distributed in particles inside a box.  <br /></td></tr>
 <tr class="separator:a38dd844d4e499c46c0e7530a83939fb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a03717b6bc9fdd8cfc5eccb3e4fcebe73" id="r_a03717b6bc9fdd8cfc5eccb3e4fcebe73"><td class="memItemLeft" align="right" valign="top">vector&lt; <a class="el" href="structLoads_1_1NodalPointLoad.html">Loads::NodalPointLoad</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceInput.html#a03717b6bc9fdd8cfc5eccb3e4fcebe73">Input::readNodalPointLoads</a> ()</td></tr>
-<tr class="memdesc:a03717b6bc9fdd8cfc5eccb3e4fcebe73"><td class="mdescLeft">&#160;</td><td class="mdescRight">read nodal point loads This function reads a points from input file in the following format: "nodal_point_loads": [[p1x,p1y,p1z],[p1x,p1y,p1z]],...,[[pnx,pny,pnz],[pnx,pny,pnz]]  <br /></td></tr>
-<tr class="separator:a03717b6bc9fdd8cfc5eccb3e4fcebe73"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a4af9571f7842a96471572cd550d598a9" id="r_a4af9571f7842a96471572cd550d598a9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structLoads_1_1NodalPointLoadData.html">Loads::NodalPointLoadData</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceInput.html#a4af9571f7842a96471572cd550d598a9">Input::readNodalPointLoads</a> ()</td></tr>
+<tr class="memdesc:a4af9571f7842a96471572cd550d598a9"><td class="mdescLeft">&#160;</td><td class="mdescRight">read nodal point loads This function reads a points from input file in the following format: "nodal_point_loads": [[p1x,p1y,p1z],[p1x,p1y,p1z]],...,[[pnx,pny,pnz],[pnx,pny,pnz]]  <br /></td></tr>
+<tr class="separator:a4af9571f7842a96471572cd550d598a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a22ce7cc2c2261b0784b944184c7efcb2" id="r_a22ce7cc2c2261b0784b944184c7efcb2"><td class="memItemLeft" align="right" valign="top">vector&lt; <a class="el" href="structLoads_1_1PressureBox.html">Loads::PressureBox</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceInput.html#a22ce7cc2c2261b0784b944184c7efcb2">Input::getPrescribedPressureBox</a> ()</td></tr>
 <tr class="memdesc:a22ce7cc2c2261b0784b944184c7efcb2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return prescribed pressure in particles inside a box.  <br /></td></tr>
 <tr class="separator:a22ce7cc2c2261b0784b944184c7efcb2"><td class="memSeparator" colspan="2">&#160;</td></tr>

diff --git a/docs/Input_8h.js b/docs/Input_8h.js
@@ -30,6 +30,6 @@ var Input_8h =
     [ "getSolver", "Input_8h.html#a0aaddb07cda3d6c988f2c5db52bb488e", null ],
     [ "getTimeStep", "Input_8h.html#a62b6f277358d9dd6b95f39001e12bae4", null ],
     [ "readInputFile", "Input_8h.html#abb1fa3d31849a7acf80a9796da0242b0", null ],
-    [ "readNodalPointLoads", "Input_8h.html#a03717b6bc9fdd8cfc5eccb3e4fcebe73", null ],
+    [ "readNodalPointLoads", "Input_8h.html#a4af9571f7842a96471572cd550d598a9", null ],
     [ "readSeismicData", "Input_8h.html#ab7aeff2285506645ef6c121dec4a0d44", null ]
 ];
diff --git a/docs/Input_8h_source.html b/docs/Input_8h_source.html
@@ -223,7 +223,7 @@
 <div class="line"><a id="l00597" name="l00597"></a><span class="lineno">  597</span>    </div>
 <div class="line"><a id="l00600" name="l00600"></a><span class="lineno"><a class="line" href="namespaceInput.html#a38dd844d4e499c46c0e7530a83939fb4">  600</a></span>    vector&lt;Loads::LoadDistributedBox&gt; <a class="code hl_function" href="namespaceInput.html#a38dd844d4e499c46c0e7530a83939fb4">getLoadDistributedBox</a>();</div>
 <div class="line"><a id="l00601" name="l00601"></a><span class="lineno">  601</span>    </div>
-<div class="line"><a id="l00606" name="l00606"></a><span class="lineno"><a class="line" href="namespaceInput.html#a03717b6bc9fdd8cfc5eccb3e4fcebe73">  606</a></span>    vector&lt;Loads::NodalPointLoad&gt; <a class="code hl_function" href="namespaceInput.html#a03717b6bc9fdd8cfc5eccb3e4fcebe73">readNodalPointLoads</a>();</div>
+<div class="line"><a id="l00606" name="l00606"></a><span class="lineno"><a class="line" href="namespaceInput.html#a4af9571f7842a96471572cd550d598a9">  606</a></span>    <a class="code hl_struct" href="structLoads_1_1NodalPointLoadData.html">Loads::NodalPointLoadData</a> <a class="code hl_function" href="namespaceInput.html#a4af9571f7842a96471572cd550d598a9">readNodalPointLoads</a>();</div>
 <div class="line"><a id="l00607" name="l00607"></a><span class="lineno">  607</span> </div>
 <div class="line"><a id="l00610" name="l00610"></a><span class="lineno"><a class="line" href="namespaceInput.html#a22ce7cc2c2261b0784b944184c7efcb2">  610</a></span>    vector&lt;Loads::PressureBox&gt; <a class="code hl_function" href="namespaceInput.html#a22ce7cc2c2261b0784b944184c7efcb2">getPrescribedPressureBox</a>();</div>
 <div class="line"><a id="l00611" name="l00611"></a><span class="lineno">  611</span> </div>
@@ -246,7 +246,6 @@
 <div class="ttc" id="aclassSolver_html"><div class="ttname"><a href="classSolver.html">Solver</a></div><div class="ttdoc">Represents the operations to solve the equations in time.</div><div class="ttdef"><b>Definition</b> Solver.h:19</div></div>
 <div class="ttc" id="anamespaceInput_html"><div class="ttname"><a href="namespaceInput.html">Input</a></div><div class="ttdoc">Operations to read the input file.</div></div>
 <div class="ttc" id="anamespaceInput_html_a00c5fbc06a1e394dd1621ac86d97a5c2"><div class="ttname"><a href="namespaceInput.html#a00c5fbc06a1e394dd1621ac86d97a5c2">Input::getMaterialList</a></div><div class="ttdeci">vector&lt; Material * &gt; getMaterialList()</div><div class="ttdoc">Return the material list.</div></div>
-<div class="ttc" id="anamespaceInput_html_a03717b6bc9fdd8cfc5eccb3e4fcebe73"><div class="ttname"><a href="namespaceInput.html#a03717b6bc9fdd8cfc5eccb3e4fcebe73">Input::readNodalPointLoads</a></div><div class="ttdeci">vector&lt; Loads::NodalPointLoad &gt; readNodalPointLoads()</div><div class="ttdoc">read nodal point loads This function reads a points from input file in the following format: &quot;nodal_p...</div></div>
 <div class="ttc" id="anamespaceInput_html_a07964090a615a8b6ded303e5142dcad0"><div class="ttname"><a href="namespaceInput.html#a07964090a615a8b6ded303e5142dcad0">Input::getNumberPhases</a></div><div class="ttdeci">unsigned getNumberPhases()</div><div class="ttdoc">Return the number of phases in the simulation.</div></div>
 <div class="ttc" id="anamespaceInput_html_a0aaddb07cda3d6c988f2c5db52bb488e"><div class="ttname"><a href="namespaceInput.html#a0aaddb07cda3d6c988f2c5db52bb488e">Input::getSolver</a></div><div class="ttdeci">Solver * getSolver()</div><div class="ttdoc">Return the solver to be used in the model.</div></div>
 <div class="ttc" id="anamespaceInput_html_a0da20030f4b1bd89c34a217fc7734296"><div class="ttname"><a href="namespaceInput.html#a0da20030f4b1bd89c34a217fc7734296">Input::getLoadState</a></div><div class="ttdeci">bool getLoadState()</div><div class="ttdoc">Return load state activated.</div></div>
@@ -256,6 +255,7 @@
 <div class="ttc" id="anamespaceInput_html_a38dd844d4e499c46c0e7530a83939fb4"><div class="ttname"><a href="namespaceInput.html#a38dd844d4e499c46c0e7530a83939fb4">Input::getLoadDistributedBox</a></div><div class="ttdeci">vector&lt; Loads::LoadDistributedBox &gt; getLoadDistributedBox()</div><div class="ttdoc">Return loads distributed in particles inside a box.</div></div>
 <div class="ttc" id="anamespaceInput_html_a439b092b2d3d47fab42c5de5fa494a67"><div class="ttname"><a href="namespaceInput.html#a439b092b2d3d47fab42c5de5fa494a67">Input::getJson</a></div><div class="ttdeci">const json &amp; getJson()</div><div class="ttdoc">Return the data file structure.</div></div>
 <div class="ttc" id="anamespaceInput_html_a4855a7486e30198da32c4b2c5cc31379"><div class="ttname"><a href="namespaceInput.html#a4855a7486e30198da32c4b2c5cc31379">Input::getGravity</a></div><div class="ttdeci">Vector3d getGravity()</div><div class="ttdoc">Return the gravity force.</div></div>
+<div class="ttc" id="anamespaceInput_html_a4af9571f7842a96471572cd550d598a9"><div class="ttname"><a href="namespaceInput.html#a4af9571f7842a96471572cd550d598a9">Input::readNodalPointLoads</a></div><div class="ttdeci">Loads::NodalPointLoadData readNodalPointLoads()</div><div class="ttdoc">read nodal point loads This function reads a points from input file in the following format: &quot;nodal_p...</div></div>
 <div class="ttc" id="anamespaceInput_html_a4eeba9dd74dc17cee6267ba774ca8a78"><div class="ttname"><a href="namespaceInput.html#a4eeba9dd74dc17cee6267ba774ca8a78">Input::getMeshBoundaryConditions</a></div><div class="ttdeci">vector&lt; Boundary::BoundaryType &gt; getMeshBoundaryConditions()</div><div class="ttdoc">Return the mesh boundary conditions.</div></div>
 <div class="ttc" id="anamespaceInput_html_a5bf735c8349c8f8e8498d4759b537346"><div class="ttname"><a href="namespaceInput.html#a5bf735c8349c8f8e8498d4759b537346">Input::getCellsNum</a></div><div class="ttdeci">Vector3i getCellsNum()</div><div class="ttdoc">Return the number of cells in each direction.</div></div>
 <div class="ttc" id="anamespaceInput_html_a5de246ace76db47015f0af32c9e7eea6"><div class="ttname"><a href="namespaceInput.html#a5de246ace76db47015f0af32c9e7eea6">Input::getResultFields</a></div><div class="ttdeci">vector&lt; string &gt; getResultFields()</div><div class="ttdoc">Return the fields to be written.</div></div>
@@ -278,7 +278,8 @@
 <div class="ttc" id="anamespaceInput_html_afba47624d2c22b55c4d2a38f4790de7e"><div class="ttname"><a href="namespaceInput.html#afba47624d2c22b55c4d2a38f4790de7e">Input::getSaveState</a></div><div class="ttdeci">bool getSaveState()</div><div class="ttdoc">Return save state activated.</div></div>
 <div class="ttc" id="anamespaceModelSetup_html_a00e7195f09f9bd709ef76fce4eb77698"><div class="ttname"><a href="namespaceModelSetup.html#a00e7195f09f9bd709ef76fce4eb77698">ModelSetup::DampingType</a></div><div class="ttdeci">DampingType</div><div class="ttdoc">Defines the type of damping.</div><div class="ttdef"><b>Definition</b> Model.h:29</div></div>
 <div class="ttc" id="anamespaceModelSetup_html_a73c7cfb411f9b3b1062e5fbe694051ab"><div class="ttname"><a href="namespaceModelSetup.html#a73c7cfb411f9b3b1062e5fbe694051ab">ModelSetup::InterpolationFunctionType</a></div><div class="ttdeci">InterpolationFunctionType</div><div class="ttdoc">Defines the type of interpolation function.</div><div class="ttdef"><b>Definition</b> Model.h:37</div></div>
-<div class="ttc" id="astructLoads_1_1SeismicData_html"><div class="ttname"><a href="structLoads_1_1SeismicData.html">Loads::SeismicData</a></div><div class="ttdoc">Seismic data structure to manage acceleration and velocity of an earthquake record.</div><div class="ttdef"><b>Definition</b> Loads.h:101</div></div>
+<div class="ttc" id="astructLoads_1_1NodalPointLoadData_html"><div class="ttname"><a href="structLoads_1_1NodalPointLoadData.html">Loads::NodalPointLoadData</a></div><div class="ttdef"><b>Definition</b> Loads.h:36</div></div>
+<div class="ttc" id="astructLoads_1_1SeismicData_html"><div class="ttname"><a href="structLoads_1_1SeismicData.html">Loads::SeismicData</a></div><div class="ttdoc">Seismic data structure to manage acceleration and velocity of an earthquake record.</div><div class="ttdef"><b>Definition</b> Loads.h:97</div></div>
 </div><!-- fragment --></div><!-- contents -->
 </div><!-- doc-content -->
 <!-- start footer part -->

diff --git a/docs/Loads_8h.html b/docs/Loads_8h.html
@@ -108,8 +108,7 @@
   <div class="summary">
 <a href="#nested-classes">Classes</a> &#124;
 <a href="#namespaces">Namespaces</a> &#124;
-<a href="#func-members">Functions</a> &#124;
-<a href="#var-members">Variables</a>  </div>
+<a href="#func-members">Functions</a>  </div>
   <div class="headertitle"><div class="title">Loads.h File Reference</div></div>
 </div><!--header-->
 <div class="contents">
@@ -185,8 +184,7 @@
 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structLoads_1_1LoadDistributedBox.html">Loads::LoadDistributedBox</a></td></tr>
 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure to define a distributed load in particles inside the cuboid defined by point p1 and p2.  <a href="structLoads_1_1LoadDistributedBox.html#details">More...</a><br /></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structLoads_1_1NodalPointLoad.html">Loads::NodalPointLoad</a></td></tr>
-<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Define a structure to store point loads.  <a href="structLoads_1_1NodalPointLoad.html#details">More...</a><br /></td></tr>
+<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structLoads_1_1NodalPointLoadData.html">Loads::NodalPointLoadData</a></td></tr>
 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structLoads_1_1PressureBox.html">Loads::PressureBox</a></td></tr>
 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Structure to represent a box with a pressure. Pressure in applied to particles inside the cuboid defined by point p1 and p2.  <a href="structLoads_1_1PressureBox.html#details">More...</a><br /></td></tr>
@@ -243,16 +241,11 @@
 <tr class="memdesc:a9d91d188d9343c0d4b35705604b6b3d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set initial velocity in bodies.  <br /></td></tr>
 <tr class="separator:a9d91d188d9343c0d4b35705604b6b3d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a70b671a26b22a970ebdb930b2c43a505" id="r_a70b671a26b22a970ebdb930b2c43a505"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceLoads.html#a70b671a26b22a970ebdb930b2c43a505">Loads::configureNodalPointLoads</a> (<a class="el" href="classMesh.html">Mesh</a> *)</td></tr>
+<tr class="memdesc:a70b671a26b22a970ebdb930b2c43a505"><td class="mdescLeft">&#160;</td><td class="mdescRight">configure nodeid-point-load data for nodal force application  <br /></td></tr>
 <tr class="separator:a70b671a26b22a970ebdb930b2c43a505"><td class="memSeparator" colspan="2">&#160;</td></tr>
-</table><table class="memberdecls">
-<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="var-members" name="var-members"></a>
-Variables</h2></td></tr>
-<tr class="memitem:ad8a3ae1d06dccc3acb90569960068461" id="r_ad8a3ae1d06dccc3acb90569960068461"><td class="memItemLeft" align="right" valign="top">vector&lt; <a class="el" href="structLoads_1_1PrescribedPorePressure.html">PrescribedPorePressure</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceLoads.html#ad8a3ae1d06dccc3acb90569960068461">Loads::prescribedPorePressureParticlesList</a></td></tr>
-<tr class="separator:ad8a3ae1d06dccc3acb90569960068461"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:afe9be730a82af1e03b57cc4906e4931d" id="r_afe9be730a82af1e03b57cc4906e4931d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structLoads_1_1SeismicData.html">SeismicData</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceLoads.html#afe9be730a82af1e03b57cc4906e4931d">Loads::seismicRecord</a></td></tr>
-<tr class="separator:afe9be730a82af1e03b57cc4906e4931d"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a7863042b1bc1dad916b60d4f7aec821e" id="r_a7863042b1bc1dad916b60d4f7aec821e"><td class="memItemLeft" align="right" valign="top">std::vector&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceLoads.html#a7863042b1bc1dad916b60d4f7aec821e">Loads::nodalPointLoad</a></td></tr>
-<tr class="separator:a7863042b1bc1dad916b60d4f7aec821e"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a67971878871ece27ff54401ffcd9a5ff" id="r_a67971878871ece27ff54401ffcd9a5ff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structLoads_1_1NodalPointLoadData.html">NodalPointLoadData</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceLoads.html#a67971878871ece27ff54401ffcd9a5ff">Loads::getNodalPointList</a> ()</td></tr>
+<tr class="memdesc:a67971878871ece27ff54401ffcd9a5ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get (node-id load) vector for set nodal point load.  <br /></td></tr>
+<tr class="separator:a67971878871ece27ff54401ffcd9a5ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 </div><!-- contents -->
 </div><!-- doc-content -->

diff --git a/docs/Loads_8h.js b/docs/Loads_8h.js
@@ -1,13 +1,14 @@
 var Loads_8h =
 [
     [ "Loads::LoadDistributedBox", "structLoads_1_1LoadDistributedBox.html", "structLoads_1_1LoadDistributedBox" ],
-    [ "Loads::NodalPointLoad", "structLoads_1_1NodalPointLoad.html", "structLoads_1_1NodalPointLoad" ],
+    [ "Loads::NodalPointLoadData", "structLoads_1_1NodalPointLoadData.html", "structLoads_1_1NodalPointLoadData" ],
     [ "Loads::PressureBox", "structLoads_1_1PressureBox.html", "structLoads_1_1PressureBox" ],
     [ "Loads::PressureBoundaryForceBox", "structLoads_1_1PressureBoundaryForceBox.html", "structLoads_1_1PressureBoundaryForceBox" ],
     [ "Loads::PressureMaterial", "structLoads_1_1PressureMaterial.html", "structLoads_1_1PressureMaterial" ],
     [ "Loads::PrescribedPorePressure", "structLoads_1_1PrescribedPorePressure.html", "structLoads_1_1PrescribedPorePressure" ],
     [ "Loads::SeismicData", "structLoads_1_1SeismicData.html", "structLoads_1_1SeismicData" ],
     [ "configureNodalPointLoads", "Loads_8h.html#a70b671a26b22a970ebdb930b2c43a505", null ],
+    [ "getNodalPointList", "Loads_8h.html#a67971878871ece27ff54401ffcd9a5ff", null ],
     [ "getSeismicData", "Loads_8h.html#ac2794cc202d1527d21f610dd1bfc4310", null ],
     [ "setGravity", "Loads_8h.html#a1a2299651bd04336c8233e10785aca1b", null ],
     [ "setInitialPorePressureBox", "Loads_8h.html#ab69a7f18bdaf04c6fd6197f465ac9446", null ],
@@ -17,8 +18,5 @@ var Loads_8h =
     [ "setPrescribedPorePressureBoundaryForceBox", "Loads_8h.html#aab3e0ec525ab42f967dc058e7d057dde", null ],
     [ "setPrescribedPorePressureBox", "Loads_8h.html#af688d48cc51e2b6005d0088502120c55", null ],
     [ "setSeismicData", "Loads_8h.html#ab8f15227c16f8394a08a4d3586f80e11", null ],
-    [ "updatePrescribedPorePressure", "Loads_8h.html#a6f957fba555640cd03240c65124a35c2", null ],
-    [ "nodalPointLoad", "Loads_8h.html#a7863042b1bc1dad916b60d4f7aec821e", null ],
-    [ "prescribedPorePressureParticlesList", "Loads_8h.html#ad8a3ae1d06dccc3acb90569960068461", null ],
-    [ "seismicRecord", "Loads_8h.html#afe9be730a82af1e03b57cc4906e4931d", null ]
+    [ "updatePrescribedPorePressure", "Loads_8h.html#a6f957fba555640cd03240c65124a35c2", null ]
 ];