Skip to content

Commit 8606f16

Browse files
Alexander HartmaierAlexander Hartmaier
Alexander Hartmaier
authored and
Alexander Hartmaier
committed
Updated documentation
1 parent dc9a5dd commit 8606f16

26 files changed

+15297
-192
lines changed

‎docs/.buildinfo‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 11e24ecb086b3722c21b5fe755982994
3+
config: ff52a5f899b7dfb16e79b33e71c1803a
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/_modules/index.html‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>Overview: module code &#8212; pyLabFEA 4.0.0 documentation</title>
8+
<title>Overview: module code &#8212; pyLabFEA 4.1.1 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="../_static/classic.css" />
1111

@@ -26,7 +26,7 @@ <h3>Navigation</h3>
2626
<li class="right" >
2727
<a href="../py-modindex.html" title="Python Module Index"
2828
>modules</a> |</li>
29-
<li class="nav-item nav-item-0"><a href="../index.html">pyLabFEA 4.0.0 documentation</a> &#187;</li>
29+
<li class="nav-item nav-item-0"><a href="../index.html">pyLabFEA 4.1.1 documentation</a> &#187;</li>
3030
<li class="nav-item nav-item-this"><a href="">Overview: module code</a></li>
3131
</ul>
3232
</div>
@@ -73,13 +73,13 @@ <h3>Navigation</h3>
7373
<li class="right" >
7474
<a href="../py-modindex.html" title="Python Module Index"
7575
>modules</a> |</li>
76-
<li class="nav-item nav-item-0"><a href="../index.html">pyLabFEA 4.0.0 documentation</a> &#187;</li>
76+
<li class="nav-item nav-item-0"><a href="../index.html">pyLabFEA 4.1.1 documentation</a> &#187;</li>
7777
<li class="nav-item nav-item-this"><a href="">Overview: module code</a></li>
7878
</ul>
7979
</div>
8080
<div class="footer" role="contentinfo">
81-
&#169; Copyright 2020, 2021, Alexander Hartmaier, ICAMS/Ruhr University Bochum, Germany.
82-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.2.0.
81+
&#169; Copyright 2020, 2021, 2022, Alexander Hartmaier, ICAMS/Ruhr University Bochum, Germany.
82+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.4.0.
8383
</div>
8484
</body>
8585
</html>

‎docs/_modules/pylabfea/basic.html‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>pylabfea.basic &#8212; pyLabFEA 4.0.0 documentation</title>
8+
<title>pylabfea.basic &#8212; pyLabFEA 4.1.1 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="../../_static/classic.css" />
1111

@@ -26,7 +26,7 @@ <h3>Navigation</h3>
2626
<li class="right" >
2727
<a href="../../py-modindex.html" title="Python Module Index"
2828
>modules</a> |</li>
29-
<li class="nav-item nav-item-0"><a href="../../index.html">pyLabFEA 4.0.0 documentation</a> &#187;</li>
29+
<li class="nav-item nav-item-0"><a href="../../index.html">pyLabFEA 4.1.1 documentation</a> &#187;</li>
3030
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
3131
<li class="nav-item nav-item-this"><a href="">pylabfea.basic</a></li>
3232
</ul>
@@ -574,6 +574,8 @@ <h1>Source code for pylabfea.basic</h1><div class="highlight"><pre>
574574
<span class="sd"> &#39;&#39;&#39;</span>
575575
<span class="k">if</span> <span class="n">name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
576576
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Name for pickled material must be given.&#39;</span><span class="p">)</span>
577+
<span class="k">if</span> <span class="n">path</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">!=</span> <span class="s1">&#39;/&#39;</span><span class="p">:</span>
578+
<span class="n">path</span> <span class="o">+=</span> <span class="s1">&#39;/&#39;</span>
577579
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">path</span><span class="o">+</span><span class="n">name</span><span class="p">,</span> <span class="s1">&#39;rb&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="nb">input</span><span class="p">:</span>
578580
<span class="n">pckl</span> <span class="o">=</span> <span class="n">pickle</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="nb">input</span><span class="p">)</span>
579581
<span class="k">return</span> <span class="n">pckl</span></div>
@@ -608,14 +610,14 @@ <h3>Navigation</h3>
608610
<li class="right" >
609611
<a href="../../py-modindex.html" title="Python Module Index"
610612
>modules</a> |</li>
611-
<li class="nav-item nav-item-0"><a href="../../index.html">pyLabFEA 4.0.0 documentation</a> &#187;</li>
613+
<li class="nav-item nav-item-0"><a href="../../index.html">pyLabFEA 4.1.1 documentation</a> &#187;</li>
612614
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
613615
<li class="nav-item nav-item-this"><a href="">pylabfea.basic</a></li>
614616
</ul>
615617
</div>
616618
<div class="footer" role="contentinfo">
617-
&#169; Copyright 2020, 2021, Alexander Hartmaier, ICAMS/Ruhr University Bochum, Germany.
618-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.2.0.
619+
&#169; Copyright 2020, 2021, 2022, Alexander Hartmaier, ICAMS/Ruhr University Bochum, Germany.
620+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.4.0.
619621
</div>
620622
</body>
621623
</html>

