Python FEniCS/ufl@c0af0f3

Author: FEniCS GitHub Actions

ufl/main/_modules/ufl/algorithms/analysis.html

@@ -343,6 +343,7 @@ <h1>Source code for ufl.algorithms.analysis</h1><div class="highlight"><pre>
 <span class="kn">from</span><span class="w"> </span><span class="nn">ufl.coefficient</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseCoefficient</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">ufl.constant</span><span class="w"> </span><span class="kn">import</span> <span class="n">Constant</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">ufl.core.base_form_operator</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseFormOperator</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">ufl.core.expr</span><span class="w"> </span><span class="kn">import</span> <span class="n">Expr</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">ufl.core.terminal</span><span class="w"> </span><span class="kn">import</span> <span class="n">Terminal</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">ufl.corealg.traversal</span><span class="w"> </span><span class="kn">import</span> <span class="n">traverse_unique_terminals</span><span class="p">,</span> <span class="n">unique_pre_traversal</span>
 <span class="kn">from</span><span class="w"> </span><span class="nn">ufl.domain</span><span class="w"> </span><span class="kn">import</span> <span class="n">Mesh</span>
@@ -375,12 +376,15 @@ <h1>Source code for ufl.algorithms.analysis</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="extract_type">
 <a class="viewcode-back" href="../../../api/api-algorithms.html#ufl.algorithms.extract_type">[docs]</a>
-<span class="k">def</span><span class="w"> </span><span class="nf">extract_type</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">ufl_types</span><span class="p">):</span>
+<span class="k">def</span><span class="w"> </span><span class="nf">extract_type</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">ufl_types</span><span class="p">,</span> <span class="n">base_form_op_as_expr</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Build a set of all objects found in a whose class is in ufl_types.</span>
 
 <span class="sd">    Args:</span>
 <span class="sd">        a: A BaseForm, Integral or Expr</span>
 <span class="sd">        ufl_types: A list of UFL types</span>
+<span class="sd">        base_form_op_as_expr: If True, treat BaseFormOperators as expressions by</span>
+<span class="sd">            dropping the dual argument. If False, treat them as BaseForms by including</span>
+<span class="sd">            coarguments. If None (default), decide based on whether `a` is a Form or Expr.</span>
 
 <span class="sd">    Returns:</span>
 <span class="sd">        All objects found in a whose class is in ufl_type</span>
@@ -394,6 +398,9 @@ <h1>Source code for ufl.algorithms.analysis</h1><div class="highlight"><pre>
     <span class="k">else</span><span class="p">:</span>
         <span class="n">remove_base_form_ops</span> <span class="o">=</span> <span class="kc">False</span>
 
+    <span class="k">if</span> <span class="n">base_form_op_as_expr</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+        <span class="n">base_form_op_as_expr</span> <span class="o">=</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">Form</span> <span class="o">|</span> <span class="n">Expr</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">BaseFormOperator</span><span class="p">)</span>
+
     <span class="c1"># BaseForms that aren&#39;t forms or base form operators</span>
     <span class="c1"># only contain arguments &amp; coefficients</span>
     <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">BaseForm</span><span class="p">)</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">Form</span> <span class="o">|</span> <span class="n">BaseFormOperator</span><span class="p">):</span>
@@ -423,23 +430,28 @@ <h1>Source code for ufl.algorithms.analysis</h1><div class="highlight"><pre>
         <span class="c1"># This accounts for having BaseFormOperator in Forms: if N is a BaseFormOperator</span>
         <span class="c1"># `N(u; v*) * v * dx` &lt;=&gt; `action(v1 * v * dx, N(...; v*))`</span>
         <span class="c1"># where `v`, `v1` are `Argument`s and `v*` a `Coargument`.</span>
