Python FEniCS/ufl@04dad81

Author: FEniCS GitHub Actions

ufl/main/_modules/ufl/action.html

@@ -64,6 +64,7 @@ <h1>Source code for ufl.action</h1><div class="highlight"><pre>
 
 <span class="sd">    For example:</span>
 <span class="sd">        res = Ax</span>
+
 <span class="sd">    A would be the first argument, left and x would be the second argument,</span>
 <span class="sd">    right.</span>
 

ufl/main/_modules/ufl/algorithms/domain_analysis.html

@@ -208,10 +208,11 @@ <h1>Source code for ufl.algorithms.domain_analysis</h1><div class="highlight"><p
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Rearrange integrals over multiple subdomains to single subdomain integrals.</span>
 
 <span class="sd">    Args:</span>
-<span class="sd">        integrals: List of integrals</span>
-<span class="sd">        do_append_everywhere_integrals: Boolean indicating if integrals</span>
-<span class="sd">        defined on the whole domain should</span>
-<span class="sd">            just be restricted to the set of input subdomain ids.</span>
+<span class="sd">        integrals:</span>
+<span class="sd">            List of integrals</span>
+<span class="sd">        do_append_everywhere_integrals:</span>
+<span class="sd">            Boolean indicating if integrals defined on the whole domain should just be restricted to</span>
+<span class="sd">            the set of input subdomain ids.</span>
 
 <span class="sd">    Returns:</span>
 <span class="sd">        The integrals reconstructed with single subdomain_id</span>
@@ -349,11 +350,13 @@ <h1>Source code for ufl.algorithms.domain_analysis</h1><div class="highlight"><p
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Group integrals by domain and type, performing canonical simplification.</span>
 
 <span class="sd">    Args:</span>
-<span class="sd">        form: the Form to group the integrals of.</span>
-<span class="sd">        domains: an iterable of Domains.</span>
-<span class="sd">        do_append_everywhere_integrals: Boolean indicating if integrals</span>
-<span class="sd">        defined on the whole domain should</span>
-<span class="sd">            just be restricted to the set of input subdomain ids.</span>
+<span class="sd">        form:</span>
+<span class="sd">            the Form to group the integrals of.</span>
+<span class="sd">        domains:</span>
+<span class="sd">            an iterable of Domains.</span>
+<span class="sd">        do_append_everywhere_integrals:</span>
+<span class="sd">            Boolean indicating if integrals defined on the whole domain should just be restricted to</span>
+<span class="sd">            the set of input subdomain ids.</span>
 
 <span class="sd">    Returns:</span>
 <span class="sd">        A new Form with gathered integrands.</span>

ufl/main/_modules/ufl/algorithms/replace_derivative_nodes.html

@@ -101,10 +101,13 @@ <h1>Source code for ufl.algorithms.replace_derivative_nodes</h1><div class="high
 <span class="sd">        dFdN -&gt; u ** 2 * Nhat * dx</span>
 
 <span class="sd">    Args:</span>
