Python API documentation update for FEFLOW 8.1

DHI · Nov 24, 2023 · c0f60b4 · c0f60b4
1 parent 46e2df1
commit c0f60b4
Show file tree

Hide file tree

Showing 16 changed files with 929 additions and 50 deletions.
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: c91da3366262a221bda537d291940ccd
+config: 053bb9ac75c9b7660236052388f5b84b
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_sources/api_objects.rst.txt b/docs/_sources/api_objects.rst.txt
@@ -35,6 +35,11 @@ ifm.ParticleTracer
 ------------------
 .. autoclass:: ifm.ParticleTracer
 	:members:
+
+ifm.ProblemDefinition
+---------------------
+.. autoclass:: ifm.ProblemDefinition
+	:members:	
 
 ifm.SubdomainBudget
 -------------------
@@ -46,6 +51,11 @@ ifm.SubdomainTransferBudget
 .. autoclass:: ifm.SubdomainTransferBudget
 	:members:
 
+ifm.SuperMesh
+---------------------------
+.. autoclass:: ifm.SuperMesh
+	:members:	
+
 ifm.WellManager
 ---------------------------
 .. autoclass:: ifm.WellManager

diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -11,8 +11,8 @@ Programming Interface for the FEFLOW Grundwater Modelling System
 Requirements
 ------------
 
-* Python >= 3.6
-* FEFLOW 8.0
+* Python >= 3.9
+* FEFLOW 8.1
 
 Installation
 ------------
@@ -36,13 +36,13 @@ The most common way is to import ifm as a package in a Python script. This is us
     >>>  doc = ifm.loadDocument("myModel.fem")
     >>>  print(doc.getNumberOfNodes())
 
-The package resides in the C:\Program Files\DHI\2022\FEFLOW 8.0\python file and the FEFLOW installer will add this path to the PYTHONPATH environment variable.
+The package resides in the "C:\\Program Files\\DHI\\2024\\FEFLOW 8.1\\python" file and the FEFLOW installer will add this path to the PYTHONPATH environment variable.
 Therefore, the example above should work out of the box.
 
 Note that if multiple versions of FEFLOW are installed, you need to adjust the PYTHONPATH environment variable accordingly thus that the desired FEFLOW version is . 
 Use `ifm.getKernelVersion()` to make sure the desired FEFLOW version has been loaded.
 
-Inline Python Skripts
+Inline Python Scripts
 ---------------------
 
 FEFLOW Python scripting capabilities are activated via Global Settings options from the  Tools menu. 

diff --git a/docs/_sources/new_release.rst.txt b/docs/_sources/new_release.rst.txt
@@ -3,6 +3,12 @@
 New Features / Version History
 ==============================
 
+New API features in FEFLOW 8.1
+------------------------------
+* Access to the Supermesh
+* Create mesh from plane 
+
+
 New API features in FEFLOW 8.0
 ------------------------------
 * Access to the Well Manager

diff --git a/docs/api_callbacks.html b/docs/api_callbacks.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Callbacks &mdash; ifm 8.02 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <title>Callbacks &mdash; ifm 8.100 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
@@ -32,7 +32,7 @@
             ifm
           </a>
               <div class="version">
-                8.0
+                8.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -519,7 +519,7 @@
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2021 DHI.</p>
+    <p>&#169; Copyright 2023 DHI.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/api_doc.html b/docs/api_doc.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>IFM FEFLOW Model Class &mdash; ifm 8.02 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <title>IFM FEFLOW Model Class &mdash; ifm 8.100 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
@@ -32,7 +32,7 @@
             ifm
           </a>
               <div class="version">
-                8.0
+                8.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -7616,14 +7616,18 @@ <h2>ifm.FeflowDoc<a class="headerlink" href="#ifm-feflowdoc" title="Permalink to
 <li>ifm.Enum.PCLS_MASS_TRANSPORT (1) = combined flow and mass transport</li>
 <li>ifm.Enum.PCLS_HEAT_TRANSPORT (2) = combined flow and heat transport</li>
 <li>ifm.Enum.PCLS_THERMOHALINE   (3) = combined flow, mass and heat transport</li>
+<li>ifm.Enum.PCLS_AGE_TRANSPORT  (4) = combined flow and age transport</li>
+<li>ifm.Enum.PCLS_MASS_AGE_TRANSPORT     (5) = Combined flow, mass, and age transport</li>
+<li>ifm.Enum.PCLS_HEAT_AGE_TRANSPORT     (6) = Combined flow, heat, and age transport</li>
+<li>ifm.Enum.PCLS_MASS_AGE_HEAT_TRANSPORT (7) = Combined flow, mass, age, and heat transport</li>
 </ul>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The class of the used problem</td>
 </tr>
-<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">int</td>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">IfmProblemClass</td>
 </tr>
 </tbody>
 </table>
@@ -7633,6 +7637,30 @@ <h2>ifm.FeflowDoc<a class="headerlink" href="#ifm-feflowdoc" title="Permalink to
 </div>
 </dd></dl>
 
