Documentation Update

ECP-copa · Jan 22, 2024 · 3652aaf · 3652aaf
1 parent d769dbc
commit 3652aaf
Show file tree

Hide file tree

Showing 47 changed files with 3,037 additions and 2,972 deletions.
diff --git a/doxygen/Cabana__Grid__HypreSemiStructuredSolver_8hpp_source.html b/doxygen/Cabana__Grid__HypreSemiStructuredSolver_8hpp_source.html
diff --git a/doxygen/Cabana__Grid__HypreStructuredSolver_8hpp_source.html b/doxygen/Cabana__Grid__HypreStructuredSolver_8hpp_source.html
diff --git a/doxygen/classCabana_1_1Grid_1_1HypreSemiStructBiCGSTAB-members.html b/doxygen/classCabana_1_1Grid_1_1HypreSemiStructBiCGSTAB-members.html
@@ -81,7 +81,7 @@
 
 <p>This is the complete list of members for <a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructBiCGSTAB.html">Cabana::Grid::HypreSemiStructBiCGSTAB&lt; Scalar, EntityType, MemorySpace &gt;</a>, including all inherited members.</p>
 <table class="directory">
-  <tr class="even"><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructBiCGSTAB.html#a0e7c9d074f71f7447a804edde5c4ff68">Base</a> typedef</td><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructBiCGSTAB.html">Cabana::Grid::HypreSemiStructBiCGSTAB&lt; Scalar, EntityType, MemorySpace &gt;</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructBiCGSTAB.html#a6c16a20c64c8ba94e8c7c721a7e26946">base_type</a> typedef</td><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructBiCGSTAB.html">Cabana::Grid::HypreSemiStructBiCGSTAB&lt; Scalar, EntityType, MemorySpace &gt;</a></td><td class="entry"></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructuredSolver.html#a9db13ef1824dbbc74b27b640fa850c6c">checkHypreError</a>(const int error) const</td><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructuredSolver.html">Cabana::Grid::HypreSemiStructuredSolver&lt; Scalar, EntityType, MemorySpace &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructuredSolver.html#aa81a3feadfa45ad64bf4880fea16702d">createMatrixStencil</a>(int NumSpaceDim, int var=0, int n_vars=3, std::vector&lt; unsigned &gt; stencil_length={ 7, 7, 7 })</td><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructuredSolver.html">Cabana::Grid::HypreSemiStructuredSolver&lt; Scalar, EntityType, MemorySpace &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructuredSolver.html#a85fcd680aeb668dba2ee966c152cb6d5">entity_type</a> typedef</td><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructuredSolver.html">Cabana::Grid::HypreSemiStructuredSolver&lt; Scalar, EntityType, MemorySpace &gt;</a></td><td class="entry"></td></tr>
@@ -114,9 +114,9 @@
   <tr class="even"><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructuredSolver.html#a677f897011f7edd12ea39c0120823119">setTolerance</a>(const double tol)</td><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructuredSolver.html">Cabana::Grid::HypreSemiStructuredSolver&lt; Scalar, EntityType, MemorySpace &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructBiCGSTAB.html#ad9072b705e3fbd5d5cefda6436bf00f6">setToleranceImpl</a>(const double tol) override</td><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructBiCGSTAB.html">Cabana::Grid::HypreSemiStructBiCGSTAB&lt; Scalar, EntityType, MemorySpace &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructuredSolver.html#a2594cee4bf997e11704f87cd71db0ab7">setup</a>()</td><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructuredSolver.html">Cabana::Grid::HypreSemiStructuredSolver&lt; Scalar, EntityType, MemorySpace &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr class="odd"><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructBiCGSTAB.html#af62b1ba25103d174df137a0517f58f04">setupImpl</a>(HYPRE_SStructMatrix A, HYPRE_SStructVector b, HYPRE_SStructVector x) override</td><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructBiCGSTAB.html">Cabana::Grid::HypreSemiStructBiCGSTAB&lt; Scalar, EntityType, MemorySpace &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></td></tr>
+  <tr class="odd"><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructBiCGSTAB.html#a34cad64e7c8fda8c1b76eda709fa358f">setupImpl</a>() override</td><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructBiCGSTAB.html">Cabana::Grid::HypreSemiStructBiCGSTAB&lt; Scalar, EntityType, MemorySpace &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructuredSolver.html#a39095c449c83e1ccbe49003e6209b964">solve</a>(const Array_t &amp;b, Array_t &amp;x, int n_vars=3)</td><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructuredSolver.html">Cabana::Grid::HypreSemiStructuredSolver&lt; Scalar, EntityType, MemorySpace &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr class="odd"><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructBiCGSTAB.html#ad6a5a3c50c9da289f02477203b3fa3fc">solveImpl</a>(HYPRE_SStructMatrix A, HYPRE_SStructVector b, HYPRE_SStructVector x) override</td><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructBiCGSTAB.html">Cabana::Grid::HypreSemiStructBiCGSTAB&lt; Scalar, EntityType, MemorySpace &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></td></tr>
+  <tr class="odd"><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructBiCGSTAB.html#a08e82f7f36c9147b45adc8b8f5a13c5e">solveImpl</a>() override</td><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructBiCGSTAB.html">Cabana::Grid::HypreSemiStructBiCGSTAB&lt; Scalar, EntityType, MemorySpace &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">virtual</span></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructuredSolver.html#acfb5e2429a03a37470be2cebf3697062">value_type</a> typedef</td><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructuredSolver.html">Cabana::Grid::HypreSemiStructuredSolver&lt; Scalar, EntityType, MemorySpace &gt;</a></td><td class="entry"></td></tr>
   <tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>~HypreSemiStructBiCGSTAB</b>() (defined in <a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructBiCGSTAB.html">Cabana::Grid::HypreSemiStructBiCGSTAB&lt; Scalar, EntityType, MemorySpace &gt;</a>)</td><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructBiCGSTAB.html">Cabana::Grid::HypreSemiStructBiCGSTAB&lt; Scalar, EntityType, MemorySpace &gt;</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
   <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>~HypreSemiStructuredSolver</b>() (defined in <a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructuredSolver.html">Cabana::Grid::HypreSemiStructuredSolver&lt; Scalar, EntityType, MemorySpace &gt;</a>)</td><td class="entry"><a class="el" href="classCabana_1_1Grid_1_1HypreSemiStructuredSolver.html">Cabana::Grid::HypreSemiStructuredSolver&lt; Scalar, EntityType, MemorySpace &gt;</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>