Commit 191b7bc0 authored by mozul's avatar mozul
Browse files

update docs to last version

parent 40c12dd7
......@@ -2583,19 +2583,22 @@ forgotten</li>
<tr class="row-even"><td><a class="reference internal" href="#pylmgc90.pre_lmgc.mesh.addNode" title="pylmgc90.pre_lmgc.mesh.addNode"><tt class="xref py py-obj docutils literal"><span class="pre">addNode</span></tt></a>(noeud)</td>
<td>addNode(noeud):</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#pylmgc90.pre_lmgc.mesh.buildMeshedAvatar" title="pylmgc90.pre_lmgc.mesh.buildMeshedAvatar"><tt class="xref py py-obj docutils literal"><span class="pre">buildMeshedAvatar</span></tt></a>(model,&nbsp;material)</td>
<td>buildMeshedAvatar(self, model, material):</td>
<tr class="row-odd"><td><a class="reference internal" href="#pylmgc90.pre_lmgc.mesh.computeNormal" title="pylmgc90.pre_lmgc.mesh.computeNormal"><tt class="xref py py-obj docutils literal"><span class="pre">computeNormal</span></tt></a>(n,&nbsp;e,&nbsp;reverse)</td>
<td>Compute normal of a node of an element</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#pylmgc90.pre_lmgc.mesh.getSubMeshes" title="pylmgc90.pre_lmgc.mesh.getSubMeshes"><tt class="xref py py-obj docutils literal"><span class="pre">getSubMeshes</span></tt></a>([entity_type])</td>
<tr class="row-even"><td><a class="reference internal" href="#pylmgc90.pre_lmgc.mesh.extrudePhysicalEntity" title="pylmgc90.pre_lmgc.mesh.extrudePhysicalEntity"><tt class="xref py py-obj docutils literal"><span class="pre">extrudePhysicalEntity</span></tt></a>(pE,&nbsp;length[,&nbsp;reverse])</td>
<td>Extrude an external layer of mesh.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#pylmgc90.pre_lmgc.mesh.getSubMeshes" title="pylmgc90.pre_lmgc.mesh.getSubMeshes"><tt class="xref py py-obj docutils literal"><span class="pre">getSubMeshes</span></tt></a>([entity_type])</td>
<td>getSubMeshes(self, entity_type=&#8221;geometricalEntity&#8221;):</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#pylmgc90.pre_lmgc.mesh.rankRenumbering" title="pylmgc90.pre_lmgc.mesh.rankRenumbering"><tt class="xref py py-obj docutils literal"><span class="pre">rankRenumbering</span></tt></a>()</td>
<tr class="row-even"><td><a class="reference internal" href="#pylmgc90.pre_lmgc.mesh.rankRenumbering" title="pylmgc90.pre_lmgc.mesh.rankRenumbering"><tt class="xref py py-obj docutils literal"><span class="pre">rankRenumbering</span></tt></a>()</td>
<td>rankRenumbering(self):</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="#pylmgc90.pre_lmgc.mesh.removeFreeNodes" title="pylmgc90.pre_lmgc.mesh.removeFreeNodes"><tt class="xref py py-obj docutils literal"><span class="pre">removeFreeNodes</span></tt></a>(self)</td>
<tr class="row-odd"><td><a class="reference internal" href="#pylmgc90.pre_lmgc.mesh.removeFreeNodes" title="pylmgc90.pre_lmgc.mesh.removeFreeNodes"><tt class="xref py py-obj docutils literal"><span class="pre">removeFreeNodes</span></tt></a>(self)</td>
<td>removes nodes not attached to an element</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="#pylmgc90.pre_lmgc.mesh.separateMeshes" title="pylmgc90.pre_lmgc.mesh.separateMeshes"><tt class="xref py py-obj docutils literal"><span class="pre">separateMeshes</span></tt></a>(dim[,&nbsp;entity_type,&nbsp;...])</td>
<tr class="row-even"><td><a class="reference internal" href="#pylmgc90.pre_lmgc.mesh.separateMeshes" title="pylmgc90.pre_lmgc.mesh.separateMeshes"><tt class="xref py py-obj docutils literal"><span class="pre">separateMeshes</span></tt></a>(dim[,&nbsp;entity_type,&nbsp;...])</td>
<td>separateMeshes(self, dim, entity_type=&#8221;geometricalEntity&#8221;):</td>
</tr>
</tbody>
......@@ -2625,16 +2628,26 @@ forgotten</li>
</dd></dl>
<dl class="method">
<dt id="pylmgc90.pre_lmgc.mesh.buildMeshedAvatar">
<tt class="descname">buildMeshedAvatar</tt><big>(</big><em>model</em>, <em>material</em><big>)</big><a class="headerlink" href="#pylmgc90.pre_lmgc.mesh.buildMeshedAvatar" title="Permalink to this definition"></a></dt>
<dd><p>buildMeshedAvatar(self, model, material):</p>
<p>this function builds a meshed avatar from the mesh.</p>
<p>parameters:</p>
<ul class="simple">
<li>self: the mesh itself</li>
<li>model: a given model</li>
<li>material: a given material</li>
</ul>
<dt id="pylmgc90.pre_lmgc.mesh.computeNormal">
<tt class="descname">computeNormal</tt><big>(</big><em>n</em>, <em>e</em>, <em>reverse</em><big>)</big><a class="headerlink" href="#pylmgc90.pre_lmgc.mesh.computeNormal" title="Permalink to this definition"></a></dt>
<dd><p>Compute normal of a node of an element</p>
</dd></dl>
<dl class="method">
<dt id="pylmgc90.pre_lmgc.mesh.extrudePhysicalEntity">
<tt class="descname">extrudePhysicalEntity</tt><big>(</big><em>pE</em>, <em>length</em>, <em>reverse=False</em><big>)</big><a class="headerlink" href="#pylmgc90.pre_lmgc.mesh.extrudePhysicalEntity" title="Permalink to this definition"></a></dt>
<dd><p>Extrude an external layer of mesh.</p>
<p>This functions use the nodes of a physical entity
to create the node extrusion and the corresponding element
in the mesh. Linear elements only !!! Physical entities are
created with prefix &#8216;E&#8217; for the extruded elements and &#8216;P&#8217;
for the projected nodes.</p>
<p>To work, the rankRenumbering function must have been called beforehand,
and the elements correctly oriented. At this time only &#8216;S2xxx&#8217; and &#8216;T3xxx&#8217;
element are supported.</p>
<p>parameters:
- pE : physical entity name to extrude from
- length : size of extrusion along the computed normals</p>
</dd></dl>
<dl class="method">
......
......@@ -176,12 +176,6 @@
<dt><a href="classes.html#pylmgc90.pre_lmgc.buildMeshedAvatar">buildMeshedAvatar() (in module pylmgc90.pre_lmgc)</a>
</dt>
<dd><dl>
<dt><a href="classes.html#pylmgc90.pre_lmgc.mesh.buildMeshedAvatar">(pylmgc90.pre_lmgc.mesh method)</a>
</dt>
</dl></dd>
<dt><a href="classes.html#pylmgc90.pre_lmgc.buildMeshH8">buildMeshH8() (in module pylmgc90.pre_lmgc)</a>
</dt>
......@@ -231,6 +225,10 @@
</dt>
<dt><a href="classes.html#pylmgc90.pre_lmgc.mesh.computeNormal">computeNormal() (pylmgc90.pre_lmgc.mesh method)</a>
</dt>
<dt><a href="classes.html#pylmgc90.pre_lmgc.avatar.computeRigidProperties">computeRigidProperties() (pylmgc90.pre_lmgc.avatar method)</a>
</dt>
......@@ -337,6 +335,10 @@
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="classes.html#pylmgc90.pre_lmgc.mesh.extrudePhysicalEntity">extrudePhysicalEntity() (pylmgc90.pre_lmgc.mesh method)</a>
</dt>
<dt><a href="classes.html#pylmgc90.pre_lmgc.extrudeRigid">extrudeRigid() (in module pylmgc90.pre_lmgc)</a>
</dt>
......
......@@ -84,7 +84,7 @@ the type.</p>
<div class="section" id="visco-elas-type">
<h2>VISCO_ELAS type:<a class="headerlink" href="#visco-elas-type" title="Permalink to this headline"></a></h2>
<p>visco elastic material</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">steel</span> <span class="o">=</span> <span class="n">material</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s">&#39;steel&#39;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s">&#39;VISCO_PLAS&#39;</span><span class="p">,</span> <span class="n">density</span><span class="o">=</span><span class="mf">8.93e3</span><span class="p">,</span>
<div class="highlight-python"><div class="highlight"><pre><span class="n">steel</span> <span class="o">=</span> <span class="n">material</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s">&#39;steel&#39;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s">&#39;VISCO_ELAS&#39;</span><span class="p">,</span> <span class="n">density</span><span class="o">=</span><span class="mf">8.93e3</span><span class="p">,</span>
<span class="n">elas</span><span class="o">=</span><span class="s">&#39;standard&#39;</span><span class="p">,</span> <span class="n">anisotropy</span><span class="o">=</span><span class="s">&#39;isotropic&#39;</span><span class="p">,</span> <span class="n">young</span><span class="o">=</span><span class="mf">1.17e11</span><span class="p">,</span> <span class="n">nu</span><span class="o">=</span><span class="mf">0.35</span><span class="p">,</span>
<span class="n">viscous_model</span><span class="o">=</span><span class="s">&#39;KelvinVoigt&#39;</span><span class="p">,</span> <span class="n">viscous_young</span><span class="o">=</span><span class="mf">1.17e9</span><span class="p">,</span> <span class="n">viscous_nu</span><span class="o">=</span><span class="mf">0.35</span><span class="p">)</span>
</pre></div>
......
......@@ -99,7 +99,8 @@
<li>anisotropy : &#8216;<a href="#id1"><span class="problematic" id="id2">iso__</span></a>&#8216;, &#8216;ortho&#8217;</li>
<li>external_model : &#8216;<a href="#id1"><span class="problematic" id="id3">yes__</span></a>&#8216;, &#8216;no___&#8217;</li>
<li>discrete : &#8216;<a href="#id1"><span class="problematic" id="id4">yes__</span></a>&#8216;, &#8216;no___&#8217;</li>
<li>ext_f</li>
<li>external_fields : list of string</li>
<li>external_vfields : list of string</li>
</ul>
</div></blockquote>
<p>Example</p>
......@@ -135,7 +136,8 @@
<li>formulation : &#8216;class&#8217;, &#8216;stdvf&#8217;, &#8216;linvf&#8217;</li>
<li>external_model : &#8216;<a href="#id1"><span class="problematic" id="id5">yes__</span></a>&#8216;, &#8216;no___&#8217;</li>
<li>convection_type : &#8216;<a href="#id16"><span class="problematic" id="id17">supg_</span></a>&#8216;,&#8217;cente&#8217;</li>
<li>ext_f</li>
<li>external_fields : list of string</li>
<li>external_vfields : list of string</li>
</ul>
</div></blockquote>
<p>Example</p>
......@@ -176,7 +178,8 @@
<li>capacity_storage : &#8216;<a href="#id24"><span class="problematic" id="id25">lump_</span></a>&#8216;, &#8216;coher&#8217;</li>
<li>convection_type : &#8216;<a href="#id26"><span class="problematic" id="id27">supg_</span></a>&#8216;, &#8216;<a href="#id28"><span class="problematic" id="id29">char_</span></a>&#8216;,&#8217;center&#8217;</li>
<li>physical_type: &#8216;fluid&#8217;, &#8216;solid&#8217;</li>
<li>ext_f</li>
<li>external_fields : list of string</li>
<li>external_vfields : list of string</li>
</ul>
</div></blockquote>
<p>Example</p>
......
......@@ -324,23 +324,29 @@ bodies read from BODIES.DAT and initialize property sets.</p>
<dl class="function">
<dt id="pylmgc90.chipy.chipy.ReadIniDof">
<tt class="descclassname">pylmgc90.chipy.chipy.</tt><tt class="descname">ReadIniDof</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pylmgc90/chipy/chipy.html#ReadIniDof"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylmgc90.chipy.chipy.ReadIniDof" title="Permalink to this definition"></a></dt>
<dd><p>Read DOF.INI file in DATBOX directory.</p>
<p>Must be called after LoadBehaviours.</p>
<tt class="descclassname">pylmgc90.chipy.chipy.</tt><tt class="descname">ReadIniDof</tt><big>(</big><em>step=0</em><big>)</big><a class="reference internal" href="_modules/pylmgc90/chipy/chipy.html#ReadIniDof"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylmgc90.chipy.chipy.ReadIniDof" title="Permalink to this definition"></a></dt>
<dd><p>Read DOF file.
If step &gt; 0 read OUTBOX/DOF.OUT.step file,
otherwise read DATBOX/DOF.INI file
Must be called after LoadBehaviours.</p>
</dd></dl>
<dl class="function">
<dt id="pylmgc90.chipy.chipy.ReadIniGPV">
<tt class="descclassname">pylmgc90.chipy.chipy.</tt><tt class="descname">ReadIniGPV</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pylmgc90/chipy/chipy.html#ReadIniGPV"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylmgc90.chipy.chipy.ReadIniGPV" title="Permalink to this definition"></a></dt>
<dd><p>Read GPV.INI file in DATBOX directory.</p>
<p>Must be called after LoadModels.</p>
<tt class="descclassname">pylmgc90.chipy.chipy.</tt><tt class="descname">ReadIniGPV</tt><big>(</big><em>step=0</em><big>)</big><a class="reference internal" href="_modules/pylmgc90/chipy/chipy.html#ReadIniGPV"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylmgc90.chipy.chipy.ReadIniGPV" title="Permalink to this definition"></a></dt>
<dd><p>Read GPV.INI.
If step &gt; 0 read OUTBOX/GPV.OUT.step file,
otherwise read DATBOX/GPV.INI file
Must be called after LoadModels.</p>
</dd></dl>
<dl class="function">
<dt id="pylmgc90.chipy.chipy.ReadIniVlocRloc">
<tt class="descclassname">pylmgc90.chipy.chipy.</tt><tt class="descname">ReadIniVlocRloc</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/pylmgc90/chipy/chipy.html#ReadIniVlocRloc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylmgc90.chipy.chipy.ReadIniVlocRloc" title="Permalink to this definition"></a></dt>
<dd><p>Read VlocRloc.INI file in DATBOX directory.</p>
<p>Must be called after LoadTactors.</p>
<tt class="descclassname">pylmgc90.chipy.chipy.</tt><tt class="descname">ReadIniVlocRloc</tt><big>(</big><em>step=0</em><big>)</big><a class="reference internal" href="_modules/pylmgc90/chipy/chipy.html#ReadIniVlocRloc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pylmgc90.chipy.chipy.ReadIniVlocRloc" title="Permalink to this definition"></a></dt>
<dd><p>Read VlocRloc file.
If step &gt; 0 read OUTBOX/VlocRloc.OUT.step file,
otherwise read DATBOX/VlocRloc.INI file
Must be called after LoadTactors.</p>
</dd></dl>
<dl class="function">
......
This diff is collapsed.
This diff is collapsed.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment