tboudreaux/stroid
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(docs): rebuilt docs

Browse Source
This commit is contained in:
Emily Boudreaux
2026-01-31 10:09:46 -05:00
parent 5d61d1d755
commit 38150e3a8d
12 changed files with 139 additions and 106 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
docs/html/index.html
View File

@@ -122,15 +122,31 @@ Building</h2>
<div class="line">meson compile -C build</div> <div class="line">meson compile -C build</div>
<div class="line">meson test -C build</div> <div class="line">meson test -C build</div>
<div class="line">meson install -C build</div> <div class="line">meson install -C build</div>
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md4"></a> </div><!-- fragment --><h3><a class="anchor" id="autotoc_md4"></a>
Uninstalling</h3>
<p>To uninstall stroid, if you built it using meson and the default ninja backend, you can use the following command </p><div class="fragment"><div class="line">sudo ninja uninstall -C build</div>
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md5"></a>
Running</h2> Running</h2>
<p>Stroid can be used either from the command line or from C++. The command line interface is the simplest way to get started. After installation, the <code>stroid generate</code> command should be available in your terminal.</p> <p>Stroid can be used either from the command line or from C++. The command line interface is the simplest way to get started. After installation, the <code>stroid generate</code> command should be available in your terminal.</p>
<div class="fragment"><div class="line">stroid generate --help</div> <div class="fragment"><div class="line">stroid generate --help</div>
</div><!-- fragment --><p>The main way to interface with this is through the subcommands (currently only <code>generate</code> and <code>info</code> are available):</p> </div><!-- fragment --><p>The main way to interface with this is through the subcommands (currently only <code>generate</code> and <code>info</code> are available):</p>
<div class="fragment"><div class="line">stroid generate -c &lt;path/to/config/file.toml&gt;</div> <div class="fragment"><div class="line">stroid generate -c &lt;path/to/config/file.toml&gt;</div>
</div><!-- fragment --><div class="fragment"><div class="line">stroid info -d</div> </div><!-- fragment --><p>One can change the output format by specificing one of the avalible output formats <b>after</b> generation options</p>
</div><!-- fragment --><p>to save the default configuration to a file named <code>default.toml</code></p> <div class="fragment"><div class="line">stroid generate -c &lt;path/to/config/file.toml&gt; -o &quot;output.vtu&quot; vtu --ref 1</div>
<h2><a class="anchor" id="autotoc_md5"></a> </div><!-- fragment --><p>each output format has its own options, which can be viewed by running</p>
<div class="fragment"><div class="line">stroid generate [fmt] --help</div>
</div><!-- fragment --><p>where <code>[fmt]</code> is replaced with the desired output format (e.g. vtu, netgen, mfem, etc.). Avalible output formats are:</p>
<ul>
<li>vtu: VTK Unstructured Grid format</li>
<li>mfem: MFEM mesh format</li>
<li>netgen: Netgen mesh format</li>
<li>vtk: Legacy VTK format</li>
<li>paraview: ParaView Data collection format</li>
<li>info: Outputs mesh information to the terminal</li>
</ul>
<p>Further, mesh generation options are loaded from a toml file, a default version of this file can be saved by running </p><div class="fragment"><div class="line">stroid info -d</div>
</div><!-- fragment --><p> which will save a default config file to <code>default.toml</code></p>
<h2><a class="anchor" id="autotoc_md6"></a>
Configuration File</h2> Configuration File</h2>
<p>Stroid uses a TOML configuration file to specify the parameters for mesh generation. An example configuration file is found below</p> <p>Stroid uses a TOML configuration file to specify the parameters for mesh generation. An example configuration file is found below</p>
<div class="fragment"><div class="line">[main]</div> <div class="fragment"><div class="line">[main]</div>
@@ -166,7 +182,7 @@ Configuration File</h2>
<td class="markdownTableBodyNone">core_steepness </td><td class="markdownTableBodyNone">The steepness of the transition between the core and envelope regions of the star </td><td class="markdownTableBodyNone">1.0 </td></tr> <td class="markdownTableBodyNone">core_steepness </td><td class="markdownTableBodyNone">The steepness of the transition between the core and envelope regions of the star </td><td class="markdownTableBodyNone">1.0 </td></tr>
</table> </table>
<p>If no configuration file is provided, stroid will use the default parameters listed above. Further, configuration files need only include parameters that differ from the defaults, any parameters not specified will use the default values.</p> <p>If no configuration file is provided, stroid will use the default parameters listed above. Further, configuration files need only include parameters that differ from the defaults, any parameters not specified will use the default values.</p>
<h2><a class="anchor" id="autotoc_md6"></a> <h2><a class="anchor" id="autotoc_md7"></a>
C++ Interface</h2> C++ Interface</h2>
<p>Stroid can be used as a library in C++ projects. After installation, include the stroid header and link against the stroid library.</p> <p>Stroid can be used as a library in C++ projects. After installation, include the stroid header and link against the stroid library.</p>
<p>A basic example of using stroid in C++ is shown below (note that you will need a glvis instance running on localhost:19916 to visualize the mesh): </p><div class="fragment"><div class="line"><span class="preprocessor">#include &lt;memory&gt;</span></div> <p>A basic example of using stroid in C++ is shown below (note that you will need a glvis instance running on localhost:19916 to visualize the mesh): </p><div class="fragment"><div class="line"><span class="preprocessor">#include &lt;memory&gt;</span></div>
@@ -200,10 +216,7 @@ C++ Interface</h2>
<div class="ttc" id="anamespacestroid_1_1topology_html_a836ed13e5bac63e7952c3ce4e5532e78"><div class="ttname"><a href="namespacestroid_1_1topology.html#a836ed13e5bac63e7952c3ce4e5532e78">stroid::topology::ProjectMesh</a></div><div class="ttdeci">void ProjectMesh(mfem::Mesh &amp;mesh, const fourdst::config::Config&lt; config::MeshConfig &gt; &amp;config)</div><div class="ttdoc">Project high-order mesh nodes using the configured curvilinear mapping.</div><div class="ttdef"><b>Definition</b> curvilinear.cpp:14</div></div> <div class="ttc" id="anamespacestroid_1_1topology_html_a836ed13e5bac63e7952c3ce4e5532e78"><div class="ttname"><a href="namespacestroid_1_1topology.html#a836ed13e5bac63e7952c3ce4e5532e78">stroid::topology::ProjectMesh</a></div><div class="ttdeci">void ProjectMesh(mfem::Mesh &amp;mesh, const fourdst::config::Config&lt; config::MeshConfig &gt; &amp;config)</div><div class="ttdoc">Project high-order mesh nodes using the configured curvilinear mapping.</div><div class="ttdef"><b>Definition</b> curvilinear.cpp:14</div></div>
<div class="ttc" id="anamespacestroid_1_1topology_html_abc0d8a1fb8e9c5ac0e259e4c93db7892"><div class="ttname"><a href="namespacestroid_1_1topology.html#abc0d8a1fb8e9c5ac0e259e4c93db7892">stroid::topology::BuildSkeleton</a></div><div class="ttdeci">std::unique_ptr&lt; mfem::Mesh &gt; BuildSkeleton(const fourdst::config::Config&lt; config::MeshConfig &gt; &amp;config)</div><div class="ttdoc">Build the initial multi-block mesh topology for the star model.</div><div class="ttdef"><b>Definition</b> topology.cpp:10</div></div> <div class="ttc" id="anamespacestroid_1_1topology_html_abc0d8a1fb8e9c5ac0e259e4c93db7892"><div class="ttname"><a href="namespacestroid_1_1topology.html#abc0d8a1fb8e9c5ac0e259e4c93db7892">stroid::topology::BuildSkeleton</a></div><div class="ttdeci">std::unique_ptr&lt; mfem::Mesh &gt; BuildSkeleton(const fourdst::config::Config&lt; config::MeshConfig &gt; &amp;config)</div><div class="ttdoc">Build the initial multi-block mesh topology for the star model.</div><div class="ttdef"><b>Definition</b> topology.cpp:10</div></div>
<div class="ttc" id="atopology_8h_html"><div class="ttname"><a href="topology_8h.html">topology.h</a></div></div> <div class="ttc" id="atopology_8h_html"><div class="ttname"><a href="topology_8h.html">topology.h</a></div></div>
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md7"></a> </div><!-- fragment --><h1><a class="anchor" id="autotoc_md8"></a>
Example Meshes</h1>
<p>An example mesh with the default configuration parameters is shown below (coloration indicates attribute IDs of different regions): <img src="assets/imgs/ExampleMesh.png" alt="Example Mesh" class="inline"/></p>
<h1><a class="anchor" id="autotoc_md8"></a>
Funding</h1> Funding</h1>
<p>Stroid is developed as part of the 4D-STAR project.</p> <p>Stroid is developed as part of the 4D-STAR project.</p>
<p>4D-STAR is funded by European Research Council (ERC) under the Horizon Europe programme (Synergy Grant agreement No. 101071505: 4D-STAR) Work for this project is funded by the European Union. Views and opinions expressed are however those of the author(s) only and do not necessarily reflect those of the European Union or the European Research Council. </p> <p>4D-STAR is funded by European Research Council (ERC) under the Horizon Europe programme (Synergy Grant agreement No. 101071505: 4D-STAR) Work for this project is funded by the European Union. Views and opinions expressed are however those of the author(s) only and do not necessarily reflect those of the European Union or the European Research Council. </p>