-<span class="sd">        expr: An Expr or BaseForm.</span>
-<span class="sd">        mapping: A dict with from:to replacements to perform.</span>
-<span class="sd">        derivative_kwargs: A dict containing the keyword arguments for</span>
-<span class="sd">            derivative (i.e. `argument` and `coefficient_derivatives`).</span>
+<span class="sd">        expr:</span>
+<span class="sd">            An Expr or BaseForm.</span>
+<span class="sd">        mapping:</span>
+<span class="sd">            A dict with from:to replacements to perform.</span>
+<span class="sd">        derivative_kwargs:</span>
+<span class="sd">            A dict containing the keyword arguments for derivative (i.e. `argument` and</span>
+<span class="sd">            `coefficient_derivatives`).</span>
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">mapping2</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">((</span><span class="n">k</span><span class="p">,</span> <span class="n">as_ufl</span><span class="p">(</span><span class="n">v</span><span class="p">))</span> <span class="k">for</span> <span class="p">(</span><span class="n">k</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span> <span class="ow">in</span> <span class="n">mapping</span><span class="o">.</span><span class="n">items</span><span class="p">())</span>
     <span class="k">return</span> <span class="n">map_integrand_dags</span><span class="p">(</span><span class="n">DerivativeNodeReplacer</span><span class="p">(</span><span class="n">mapping2</span><span class="p">,</span> <span class="o">**</span><span class="n">derivative_kwargs</span><span class="p">),</span> <span class="n">expr</span><span class="p">)</span></div>

ufl/main/_modules/ufl/algorithms/strip_terminal_data.html

@@ -139,9 +139,11 @@ <h1>Source code for ufl.algorithms.strip_terminal_data</h1><div class="highlight
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Return a new form where the terminals have been replaced using the provided mapping.</span>
 
 <span class="sd">    Args:</span>
-<span class="sd">        o: The object to have its terminals replaced. This must either be a Form or Integral.</span>
-<span class="sd">        mapping: A mapping suitable for reconstructing the form such as the one</span>
-<span class="sd">            returned by strip_terminal_data.</span>
+<span class="sd">        o:</span>
+<span class="sd">            The object to have its terminals replaced. This must either be a Form or Integral.</span>
+<span class="sd">        mapping:</span>
+<span class="sd">            A mapping suitable for reconstructing the form such as the one returned by</span>
+<span class="sd">            strip_terminal_data.</span>
 
 <span class="sd">    Returns:</span>
 <span class="sd">        The new form.</span>

ufl/main/_modules/ufl/core/interpolate.html

@@ -137,9 +137,12 @@ <h1>Source code for ufl.core.interpolate</h1><div class="highlight"><pre>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Create symbolic representation of the interpolation operator.</span>
 
 <span class="sd">    Args:</span>
-<span class="sd">        expr: a UFL expression to interpolate.</span>
-<span class="sd">        v: the FunctionSpace to interpolate into or the Coargument</span>
+<span class="sd">        expr:</span>
+<span class="sd">            a UFL expression to interpolate.</span>
+<span class="sd">        v:</span>
+<span class="sd">            the FunctionSpace to interpolate into or the Coargument</span>
 <span class="sd">            defined on the dual of the FunctionSpace to interpolate into.</span>
+
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="k">return</span> <span class="n">Interpolate</span><span class="p">(</span><span class="n">expr</span><span class="p">,</span> <span class="n">v</span><span class="p">)</span></div>
 

ufl/main/_modules/ufl/corealg/map_dag.html

@@ -55,8 +55,10 @@ <h1>Source code for ufl.corealg.map_dag</h1><div class="highlight"><pre>
 <span class="sd">    the call, use the arguments vcache and rcache.</span>
 
 <span class="sd">    Args:</span>
-<span class="sd">        function: The function</span>
-<span class="sd">        expression: An expression</span>
+<span class="sd">        function:</span>
+<span class="sd">            The function</span>
+<span class="sd">        expression:</span>
+<span class="sd">            An expression</span>
 <span class="sd">        compress: If True (default), the output object from</span>
 <span class="sd">            the function is cached in a dict and reused such that the</span>
 <span class="sd">            resulting expression DAG does not contain duplicate objects</span>
@@ -88,13 +90,17 @@ <h1>Source code for ufl.corealg.map_dag</h1><div class="highlight"><pre>
 <span class="sd">    the call, use the arguments vcache and rcache.</span>
 
 <span class="sd">    Args:</span>
-<span class="sd">        function: The function</span>
-<span class="sd">        expressions: An expression</span>
-<span class="sd">        compress: If True (default), the output object from</span>
-<span class="sd">            the function is cached in a dict and reused such that the</span>
-<span class="sd">            resulting expression DAG does not contain duplicate objects</span>
-<span class="sd">        vcache: Optional dict for caching results of intermediate transformations</span>
-<span class="sd">        rcache: Optional dict for caching results for compression</span>
+<span class="sd">        function:</span>
+<span class="sd">            The function</span>
+<span class="sd">        expressions:</span>
+<span class="sd">            An expression</span>
+<span class="sd">        compress:</span>
+<span class="sd">            If True (default), the output object from the function is cached in a dict and reused</span>
+<span class="sd">            such that the resulting expression DAG does not contain duplicate objects</span>
+<span class="sd">        vcache:</span>
+<span class="sd">            Optional dict for caching results of intermediate transformations</span>
+<span class="sd">        rcache:</span>
+<span class="sd">            Optional dict for caching results for compression</span>
 
 <span class="sd">    Returns:</span>
 <span class="sd">        a list with the result of the final function call for each expression</span>

ufl/main/_modules/ufl/domain.html

@@ -260,7 +260,7 @@ <h1>Source code for ufl.domain</h1><div class="highlight"><pre>
 <span class="sd">    thus the same topological dimension).</span>
 
 <span class="sd">    Currently, one can only perform cell integrations when</span>
-<span class="sd">    :class:`MeshSequence`es are used.</span>
+<span class="sd">    :class:`MeshSequence` is used.</span>
 
 <span class="sd">    .. code-block:: python3</span>
 

ufl/main/_modules/ufl/form.html

@@ -509,8 +509,8 @@ <h1>Source code for ufl.form</h1><div class="highlight"><pre>
 
 <span class="sd">        The returned object is mapping from terminal to its number (an integer).</span>
 
-<span class="sd">        The numbering is computed per type so :class:`Coefficient`s,</span>
-<span class="sd">        :class:`Constant`s, etc will each be numbered from zero.</span>
+<span class="sd">        The numbering is computed per type so :class:`Coefficient`,</span>
+<span class="sd">        :class:`Constant`, etc will each be numbered from zero.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="c1"># cyclic import</span>
         <span class="kn">from</span><span class="w"> </span><span class="nn">ufl.algorithms.analysis</span><span class="w"> </span><span class="kn">import</span> <span class="n">extract_type</span>

ufl/main/_modules/ufl/operators.html

@@ -454,6 +454,7 @@ <h1>Source code for ufl.operators</h1><div class="highlight"><pre>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Take the partial derivative of f with respect to spatial variable number i.</span>
 
 <span class="sd">    Equivalent to f.dx(*i).</span>
+
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">f</span> <span class="o">=</span> <span class="n">as_ufl</span><span class="p">(</span><span class="n">f</span><span class="p">)</span>
     <span class="k">return</span> <span class="n">f</span><span class="o">.</span><span class="n">dx</span><span class="p">(</span><span class="o">*</span><span class="n">i</span><span class="p">)</span></div>
@@ -511,6 +512,7 @@ <h1>Source code for ufl.operators</h1><div class="highlight"><pre>
 <span class="sd">    and arbitrary rank tensor expressions T.</span>
 
 <span class="sd">    See also: :py:func:`nabla_grad`</span>
+
 <span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">f</span> <span class="o">=</span> <span class="n">as_ufl</span><span class="p">(</span><span class="n">f</span><span class="p">)</span>
     <span class="k">return</span> <span class="n">Grad</span><span class="p">(</span><span class="n">f</span><span class="p">)</span></div>

ufl/main/_sources/manual.rst.txt

@@ -13,4 +13,3 @@ User manual
    manual/examples
    manual/internal_representation
    manual/algorithms
-   manual/command_line_utils