From 38150e3a8d0586ed00fbd2cfe127338a3fb76865 Mon Sep 17 00:00:00 2001 From: Emily Boudreaux Date: Sat, 31 Jan 2026 10:09:46 -0500 Subject: [PATCH] docs(docs): rebuilt docs --- docs/html/index.html | 31 ++++--- docs/html/navtreedata.js | 11 +-- docs/html/navtreeindex0.js | 144 ++++++++++++++++----------------- docs/html/search/all_2.js | 4 +- docs/html/search/all_3.js | 3 +- docs/html/search/all_4.js | 2 +- docs/html/search/all_6.js | 2 +- docs/html/search/all_8.js | 5 +- docs/html/search/all_c.js | 2 +- docs/html/search/all_f.js | 4 +- docs/html/search/searchdata.js | 2 +- docs/static/mainpage.md | 35 ++++++-- 12 files changed, 139 insertions(+), 106 deletions(-) diff --git a/docs/html/index.html b/docs/html/index.html index 709053e..56d6f16 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -122,15 +122,31 @@ Building
meson compile -C build
meson test -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

sudo ninja uninstall -C build
+

Running

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.

stroid generate --help

The main way to interface with this is through the subcommands (currently only generate and info are available):

stroid generate -c <path/to/config/file.toml>
-
stroid info -d
-

to save the default configuration to a file named default.toml

-

+

One can change the output format by specificing one of the avalible output formats after generation options

+
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

+
stroid generate [fmt] --help
+

where [fmt] is replaced with the desired output format (e.g. vtu, netgen, mfem, etc.). Avalible output formats are:

+ +

Further, mesh generation options are loaded from a toml file, a default version of this file can be saved by running

stroid info -d
+

which will save a default config file to default.toml

+

Configuration File

Stroid uses a TOML configuration file to specify the parameters for mesh generation. An example configuration file is found below

[main]
@@ -166,7 +182,7 @@ Configuration File core_steepness The steepness of the transition between the core and envelope regions of the star 1.0

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.

-

+

C++ Interface

Stroid can be used as a library in C++ projects. After installation, include the stroid header and link against the stroid library.

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):

#include <memory>
@@ -200,10 +216,7 @@ C++ Interface
stroid::topology::ProjectMesh
void ProjectMesh(mfem::Mesh &mesh, const fourdst::config::Config< config::MeshConfig > &config)
Project high-order mesh nodes using the configured curvilinear mapping.
Definition curvilinear.cpp:14
stroid::topology::BuildSkeleton
std::unique_ptr< mfem::Mesh > BuildSkeleton(const fourdst::config::Config< config::MeshConfig > &config)
Build the initial multi-block mesh topology for the star model.
Definition topology.cpp:10
-

-Example Meshes

-

An example mesh with the default configuration parameters is shown below (coloration indicates attribute IDs of different regions): Example Mesh

-

+

Funding

Stroid is developed as part of the 4D-STAR project.

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.