‎docs/_modules/pylabfea/data.html‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>pylabfea.data &#8212; pyLabFEA 4.0.0 documentation</title>
8+
<title>pylabfea.data &#8212; pyLabFEA 4.1.1 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="../../_static/classic.css" />
1111

@@ -26,7 +26,7 @@ <h3>Navigation</h3>
2626
<li class="right" >
2727
<a href="../../py-modindex.html" title="Python Module Index"
2828
>modules</a> |</li>
29-
<li class="nav-item nav-item-0"><a href="../../index.html">pyLabFEA 4.0.0 documentation</a> &#187;</li>
29+
<li class="nav-item nav-item-0"><a href="../../index.html">pyLabFEA 4.1.1 documentation</a> &#187;</li>
3030
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
3131
<li class="nav-item nav-item-this"><a href="">pylabfea.data</a></li>
3232
</ul>
@@ -285,7 +285,7 @@ <h1>Source code for pylabfea.data</h1><div class="highlight"><pre>
285285
<span class="s1">&#39;nu_av&#39;</span> <span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">nu_av</span><span class="p">,</span><span class="c1"># Poisson ratio</span>
286286
<span class="s1">&#39;sy_av&#39;</span> <span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">sy_av</span> <span class="c1"># yield strength</span>
287287
<span class="p">}</span>
288-
<span class="nb">print</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">mat_param</span><span class="p">)</span>
288+
<span class="c1">#print(self.mat_param)</span>
289289
<span class="n">syld</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="bp">self</span><span class="o">.</span><span class="n">Nset</span><span class="p">,</span><span class="n">Nlc_min</span><span class="p">,</span><span class="mi">6</span><span class="p">))</span> <span class="c1"># Voigt stress tensor at onset of yielding</span>
290290
<span class="k">for</span> <span class="n">iset</span><span class="p">,</span> <span class="n">dset</span> <span class="ow">in</span> <span class="nb">enumerate</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">set</span><span class="p">):</span> <span class="c1"># loop over data sets</span>
291291
<span class="n">syld</span><span class="p">[</span><span class="n">iset</span><span class="p">,:,:]</span> <span class="o">=</span> <span class="n">dset</span><span class="o">.</span><span class="n">syld</span><span class="p">[</span><span class="mi">0</span><span class="p">:</span><span class="n">Nlc_min</span><span class="p">,:]</span>
@@ -1133,14 +1133,14 @@ <h3>Navigation</h3>
11331133
<li class="right" >
11341134
<a href="../../py-modindex.html" title="Python Module Index"
11351135
>modules</a> |</li>
1136-
<li class="nav-item nav-item-0"><a href="../../index.html">pyLabFEA 4.0.0 documentation</a> &#187;</li>
1136+
<li class="nav-item nav-item-0"><a href="../../index.html">pyLabFEA 4.1.1 documentation</a> &#187;</li>
11371137
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
11381138
<li class="nav-item nav-item-this"><a href="">pylabfea.data</a></li>
11391139
</ul>
11401140
</div>
11411141
<div class="footer" role="contentinfo">
1142-
&#169; Copyright 2020, 2021, Alexander Hartmaier, ICAMS/Ruhr University Bochum, Germany.
1143-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.2.0.
1142+
&#169; Copyright 2020, 2021, 2022, Alexander Hartmaier, ICAMS/Ruhr University Bochum, Germany.
1143+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.4.0.
11441144
</div>
11451145
</body>
11461146
</html>

‎docs/_modules/pylabfea/material.html‎

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>pylabfea.material &#8212; pyLabFEA 4.0.0 documentation</title>
8+
<title>pylabfea.material &#8212; pyLabFEA 4.1.1 documentation</title>
99
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css" />
1010
<link rel="stylesheet" type="text/css" href="../../_static/classic.css" />
1111

