Update Basix docs FEniCS/basix@08d1f58

Author: FEniCS GitHub Actions

basix/main/cpp/e-brezzi-douglas-marini_8h_source.html

@@ -170,7 +170,7 @@ <h2 id="project_subtitle"><a class='fenicsnav' href='https://docs.fenicsproject.
 <div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;                            <a class="code" href="namespacebasix_1_1element.html#a5d97cf44f3a72fad549a01ab3933b77f">lagrange_variant</a> lvariant, <span class="keywordtype">bool</span> discontinuous);</div>
 <div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160; </div>
 <div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;} <span class="comment">// namespace basix::element</span></div>
-<div class="ttc" id="aclassbasix_1_1FiniteElement_html"><div class="ttname"><a href="classbasix_1_1FiniteElement.html">basix::FiniteElement</a></div><div class="ttdoc">A finite element.</div><div class="ttdef"><b>Definition:</b> finite-element.h:137</div></div>
+<div class="ttc" id="aclassbasix_1_1FiniteElement_html"><div class="ttname"><a href="classbasix_1_1FiniteElement.html">basix::FiniteElement</a></div><div class="ttdoc">A finite element.</div><div class="ttdef"><b>Definition:</b> finite-element.h:138</div></div>
 <div class="ttc" id="anamespacebasix_1_1cell_html_a30ecf43ef8a377355caf943f9d8204b4"><div class="ttname"><a href="namespacebasix_1_1cell.html#a30ecf43ef8a377355caf943f9d8204b4">basix::cell::type</a></div><div class="ttdeci">type</div><div class="ttdoc">Cell type.</div><div class="ttdef"><b>Definition:</b> cell.h:21</div></div>
 <div class="ttc" id="anamespacebasix_1_1element_html"><div class="ttname"><a href="namespacebasix_1_1element.html">basix::element</a></div><div class="ttdoc">Interfaces for creating finite elements.</div><div class="ttdef"><b>Definition:</b> e-brezzi-douglas-marini.h:13</div></div>
 <div class="ttc" id="anamespacebasix_1_1element_html_a5d97cf44f3a72fad549a01ab3933b77f"><div class="ttname"><a href="namespacebasix_1_1element.html#a5d97cf44f3a72fad549a01ab3933b77f">basix::element::lagrange_variant</a></div><div class="ttdeci">lagrange_variant</div><div class="ttdoc">Variants of a Lagrange space that can be created.</div><div class="ttdef"><b>Definition:</b> element-families.h:12</div></div>

basix/main/cpp/finite-element_8h_source.html

@@ -203,7 +203,7 @@ <h2 id="project_subtitle"><a class='fenicsnav' href='https://docs.fenicsproject.
 <div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160; </div>
 <div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;} <span class="comment">// namespace moments</span></div>
 <div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;} <span class="comment">// namespace basix</span></div>
-<div class="ttc" id="aclassbasix_1_1FiniteElement_html"><div class="ttname"><a href="classbasix_1_1FiniteElement.html">basix::FiniteElement</a></div><div class="ttdoc">A finite element.</div><div class="ttdef"><b>Definition:</b> finite-element.h:137</div></div>
+<div class="ttc" id="aclassbasix_1_1FiniteElement_html"><div class="ttname"><a href="classbasix_1_1FiniteElement.html">basix::FiniteElement</a></div><div class="ttdoc">A finite element.</div><div class="ttdef"><b>Definition:</b> finite-element.h:138</div></div>
 <div class="ttc" id="anamespacebasix_1_1cell_html_a30ecf43ef8a377355caf943f9d8204b4"><div class="ttname"><a href="namespacebasix_1_1cell.html#a30ecf43ef8a377355caf943f9d8204b4">basix::cell::type</a></div><div class="ttdeci">type</div><div class="ttdoc">Cell type.</div><div class="ttdef"><b>Definition:</b> cell.h:21</div></div>
 <div class="ttc" id="anamespacebasix_1_1moments_html_a34b206fb81f38f675b2bae733c08301d"><div class="ttname"><a href="namespacebasix_1_1moments.html#a34b206fb81f38f675b2bae733c08301d">basix::moments::make_dot_integral_moments</a></div><div class="ttdeci">std::tuple&lt; std::vector&lt; std::vector&lt; T &gt; &gt;, std::array&lt; std::size_t, 2 &gt;, std::vector&lt; std::vector&lt; T &gt; &gt;, std::array&lt; std::size_t, 4 &gt; &gt; make_dot_integral_moments(const FiniteElement&lt; T &gt; &amp;V, cell::type celltype, polyset::type ptype, std::size_t value_size, int q_deg)</div><div class="ttdoc">Make interpolation points and weights for dot product integral moments.</div><div class="ttdef"><b>Definition:</b> moments.cpp:194</div></div>
 <div class="ttc" id="anamespacebasix_1_1moments_html_acb1d4febfabf16e72a71c0e956b667b0"><div class="ttname"><a href="namespacebasix_1_1moments.html#acb1d4febfabf16e72a71c0e956b667b0">basix::moments::make_normal_integral_moments</a></div><div class="ttdeci">std::tuple&lt; std::vector&lt; std::vector&lt; T &gt; &gt;, std::array&lt; std::size_t, 2 &gt;, std::vector&lt; std::vector&lt; T &gt; &gt;, std::array&lt; std::size_t, 4 &gt; &gt; make_normal_integral_moments(const FiniteElement&lt; T &gt; &amp;V, cell::type celltype, polyset::type ptype, std::size_t value_size, int q_deg)</div><div class="ttdoc">Compute interpolation points and weights for normal integral moments.</div><div class="ttdef"><b>Definition:</b> moments.cpp:346</div></div>