diff --git a/docs/html/navtreedata.js b/docs/html/navtreedata.js index e22707c..3464aff 100644 --- a/docs/html/navtreedata.js +++ b/docs/html/navtreedata.js @@ -27,12 +27,13 @@ var NAVTREE = [ "stroid", "index.html", [ [ "A multi-block mesh generation tool for stellar modeling", "index.html#autotoc_md1", null ], [ "Building and Installing", "index.html#autotoc_md2", [ - [ "Building", "index.html#autotoc_md3", null ], - [ "Running", "index.html#autotoc_md4", null ], - [ "Configuration File", "index.html#autotoc_md5", null ], - [ "C++ Interface", "index.html#autotoc_md6", null ] + [ "Building", "index.html#autotoc_md3", [ + [ "Uninstalling", "index.html#autotoc_md4", 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 ], [ "Namespaces", "namespaces.html", [ [ "Namespace List", "namespaces.html", "namespaces_dup" ], diff --git a/docs/html/navtreeindex0.js b/docs/html/navtreeindex0.js index f8fc820..869f13f 100644 --- a/docs/html/navtreeindex0.js +++ b/docs/html/navtreeindex0.js @@ -1,90 +1,90 @@ var NAVTREEINDEX0 = { -"_logo_8png.html":[6,0,0,0,0], -"annotated.html":[5,0], -"classes.html":[5,1], -"config_8h.html":[6,0,1,0,0,0,0], -"curvilinear_8cpp.html":[6,0,1,1,1,0], -"curvilinear_8h.html":[6,0,1,0,0,2,0], -"dir_31a6c70da1404d38d1b51e38b19548a1.html":[6,0,1,0,0,1], -"dir_3f4f28e99864f6e7d54ad0c93ce0a2a5.html":[6,0,1,0,0], -"dir_49e56c817e5e54854c35e136979f97ca.html":[6,0,0], -"dir_68267d1309a1af8e8297ef4c3efbcdba.html":[6,0,1], -"dir_82887d4f338e92537fa9d809bec8c614.html":[6,0,1,1,0], -"dir_87d18a4dc5174905bfd7d2dc734defe6.html":[6,0,1,1,2], -"dir_936721fd6a792737eaef7358bcd49428.html":[6,0,1,1,1], -"dir_9d5018b9ddb63a582aa4c6b91bec2f8c.html":[6,0,1,0,0,3], -"dir_9da86e8abab39b749c6020360d8e4403.html":[6,0,1,0,0,2], -"dir_b0856f6b0d80ccb263b2f415c91f9e17.html":[6,0,1,0], -"dir_c34d5e8363cf0aa3fabc4f3fad3412a4.html":[6,0,0,0], -"dir_c85d3e3c5052e9ad9ce18c6863244a25.html":[6,0,1,1], -"dir_dc36fd7496f87f6989d6d6a9445d600c.html":[6,0,1,0,0,0], -"files.html":[6,0], -"functions.html":[5,2,0], -"functions_vars.html":[5,2,1], +"_logo_8png.html":[5,0,0,0,0], +"annotated.html":[4,0], +"classes.html":[4,1], +"config_8h.html":[5,0,1,0,0,0,0], +"curvilinear_8cpp.html":[5,0,1,1,1,0], +"curvilinear_8h.html":[5,0,1,0,0,2,0], +"dir_31a6c70da1404d38d1b51e38b19548a1.html":[5,0,1,0,0,1], +"dir_3f4f28e99864f6e7d54ad0c93ce0a2a5.html":[5,0,1,0,0], +"dir_49e56c817e5e54854c35e136979f97ca.html":[5,0,0], +"dir_68267d1309a1af8e8297ef4c3efbcdba.html":[5,0,1], +"dir_82887d4f338e92537fa9d809bec8c614.html":[5,0,1,1,0], +"dir_87d18a4dc5174905bfd7d2dc734defe6.html":[5,0,1,1,2], +"dir_936721fd6a792737eaef7358bcd49428.html":[5,0,1,1,1], +"dir_9d5018b9ddb63a582aa4c6b91bec2f8c.html":[5,0,1,0,0,3], +"dir_9da86e8abab39b749c6020360d8e4403.html":[5,0,1,0,0,2], +"dir_b0856f6b0d80ccb263b2f415c91f9e17.html":[5,0,1,0], +"dir_c34d5e8363cf0aa3fabc4f3fad3412a4.html":[5,0,0,0], +"dir_c85d3e3c5052e9ad9ce18c6863244a25.html":[5,0,1,1], +"dir_dc36fd7496f87f6989d6d6a9445d600c.html":[5,0,1,0,0,0], +"files.html":[5,0], +"functions.html":[4,2,0], +"functions_vars.html":[4,2,1], "index.html":[], "index.html#autotoc_md1":[0], "index.html#autotoc_md2":[1], "index.html#autotoc_md3":[1,0], -"index.html#autotoc_md4":[1,1], -"index.html#autotoc_md5":[1,2], -"index.html#autotoc_md6":[1,3], -"index.html#autotoc_md7":[2], -"index.html#autotoc_md8":[3], -"mapping_8cpp.html":[6,0,1,1,1,1], -"mapping_8h.html":[6,0,1,0,0,2,1], -"mesh_8cpp.html":[6,0,1,1,0,0], -"mesh_8h.html":[6,0,1,0,0,1,0], -"mesh__utils_8cpp.html":[6,0,1,1,2,0], -"mesh__utils_8h.html":[6,0,1,0,0,3,0], -"namespacemembers.html":[4,1,0], -"namespacemembers_enum.html":[4,1,2], -"namespacemembers_func.html":[4,1,1], -"namespaces.html":[4,0], -"namespacestroid.html":[4,0,0], -"namespacestroid_1_1_i_o.html":[4,0,0,1], -"namespacestroid_1_1_i_o.html#a496f5c16eaffda5922a0b96c1f525dab":[4,0,0,1,3], -"namespacestroid_1_1_i_o.html#a8100e130b3a49fdee48bc3c4d4e63963":[4,0,0,1,4], -"namespacestroid_1_1_i_o.html#ab4c8bda7ab370e34376a7832fbf0951e":[4,0,0,1,2], -"namespacestroid_1_1_i_o.html#ad4048304d8a0c7075d2b2a6e465d0b6e":[4,0,0,1,0], -"namespacestroid_1_1_i_o.html#ad4048304d8a0c7075d2b2a6e465d0b6eab50339a10e1de285ac99d4c3990b8693":[4,0,0,1,0,0], -"namespacestroid_1_1_i_o.html#ad4048304d8a0c7075d2b2a6e465d0b6eac31a2fe3e97d218a154c1947b43d6bbf":[4,0,0,1,0,1], -"namespacestroid_1_1_i_o.html#ad4048304d8a0c7075d2b2a6e465d0b6eaee96e14c2b71bd59252006289ba464cf":[4,0,0,1,0,2], -"namespacestroid_1_1_i_o.html#aeb567ddc70ff2d064c139dee87575830":[4,0,0,1,1], -"namespacestroid_1_1config.html":[4,0,0,0], -"namespacestroid_1_1topology.html":[4,0,0,2], -"namespacestroid_1_1topology.html#a03f0b29ccf7d427a175de9ff75824b7c":[4,0,0,2,0], -"namespacestroid_1_1topology.html#a394e33bdfafdaccd6edfaae0642d3456":[4,0,0,2,7], -"namespacestroid_1_1topology.html#a5907aa2e639cda703d48d177abc37caf":[4,0,0,2,6], -"namespacestroid_1_1topology.html#a59c54a10f726d323f8506b4a2edd7467":[4,0,0,2,1], -"namespacestroid_1_1topology.html#a62774bcba7ea1a485892dcd4bed6425b":[4,0,0,2,4], -"namespacestroid_1_1topology.html#a7fbf58c40c03bc751d53f4a3273744fc":[4,0,0,2,2], -"namespacestroid_1_1topology.html#a836ed13e5bac63e7952c3ce4e5532e78":[4,0,0,2,5], -"namespacestroid_1_1topology.html#abc0d8a1fb8e9c5ac0e259e4c93db7892":[4,0,0,2,3], -"namespacestroid_1_1utils.html":[4,0,0,3], -"namespacestroid_1_1utils.html#a22ab5809195bf85156607790f82b5e2d":[4,0,0,3,1], -"namespacestroid_1_1utils.html#ae047d97d7d5dc12812395909d00f5bbe":[4,0,0,3,0], +"index.html#autotoc_md4":[1,0,0], +"index.html#autotoc_md5":[1,1], +"index.html#autotoc_md6":[1,2], +"index.html#autotoc_md7":[1,3], +"index.html#autotoc_md8":[2], +"mapping_8cpp.html":[5,0,1,1,1,1], +"mapping_8h.html":[5,0,1,0,0,2,1], +"mesh_8cpp.html":[5,0,1,1,0,0], +"mesh_8h.html":[5,0,1,0,0,1,0], +"mesh__utils_8cpp.html":[5,0,1,1,2,0], +"mesh__utils_8h.html":[5,0,1,0,0,3,0], +"namespacemembers.html":[3,1,0], +"namespacemembers_enum.html":[3,1,2], +"namespacemembers_func.html":[3,1,1], +"namespaces.html":[3,0], +"namespacestroid.html":[3,0,0], +"namespacestroid_1_1_i_o.html":[3,0,0,1], +"namespacestroid_1_1_i_o.html#a496f5c16eaffda5922a0b96c1f525dab":[3,0,0,1,3], +"namespacestroid_1_1_i_o.html#a8100e130b3a49fdee48bc3c4d4e63963":[3,0,0,1,4], +"namespacestroid_1_1_i_o.html#ab4c8bda7ab370e34376a7832fbf0951e":[3,0,0,1,2], +"namespacestroid_1_1_i_o.html#ad4048304d8a0c7075d2b2a6e465d0b6e":[3,0,0,1,0], +"namespacestroid_1_1_i_o.html#ad4048304d8a0c7075d2b2a6e465d0b6eab50339a10e1de285ac99d4c3990b8693":[3,0,0,1,0,0], +"namespacestroid_1_1_i_o.html#ad4048304d8a0c7075d2b2a6e465d0b6eac31a2fe3e97d218a154c1947b43d6bbf":[3,0,0,1,0,1], +"namespacestroid_1_1_i_o.html#ad4048304d8a0c7075d2b2a6e465d0b6eaee96e14c2b71bd59252006289ba464cf":[3,0,0,1,0,2], +"namespacestroid_1_1_i_o.html#aeb567ddc70ff2d064c139dee87575830":[3,0,0,1,1], +"namespacestroid_1_1config.html":[3,0,0,0], +"namespacestroid_1_1topology.html":[3,0,0,2], +"namespacestroid_1_1topology.html#a03f0b29ccf7d427a175de9ff75824b7c":[3,0,0,2,0], +"namespacestroid_1_1topology.html#a394e33bdfafdaccd6edfaae0642d3456":[3,0,0,2,7], +"namespacestroid_1_1topology.html#a5907aa2e639cda703d48d177abc37caf":[3,0,0,2,6], +"namespacestroid_1_1topology.html#a59c54a10f726d323f8506b4a2edd7467":[3,0,0,2,1], +"namespacestroid_1_1topology.html#a62774bcba7ea1a485892dcd4bed6425b":[3,0,0,2,4], +"namespacestroid_1_1topology.html#a7fbf58c40c03bc751d53f4a3273744fc":[3,0,0,2,2], +"namespacestroid_1_1topology.html#a836ed13e5bac63e7952c3ce4e5532e78":[3,0,0,2,5], +"namespacestroid_1_1topology.html#abc0d8a1fb8e9c5ac0e259e4c93db7892":[3,0,0,2,3], +"namespacestroid_1_1utils.html":[3,0,0,3], +"namespacestroid_1_1utils.html#a22ab5809195bf85156607790f82b5e2d":[3,0,0,3,1], +"namespacestroid_1_1utils.html#ae047d97d7d5dc12812395909d00f5bbe":[3,0,0,3,0], "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":[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":[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":[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":[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":[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":[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":[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":[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":[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":[5,0,0,0,0,1], -"topology_8cpp.html":[6,0,1,1,1,2], -"topology_8h.html":[6,0,1,0,0,2,2] +"topology_8cpp.html":[5,0,1,1,1,2], +"topology_8h.html":[5,0,1,0,0,2,2] }; diff --git a/docs/html/search/all_2.js b/docs/html/search/all_2.js index d4538bf..b596d77 100644 --- a/docs/html/search/all_2.js +++ b/docs/html/search/all_2.js @@ -1,8 +1,8 @@ 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,'']]], - ['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']]], ['curvilinear_2ecpp_4',['curvilinear.cpp',['../curvilinear_8cpp.html',1,'']]], ['curvilinear_2eh_5',['curvilinear.h',['../curvilinear_8h.html',1,'']]] diff --git a/docs/html/search/all_3.js b/docs/html/search/all_3.js index 0741bc3..4894a43 100644 --- a/docs/html/search/all_3.js +++ b/docs/html/search/all_3.js @@ -1,5 +1,4 @@ var searchData= [ - ['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,'']]] + ['element_5fid_0',['ELEMENT_ID',['../namespacestroid_1_1_i_o.html#ad4048304d8a0c7075d2b2a6e465d0b6eac31a2fe3e97d218a154c1947b43d6bbf',1,'stroid::IO']]] ]; diff --git a/docs/html/search/all_4.js b/docs/html/search/all_4.js index 74e2e6b..d7f5d4b 100644 --- a/docs/html/search/all_4.js +++ b/docs/html/search/all_4.js @@ -1,6 +1,6 @@ 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']]], ['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,'']]], diff --git a/docs/html/search/all_6.js b/docs/html/search/all_6.js index cc8b57a..db440e8 100644 --- a/docs/html/search/all_6.js +++ b/docs/html/search/all_6.js @@ -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']]], ['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,'']]] ]; diff --git a/docs/html/search/all_8.js b/docs/html/search/all_8.js index 853e1aa..d683c61 100644 --- a/docs/html/search/all_8.js +++ b/docs/html/search/all_8.js @@ -11,7 +11,6 @@ var searchData= ['mesh_5futils_2ecpp_8',['mesh_utils.cpp',['../mesh__utils_8cpp.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']]], - ['meshes_11',['Example Meshes',['../index.html#autotoc_md7',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_13',['A multi-block mesh generation tool for stellar modeling',['../index.html#autotoc_md1',1,'']]] + ['modeling_11',['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,'']]] ]; diff --git a/docs/html/search/all_c.js b/docs/html/search/all_c.js index 957153d..aa17c56 100644 --- a/docs/html/search/all_c.js +++ b/docs/html/search/all_c.js @@ -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_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']]], - ['running_5',['Running',['../index.html#autotoc_md4',1,'']]] + ['running_5',['Running',['../index.html#autotoc_md5',1,'']]] ]; diff --git a/docs/html/search/all_f.js b/docs/html/search/all_f.js index 95cbf6d..afad534 100644 --- a/docs/html/search/all_f.js +++ b/docs/html/search/all_f.js @@ -1,6 +1,4 @@ var searchData= [ - ['viewmesh_0',['ViewMesh',['../namespacestroid_1_1_i_o.html#a496f5c16eaffda5922a0b96c1f525dab',1,'stroid::IO']]], - ['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']]] + ['uninstalling_0',['Uninstalling',['../index.html#autotoc_md4',1,'']]] ]; diff --git a/docs/html/search/searchdata.js b/docs/html/search/searchdata.js index 972ddd6..bdf9aa5 100644 --- a/docs/html/search/searchdata.js +++ b/docs/html/search/searchdata.js @@ -1,6 +1,6 @@ var indexSectionsWithContent = { - 0: "abcefgilmnoprstv", + 0: "abcefgilmnoprstuv", 1: "m", 2: "s", 3: "clmt", diff --git a/docs/static/mainpage.md b/docs/static/mainpage.md index 76b2980..c1b920e 100644 --- a/docs/static/mainpage.md +++ b/docs/static/mainpage.md @@ -24,6 +24,12 @@ meson test -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 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. @@ -38,11 +44,32 @@ The main way to interface with this is through the subcommands (currently only ` stroid generate -c ``` +One can change the output format by specificing one of the avalible output formats __after__ generation options + +```bash +stroid generate -c -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 stroid info -d ``` - -to save the default configuration to a file named ``default.toml`` +which will save a default config file to ``default.toml`` ### Configuration File 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 Stroid is developed as part of the 4D-STAR project.