Merge pull request #14 from fabricix/doc--creating-md-files-for-docum…

…entation-of-introduction-and-compiling

doc: creating md files for introduction in the manual

docs/Loads_8h.html

@@ -240,9 +240,9 @@
 <tr class="memitem:a9d91d188d9343c0d4b35705604b6b3d1" id="r_a9d91d188d9343c0d4b35705604b6b3d1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceLoads.html#a9d91d188d9343c0d4b35705604b6b3d1">Loads::setInitialVelocity</a> (vector&lt; <a class="el" href="classBody.html">Body</a> * &gt; &amp;bodies)</td></tr>
 <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>
+<tr class="memitem:a17a7cd5461a3f485a589936ab71da9da" id="r_a17a7cd5461a3f485a589936ab71da9da"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceLoads.html#a17a7cd5461a3f485a589936ab71da9da">Loads::configureNodalPointLoads</a> (<a class="el" href="classMesh.html">Mesh</a> *mesh)</td></tr>
+<tr class="memdesc:a17a7cd5461a3f485a589936ab71da9da"><td class="mdescLeft">&#160;</td><td class="mdescRight">configure nodeid-point-load data for nodal force application  <br /></td></tr>
+<tr class="separator:a17a7cd5461a3f485a589936ab71da9da"><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>

docs/Loads_8h.js

@@ -7,7 +7,7 @@ var Loads_8h =
     [ "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 ],
+    [ "configureNodalPointLoads", "Loads_8h.html#a17a7cd5461a3f485a589936ab71da9da", null ],
     [ "getNodalPointList", "Loads_8h.html#a67971878871ece27ff54401ffcd9a5ff", null ],
     [ "getSeismicData", "Loads_8h.html#ac2794cc202d1527d21f610dd1bfc4310", null ],
     [ "setGravity", "Loads_8h.html#a1a2299651bd04336c8233e10785aca1b", null ],

docs/Loads_8h_source.html

@@ -219,20 +219,20 @@
 <div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span> </div>
 <div class="line"><a id="l00153" name="l00153"></a><span class="lineno"><a class="line" href="namespaceLoads.html#a9d91d188d9343c0d4b35705604b6b3d1">  153</a></span>    <span class="keywordtype">void</span> <a class="code hl_function" href="namespaceLoads.html#a9d91d188d9343c0d4b35705604b6b3d1">setInitialVelocity</a>(vector&lt;Body*&gt;&amp; bodies);</div>
 <div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span> </div>
-<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"><a class="line" href="namespaceLoads.html#a70b671a26b22a970ebdb930b2c43a505">  157</a></span>    <span class="keywordtype">void</span> <a class="code hl_function" href="namespaceLoads.html#a70b671a26b22a970ebdb930b2c43a505">configureNodalPointLoads</a>(<a class="code hl_class" href="classMesh.html">Mesh</a>*);</div>
+<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"><a class="line" href="namespaceLoads.html#a17a7cd5461a3f485a589936ab71da9da">  157</a></span>    <span class="keywordtype">void</span> <a class="code hl_function" href="namespaceLoads.html#a17a7cd5461a3f485a589936ab71da9da">configureNodalPointLoads</a>(<a class="code hl_class" href="classMesh.html">Mesh</a>* mesh);</div>
 <div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span> </div>
-<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"><a class="line" href="namespaceLoads.html#a67971878871ece27ff54401ffcd9a5ff">  161</a></span>    <a class="code hl_struct" href="structLoads_1_1NodalPointLoadData.html">NodalPointLoadData</a>&amp; <a class="code hl_function" href="namespaceLoads.html#a67971878871ece27ff54401ffcd9a5ff">getNodalPointList</a>();</div>
-<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span>};</div>
-<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span> </div>
-<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span><span class="preprocessor">#endif </span><span class="comment">/* LOADS_H_ */</span><span class="preprocessor"></span></div>
+<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"><a class="line" href="namespaceLoads.html#a67971878871ece27ff54401ffcd9a5ff">  160</a></span>    <a class="code hl_struct" href="structLoads_1_1NodalPointLoadData.html">NodalPointLoadData</a>&amp; <a class="code hl_function" href="namespaceLoads.html#a67971878871ece27ff54401ffcd9a5ff">getNodalPointList</a>();</div>
+<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span>};</div>
+<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span> </div>
+<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="preprocessor">#endif </span><span class="comment">/* LOADS_H_ */</span><span class="preprocessor"></span></div>
 <div class="ttc" id="aBody_8h_html"><div class="ttname"><a href="Body_8h.html">Body.h</a></div></div>
 <div class="ttc" id="aclassMesh_html"><div class="ttname"><a href="classMesh.html">Mesh</a></div><div class="ttdoc">Class representing a rectangular grid mesh.</div><div class="ttdef"><b>Definition</b> Mesh.h:29</div></div>
 <div class="ttc" id="anamespaceLoads_html"><div class="ttname"><a href="namespaceLoads.html">Loads</a></div><div class="ttdoc">Operations to manage loads in the MPM model.</div></div>