basix/main/cpp/moments_8h_source.html

@@ -212,13 +212,13 @@ <h2 id="project_subtitle"><a class='fenicsnav' href='https://docs.fenicsproject.
 <tr class="memitem:a03975721dd04b7424b31cf60dd7ce88f"><td class="memTemplParams" colspan="2">template&lt;std::floating_point T&gt; </td></tr>
 <tr class="memitem:a03975721dd04b7424b31cf60dd7ce88f"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classbasix_1_1FiniteElement.html">FiniteElement</a>&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacebasix.html#a03975721dd04b7424b31cf60dd7ce88f">create_element</a> (<a class="el" href="namespacebasix_1_1element.html#ada0a7daa08f1923682c927786b8ee007">element::family</a> family, <a class="el" href="namespacebasix_1_1cell.html#a30ecf43ef8a377355caf943f9d8204b4">cell::type</a> cell, int degree, <a class="el" href="namespacebasix_1_1element.html#a5d97cf44f3a72fad549a01ab3933b77f">element::lagrange_variant</a> lvariant, <a class="el" href="namespacebasix_1_1element.html#a8e196cd0bcdc926110b57d13fa278060">element::dpc_variant</a> dvariant, bool discontinuous, std::vector&lt; int &gt; dof_ordering={})</td></tr>
 <tr class="separator:a03975721dd04b7424b31cf60dd7ce88f"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a262553e872a1b76a3e9c579c636ec082"><td class="memItemLeft" align="right" valign="top">std::vector&lt; int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacebasix.html#a262553e872a1b76a3e9c579c636ec082">tp_dof_ordering</a> (<a class="el" href="namespacebasix_1_1element.html#ada0a7daa08f1923682c927786b8ee007">element::family</a> family, <a class="el" href="namespacebasix_1_1cell.html#a30ecf43ef8a377355caf943f9d8204b4">cell::type</a> cell, int degree, <a class="el" href="namespacebasix_1_1element.html#a5d97cf44f3a72fad549a01ab3933b77f">element::lagrange_variant</a> lvariant, <a class="el" href="namespacebasix_1_1element.html#a8e196cd0bcdc926110b57d13fa278060">element::dpc_variant</a> dvariant, bool discontinuous)</td></tr>
-<tr class="separator:a262553e872a1b76a3e9c579c636ec082"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:adbb8fed37fdb525cbe72b5ef0ff89728"><td class="memItemLeft" align="right" valign="top">std::optional&lt; std::vector&lt; int &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacebasix.html#adbb8fed37fdb525cbe72b5ef0ff89728">tp_dof_ordering</a> (<a class="el" href="namespacebasix_1_1element.html#ada0a7daa08f1923682c927786b8ee007">element::family</a> family, <a class="el" href="namespacebasix_1_1cell.html#a30ecf43ef8a377355caf943f9d8204b4">cell::type</a> cell, int degree, <a class="el" href="namespacebasix_1_1element.html#a5d97cf44f3a72fad549a01ab3933b77f">element::lagrange_variant</a> lvariant, <a class="el" href="namespacebasix_1_1element.html#a8e196cd0bcdc926110b57d13fa278060">element::dpc_variant</a> dvariant, bool discontinuous)</td></tr>
+<tr class="separator:adbb8fed37fdb525cbe72b5ef0ff89728"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:aa8b03415c6641314f73824d08540b667"><td class="memItemLeft" align="right" valign="top">std::vector&lt; int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacebasix.html#aa8b03415c6641314f73824d08540b667">lex_dof_ordering</a> (<a class="el" href="namespacebasix_1_1element.html#ada0a7daa08f1923682c927786b8ee007">element::family</a> family, <a class="el" href="namespacebasix_1_1cell.html#a30ecf43ef8a377355caf943f9d8204b4">cell::type</a> cell, int degree, <a class="el" href="namespacebasix_1_1element.html#a5d97cf44f3a72fad549a01ab3933b77f">element::lagrange_variant</a> lvariant, <a class="el" href="namespacebasix_1_1element.html#a8e196cd0bcdc926110b57d13fa278060">element::dpc_variant</a> dvariant, bool discontinuous)</td></tr>
 <tr class="separator:aa8b03415c6641314f73824d08540b667"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a20117356c06f76fb548ae4c7f4fbfe11"><td class="memTemplParams" colspan="2">template&lt;std::floating_point T&gt; </td></tr>