11
docs/html/navtreedata.js
View File

@@ -27,12 +27,13 @@ var NAVTREE =
[ "stroid", "index.html", [ [ "stroid", "index.html", [
[ "A multi-block mesh generation tool for stellar modeling", "index.html#autotoc_md1", null ], [ "A multi-block mesh generation tool for stellar modeling", "index.html#autotoc_md1", null ],
[ "Building and Installing", "index.html#autotoc_md2", [ [ "Building and Installing", "index.html#autotoc_md2", [
[ "Building", "index.html#autotoc_md3", null ], [ "Building", "index.html#autotoc_md3", [
[ "Running", "index.html#autotoc_md4", null ], [ "Uninstalling", "index.html#autotoc_md4", null ]
[ "Configuration File", "index.html#autotoc_md5", null ], ] ],
[ "C++ Interface", "index.html#autotoc_md6", null ] [ "Running", "index.html#autotoc_md5", null ],
[ "Configuration File", "index.html#autotoc_md6", null ],
[ "C++ Interface", "index.html#autotoc_md7", null ]
] ], ] ],
[ "Example Meshes", "index.html#autotoc_md7", null ],
[ "Funding", "index.html#autotoc_md8", null ], [ "Funding", "index.html#autotoc_md8", null ],
[ "Namespaces", "namespaces.html", [ [ "Namespaces", "namespaces.html", [
[ "Namespace List", "namespaces.html", "namespaces_dup" ], [ "Namespace List", "namespaces.html", "namespaces_dup" ],

144
docs/html/navtreeindex0.js
View File

@@ -1,90 +1,90 @@
var NAVTREEINDEX0 = var NAVTREEINDEX0 =
{ {
"_logo_8png.html":[6,0,0,0,0], "_logo_8png.html":[5,0,0,0,0],
"annotated.html":[5,0], "annotated.html":[4,0],
"classes.html":[5,1], "classes.html":[4,1],
"config_8h.html":[6,0,1,0,0,0,0], "config_8h.html":[5,0,1,0,0,0,0],
"curvilinear_8cpp.html":[6,0,1,1,1,0], "curvilinear_8cpp.html":[5,0,1,1,1,0],
"curvilinear_8h.html":[6,0,1,0,0,2,0], "curvilinear_8h.html":[5,0,1,0,0,2,0],
"dir_31a6c70da1404d38d1b51e38b19548a1.html":[6,0,1,0,0,1], "dir_31a6c70da1404d38d1b51e38b19548a1.html":[5,0,1,0,0,1],
"dir_3f4f28e99864f6e7d54ad0c93ce0a2a5.html":[6,0,1,0,0], "dir_3f4f28e99864f6e7d54ad0c93ce0a2a5.html":[5,0,1,0,0],
"dir_49e56c817e5e54854c35e136979f97ca.html":[6,0,0], "dir_49e56c817e5e54854c35e136979f97ca.html":[5,0,0],
"dir_68267d1309a1af8e8297ef4c3efbcdba.html":[6,0,1], "dir_68267d1309a1af8e8297ef4c3efbcdba.html":[5,0,1],
"dir_82887d4f338e92537fa9d809bec8c614.html":[6,0,1,1,0], "dir_82887d4f338e92537fa9d809bec8c614.html":[5,0,1,1,0],
"dir_87d18a4dc5174905bfd7d2dc734defe6.html":[6,0,1,1,2], "dir_87d18a4dc5174905bfd7d2dc734defe6.html":[5,0,1,1,2],
"dir_936721fd6a792737eaef7358bcd49428.html":[6,0,1,1,1], "dir_936721fd6a792737eaef7358bcd49428.html":[5,0,1,1,1],
"dir_9d5018b9ddb63a582aa4c6b91bec2f8c.html":[6,0,1,0,0,3], "dir_9d5018b9ddb63a582aa4c6b91bec2f8c.html":[5,0,1,0,0,3],
"dir_9da86e8abab39b749c6020360d8e4403.html":[6,0,1,0,0,2], "dir_9da86e8abab39b749c6020360d8e4403.html":[5,0,1,0,0,2],
"dir_b0856f6b0d80ccb263b2f415c91f9e17.html":[6,0,1,0], "dir_b0856f6b0d80ccb263b2f415c91f9e17.html":[5,0,1,0],
"dir_c34d5e8363cf0aa3fabc4f3fad3412a4.html":[6,0,0,0], "dir_c34d5e8363cf0aa3fabc4f3fad3412a4.html":[5,0,0,0],
"dir_c85d3e3c5052e9ad9ce18c6863244a25.html":[6,0,1,1], "dir_c85d3e3c5052e9ad9ce18c6863244a25.html":[5,0,1,1],
"dir_dc36fd7496f87f6989d6d6a9445d600c.html":[6,0,1,0,0,0], "dir_dc36fd7496f87f6989d6d6a9445d600c.html":[5,0,1,0,0,0],
"files.html":[6,0], "files.html":[5,0],
"functions.html":[5,2,0], "functions.html":[4,2,0],
"functions_vars.html":[5,2,1], "functions_vars.html":[4,2,1],
"index.html":[], "index.html":[],
"index.html#autotoc_md1":[0], "index.html#autotoc_md1":[0],
"index.html#autotoc_md2":[1], "index.html#autotoc_md2":[1],
"index.html#autotoc_md3":[1,0], "index.html#autotoc_md3":[1,0],
"index.html#autotoc_md4":[1,1], "index.html#autotoc_md4":[1,0,0],
"index.html#autotoc_md5":[1,2], "index.html#autotoc_md5":[1,1],
"index.html#autotoc_md6":[1,3], "index.html#autotoc_md6":[1,2],
"index.html#autotoc_md7":[2], "index.html#autotoc_md7":[1,3],
"index.html#autotoc_md8":[3], "index.html#autotoc_md8":[2],
"mapping_8cpp.html":[6,0,1,1,1,1], "mapping_8cpp.html":[5,0,1,1,1,1],
"mapping_8h.html":[6,0,1,0,0,2,1], "mapping_8h.html":[5,0,1,0,0,2,1],
"mesh_8cpp.html":[6,0,1,1,0,0], "mesh_8cpp.html":[5,0,1,1,0,0],
"mesh_8h.html":[6,0,1,0,0,1,0], "mesh_8h.html":[5,0,1,0,0,1,0],
"mesh__utils_8cpp.html":[6,0,1,1,2,0], "mesh__utils_8cpp.html":[5,0,1,1,2,0],
"mesh__utils_8h.html":[6,0,1,0,0,3,0], "mesh__utils_8h.html":[5,0,1,0,0,3,0],
"namespacemembers.html":[4,1,0], "namespacemembers.html":[3,1,0],
"namespacemembers_enum.html":[4,1,2], "namespacemembers_enum.html":[3,1,2],
"namespacemembers_func.html":[4,1,1], "namespacemembers_func.html":[3,1,1],
"namespaces.html":[4,0], "namespaces.html":[3,0],
"namespacestroid.html":[4,0,0], "namespacestroid.html":[3,0,0],
"namespacestroid_1_1_i_o.html":[4,0,0,1], "namespacestroid_1_1_i_o.html":[3,0,0,1],
"namespacestroid_1_1_i_o.html#a496f5c16eaffda5922a0b96c1f525dab":[4,0,0,1,3], "namespacestroid_1_1_i_o.html#a496f5c16eaffda5922a0b96c1f525dab":[3,0,0,1,3],
"namespacestroid_1_1_i_o.html#a8100e130b3a49fdee48bc3c4d4e63963":[4,0,0,1,4], "namespacestroid_1_1_i_o.html#a8100e130b3a49fdee48bc3c4d4e63963":[3,0,0,1,4],
"namespacestroid_1_1_i_o.html#ab4c8bda7ab370e34376a7832fbf0951e":[4,0,0,1,2], "namespacestroid_1_1_i_o.html#ab4c8bda7ab370e34376a7832fbf0951e":[3,0,0,1,2],
"namespacestroid_1_1_i_o.html#ad4048304d8a0c7075d2b2a6e465d0b6e":[4,0,0,1,0], "namespacestroid_1_1_i_o.html#ad4048304d8a0c7075d2b2a6e465d0b6e":[3,0,0,1,0],
"namespacestroid_1_1_i_o.html#ad4048304d8a0c7075d2b2a6e465d0b6eab50339a10e1de285ac99d4c3990b8693":[4,0,0,1,0,0], "namespacestroid_1_1_i_o.html#ad4048304d8a0c7075d2b2a6e465d0b6eab50339a10e1de285ac99d4c3990b8693":[3,0,0,1,0,0],
"namespacestroid_1_1_i_o.html#ad4048304d8a0c7075d2b2a6e465d0b6eac31a2fe3e97d218a154c1947b43d6bbf":[4,0,0,1,0,1], "namespacestroid_1_1_i_o.html#ad4048304d8a0c7075d2b2a6e465d0b6eac31a2fe3e97d218a154c1947b43d6bbf":[3,0,0,1,0,1],
"namespacestroid_1_1_i_o.html#ad4048304d8a0c7075d2b2a6e465d0b6eaee96e14c2b71bd59252006289ba464cf":[4,0,0,1,0,2], "namespacestroid_1_1_i_o.html#ad4048304d8a0c7075d2b2a6e465d0b6eaee96e14c2b71bd59252006289ba464cf":[3,0,0,1,0,2],
"namespacestroid_1_1_i_o.html#aeb567ddc70ff2d064c139dee87575830":[4,0,0,1,1], "namespacestroid_1_1_i_o.html#aeb567ddc70ff2d064c139dee87575830":[3,0,0,1,1],
"namespacestroid_1_1config.html":[4,0,0,0], "namespacestroid_1_1config.html":[3,0,0,0],
"namespacestroid_1_1topology.html":[4,0,0,2], "namespacestroid_1_1topology.html":[3,0,0,2],
"namespacestroid_1_1topology.html#a03f0b29ccf7d427a175de9ff75824b7c":[4,0,0,2,0], "namespacestroid_1_1topology.html#a03f0b29ccf7d427a175de9ff75824b7c":[3,0,0,2,0],
"namespacestroid_1_1topology.html#a394e33bdfafdaccd6edfaae0642d3456":[4,0,0,2,7], "namespacestroid_1_1topology.html#a394e33bdfafdaccd6edfaae0642d3456":[3,0,0,2,7],
"namespacestroid_1_1topology.html#a5907aa2e639cda703d48d177abc37caf":[4,0,0,2,6], "namespacestroid_1_1topology.html#a5907aa2e639cda703d48d177abc37caf":[3,0,0,2,6],
"namespacestroid_1_1topology.html#a59c54a10f726d323f8506b4a2edd7467":[4,0,0,2,1], "namespacestroid_1_1topology.html#a59c54a10f726d323f8506b4a2edd7467":[3,0,0,2,1],
"namespacestroid_1_1topology.html#a62774bcba7ea1a485892dcd4bed6425b":[4,0,0,2,4], "namespacestroid_1_1topology.html#a62774bcba7ea1a485892dcd4bed6425b":[3,0,0,2,4],
"namespacestroid_1_1topology.html#a7fbf58c40c03bc751d53f4a3273744fc":[4,0,0,2,2], "namespacestroid_1_1topology.html#a7fbf58c40c03bc751d53f4a3273744fc":[3,0,0,2,2],
"namespacestroid_1_1topology.html#a836ed13e5bac63e7952c3ce4e5532e78":[4,0,0,2,5], "namespacestroid_1_1topology.html#a836ed13e5bac63e7952c3ce4e5532e78":[3,0,0,2,5],
"namespacestroid_1_1topology.html#abc0d8a1fb8e9c5ac0e259e4c93db7892":[4,0,0,2,3], "namespacestroid_1_1topology.html#abc0d8a1fb8e9c5ac0e259e4c93db7892":[3,0,0,2,3],
"namespacestroid_1_1utils.html":[4,0,0,3], "namespacestroid_1_1utils.html":[3,0,0,3],
"namespacestroid_1_1utils.html#a22ab5809195bf85156607790f82b5e2d":[4,0,0,3,1], "namespacestroid_1_1utils.html#a22ab5809195bf85156607790f82b5e2d":[3,0,0,3,1],
"namespacestroid_1_1utils.html#ae047d97d7d5dc12812395909d00f5bbe":[4,0,0,3,0], "namespacestroid_1_1utils.html#ae047d97d7d5dc12812395909d00f5bbe":[3,0,0,3,0],
"pages.html":[], "pages.html":[],
"structstroid_1_1config_1_1_mesh_config.html":[3,0,0,0,0],
"structstroid_1_1config_1_1_mesh_config.html":[4,0,0,0,0], "structstroid_1_1config_1_1_mesh_config.html":[4,0,0,0,0],
"structstroid_1_1config_1_1_mesh_config.html":[5,0,0,0,0], "structstroid_1_1config_1_1_mesh_config.html#a062652781f4f3ea0b7ca8764362a7368":[3,0,0,0,0,2],
"structstroid_1_1config_1_1_mesh_config.html#a062652781f4f3ea0b7ca8764362a7368":[4,0,0,0,0,2], "structstroid_1_1config_1_1_mesh_config.html#a062652781f4f3ea0b7ca8764362a7368":[4,0,0,0,0,2],
"structstroid_1_1config_1_1_mesh_config.html#a062652781f4f3ea0b7ca8764362a7368":[5,0,0,0,0,2], "structstroid_1_1config_1_1_mesh_config.html#a3fe80a30990d484dcc39b6f9a0befc05":[3,0,0,0,0,7],
"structstroid_1_1config_1_1_mesh_config.html#a3fe80a30990d484dcc39b6f9a0befc05":[4,0,0,0,0,7], "structstroid_1_1config_1_1_mesh_config.html#a3fe80a30990d484dcc39b6f9a0befc05":[4,0,0,0,0,7],
"structstroid_1_1config_1_1_mesh_config.html#a3fe80a30990d484dcc39b6f9a0befc05":[5,0,0,0,0,7], "structstroid_1_1config_1_1_mesh_config.html#a4da6d99ff7ba24d2f917e1fd98ddd877":[3,0,0,0,0,6],
"structstroid_1_1config_1_1_mesh_config.html#a4da6d99ff7ba24d2f917e1fd98ddd877":[4,0,0,0,0,6], "structstroid_1_1config_1_1_mesh_config.html#a4da6d99ff7ba24d2f917e1fd98ddd877":[4,0,0,0,0,6],
"structstroid_1_1config_1_1_mesh_config.html#a4da6d99ff7ba24d2f917e1fd98ddd877":[5,0,0,0,0,6], "structstroid_1_1config_1_1_mesh_config.html#a5c68a895f73dc82a38a8daac22a83ad7":[3,0,0,0,0,4],
"structstroid_1_1config_1_1_mesh_config.html#a5c68a895f73dc82a38a8daac22a83ad7":[4,0,0,0,0,4], "structstroid_1_1config_1_1_mesh_config.html#a5c68a895f73dc82a38a8daac22a83ad7":[4,0,0,0,0,4],
"structstroid_1_1config_1_1_mesh_config.html#a5c68a895f73dc82a38a8daac22a83ad7":[5,0,0,0,0,4], "structstroid_1_1config_1_1_mesh_config.html#a860e78f1906acb0c3aa08d55f94de3fd":[3,0,0,0,0,3],
"structstroid_1_1config_1_1_mesh_config.html#a860e78f1906acb0c3aa08d55f94de3fd":[4,0,0,0,0,3], "structstroid_1_1config_1_1_mesh_config.html#a860e78f1906acb0c3aa08d55f94de3fd":[4,0,0,0,0,3],
"structstroid_1_1config_1_1_mesh_config.html#a860e78f1906acb0c3aa08d55f94de3fd":[5,0,0,0,0,3], "structstroid_1_1config_1_1_mesh_config.html#a8cafcbebf64ae251517118eb152de981":[3,0,0,0,0,8],
"structstroid_1_1config_1_1_mesh_config.html#a8cafcbebf64ae251517118eb152de981":[4,0,0,0,0,8], "structstroid_1_1config_1_1_mesh_config.html#a8cafcbebf64ae251517118eb152de981":[4,0,0,0,0,8],
"structstroid_1_1config_1_1_mesh_config.html#a8cafcbebf64ae251517118eb152de981":[5,0,0,0,0,8], "structstroid_1_1config_1_1_mesh_config.html#ac7546899ebbfe191ea3a8bf2403b31eb":[3,0,0,0,0,5],
"structstroid_1_1config_1_1_mesh_config.html#ac7546899ebbfe191ea3a8bf2403b31eb":[4,0,0,0,0,5], "structstroid_1_1config_1_1_mesh_config.html#ac7546899ebbfe191ea3a8bf2403b31eb":[4,0,0,0,0,5],
"structstroid_1_1config_1_1_mesh_config.html#ac7546899ebbfe191ea3a8bf2403b31eb":[5,0,0,0,0,5], "structstroid_1_1config_1_1_mesh_config.html#aed32864839b149c94842801b6413d94d":[3,0,0,0,0,0],
"structstroid_1_1config_1_1_mesh_config.html#aed32864839b149c94842801b6413d94d":[4,0,0,0,0,0], "structstroid_1_1config_1_1_mesh_config.html#aed32864839b149c94842801b6413d94d":[4,0,0,0,0,0],
"structstroid_1_1config_1_1_mesh_config.html#aed32864839b149c94842801b6413d94d":[5,0,0,0,0,0], "structstroid_1_1config_1_1_mesh_config.html#affad4638b0ae7b710f2b2db992f6f584":[3,0,0,0,0,1],
"structstroid_1_1config_1_1_mesh_config.html#affad4638b0ae7b710f2b2db992f6f584":[4,0,0,0,0,1], "structstroid_1_1config_1_1_mesh_config.html#affad4638b0ae7b710f2b2db992f6f584":[4,0,0,0,0,1],
"structstroid_1_1config_1_1_mesh_config.html#affad4638b0ae7b710f2b2db992f6f584":[5,0,0,0,0,1], "topology_8cpp.html":[5,0,1,1,1,2],
"topology_8cpp.html":[6,0,1,1,1,2], "topology_8h.html":[5,0,1,0,0,2,2]
"topology_8h.html":[6,0,1,0,0,2,2]
}; };

4
docs/html/search/all_2.js
View File

@@ -1,8 +1,8 @@
var searchData= var searchData=
[ [
['c_20interface_0',['C++ Interface',['../index.html#autotoc_md6',1,'']]], ['c_20interface_0',['C++ Interface',['../index.html#autotoc_md7',1,'']]],
['config_2eh_1',['config.h',['../config_8h.html',1,'']]], ['config_2eh_1',['config.h',['../config_8h.html',1,'']]],
['configuration_20file_2',['Configuration File',['../index.html#autotoc_md5',1,'']]], ['configuration_20file_2',['Configuration File',['../index.html#autotoc_md6',1,'']]],
['core_5fsteepness_3',['core_steepness',['../structstroid_1_1config_1_1_mesh_config.html#aed32864839b149c94842801b6413d94d',1,'stroid::config::MeshConfig']]], ['core_5fsteepness_3',['core_steepness',['../structstroid_1_1config_1_1_mesh_config.html#aed32864839b149c94842801b6413d94d',1,'stroid::config::MeshConfig']]],
['curvilinear_2ecpp_4',['curvilinear.cpp',['../curvilinear_8cpp.html',1,'']]], ['curvilinear_2ecpp_4',['curvilinear.cpp',['../curvilinear_8cpp.html',1,'']]],
['curvilinear_2eh_5',['curvilinear.h',['../curvilinear_8h.html',1,'']]] ['curvilinear_2eh_5',['curvilinear.h',['../curvilinear_8h.html',1,'']]]

3
docs/html/search/all_3.js
View File

@@ -1,5 +1,4 @@
var searchData= var searchData=
[ [
['element_5fid_0',['ELEMENT_ID',['../namespacestroid_1_1_i_o.html#ad4048304d8a0c7075d2b2a6e465d0b6eac31a2fe3e97d218a154c1947b43d6bbf',1,'stroid::IO']]], ['element_5fid_0',['ELEMENT_ID',['../namespacestroid_1_1_i_o.html#ad4048304d8a0c7075d2b2a6e465d0b6eac31a2fe3e97d218a154c1947b43d6bbf',1,'stroid::IO']]]
['example_20meshes_1',['Example Meshes',['../index.html#autotoc_md7',1,'']]]
]; ];

2
docs/html/search/all_4.js
View File

@@ -1,6 +1,6 @@
var searchData= var searchData=
[ [
['file_0',['Configuration File',['../index.html#autotoc_md5',1,'']]], ['file_0',['Configuration File',['../index.html#autotoc_md6',1,'']]],
['finalize_1',['Finalize',['../namespacestroid_1_1topology.html#a62774bcba7ea1a485892dcd4bed6425b',1,'stroid::topology']]], ['finalize_1',['Finalize',['../namespacestroid_1_1topology.html#a62774bcba7ea1a485892dcd4bed6425b',1,'stroid::topology']]],
['flattening_2',['flattening',['../structstroid_1_1config_1_1_mesh_config.html#affad4638b0ae7b710f2b2db992f6f584',1,'stroid::config::MeshConfig']]], ['flattening_2',['flattening',['../structstroid_1_1config_1_1_mesh_config.html#affad4638b0ae7b710f2b2db992f6f584',1,'stroid::config::MeshConfig']]],
['for_20stellar_20modeling_3',['A multi-block mesh generation tool for stellar modeling',['../index.html#autotoc_md1',1,'']]], ['for_20stellar_20modeling_3',['A multi-block mesh generation tool for stellar modeling',['../index.html#autotoc_md1',1,'']]],

2
docs/html/search/all_6.js
View File

@@ -2,5 +2,5 @@ var searchData=
[ [
['include_5fexternal_5fdomain_0',['include_external_domain',['../structstroid_1_1config_1_1_mesh_config.html#a062652781f4f3ea0b7ca8764362a7368',1,'stroid::config::MeshConfig']]], ['include_5fexternal_5fdomain_0',['include_external_domain',['../structstroid_1_1config_1_1_mesh_config.html#a062652781f4f3ea0b7ca8764362a7368',1,'stroid::config::MeshConfig']]],
['installing_1',['Building and Installing',['../index.html#autotoc_md2',1,'']]], ['installing_1',['Building and Installing',['../index.html#autotoc_md2',1,'']]],
['interface_2',['C++ Interface',['../index.html#autotoc_md6',1,'']]] ['interface_2',['C++ Interface',['../index.html#autotoc_md7',1,'']]]
]; ];

5
docs/html/search/all_8.js
View File

@@ -11,7 +11,6 @@ var searchData=
['mesh_5futils_2ecpp_8',['mesh_utils.cpp',['../mesh__utils_8cpp.html',1,'']]], ['mesh_5futils_2ecpp_8',['mesh_utils.cpp',['../mesh__utils_8cpp.html',1,'']]],
['mesh_5futils_2eh_9',['mesh_utils.h',['../mesh__utils_8h.html',1,'']]], ['mesh_5futils_2eh_9',['mesh_utils.h',['../mesh__utils_8h.html',1,'']]],
['meshconfig_10',['MeshConfig',['../structstroid_1_1config_1_1_mesh_config.html',1,'stroid::config']]], ['meshconfig_10',['MeshConfig',['../structstroid_1_1config_1_1_mesh_config.html',1,'stroid::config']]],
['meshes_11',['Example Meshes',['../index.html#autotoc_md7',1,'']]], ['modeling_11',['A multi-block mesh generation tool for stellar modeling',['../index.html#autotoc_md1',1,'']]],
['modeling_12',['A multi-block mesh generation tool for stellar modeling',['../index.html#autotoc_md1',1,'']]], ['multi_20block_20mesh_20generation_20tool_20for_20stellar_20modeling_12',['A multi-block mesh generation tool for stellar modeling',['../index.html#autotoc_md1',1,'']]]
['multi_20block_20mesh_20generation_20tool_20for_20stellar_20modeling_13',['A multi-block mesh generation tool for stellar modeling',['../index.html#autotoc_md1',1,'']]]
]; ];

2
docs/html/search/all_c.js
View File

@@ -5,5 +5,5 @@ var searchData=
['r_5finstability_2',['r_instability',['../structstroid_1_1config_1_1_mesh_config.html#a4da6d99ff7ba24d2f917e1fd98ddd877',1,'stroid::config::MeshConfig']]], ['r_5finstability_2',['r_instability',['../structstroid_1_1config_1_1_mesh_config.html#a4da6d99ff7ba24d2f917e1fd98ddd877',1,'stroid::config::MeshConfig']]],
['r_5fstar_3',['r_star',['../structstroid_1_1config_1_1_mesh_config.html#a3fe80a30990d484dcc39b6f9a0befc05',1,'stroid::config::MeshConfig']]], ['r_5fstar_3',['r_star',['../structstroid_1_1config_1_1_mesh_config.html#a3fe80a30990d484dcc39b6f9a0befc05',1,'stroid::config::MeshConfig']]],
['refinement_5flevels_4',['refinement_levels',['../structstroid_1_1config_1_1_mesh_config.html#a8cafcbebf64ae251517118eb152de981',1,'stroid::config::MeshConfig']]], ['refinement_5flevels_4',['refinement_levels',['../structstroid_1_1config_1_1_mesh_config.html#a8cafcbebf64ae251517118eb152de981',1,'stroid::config::MeshConfig']]],
['running_5',['Running',['../index.html#autotoc_md4',1,'']]] ['running_5',['Running',['../index.html#autotoc_md5',1,'']]]
]; ];

4
docs/html/search/all_f.js
View File

@@ -1,6 +1,4 @@
var searchData= var searchData=
[ [
['viewmesh_0',['ViewMesh',['../namespacestroid_1_1_i_o.html#a496f5c16eaffda5922a0b96c1f525dab',1,'stroid::IO']]], ['uninstalling_0',['Uninstalling',['../index.html#autotoc_md4',1,'']]]
['visualization_5fmode_1',['VISUALIZATION_MODE',['../namespacestroid_1_1_i_o.html#ad4048304d8a0c7075d2b2a6e465d0b6e',1,'stroid::IO']]],
['visualizefacevalence_2',['VisualizeFaceValence',['../namespacestroid_1_1_i_o.html#a8100e130b3a49fdee48bc3c4d4e63963',1,'stroid::IO']]]
]; ];

2
docs/html/search/searchdata.js
View File

@@ -1,6 +1,6 @@
var indexSectionsWithContent = var indexSectionsWithContent =
{ {
0: "abcefgilmnoprstv", 0: "abcefgilmnoprstuv",
1: "m", 1: "m",
2: "s", 2: "s",
3: "clmt", 3: "clmt",

35
docs/static/mainpage.md vendored
View File

@@ -24,6 +24,12 @@ meson test -C build
meson install -C build meson install -C build
``` ```
#### Uninstalling
To uninstall stroid, if you built it using meson and the default ninja backend, you can use the following command
```bash
sudo ninja uninstall -C build
```
### Running ### Running
Stroid can be used either from the command line or from C++. The command line interface is Stroid can be used either from the command line or from C++. The command line interface is
the simplest way to get started. After installation, the `stroid generate` command should be available in your terminal. the simplest way to get started. After installation, the `stroid generate` command should be available in your terminal.
@@ -38,11 +44,32 @@ The main way to interface with this is through the subcommands (currently only `
stroid generate -c <path/to/config/file.toml> stroid generate -c <path/to/config/file.toml>
``` ```
One can change the output format by specificing one of the avalible output formats __after__ generation options
```bash
stroid generate -c <path/to/config/file.toml> -o "output.vtu" vtu --ref 1
```
each output format has its own options, which can be viewed by running
```bash
stroid generate [fmt] --help
```
where ``[fmt]`` is replaced with the desired output format (e.g. vtu, netgen, mfem, etc.). Avalible output formats are:
- vtu: VTK Unstructured Grid format
- mfem: MFEM mesh format
- netgen: Netgen mesh format
- vtk: Legacy VTK format
- paraview: ParaView Data collection format
- info: Outputs mesh information to the terminal
Further, mesh generation options are loaded from a toml file, a default version of this file can be saved by running
```bash ```bash
stroid info -d stroid info -d
``` ```
which will save a default config file to ``default.toml``
to save the default configuration to a file named ``default.toml``
### Configuration File ### Configuration File
Stroid uses a TOML configuration file to specify the parameters for mesh generation. An example configuration Stroid uses a TOML configuration file to specify the parameters for mesh generation. An example configuration
@@ -106,10 +133,6 @@ int main() {
} }
``` ```
## Example Meshes
An example mesh with the default configuration parameters is shown below (coloration indicates attribute IDs of different regions):
![Example Mesh](assets/imgs/ExampleMesh.png)
## Funding ## Funding
Stroid is developed as part of the 4D-STAR project. Stroid is developed as part of the 4D-STAR project.