+<div class="ttc" id="anamespaceLoads_html_a17a7cd5461a3f485a589936ab71da9da"><div class="ttname"><a href="namespaceLoads.html#a17a7cd5461a3f485a589936ab71da9da">Loads::configureNodalPointLoads</a></div><div class="ttdeci">void configureNodalPointLoads(Mesh *mesh)</div><div class="ttdoc">configure nodeid-point-load data for nodal force application</div></div>
 <div class="ttc" id="anamespaceLoads_html_a1a2299651bd04336c8233e10785aca1b"><div class="ttname"><a href="namespaceLoads.html#a1a2299651bd04336c8233e10785aca1b">Loads::setGravity</a></div><div class="ttdeci">void setGravity(vector&lt; Body * &gt; &amp;bodies)</div><div class="ttdoc">Configures the gravity load in particles.</div></div>
 <div class="ttc" id="anamespaceLoads_html_a2f4cbf0274418e75675e0f07616538d4"><div class="ttname"><a href="namespaceLoads.html#a2f4cbf0274418e75675e0f07616538d4">Loads::setLoadDistributedBox</a></div><div class="ttdeci">void setLoadDistributedBox(vector&lt; Body * &gt; &amp;bodies, vector&lt; Loads::LoadDistributedBox &gt; loads)</div><div class="ttdoc">Configure distributed load in particles inside of a box.</div></div>
 <div class="ttc" id="anamespaceLoads_html_a67971878871ece27ff54401ffcd9a5ff"><div class="ttname"><a href="namespaceLoads.html#a67971878871ece27ff54401ffcd9a5ff">Loads::getNodalPointList</a></div><div class="ttdeci">NodalPointLoadData &amp; getNodalPointList()</div><div class="ttdoc">Get (node-id load) vector for set nodal point load.</div></div>
 <div class="ttc" id="anamespaceLoads_html_a6f957fba555640cd03240c65124a35c2"><div class="ttname"><a href="namespaceLoads.html#a6f957fba555640cd03240c65124a35c2">Loads::updatePrescribedPorePressure</a></div><div class="ttdeci">void updatePrescribedPorePressure(vector&lt; Body * &gt; *bodies)</div><div class="ttdoc">Set prescribed pore pressure in particles.</div></div>
-<div class="ttc" id="anamespaceLoads_html_a70b671a26b22a970ebdb930b2c43a505"><div class="ttname"><a href="namespaceLoads.html#a70b671a26b22a970ebdb930b2c43a505">Loads::configureNodalPointLoads</a></div><div class="ttdeci">void configureNodalPointLoads(Mesh *)</div><div class="ttdoc">configure nodeid-point-load data for nodal force application</div></div>
 <div class="ttc" id="anamespaceLoads_html_a9d91d188d9343c0d4b35705604b6b3d1"><div class="ttname"><a href="namespaceLoads.html#a9d91d188d9343c0d4b35705604b6b3d1">Loads::setInitialVelocity</a></div><div class="ttdeci">void setInitialVelocity(vector&lt; Body * &gt; &amp;bodies)</div><div class="ttdoc">Set initial velocity in bodies.</div></div>
 <div class="ttc" id="anamespaceLoads_html_aab3e0ec525ab42f967dc058e7d057dde"><div class="ttname"><a href="namespaceLoads.html#aab3e0ec525ab42f967dc058e7d057dde">Loads::setPrescribedPorePressureBoundaryForceBox</a></div><div class="ttdeci">void setPrescribedPorePressureBoundaryForceBox(vector&lt; Body * &gt; &amp;bodies, vector&lt; Loads::PressureBoundaryForceBox &gt; loads)</div><div class="ttdoc">Set external boundary force in fluid phase due the prescribed pore pressure in particles.</div></div>
 <div class="ttc" id="anamespaceLoads_html_ab43ba822ff0a2657155f8819db1a36b8"><div class="ttname"><a href="namespaceLoads.html#ab43ba822ff0a2657155f8819db1a36b8">Loads::setInitialPorePressureMaterial</a></div><div class="ttdeci">void setInitialPorePressureMaterial(vector&lt; Body * &gt; &amp;bodies, vector&lt; Loads::PressureMaterial &gt; pressures)</div><div class="ttdoc">Configure initial pore pressure in particles by material id.</div></div>