-        <span class="k">for</span> <span class="n">ai</span> <span class="ow">in</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">arg</span> <span class="k">for</span> <span class="n">arg</span> <span class="ow">in</span> <span class="n">o</span><span class="o">.</span><span class="n">argument_slots</span><span class="p">(</span><span class="nb">isinstance</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">Form</span><span class="p">))):</span>
+        <span class="k">for</span> <span class="n">ai</span> <span class="ow">in</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">arg</span> <span class="k">for</span> <span class="n">arg</span> <span class="ow">in</span> <span class="n">o</span><span class="o">.</span><span class="n">argument_slots</span><span class="p">(</span><span class="n">outer_form</span><span class="o">=</span><span class="n">base_form_op_as_expr</span><span class="p">)):</span>
             <span class="c1"># Extracting BaseArguments of an object of which a</span>
             <span class="c1"># Coargument is an argument, then we just return the dual</span>
             <span class="c1"># argument of the Coargument and not its primal argument.</span>
             <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">ai</span><span class="p">,</span> <span class="n">Coargument</span><span class="p">):</span>
                 <span class="n">new_types</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">Coargument</span> <span class="k">if</span> <span class="n">t</span> <span class="ow">is</span> <span class="n">BaseArgument</span> <span class="k">else</span> <span class="n">t</span> <span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="n">ufl_types</span><span class="p">)</span>
-                <span class="n">base_form_objects</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">extract_type</span><span class="p">(</span><span class="n">ai</span><span class="p">,</span> <span class="n">new_types</span><span class="p">))</span>
+                <span class="n">extracted</span> <span class="o">=</span> <span class="n">extract_type</span><span class="p">(</span><span class="n">ai</span><span class="p">,</span> <span class="n">new_types</span><span class="p">,</span> <span class="n">base_form_op_as_expr</span><span class="p">)</span>
             <span class="k">else</span><span class="p">:</span>