-<tr class="memitem:a20117356c06f76fb548ae4c7f4fbfe11"><td class="memTemplItemLeft" align="right" valign="top">std::vector&lt; std::vector&lt; <a class="el" href="classbasix_1_1FiniteElement.html">FiniteElement</a>&lt; T &gt; &gt; &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacebasix.html#a20117356c06f76fb548ae4c7f4fbfe11">tp_factors</a> (<a class="el" href="namespacebasix_1_1element.html#ada0a7daa08f1923682c927786b8ee007">element::family</a> family, <a class="el" href="namespacebasix_1_1cell.html#a30ecf43ef8a377355caf943f9d8204b4">cell::type</a> cell, int degree, <a class="el" href="namespacebasix_1_1element.html#a5d97cf44f3a72fad549a01ab3933b77f">element::lagrange_variant</a> lvariant, <a class="el" href="namespacebasix_1_1element.html#a8e196cd0bcdc926110b57d13fa278060">element::dpc_variant</a> dvariant, bool discontinuous, const std::vector&lt; int &gt; &amp;dof_ordering)</td></tr>
-<tr class="separator:a20117356c06f76fb548ae4c7f4fbfe11"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a649065b9c56bf3b5388aec209804578c"><td class="memTemplParams" colspan="2">template&lt;std::floating_point T&gt; </td></tr>
+<tr class="memitem:a649065b9c56bf3b5388aec209804578c"><td class="memTemplItemLeft" align="right" valign="top">std::optional&lt; std::vector&lt; std::vector&lt; <a class="el" href="classbasix_1_1FiniteElement.html">FiniteElement</a>&lt; T &gt; &gt; &gt; &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacebasix.html#a649065b9c56bf3b5388aec209804578c">tp_factors</a> (<a class="el" href="namespacebasix_1_1element.html#ada0a7daa08f1923682c927786b8ee007">element::family</a> family, <a class="el" href="namespacebasix_1_1cell.html#a30ecf43ef8a377355caf943f9d8204b4">cell::type</a> cell, int degree, <a class="el" href="namespacebasix_1_1element.html#a5d97cf44f3a72fad549a01ab3933b77f">element::lagrange_variant</a> lvariant, <a class="el" href="namespacebasix_1_1element.html#a8e196cd0bcdc926110b57d13fa278060">element::dpc_variant</a> dvariant, bool discontinuous, const std::vector&lt; int &gt; &amp;dof_ordering)</td></tr>
+<tr class="separator:a649065b9c56bf3b5388aec209804578c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ae7943e49b14c4df44efd7192821aed65"><td class="memTemplParams" colspan="2">template&lt;std::floating_point T&gt; </td></tr>
 <tr class="memitem:ae7943e49b14c4df44efd7192821aed65"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classbasix_1_1FiniteElement.html">FiniteElement</a>&lt; T &gt;&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespacebasix.html#ae7943e49b14c4df44efd7192821aed65">create_tp_element</a> (<a class="el" href="namespacebasix_1_1element.html#ada0a7daa08f1923682c927786b8ee007">element::family</a> family, <a class="el" href="namespacebasix_1_1cell.html#a30ecf43ef8a377355caf943f9d8204b4">cell::type</a> cell, int degree, <a class="el" href="namespacebasix_1_1element.html#a5d97cf44f3a72fad549a01ab3933b77f">element::lagrange_variant</a> lvariant, <a class="el" href="namespacebasix_1_1element.html#a8e196cd0bcdc926110b57d13fa278060">element::dpc_variant</a> dvariant, bool discontinuous)</td></tr>
 <tr class="separator:ae7943e49b14c4df44efd7192821aed65"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -413,14 +413,14 @@ <h2 class="memtitle"><span class="permalink"><a href="#a03975721dd04b7424b31cf60
 
 </div>
 </div>