+<dl class="method">
+<dt id="ifm.FeflowDoc.getProblemDefinition">
+<code class="descname">getProblemDefinition</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ifm.FeflowDoc.getProblemDefinition" title="Permalink to this definition">¶</a></dt>
+<dd><p>Create a Problem Definition Instance.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Problem Definition Instance</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="api_objects.html#ifm.ProblemDefinition" title="ifm.ProblemDefinition">ifm.ProblemDefinition</a></td>
+</tr>
+</tbody>
+</table>
+<p class="rubric">Examples</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">pdf</span> <span class="o">=</span> <span class="n">doc</span><span class="o">.</span><span class="n">getProblemDefinition</span><span class="p">()</span>
+</pre></div>
+</div>
+<div class="admonition seealso">
+<p class="first admonition-title">See also</p>
+<p class="last"><a class="reference internal" href="api_objects.html#ifm.ProblemDefinition" title="ifm.ProblemDefinition"><code class="xref py py-meth docutils literal notranslate"><span class="pre">ifm.ProblemDefinition()</span></code></a></p>
+</div>
+</dd></dl>
+
 <dl class="method">
 <dt id="ifm.FeflowDoc.getProblemDescription">
 <code class="descname">getProblemDescription</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ifm.FeflowDoc.getProblemDescription" title="Permalink to this definition">¶</a></dt>
@@ -9228,6 +9256,31 @@ <h2>ifm.FeflowDoc<a class="headerlink" href="#ifm-feflowdoc" title="Permalink to
 </div>
 </dd></dl>
 
+<dl class="method">
+<dt id="ifm.FeflowDoc.getSuperMesh">
+<code class="descname">getSuperMesh</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ifm.FeflowDoc.getSuperMesh" title="Permalink to this definition">¶</a></dt>
+<dd><p>Create a Supermesh Instance.</p>
+<p>getSuperMesh() returns a Supermesh object which can then be costumized by the user.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Supermesh Instance</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="api_objects.html#ifm.SuperMesh" title="ifm.SuperMesh">ifm.SuperMesh</a></td>
+</tr>
+</tbody>
+</table>
+<p class="rubric">Examples</p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">smh</span> <span class="o">=</span> <span class="n">doc</span><span class="o">.</span><span class="n">getSuperMesh</span><span class="p">()</span>
+</pre></div>
+</div>
+<div class="admonition seealso">
+<p class="first admonition-title">See also</p>
+<p class="last"><a class="reference internal" href="api_objects.html#ifm.SuperMesh" title="ifm.SuperMesh"><code class="xref py py-meth docutils literal notranslate"><span class="pre">ifm.SuperMesh()</span></code></a></p>
+</div>
+</dd></dl>
+
 <dl class="method">
 <dt id="ifm.FeflowDoc.getTimeClass">
 <code class="descname">getTimeClass</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ifm.FeflowDoc.getTimeClass" title="Permalink to this definition">¶</a></dt>
@@ -9901,8 +9954,8 @@ <h2>ifm.FeflowDoc<a class="headerlink" href="#ifm-feflowdoc" title="Permalink to
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>constraint_type</strong> (<em>{ifm.Enum.MIN_BCC_TYPE</em><em>, </em><em>ifm.Enum.MAX_BCC_TYPE}</em>) – constraint type</li>
 <li><strong>node</strong> (<em>int</em>) – node index</li>
+<li><strong>constraint_type</strong> (<em>{ifm.Enum.MIN_BCC_TYPE</em><em>, </em><em>ifm.Enum.MAX_BCC_TYPE}</em>) – constraint type</li>
 </ul>
 </td>
 </tr>
@@ -9929,8 +9982,8 @@ <h2>ifm.FeflowDoc<a class="headerlink" href="#ifm-feflowdoc" title="Permalink to
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>constraint_type</strong> (<em>{ifm.Enum.MIN_BCC_TYPE</em><em>, </em><em>ifm.Enum.MAX_BCC_TYPE}</em>) – constraint type</li>
 <li><strong>node</strong> (<em>int</em>) – node index</li>
+<li><strong>constraint_type</strong> (<em>{ifm.Enum.MIN_BCC_TYPE</em><em>, </em><em>ifm.Enum.MAX_BCC_TYPE}</em>) – constraint type</li>
 </ul>
 </td>
 </tr>
@@ -9961,8 +10014,8 @@ <h2>ifm.FeflowDoc<a class="headerlink" href="#ifm-feflowdoc" title="Permalink to
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
-<li><strong>constraint_type</strong> (<em>{ifm.Enum.MIN_BCC_TYPE</em><em>, </em><em>ifm.Enum.MAX_BCC_TYPE}</em>) – constraint type</li>
 <li><strong>node</strong> (<em>int</em>) – node index</li>
+<li><strong>constraint_type</strong> (<em>{ifm.Enum.MIN_BCC_TYPE</em><em>, </em><em>ifm.Enum.MAX_BCC_TYPE}</em>) – constraint type</li>
 </ul>
 </td>
 </tr>
@@ -16584,7 +16637,7 @@ <h2>ifm.FeflowDoc<a class="headerlink" href="#ifm-feflowdoc" title="Permalink to
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2021 DHI.</p>
+    <p>&#169; Copyright 2023 DHI.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

diff --git a/docs/api_kernel.html b/docs/api_kernel.html
@@ -3,7 +3,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>IFM Kernel Methods &mdash; ifm 8.02 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
+  <title>IFM Kernel Methods &mdash; ifm 8.100 documentation</title><link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
   <!--[if lt IE 9]>
     <script src="_static/js/html5shiv.min.js"></script>
@@ -32,7 +32,7 @@
             ifm
           </a>
               <div class="version">
-                8.0
+                8.1
               </div>
 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -275,7 +275,7 @@ <h1>IFM Kernel Methods<a class="headerlink" href="#ifm-kernel-methods" title="Pe
   <hr/>
 
   <div role="contentinfo">
-    <p>&#169; Copyright 2021 DHI.</p>
+    <p>&#169; Copyright 2023 DHI.</p>
   </div>
 
   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a