-                <span class="n">base_form_objects</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">extract_type</span><span class="p">(</span><span class="n">ai</span><span class="p">,</span> <span class="n">ufl_types</span><span class="p">))</span>
+                <span class="n">extracted</span> <span class="o">=</span> <span class="n">extract_type</span><span class="p">(</span><span class="n">ai</span><span class="p">,</span> <span class="n">ufl_types</span><span class="p">,</span> <span class="n">base_form_op_as_expr</span><span class="p">)</span>
+            <span class="c1"># Filter out any BaseFormOperators if necessary</span>
+            <span class="c1"># from the recursively extracted results</span>
+            <span class="k">if</span> <span class="n">remove_base_form_ops</span><span class="p">:</span>
+                <span class="n">extracted</span> <span class="o">=</span> <span class="p">{</span><span class="n">obj</span> <span class="k">for</span> <span class="n">obj</span> <span class="ow">in</span> <span class="n">extracted</span> <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">BaseFormOperator</span><span class="p">)}</span>
+            <span class="n">base_form_objects</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">extracted</span><span class="p">)</span>
         <span class="c1"># Look for BaseArguments in BaseFormOperator&#39;s argument slots</span>
         <span class="c1"># only since that&#39;s where they are by definition. Don&#39;t look</span>
         <span class="c1"># into operands, which is convenient for external operator</span>
         <span class="c1"># composition, e.g. N1(N2; v*) where N2 is seen as an operator</span>
         <span class="c1"># and not a form.</span>
         <span class="n">slots</span> <span class="o">=</span> <span class="n">o</span><span class="o">.</span><span class="n">ufl_operands</span>
         <span class="k">for</span> <span class="n">ai</span> <span class="ow">in</span> <span class="n">slots</span><span class="p">:</span>
-            <span class="n">base_form_objects</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">extract_type</span><span class="p">(</span><span class="n">ai</span><span class="p">,</span> <span class="n">ufl_types_no_args</span><span class="p">))</span>
+            <span class="n">base_form_objects</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">extract_type</span><span class="p">(</span><span class="n">ai</span><span class="p">,</span> <span class="n">ufl_types_no_args</span><span class="p">,</span> <span class="n">base_form_op_as_expr</span><span class="p">))</span>
     <span class="n">objects</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">base_form_objects</span><span class="p">)</span>
 
     <span class="c1"># `Remove BaseFormOperator` objects if there were initially not in `ufl_types`</span>

ufl/main/_modules/ufl/core/base_form_operator.html

@@ -439,7 +439,8 @@ <h1>Source code for ufl.core.base_form_operator</h1><div class="highlight"><pre>
 
     <span class="k">def</span><span class="w"> </span><span class="nf">_analyze_form_arguments</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Analyze which Argument and Coefficient objects can be found in the base form.&quot;&quot;&quot;</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_arguments</span><span class="p">,</span> <span class="n">extract_coefficients</span><span class="p">,</span> <span class="n">extract_type</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_coefficients</span><span class="p">,</span> <span class="n">extract_type</span>
+        <span class="kn">from</span><span class="w"> </span><span class="nn">ufl.form</span><span class="w"> </span><span class="kn">import</span> <span class="n">Form</span>
 
         <span class="n">dual_arg</span><span class="p">,</span> <span class="o">*</span><span class="n">arguments</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">argument_slots</span><span class="p">()</span>
         <span class="c1"># When coarguments are treated as BaseForms, they have two</span>
@@ -450,9 +451,17 @@ <h1>Source code for ufl.core.base_form_operator</h1><div class="highlight"><pre>
         <span class="c1"># exact same situation than BaseFormOperator&#39;s arguments which</span>
         <span class="c1"># are different depending on whether the BaseFormOperator is</span>
         <span class="c1"># used in an outer form or not.</span>
-        <span class="n">arguments</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">extract_type</span><span class="p">(</span><span class="n">dual_arg</span><span class="p">,</span> <span class="n">Coargument</span><span class="p">))</span> <span class="o">+</span> <span class="nb">tuple</span><span class="p">(</span>
-            <span class="n">a</span> <span class="k">for</span> <span class="n">arg</span> <span class="ow">in</span> <span class="n">arguments</span> <span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">extract_arguments</span><span class="p">(</span><span class="n">arg</span><span class="p">)</span>
+
+        <span class="n">primal_args</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span>
+            <span class="n">a</span> <span class="k">for</span> <span class="n">arg</span> <span class="ow">in</span> <span class="n">arguments</span> <span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">extract_type</span><span class="p">(</span><span class="n">arg</span><span class="p">,</span> <span class="n">Argument</span><span class="p">,</span> <span class="n">base_form_op_as_expr</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
+        <span class="p">)</span>
+        <span class="n">primal_arg_num</span> <span class="o">=</span> <span class="p">{</span><span class="n">a</span><span class="o">.</span><span class="n">number</span><span class="p">()</span> <span class="k">for</span> <span class="n">a</span> <span class="ow">in</span> <span class="n">primal_args</span><span class="p">}</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">dual_arg</span><span class="p">,</span> <span class="n">Form</span><span class="p">)</span> <span class="k">else</span> <span class="p">{</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">}</span>
+        <span class="n">dual_args</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span>
+            <span class="n">arg</span>
+            <span class="k">for</span> <span class="n">arg</span> <span class="ow">in</span> <span class="n">dual_arg</span><span class="o">.</span><span class="n">arguments</span><span class="p">()</span>
+            <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">arg</span><span class="p">,</span> <span class="n">Coargument</span><span class="p">)</span> <span class="ow">or</span> <span class="n">arg</span><span class="o">.</span><span class="n">number</span><span class="p">()</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">primal_arg_num</span>
         <span class="p">)</span>
+        <span class="n">arguments</span> <span class="o">=</span> <span class="n">dual_args</span> <span class="o">+</span> <span class="n">primal_args</span>
         <span class="n">coefficients</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">c</span> <span class="k">for</span> <span class="n">op</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">ufl_operands</span> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">extract_coefficients</span><span class="p">(</span><span class="n">op</span><span class="p">))</span>
         <span class="c1"># Define canonical numbering of arguments and coefficients</span>
         <span class="c1"># 1) Need concept of order since we may have arguments with the same number</span>