-<a id="a262553e872a1b76a3e9c579c636ec082"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a262553e872a1b76a3e9c579c636ec082">&#9670;&nbsp;</a></span>tp_dof_ordering()</h2>
+<a id="adbb8fed37fdb525cbe72b5ef0ff89728"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#adbb8fed37fdb525cbe72b5ef0ff89728">&#9670;&nbsp;</a></span>tp_dof_ordering()</h2>
 
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
-          <td class="memname">std::vector&lt; int &gt; basix::tp_dof_ordering </td>
+          <td class="memname">std::optional&lt; std::vector&lt; int &gt; &gt; basix::tp_dof_ordering </td>
           <td>(</td>
           <td class="paramtype"><a class="el" href="namespacebasix_1_1element.html#ada0a7daa08f1923682c927786b8ee007">element::family</a>&#160;</td>
           <td class="paramname"><em>family</em>, </td>
@@ -473,7 +473,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a262553e872a1b76a3e9c579c
   </table>
   </dd>
 </dl>
-<dl class="section return"><dt>Returns</dt><dd>A vector containing the dof ordering </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd>An optional vector containing the dof ordering, if has tensor structure </dd></dl>
 
 </div>
 </div>
@@ -541,16 +541,16 @@ <h2 class="memtitle"><span class="permalink"><a href="#aa8b03415c6641314f73824d0
 
 </div>
 </div>
-<a id="a20117356c06f76fb548ae4c7f4fbfe11"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a20117356c06f76fb548ae4c7f4fbfe11">&#9670;&nbsp;</a></span>tp_factors()</h2>
+<a id="a649065b9c56bf3b5388aec209804578c"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a649065b9c56bf3b5388aec209804578c">&#9670;&nbsp;</a></span>tp_factors()</h2>
 
 <div class="memitem">
 <div class="memproto">
 <div class="memtemplate">
 template&lt;std::floating_point T&gt; </div>
       <table class="memname">
         <tr>
-          <td class="memname">template std::vector&lt; std::vector&lt; <a class="el" href="classbasix_1_1FiniteElement.html">basix::FiniteElement</a>&lt; double &gt; &gt; &gt; basix::tp_factors </td>
+          <td class="memname">template std::optional&lt; std::vector&lt; std::vector&lt; <a class="el" href="classbasix_1_1FiniteElement.html">basix::FiniteElement</a>&lt; double &gt; &gt; &gt; &gt; basix::tp_factors </td>
           <td>(</td>
           <td class="paramtype"><a class="el" href="namespacebasix_1_1element.html#ada0a7daa08f1923682c927786b8ee007">element::family</a>&#160;</td>
           <td class="paramname"><em>family</em>, </td>
@@ -610,7 +610,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a20117356c06f76fb548ae4c7
   </table>
   </dd>
 </dl>
-<dl class="section return"><dt>Returns</dt><dd>A list of lists of finite element factors </dd></dl>
+<dl class="section return"><dt>Returns</dt><dd>An optioanl list of lists of finite element factors if family has tensor structure </dd></dl>
 
 </div>
 </div>

basix/main/cpp/namespacebasix.html

@@ -455,10 +455,10 @@ <h3><a id="index_t"></a>- t -</h3><ul>
 : <a class="el" href="namespacebasix_1_1cell.html#a5cae2b1e6148e0c376d6ad8ea32a2f44">basix::cell</a>
 </li>
 <li>tp_dof_ordering()
-: <a class="el" href="namespacebasix.html#a262553e872a1b76a3e9c579c636ec082">basix</a>
+: <a class="el" href="namespacebasix.html#adbb8fed37fdb525cbe72b5ef0ff89728">basix</a>
 </li>
 <li>tp_factors()
-: <a class="el" href="namespacebasix.html#a20117356c06f76fb548ae4c7f4fbfe11">basix</a>
+: <a class="el" href="namespacebasix.html#a649065b9c56bf3b5388aec209804578c">basix</a>
 </li>
 <li>transpose_lu()
 : <a class="el" href="namespacebasix_1_1math.html#ae3c73e636dd4b9878420d38bbd72de16">basix::math</a>

basix/main/cpp/namespacemembers.html

@@ -437,10 +437,10 @@ <h3><a id="index_t"></a>- t -</h3><ul>
 : <a class="el" href="namespacebasix_1_1cell.html#a5cae2b1e6148e0c376d6ad8ea32a2f44">basix::cell</a>
 </li>
 <li>tp_dof_ordering()
-: <a class="el" href="namespacebasix.html#a262553e872a1b76a3e9c579c636ec082">basix</a>
+: <a class="el" href="namespacebasix.html#adbb8fed37fdb525cbe72b5ef0ff89728">basix</a>
 </li>
 <li>tp_factors()
-: <a class="el" href="namespacebasix.html#a20117356c06f76fb548ae4c7f4fbfe11">basix</a>
+: <a class="el" href="namespacebasix.html#a649065b9c56bf3b5388aec209804578c">basix</a>
 </li>
 <li>transpose_lu()
 : <a class="el" href="namespacebasix_1_1math.html#ae3c73e636dd4b9878420d38bbd72de16">basix::math</a>