@@ -26,7 +26,7 @@ <h3>Navigation</h3>
2626
<li class="right" >
2727
<a href="../../py-modindex.html" title="Python Module Index"
2828
>modules</a> |</li>
29-
<li class="nav-item nav-item-0"><a href="../../index.html">pyLabFEA 4.0.0 documentation</a> &#187;</li>
29+
<li class="nav-item nav-item-0"><a href="../../index.html">pyLabFEA 4.1.1 documentation</a> &#187;</li>
3030
<li class="nav-item nav-item-1"><a href="../index.html" accesskey="U">Module code</a> &#187;</li>
3131
<li class="nav-item nav-item-this"><a href="">pylabfea.material</a></li>
3232
</ul>
@@ -1475,11 +1475,11 @@ <h1>Source code for pylabfea.material</h1><div class="highlight"><pre>
14751475
<span class="sd"> sname : str</span>
14761476
<span class="sd"> Name of script that created this material</span>
14771477
<span class="sd"> source : str</span>
1478-
<span class="sd"> Source of parameters (optiona, default: None)</span>
1478+
<span class="sd"> Source of parameters (optional, default: None)</span>
14791479
<span class="sd"> file : str</span>
14801480
<span class="sd"> Trunk of filename to which CSV flies are written (optional, default: None)</span>
14811481
<span class="sd"> path : str</span>
1482-
<span class="sd"> Path to which files are written (optional: default: &#39;&#39;)</span>
1482+
<span class="sd"> Path to which files are written (optional: default: &#39;../../models/&#39;)</span>
14831483
<span class="sd"> descr : list</span>
14841484
<span class="sd"> List of names of model parameters used for generating this ML material (optional, default: [])</span>
14851485
<span class="sd"> param : list</span>
@@ -1511,7 +1511,9 @@ <h1>Source code for pylabfea.material</h1><div class="highlight"><pre>
15111511
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Lists for descr and param must have the same lengths.&#39;</span><span class="p">)</span>
15121512
<span class="k">if</span> <span class="n">file</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
15131513
<span class="n">file</span> <span class="o">=</span> <span class="s1">&#39;abq_&#39;</span><span class="o">+</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span>
1514-
<span class="n">file</span> <span class="o">=</span> <span class="n">path</span><span class="o">+</span><span class="n">file</span>
1514+
<span class="k">if</span> <span class="n">path</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">!=</span> <span class="s1">&#39;/&#39;</span><span class="p">:</span>
1515+
<span class="n">path</span> <span class="o">+=</span> <span class="s1">&#39;/&#39;</span>
1516+
<span class="n">file</span> <span class="o">=</span> <span class="n">path</span> <span class="o">+</span> <span class="n">file</span>
15151517

15161518
<span class="c1"># write parameters of trained SVC to file readable to Abaqus</span>
15171519
<span class="n">dc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">svm_yf</span><span class="o">.</span><span class="n">dual_coef_</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="c1"># dual coefficients</span>
@@ -1621,6 +1623,8 @@ <h1>Source code for pylabfea.material</h1><div class="highlight"><pre>
16211623
<span class="sd"> &#39;&#39;&#39;</span>
16221624
<span class="k">if</span> <span class="n">name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
16231625
<span class="n">name</span> <span class="o">=</span> <span class="s1">&#39;mat_&#39;</span><span class="o">+</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">+</span> <span class="s1">&#39;.pkl&#39;</span>
1626+
<span class="k">if</span> <span class="n">path</span><span class="p">[</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span> <span class="o">!=</span> <span class="s1">&#39;/&#39;</span><span class="p">:</span>
1627+
<span class="n">path</span> <span class="o">+=</span> <span class="s1">&#39;/&#39;</span>
16241628
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">path</span><span class="o">+</span><span class="n">name</span><span class="p">,</span> <span class="s1">&#39;wb&#39;</span><span class="p">)</span> <span class="k">as</span> <span class="n">output</span><span class="p">:</span>
16251629
<span class="n">pickle</span><span class="o">.</span><span class="n">dump</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">output</span><span class="p">,</span> <span class="n">pickle</span><span class="o">.</span><span class="n">HIGHEST_PROTOCOL</span><span class="p">)</span>
16261630
<span class="k">return</span></div>
@@ -1790,7 +1794,8 @@ <h1>Source code for pylabfea.material</h1><div class="highlight"><pre>
17901794
<span class="sd"> grain shapes and porosities. Will invoke definition of elastic and plastic </span>
17911795
<span class="sd"> parameters by calls to the methods `Material.elasticity` and `Material.plasticity` </span>
17921796
<span class="sd"> with the parameters provided in the data set. </span>
1793-
<span class="sd"> Also initializes current texture to first one in list and re-sets work-hardening parameters.</span>
1797+
<span class="sd"> Also initializes current texture to first one in list and resets work hardening </span>
1798+
<span class="sd"> parameters.</span>
17941799

17951800
<span class="sd"> Parameters</span>
17961801
<span class="sd"> ----------</span>
@@ -1839,6 +1844,23 @@ <h1>Source code for pylabfea.material</h1><div class="highlight"><pre>
18391844
<span class="n">tp</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">Nset</span><span class="p">)</span>
18401845
<span class="n">tp</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">=</span> <span class="mf">1.</span>
18411846
<span class="bp">self</span><span class="o">.</span><span class="n">set_texture</span><span class="p">(</span><span class="n">tp</span><span class="p">)</span></div>
1847+
1848+
<div class="viewcode-block" id="Material.from_MLparam"><a class="viewcode-back" href="../../pyLabFEA.html#pylabfea.material.Material.from_MLparam">[docs]</a> <span class="k">def</span> <span class="nf">from_MLparam</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="s1">&#39;../../models/&#39;</span><span class="p">):</span>
1849+
<span class="sd">&#39;&#39;&#39;Define material properties from parameters of trained machine learning </span>
1850+
<span class="sd"> models that have been written with `Material.export_MLparam`.</span>
1851+
<span class="sd"> Will invoke definition of elastic parameters by calls to the methods </span>
1852+
<span class="sd"> `Material.elasticity` with the parameters provided in the data set. </span>
1853+
<span class="sd"> Also initializes current texture to first one in list and resets work hardening</span>
1854+
<span class="sd"> parameters.</span>
1855+
1856+
<span class="sd"> Parameters</span>
1857+
<span class="sd"> ----------</span>
1858+
<span class="sd"> name : string</span>
1859+
<span class="sd"> Name of parameter files (`name`.csv file and metadata file `name_meta.json`)</span>
1860+
<span class="sd"> path : string</span>
1861+
<span class="sd"> Path in which files are stored (optional, default: &#39;../../models/&#39;) </span>
1862+
<span class="sd"> &#39;&#39;&#39;</span>
1863+
<span class="k">raise</span> <span class="ne">ModuleNotFoundError</span><span class="p">(</span><span class="s1">&#39;Import from ML parameters not yet implemented.&#39;</span><span class="p">)</span></div>
18421864

18431865
<div class="viewcode-block" id="Material.set_texture"><a class="viewcode-back" href="../../pyLabFEA.html#pylabfea.material.Material.set_texture">[docs]</a> <span class="k">def</span> <span class="nf">set_texture</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">current</span><span class="p">,</span> <span class="n">verb</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
18441866
<span class="sd">&#39;&#39;&#39;Set parameters for current crystallographic texture of material as defined in microstructure.</span>
@@ -2478,14 +2500,14 @@ <h3>Navigation</h3>
24782500
<li class="right" >
24792501
<a href="../../py-modindex.html" title="Python Module Index"
24802502
>modules</a> |</li>
2481-
<li class="nav-item nav-item-0"><a href="../../index.html">pyLabFEA 4.0.0 documentation</a> &#187;</li>
2503+
<li class="nav-item nav-item-0"><a href="../../index.html">pyLabFEA 4.1.1 documentation</a> &#187;</li>
24822504
<li class="nav-item nav-item-1"><a href="../index.html" >Module code</a> &#187;</li>
24832505
<li class="nav-item nav-item-this"><a href="">pylabfea.material</a></li>
24842506
</ul>
24852507
</div>
24862508
<div class="footer" role="contentinfo">
2487-
&#169; Copyright 2020, 2021, Alexander Hartmaier, ICAMS/Ruhr University Bochum, Germany.
2488-
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.2.0.
2509+
&#169; Copyright 2020, 2021, 2022, Alexander Hartmaier, ICAMS/Ruhr University Bochum, Germany.
2510+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.4.0.
24892511
</div>
24902512
</body>
24912513
</html>

0 commit comments

Comments
 (0)