From b00a64309b2086f316bb38d04810a360aa788e06 Mon Sep 17 00:00:00 2001 From: Emily Boudreaux Date: Fri, 20 Mar 2026 13:02:09 -0400 Subject: [PATCH] docs(docs): updated docs for version v0.2.0 --- Doxyfile | 2 +- docs/html/_logo_8png.html | 2 +- docs/html/annotated.html | 2 +- docs/html/classes.html | 2 +- docs/html/config_8h.html | 2 +- docs/html/curvilinear_8cpp.html | 5 +- docs/html/curvilinear_8cpp__incl.map | 32 +-- docs/html/curvilinear_8cpp__incl.md5 | 2 +- docs/html/curvilinear_8cpp__incl.svg | 145 ++++++++++--- docs/html/curvilinear_8cpp__incl_org.svg | 84 +++++--- docs/html/curvilinear_8h.html | 2 +- docs/html/dir_000004_000002.html | 2 +- docs/html/dir_000005_000002.html | 2 +- docs/html/dir_000009_000000.html | 2 +- docs/html/dir_000010_000002.html | 2 +- docs/html/dir_000012_000002.html | 2 +- .../dir_31a6c70da1404d38d1b51e38b19548a1.html | 2 +- .../dir_3f4f28e99864f6e7d54ad0c93ce0a2a5.html | 2 +- .../dir_49e56c817e5e54854c35e136979f97ca.html | 2 +- .../dir_68267d1309a1af8e8297ef4c3efbcdba.html | 2 +- .../dir_82887d4f338e92537fa9d809bec8c614.html | 2 +- .../dir_87d18a4dc5174905bfd7d2dc734defe6.html | 2 +- .../dir_936721fd6a792737eaef7358bcd49428.html | 2 +- .../dir_9d5018b9ddb63a582aa4c6b91bec2f8c.html | 2 +- .../dir_9da86e8abab39b749c6020360d8e4403.html | 2 +- .../dir_b0856f6b0d80ccb263b2f415c91f9e17.html | 2 +- .../dir_c34d5e8363cf0aa3fabc4f3fad3412a4.html | 2 +- .../dir_c85d3e3c5052e9ad9ce18c6863244a25.html | 2 +- .../dir_dc36fd7496f87f6989d6d6a9445d600c.html | 2 +- docs/html/doxygen_crawl.html | 5 + docs/html/files.html | 2 +- docs/html/functions.html | 7 +- docs/html/functions_vars.html | 7 +- docs/html/graph_legend.html | 2 +- docs/html/index.html | 37 +++- docs/html/mainpage_8md.html | 2 +- docs/html/mapping_8cpp.html | 5 +- docs/html/mapping_8cpp.js | 1 - docs/html/mapping_8h.html | 2 +- docs/html/mesh_8cpp.html | 2 +- docs/html/mesh_8h.html | 2 +- docs/html/mesh__utils_8cpp.html | 2 +- docs/html/mesh__utils_8h.html | 2 +- docs/html/namespacemembers.html | 2 +- docs/html/namespacemembers_enum.html | 2 +- docs/html/namespacemembers_func.html | 2 +- docs/html/namespaces.html | 2 +- docs/html/namespacestroid.html | 2 +- docs/html/namespacestroid_1_1_i_o.html | 2 +- docs/html/namespacestroid_1_1config.html | 2 +- docs/html/namespacestroid_1_1topology.html | 2 +- docs/html/namespacestroid_1_1utils.html | 2 +- docs/html/navtreeindex0.js | 46 ++-- docs/html/search/all_2.js | 7 +- docs/html/search/all_3.js | 3 +- docs/html/search/all_6.js | 5 +- docs/html/search/all_d.js | 3 +- docs/html/search/searchdata.js | 2 +- docs/html/search/variables_0.js | 3 +- docs/html/search/variables_1.js | 2 +- docs/html/search/variables_2.js | 2 +- docs/html/search/variables_3.js | 3 +- docs/html/search/variables_4.js | 6 +- ...oid_1_1config_1_1_mesh_config-members.html | 21 +- ...tructstroid_1_1config_1_1_mesh_config.html | 204 ++++++++++++++++-- .../structstroid_1_1config_1_1_mesh_config.js | 7 +- docs/html/topology_8cpp.html | 2 +- docs/html/topology_8h.html | 2 +- docs/static/mainpage.md | 22 +- readme.md | 22 +- 70 files changed, 551 insertions(+), 223 deletions(-) diff --git a/Doxyfile b/Doxyfile index 0124adc..7799517 100644 --- a/Doxyfile +++ b/Doxyfile @@ -48,7 +48,7 @@ PROJECT_NAME = stroid # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = v0.1.0 +PROJECT_NUMBER = v0.2.0 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewers a diff --git a/docs/html/_logo_8png.html b/docs/html/_logo_8png.html index 65f9a4c..5b25451 100644 --- a/docs/html/_logo_8png.html +++ b/docs/html/_logo_8png.html @@ -31,7 +31,7 @@ Logo -
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
diff --git a/docs/html/annotated.html b/docs/html/annotated.html index 1726115..d1ad2ce 100644 --- a/docs/html/annotated.html +++ b/docs/html/annotated.html @@ -31,7 +31,7 @@ Logo -
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
diff --git a/docs/html/classes.html b/docs/html/classes.html index f2b564b..409af46 100644 --- a/docs/html/classes.html +++ b/docs/html/classes.html @@ -31,7 +31,7 @@ Logo -
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
diff --git a/docs/html/config_8h.html b/docs/html/config_8h.html index 257814d..b25291e 100644 --- a/docs/html/config_8h.html +++ b/docs/html/config_8h.html @@ -31,7 +31,7 @@ Logo -
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
diff --git a/docs/html/curvilinear_8cpp.html b/docs/html/curvilinear_8cpp.html index 59d7671..0034dc5 100644 --- a/docs/html/curvilinear_8cpp.html +++ b/docs/html/curvilinear_8cpp.html @@ -31,7 +31,7 @@ Logo -
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
@@ -111,10 +111,11 @@ $(function(){initNavTree('curvilinear_8cpp.html',''); initResizable(true); }); #include "stroid/topology/mapping.h"
#include <iostream>
#include <memory>
+#include <sys/proc.h>
Include dependency graph for curvilinear.cpp:
-
+
diff --git a/docs/html/dir_000004_000002.html b/docs/html/dir_000004_000002.html index b809222..41d633c 100644 --- a/docs/html/dir_000004_000002.html +++ b/docs/html/dir_000004_000002.html @@ -31,7 +31,7 @@ diff --git a/docs/html/dir_000005_000002.html b/docs/html/dir_000005_000002.html index 934a8c7..961e47a 100644 --- a/docs/html/dir_000005_000002.html +++ b/docs/html/dir_000005_000002.html @@ -31,7 +31,7 @@ diff --git a/docs/html/dir_000009_000000.html b/docs/html/dir_000009_000000.html index 9f0dbcf..018e4f5 100644 --- a/docs/html/dir_000009_000000.html +++ b/docs/html/dir_000009_000000.html @@ -31,7 +31,7 @@ diff --git a/docs/html/dir_000010_000002.html b/docs/html/dir_000010_000002.html index 0a4b76d..0f19dd9 100644 --- a/docs/html/dir_000010_000002.html +++ b/docs/html/dir_000010_000002.html @@ -31,7 +31,7 @@ diff --git a/docs/html/dir_000012_000002.html b/docs/html/dir_000012_000002.html index d5c4ba4..7f2c45c 100644 --- a/docs/html/dir_000012_000002.html +++ b/docs/html/dir_000012_000002.html @@ -31,7 +31,7 @@ diff --git a/docs/html/dir_31a6c70da1404d38d1b51e38b19548a1.html b/docs/html/dir_31a6c70da1404d38d1b51e38b19548a1.html index 4697d9c..e2cf351 100644 --- a/docs/html/dir_31a6c70da1404d38d1b51e38b19548a1.html +++ b/docs/html/dir_31a6c70da1404d38d1b51e38b19548a1.html @@ -31,7 +31,7 @@ diff --git a/docs/html/dir_3f4f28e99864f6e7d54ad0c93ce0a2a5.html b/docs/html/dir_3f4f28e99864f6e7d54ad0c93ce0a2a5.html index fe0cbba..622b183 100644 --- a/docs/html/dir_3f4f28e99864f6e7d54ad0c93ce0a2a5.html +++ b/docs/html/dir_3f4f28e99864f6e7d54ad0c93ce0a2a5.html @@ -31,7 +31,7 @@ diff --git a/docs/html/dir_49e56c817e5e54854c35e136979f97ca.html b/docs/html/dir_49e56c817e5e54854c35e136979f97ca.html index 34104b1..006a472 100644 --- a/docs/html/dir_49e56c817e5e54854c35e136979f97ca.html +++ b/docs/html/dir_49e56c817e5e54854c35e136979f97ca.html @@ -31,7 +31,7 @@ diff --git a/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html index d0e56a7..7b29cbc 100644 --- a/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html +++ b/docs/html/dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -31,7 +31,7 @@ diff --git a/docs/html/dir_82887d4f338e92537fa9d809bec8c614.html b/docs/html/dir_82887d4f338e92537fa9d809bec8c614.html index fb29305..a076755 100644 --- a/docs/html/dir_82887d4f338e92537fa9d809bec8c614.html +++ b/docs/html/dir_82887d4f338e92537fa9d809bec8c614.html @@ -31,7 +31,7 @@ diff --git a/docs/html/dir_87d18a4dc5174905bfd7d2dc734defe6.html b/docs/html/dir_87d18a4dc5174905bfd7d2dc734defe6.html index 49bb0e5..03d0d9a 100644 --- a/docs/html/dir_87d18a4dc5174905bfd7d2dc734defe6.html +++ b/docs/html/dir_87d18a4dc5174905bfd7d2dc734defe6.html @@ -31,7 +31,7 @@ diff --git a/docs/html/dir_936721fd6a792737eaef7358bcd49428.html b/docs/html/dir_936721fd6a792737eaef7358bcd49428.html index 698914a..431306a 100644 --- a/docs/html/dir_936721fd6a792737eaef7358bcd49428.html +++ b/docs/html/dir_936721fd6a792737eaef7358bcd49428.html @@ -31,7 +31,7 @@ diff --git a/docs/html/dir_9d5018b9ddb63a582aa4c6b91bec2f8c.html b/docs/html/dir_9d5018b9ddb63a582aa4c6b91bec2f8c.html index 45d405e..8f852de 100644 --- a/docs/html/dir_9d5018b9ddb63a582aa4c6b91bec2f8c.html +++ b/docs/html/dir_9d5018b9ddb63a582aa4c6b91bec2f8c.html @@ -31,7 +31,7 @@ diff --git a/docs/html/dir_9da86e8abab39b749c6020360d8e4403.html b/docs/html/dir_9da86e8abab39b749c6020360d8e4403.html index 23e666a..9e3aebf 100644 --- a/docs/html/dir_9da86e8abab39b749c6020360d8e4403.html +++ b/docs/html/dir_9da86e8abab39b749c6020360d8e4403.html @@ -31,7 +31,7 @@ diff --git a/docs/html/dir_b0856f6b0d80ccb263b2f415c91f9e17.html b/docs/html/dir_b0856f6b0d80ccb263b2f415c91f9e17.html index c7d0bb0..969097a 100644 --- a/docs/html/dir_b0856f6b0d80ccb263b2f415c91f9e17.html +++ b/docs/html/dir_b0856f6b0d80ccb263b2f415c91f9e17.html @@ -31,7 +31,7 @@ diff --git a/docs/html/dir_c34d5e8363cf0aa3fabc4f3fad3412a4.html b/docs/html/dir_c34d5e8363cf0aa3fabc4f3fad3412a4.html index 51e1c3e..622729c 100644 --- a/docs/html/dir_c34d5e8363cf0aa3fabc4f3fad3412a4.html +++ b/docs/html/dir_c34d5e8363cf0aa3fabc4f3fad3412a4.html @@ -31,7 +31,7 @@ diff --git a/docs/html/dir_c85d3e3c5052e9ad9ce18c6863244a25.html b/docs/html/dir_c85d3e3c5052e9ad9ce18c6863244a25.html index 039e264..aaafd14 100644 --- a/docs/html/dir_c85d3e3c5052e9ad9ce18c6863244a25.html +++ b/docs/html/dir_c85d3e3c5052e9ad9ce18c6863244a25.html @@ -31,7 +31,7 @@ diff --git a/docs/html/dir_dc36fd7496f87f6989d6d6a9445d600c.html b/docs/html/dir_dc36fd7496f87f6989d6d6a9445d600c.html index 9e4fe8a..b12ada7 100644 --- a/docs/html/dir_dc36fd7496f87f6989d6d6a9445d600c.html +++ b/docs/html/dir_dc36fd7496f87f6989d6d6a9445d600c.html @@ -31,7 +31,7 @@ diff --git a/docs/html/doxygen_crawl.html b/docs/html/doxygen_crawl.html index 2f6cc12..b1a22fc 100644 --- a/docs/html/doxygen_crawl.html +++ b/docs/html/doxygen_crawl.html @@ -83,12 +83,17 @@ + + + + + diff --git a/docs/html/files.html b/docs/html/files.html index f6fb948..009efdf 100644 --- a/docs/html/files.html +++ b/docs/html/files.html @@ -31,7 +31,7 @@ diff --git a/docs/html/functions.html b/docs/html/functions.html index 6a52b83..d8a6ec2 100644 --- a/docs/html/functions.html +++ b/docs/html/functions.html @@ -31,7 +31,7 @@ @@ -102,15 +102,20 @@ $(function(){initNavTree('functions.html',''); initResizable(true); });
Here is a list of all class members with links to the classes they belong to:
diff --git a/docs/html/functions_vars.html b/docs/html/functions_vars.html index 56ad7d4..faeec47 100644 --- a/docs/html/functions_vars.html +++ b/docs/html/functions_vars.html @@ -31,7 +31,7 @@ @@ -102,15 +102,20 @@ $(function(){initNavTree('functions_vars.html',''); initResizable(true); });
Here is a list of all variables with links to the classes they belong to:
diff --git a/docs/html/graph_legend.html b/docs/html/graph_legend.html index e58cc71..0ef7558 100644 --- a/docs/html/graph_legend.html +++ b/docs/html/graph_legend.html @@ -31,7 +31,7 @@ diff --git a/docs/html/index.html b/docs/html/index.html index 56d6f16..971ca54 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -31,7 +31,7 @@ @@ -150,15 +150,20 @@ Running Configuration File

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

[main]
-
core_steepness = 1.0
-
flattening = 0.0
-
include_external_domain = false
+
refinement_levels = 2
order = 3
+
include_external_domain = true
r_core = 1.5
+
r_star = 5.0
+
flattening = 0.08
r_infinity = 6.0
r_instability = 1e-14
-
r_star = 5.0
-
refinement_levels = 4
+
core_steepness = 1.0
+
surface_bdr_id = 1
+
inf_bdr_id = 2
+
core_id = 1
+
envelope_id = 2
+
vacuum_id = 3

diff --git a/docs/html/curvilinear_8cpp__incl.map b/docs/html/curvilinear_8cpp__incl.map index 14961d1..dfbbeaa 100644 --- a/docs/html/curvilinear_8cpp__incl.map +++ b/docs/html/curvilinear_8cpp__incl.map @@ -1,20 +1,22 @@ - - - - - - - - - + + + + + + + + + + + - + - + - - - - + + + + diff --git a/docs/html/curvilinear_8cpp__incl.md5 b/docs/html/curvilinear_8cpp__incl.md5 index 7359c47..eb20556 100644 --- a/docs/html/curvilinear_8cpp__incl.md5 +++ b/docs/html/curvilinear_8cpp__incl.md5 @@ -1 +1 @@ -b8eef4875e081be998fbcbc84a3978b1 \ No newline at end of file +6950d4e2891a4c4f47ed638d27c5bf68 \ No newline at end of file diff --git a/docs/html/curvilinear_8cpp__incl.svg b/docs/html/curvilinear_8cpp__incl.svg index 11516ce..ba0748f 100644 --- a/docs/html/curvilinear_8cpp__incl.svg +++ b/docs/html/curvilinear_8cpp__incl.svg @@ -1,13 +1,12 @@ - - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + src/lib/topology/curvilinear.cpp Node1 - -src/lib/topology/curvilinear.cpp + +src/lib/topology/curvilinear.cpp @@ -32,8 +68,8 @@ Node2 - -stroid/topology/curvilinear.h + +stroid/topology/curvilinear.h @@ -41,8 +77,8 @@ Node1->Node2 - - + + @@ -50,8 +86,8 @@ Node6 - -stroid/topology/mapping.h + +stroid/topology/mapping.h @@ -59,8 +95,8 @@ Node1->Node6 - - + + @@ -68,8 +104,8 @@ Node7 - -iostream + +iostream @@ -77,8 +113,8 @@ Node1->Node7 - - + + @@ -86,8 +122,8 @@ Node8 - -memory + +memory @@ -95,8 +131,26 @@ Node1->Node8 - - + + + + + + + +Node9 + + +sys/proc.h + + + + + +Node1->Node9 + + + @@ -113,8 +167,8 @@ Node2->Node3 - - + + @@ -131,8 +185,8 @@ Node2->Node4 - - + + @@ -149,8 +203,8 @@ Node2->Node5 - - + + @@ -158,8 +212,8 @@ Node6->Node3 - - + + @@ -167,8 +221,8 @@ Node6->Node4 - - + + @@ -176,13 +230,34 @@ Node6->Node5 - - + + + + + + + + + + + + + + + + + + + + Logo

 -
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
-
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
-
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
-
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
-
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
-
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
-
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
-
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
-
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
-
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
-
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
-
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
-
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
-
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
-
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
-
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
-
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
-
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
-
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
-
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
-
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
-
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
-
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
-
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
@@ -167,7 +172,7 @@ Configuration File - + @@ -179,7 +184,17 @@ Configuration File - + + + + + + + + + + +
Parameter Description Default
order The polynomial order of the finite elements in the mesh 3
include_external_domain Whether to include an external domain extending to r_infinity false
include_external_domain Whether to include an external domain extending to r_infinity true
r_core The radius of the core region of the star 1.5
r_instability The radius at which no transformations are applied to the initial topology (to avoid singularities) 1e-14
core_steepness The steepness of the transition between the core and envelope regions of the star 1.0
core_steepness The steepness of the transition between the core and envelope regions of the star 1.0
surface_bdr_id The boundary ID to assign to the surface of the star 1
inf_bdr_id The boundary ID to assign to the outer boundary of the external domain (if included) 2
core_id The material ID to assign to the core region of the star 1
envelope_id The material ID to assign to the envelope region of the star 2
vacuum_id The material ID to assign to the vacuum region of the star (if included) 3

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.

@@ -211,9 +226,9 @@ C++ Interface

stroid::IO::ViewMesh
void ViewMesh(mfem::Mesh &mesh, const std::string &title, VISUALIZATION_MODE mode, const std::string &vishost, int visport)
Stream a mesh to a running GLVis server for interactive viewing.
Definition mesh.cpp:25
stroid::IO::VISUALIZATION_MODE::BOUNDARY_ELEMENT_ID
@ BOUNDARY_ELEMENT_ID
Color boundary-adjacent elements by boundary attribute/ID.
Definition mesh.h:15
-
stroid::topology::PromoteToHighOrder
void PromoteToHighOrder(mfem::Mesh &mesh, const fourdst::config::Config< config::MeshConfig > &config)
Promote a mesh to high-order by attaching an H1 nodal finite element space.
Definition curvilinear.cpp:8
-
stroid::topology::Finalize
void Finalize(mfem::Mesh &mesh, const fourdst::config::Config< config::MeshConfig > &config)
Finalize topology, validate orientation, and apply uniform refinement.
Definition topology.cpp:59
-
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::PromoteToHighOrder
void PromoteToHighOrder(mfem::Mesh &mesh, const fourdst::config::Config< config::MeshConfig > &config)
Promote a mesh to high-order by attaching an H1 nodal finite element space.
Definition curvilinear.cpp:9
+
stroid::topology::Finalize
void Finalize(mfem::Mesh &mesh, const fourdst::config::Config< config::MeshConfig > &config)
Finalize topology, validate orientation, and apply uniform refinement.
Definition topology.cpp:90
+
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:15
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

diff --git a/docs/html/mainpage_8md.html b/docs/html/mainpage_8md.html index 7fd3c98..402a917 100644 --- a/docs/html/mainpage_8md.html +++ b/docs/html/mainpage_8md.html @@ -31,7 +31,7 @@ Logo -
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
diff --git a/docs/html/mapping_8cpp.html b/docs/html/mapping_8cpp.html index 5fa4076..3ba75c9 100644 --- a/docs/html/mapping_8cpp.html +++ b/docs/html/mapping_8cpp.html @@ -31,7 +31,7 @@ Logo -
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
@@ -131,9 +131,6 @@ Functions

void stroid::topology::ApplySpheroidal (mfem::Vector &pos, const fourdst::config::Config< config::MeshConfig > &config)  Apply spheroidal flattening along the Z axis.
  -void stroid::topology::ApplyKelvin (mfem::Vector &pos, const fourdst::config::Config< config::MeshConfig > &config) - Apply Kelvin transform outside the stellar radius.
-  void stroid::topology::TransformPoint (mfem::Vector &pos, const fourdst::config::Config< config::MeshConfig > &config, int attribute_id)  Map a point from the initial block topology to the curvilinear domain.
  diff --git a/docs/html/mapping_8cpp.js b/docs/html/mapping_8cpp.js index fbbc436..cc17306 100644 --- a/docs/html/mapping_8cpp.js +++ b/docs/html/mapping_8cpp.js @@ -1,7 +1,6 @@ var mapping_8cpp = [ [ "stroid::topology::ApplyEquiangular", "namespacestroid_1_1topology.html#a03f0b29ccf7d427a175de9ff75824b7c", null ], - [ "stroid::topology::ApplyKelvin", "namespacestroid_1_1topology.html#a59c54a10f726d323f8506b4a2edd7467", null ], [ "stroid::topology::ApplySpheroidal", "namespacestroid_1_1topology.html#a7fbf58c40c03bc751d53f4a3273744fc", null ], [ "stroid::topology::TransformPoint", "namespacestroid_1_1topology.html#a394e33bdfafdaccd6edfaae0642d3456", null ] ]; \ No newline at end of file diff --git a/docs/html/mapping_8h.html b/docs/html/mapping_8h.html index 104fbbd..d003e76 100644 --- a/docs/html/mapping_8h.html +++ b/docs/html/mapping_8h.html @@ -31,7 +31,7 @@ Logo -
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
diff --git a/docs/html/mesh_8cpp.html b/docs/html/mesh_8cpp.html index 72aa9b1..5251183 100644 --- a/docs/html/mesh_8cpp.html +++ b/docs/html/mesh_8cpp.html @@ -31,7 +31,7 @@ Logo -
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
diff --git a/docs/html/mesh_8h.html b/docs/html/mesh_8h.html index 6f391d0..a77697e 100644 --- a/docs/html/mesh_8h.html +++ b/docs/html/mesh_8h.html @@ -31,7 +31,7 @@ Logo -
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
diff --git a/docs/html/mesh__utils_8cpp.html b/docs/html/mesh__utils_8cpp.html index 1fcb5b5..424e402 100644 --- a/docs/html/mesh__utils_8cpp.html +++ b/docs/html/mesh__utils_8cpp.html @@ -31,7 +31,7 @@ Logo -
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
diff --git a/docs/html/mesh__utils_8h.html b/docs/html/mesh__utils_8h.html index d56fb2d..4e76db2 100644 --- a/docs/html/mesh__utils_8h.html +++ b/docs/html/mesh__utils_8h.html @@ -31,7 +31,7 @@ Logo -
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
diff --git a/docs/html/namespacemembers.html b/docs/html/namespacemembers.html index ac43679..631e2d5 100644 --- a/docs/html/namespacemembers.html +++ b/docs/html/namespacemembers.html @@ -31,7 +31,7 @@ Logo -
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
diff --git a/docs/html/namespacemembers_enum.html b/docs/html/namespacemembers_enum.html index 89d4bd9..445249f 100644 --- a/docs/html/namespacemembers_enum.html +++ b/docs/html/namespacemembers_enum.html @@ -31,7 +31,7 @@ Logo -
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
diff --git a/docs/html/namespacemembers_func.html b/docs/html/namespacemembers_func.html index 1ea31fb..d5585f4 100644 --- a/docs/html/namespacemembers_func.html +++ b/docs/html/namespacemembers_func.html @@ -31,7 +31,7 @@ Logo -
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
diff --git a/docs/html/namespaces.html b/docs/html/namespaces.html index 3e7f362..2264a17 100644 --- a/docs/html/namespaces.html +++ b/docs/html/namespaces.html @@ -31,7 +31,7 @@ Logo -
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
diff --git a/docs/html/namespacestroid.html b/docs/html/namespacestroid.html index 233eab8..dae297b 100644 --- a/docs/html/namespacestroid.html +++ b/docs/html/namespacestroid.html @@ -31,7 +31,7 @@ Logo -
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
diff --git a/docs/html/namespacestroid_1_1_i_o.html b/docs/html/namespacestroid_1_1_i_o.html index 3250e30..e240f36 100644 --- a/docs/html/namespacestroid_1_1_i_o.html +++ b/docs/html/namespacestroid_1_1_i_o.html @@ -31,7 +31,7 @@ Logo -
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
diff --git a/docs/html/namespacestroid_1_1config.html b/docs/html/namespacestroid_1_1config.html index 22b562b..6f3e378 100644 --- a/docs/html/namespacestroid_1_1config.html +++ b/docs/html/namespacestroid_1_1config.html @@ -31,7 +31,7 @@ Logo -
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
diff --git a/docs/html/namespacestroid_1_1topology.html b/docs/html/namespacestroid_1_1topology.html index be81d3f..4f75b08 100644 --- a/docs/html/namespacestroid_1_1topology.html +++ b/docs/html/namespacestroid_1_1topology.html @@ -31,7 +31,7 @@ Logo -
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
diff --git a/docs/html/namespacestroid_1_1utils.html b/docs/html/namespacestroid_1_1utils.html index 6d35d01..73605cc 100644 --- a/docs/html/namespacestroid_1_1utils.html +++ b/docs/html/namespacestroid_1_1utils.html @@ -31,7 +31,7 @@ Logo -
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
diff --git a/docs/html/navtreeindex0.js b/docs/html/navtreeindex0.js index 869f13f..1918b57 100644 --- a/docs/html/navtreeindex0.js +++ b/docs/html/navtreeindex0.js @@ -67,24 +67,34 @@ var NAVTREEINDEX0 = "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#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#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#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#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#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#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#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#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#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#a062652781f4f3ea0b7ca8764362a7368":[3,0,0,0,0,4], +"structstroid_1_1config_1_1_mesh_config.html#a062652781f4f3ea0b7ca8764362a7368":[4,0,0,0,0,4], +"structstroid_1_1config_1_1_mesh_config.html#a2faa5aa1fef84ebbda30590d3fb2799b":[3,0,0,0,0,0], +"structstroid_1_1config_1_1_mesh_config.html#a2faa5aa1fef84ebbda30590d3fb2799b":[4,0,0,0,0,0], +"structstroid_1_1config_1_1_mesh_config.html#a33f25ff277aa8834065e04ccb9cdbdda":[3,0,0,0,0,12], +"structstroid_1_1config_1_1_mesh_config.html#a33f25ff277aa8834065e04ccb9cdbdda":[4,0,0,0,0,12], +"structstroid_1_1config_1_1_mesh_config.html#a36c7b05405691393d381086a27ea36ad":[3,0,0,0,0,13], +"structstroid_1_1config_1_1_mesh_config.html#a36c7b05405691393d381086a27ea36ad":[4,0,0,0,0,13], +"structstroid_1_1config_1_1_mesh_config.html#a3fe80a30990d484dcc39b6f9a0befc05":[3,0,0,0,0,10], +"structstroid_1_1config_1_1_mesh_config.html#a3fe80a30990d484dcc39b6f9a0befc05":[4,0,0,0,0,10], +"structstroid_1_1config_1_1_mesh_config.html#a4da6d99ff7ba24d2f917e1fd98ddd877":[3,0,0,0,0,9], +"structstroid_1_1config_1_1_mesh_config.html#a4da6d99ff7ba24d2f917e1fd98ddd877":[4,0,0,0,0,9], +"structstroid_1_1config_1_1_mesh_config.html#a5c68a895f73dc82a38a8daac22a83ad7":[3,0,0,0,0,7], +"structstroid_1_1config_1_1_mesh_config.html#a5c68a895f73dc82a38a8daac22a83ad7":[4,0,0,0,0,7], +"structstroid_1_1config_1_1_mesh_config.html#a64cb00c8cba27267279a52207a4b5be0":[3,0,0,0,0,5], +"structstroid_1_1config_1_1_mesh_config.html#a64cb00c8cba27267279a52207a4b5be0":[4,0,0,0,0,5], +"structstroid_1_1config_1_1_mesh_config.html#a860e78f1906acb0c3aa08d55f94de3fd":[3,0,0,0,0,6], +"structstroid_1_1config_1_1_mesh_config.html#a860e78f1906acb0c3aa08d55f94de3fd":[4,0,0,0,0,6], +"structstroid_1_1config_1_1_mesh_config.html#a8cafcbebf64ae251517118eb152de981":[3,0,0,0,0,11], +"structstroid_1_1config_1_1_mesh_config.html#a8cafcbebf64ae251517118eb152de981":[4,0,0,0,0,11], +"structstroid_1_1config_1_1_mesh_config.html#ac7546899ebbfe191ea3a8bf2403b31eb":[3,0,0,0,0,8], +"structstroid_1_1config_1_1_mesh_config.html#ac7546899ebbfe191ea3a8bf2403b31eb":[4,0,0,0,0,8], +"structstroid_1_1config_1_1_mesh_config.html#ac99aa48fe3e71e2ef57b09d48cacfef8":[3,0,0,0,0,2], +"structstroid_1_1config_1_1_mesh_config.html#ac99aa48fe3e71e2ef57b09d48cacfef8":[4,0,0,0,0,2], +"structstroid_1_1config_1_1_mesh_config.html#aed32864839b149c94842801b6413d94d":[3,0,0,0,0,1], +"structstroid_1_1config_1_1_mesh_config.html#aed32864839b149c94842801b6413d94d":[4,0,0,0,0,1], +"structstroid_1_1config_1_1_mesh_config.html#affad4638b0ae7b710f2b2db992f6f584":[3,0,0,0,0,3], +"structstroid_1_1config_1_1_mesh_config.html#affad4638b0ae7b710f2b2db992f6f584":[4,0,0,0,0,3], "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 b596d77..507bf3a 100644 --- a/docs/html/search/all_2.js +++ b/docs/html/search/all_2.js @@ -3,7 +3,8 @@ var searchData= ['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_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,'']]] + ['core_5fid_3',['core_id',['../structstroid_1_1config_1_1_mesh_config.html#a2faa5aa1fef84ebbda30590d3fb2799b',1,'stroid::config::MeshConfig']]], + ['core_5fsteepness_4',['core_steepness',['../structstroid_1_1config_1_1_mesh_config.html#aed32864839b149c94842801b6413d94d',1,'stroid::config::MeshConfig']]], + ['curvilinear_2ecpp_5',['curvilinear.cpp',['../curvilinear_8cpp.html',1,'']]], + ['curvilinear_2eh_6',['curvilinear.h',['../curvilinear_8h.html',1,'']]] ]; diff --git a/docs/html/search/all_3.js b/docs/html/search/all_3.js index 4894a43..fea5a2f 100644 --- a/docs/html/search/all_3.js +++ b/docs/html/search/all_3.js @@ -1,4 +1,5 @@ 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']]], + ['envelope_5fid_1',['envelope_id',['../structstroid_1_1config_1_1_mesh_config.html#ac99aa48fe3e71e2ef57b09d48cacfef8',1,'stroid::config::MeshConfig']]] ]; diff --git a/docs/html/search/all_6.js b/docs/html/search/all_6.js index db440e8..1d61dde 100644 --- a/docs/html/search/all_6.js +++ b/docs/html/search/all_6.js @@ -1,6 +1,7 @@ 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_md7',1,'']]] + ['inf_5fbdr_5fid_1',['inf_bdr_id',['../structstroid_1_1config_1_1_mesh_config.html#a64cb00c8cba27267279a52207a4b5be0',1,'stroid::config::MeshConfig']]], + ['installing_2',['Building and Installing',['../index.html#autotoc_md2',1,'']]], + ['interface_3',['C++ Interface',['../index.html#autotoc_md7',1,'']]] ]; diff --git a/docs/html/search/all_d.js b/docs/html/search/all_d.js index 4d9b9c4..727423c 100644 --- a/docs/html/search/all_d.js +++ b/docs/html/search/all_d.js @@ -8,5 +8,6 @@ var searchData= ['stroid_3a_3aconfig_5',['config',['../namespacestroid_1_1config.html',1,'stroid']]], ['stroid_3a_3aio_6',['IO',['../namespacestroid_1_1_i_o.html',1,'stroid']]], ['stroid_3a_3atopology_7',['topology',['../namespacestroid_1_1topology.html',1,'stroid']]], - ['stroid_3a_3autils_8',['utils',['../namespacestroid_1_1utils.html',1,'stroid']]] + ['stroid_3a_3autils_8',['utils',['../namespacestroid_1_1utils.html',1,'stroid']]], + ['surface_5fbdr_5fid_9',['surface_bdr_id',['../structstroid_1_1config_1_1_mesh_config.html#a33f25ff277aa8834065e04ccb9cdbdda',1,'stroid::config::MeshConfig']]] ]; diff --git a/docs/html/search/searchdata.js b/docs/html/search/searchdata.js index bdf9aa5..f3fcd0b 100644 --- a/docs/html/search/searchdata.js +++ b/docs/html/search/searchdata.js @@ -5,7 +5,7 @@ var indexSectionsWithContent = 2: "s", 3: "clmt", 4: "abfmpstv", - 5: "cfior", + 5: "cefiorsv", 6: "v", 7: "ben", 8: "s" diff --git a/docs/html/search/variables_0.js b/docs/html/search/variables_0.js index d55962b..fe8dc5f 100644 --- a/docs/html/search/variables_0.js +++ b/docs/html/search/variables_0.js @@ -1,4 +1,5 @@ var searchData= [ - ['core_5fsteepness_0',['core_steepness',['../structstroid_1_1config_1_1_mesh_config.html#aed32864839b149c94842801b6413d94d',1,'stroid::config::MeshConfig']]] + ['core_5fid_0',['core_id',['../structstroid_1_1config_1_1_mesh_config.html#a2faa5aa1fef84ebbda30590d3fb2799b',1,'stroid::config::MeshConfig']]], + ['core_5fsteepness_1',['core_steepness',['../structstroid_1_1config_1_1_mesh_config.html#aed32864839b149c94842801b6413d94d',1,'stroid::config::MeshConfig']]] ]; diff --git a/docs/html/search/variables_1.js b/docs/html/search/variables_1.js index 13cb414..3eb6c41 100644 --- a/docs/html/search/variables_1.js +++ b/docs/html/search/variables_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['flattening_0',['flattening',['../structstroid_1_1config_1_1_mesh_config.html#affad4638b0ae7b710f2b2db992f6f584',1,'stroid::config::MeshConfig']]] + ['envelope_5fid_0',['envelope_id',['../structstroid_1_1config_1_1_mesh_config.html#ac99aa48fe3e71e2ef57b09d48cacfef8',1,'stroid::config::MeshConfig']]] ]; diff --git a/docs/html/search/variables_2.js b/docs/html/search/variables_2.js index 0f72429..13cb414 100644 --- a/docs/html/search/variables_2.js +++ b/docs/html/search/variables_2.js @@ -1,4 +1,4 @@ var searchData= [ - ['include_5fexternal_5fdomain_0',['include_external_domain',['../structstroid_1_1config_1_1_mesh_config.html#a062652781f4f3ea0b7ca8764362a7368',1,'stroid::config::MeshConfig']]] + ['flattening_0',['flattening',['../structstroid_1_1config_1_1_mesh_config.html#affad4638b0ae7b710f2b2db992f6f584',1,'stroid::config::MeshConfig']]] ]; diff --git a/docs/html/search/variables_3.js b/docs/html/search/variables_3.js index 54e4e33..ea892bd 100644 --- a/docs/html/search/variables_3.js +++ b/docs/html/search/variables_3.js @@ -1,4 +1,5 @@ var searchData= [ - ['order_0',['order',['../structstroid_1_1config_1_1_mesh_config.html#a860e78f1906acb0c3aa08d55f94de3fd',1,'stroid::config::MeshConfig']]] + ['include_5fexternal_5fdomain_0',['include_external_domain',['../structstroid_1_1config_1_1_mesh_config.html#a062652781f4f3ea0b7ca8764362a7368',1,'stroid::config::MeshConfig']]], + ['inf_5fbdr_5fid_1',['inf_bdr_id',['../structstroid_1_1config_1_1_mesh_config.html#a64cb00c8cba27267279a52207a4b5be0',1,'stroid::config::MeshConfig']]] ]; diff --git a/docs/html/search/variables_4.js b/docs/html/search/variables_4.js index ca9c138..54e4e33 100644 --- a/docs/html/search/variables_4.js +++ b/docs/html/search/variables_4.js @@ -1,8 +1,4 @@ var searchData= [ - ['r_5fcore_0',['r_core',['../structstroid_1_1config_1_1_mesh_config.html#a5c68a895f73dc82a38a8daac22a83ad7',1,'stroid::config::MeshConfig']]], - ['r_5finfinity_1',['r_infinity',['../structstroid_1_1config_1_1_mesh_config.html#ac7546899ebbfe191ea3a8bf2403b31eb',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']]], - ['refinement_5flevels_4',['refinement_levels',['../structstroid_1_1config_1_1_mesh_config.html#a8cafcbebf64ae251517118eb152de981',1,'stroid::config::MeshConfig']]] + ['order_0',['order',['../structstroid_1_1config_1_1_mesh_config.html#a860e78f1906acb0c3aa08d55f94de3fd',1,'stroid::config::MeshConfig']]] ]; diff --git a/docs/html/structstroid_1_1config_1_1_mesh_config-members.html b/docs/html/structstroid_1_1config_1_1_mesh_config-members.html index 75f2464..0ba8dc0 100644 --- a/docs/html/structstroid_1_1config_1_1_mesh_config-members.html +++ b/docs/html/structstroid_1_1config_1_1_mesh_config-members.html @@ -31,7 +31,7 @@ Logo -
diff --git a/docs/html/structstroid_1_1config_1_1_mesh_config.html b/docs/html/structstroid_1_1config_1_1_mesh_config.html index 83a108d..8cebfc5 100644 --- a/docs/html/structstroid_1_1config_1_1_mesh_config.html +++ b/docs/html/structstroid_1_1config_1_1_mesh_config.html @@ -31,7 +31,7 @@ Logo -
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
@@ -116,37 +116,73 @@ $(function(){initNavTree('structstroid_1_1config_1_1_mesh_config.html',''); init

Public Attributes

int refinement_levels = 4 - Number of uniform refinement passes applied after topology creation. @toml [main].refinement_levels.
+ Number of uniform refinement passes applied after topology creation.
  int order = 3 - Polynomial order for high-order elements. @toml [main].order.
+ Polynomial order for high-order elements.
  -bool include_external_domain = false +bool include_external_domain = true  Whether to include an external domain extending to r_infinity.
  double r_core = 1.5 - Radius of the stellar core region. @toml [main].r_core.
+ Radius of the stellar core region.
  double r_star = 5.0 - Radius of the stellar surface. @toml [main].r_star.
+ Radius of the stellar surface.
  double flattening = 0 - Flattening factor for spheroidal shaping (0 = spherical, >0 = oblate). @toml [main].flattening.
+ Flattening factor for spheroidal shaping (0 = spherical, >0 = oblate).
  double r_infinity = 6.0 - Outer radius of the external domain when enabled. @toml [main].r_infinity.
+ Outer radius of the external domain when enabled.
  double r_instability = 1e-14 - Radius inside which transformations are skipped to avoid singularities. @toml [main].r_instability.
+ Radius inside which transformations are skipped to avoid singularities.
  double core_steepness = 1.0 - Controls the smoothness/steepness of the core-to-envelope transition. @toml [main].core_steepness.
+ Controls the smoothness/steepness of the core-to-envelope transition.
  +size_t surface_bdr_id = 1 + Boundary attribute id for stellar surface.
+  +size_t inf_bdr_id = 2 + Boundary attribute id for infinity in kelvin mapping.
+  +size_t core_id = 1 + Material attribute id for the core region.
+  +size_t envelope_id = 2 + Material attribute id for the envelope region.
+  +size_t vacuum_id = 3 + Material attribute id for the external domain (if enabled)
+ 

Detailed Description

Configuration parameters for stroid mesh generation.

These values are typically loaded via fourdst::config::Config<stroid::config::MeshConfig> from a TOML file. The README shows the expected TOML layout under the [main] table. Unspecified keys use the defaults defined here.

Member Data Documentation

+ +

◆ core_id

+ +
+
+ + + + +
size_t stroid::config::MeshConfig::core_id = 1
+
+ +

Material attribute id for the core region.

+

+toml

+
    +
  • [main].core_id
    • +
+ +
+

◆ core_steepness

@@ -159,7 +195,33 @@ Public Attributes
-

Controls the smoothness/steepness of the core-to-envelope transition. @toml [main].core_steepness.

+

Controls the smoothness/steepness of the core-to-envelope transition.

+

+toml

+
    +
  • [main].core_steepness
    • +
+ +
+
+ +

◆ envelope_id

+ +
+
+ + + + +
size_t stroid::config::MeshConfig::envelope_id = 2
+
+ +

Material attribute id for the envelope region.

+

+toml

+
    +
  • [main].envelope_id
    • +
@@ -175,7 +237,12 @@ Public Attributes
-

Flattening factor for spheroidal shaping (0 = spherical, >0 = oblate). @toml [main].flattening.

+

Flattening factor for spheroidal shaping (0 = spherical, >0 = oblate).

+

+toml

+
    +
  • [main].flattening
    • +
@@ -186,13 +253,38 @@ Public Attributes
- +
bool stroid::config::MeshConfig::include_external_domain = falsebool stroid::config::MeshConfig::include_external_domain = true

Whether to include an external domain extending to r_infinity.

-

Currently this flag does not affect mesh generation. @toml [main].include_external_domain

+

+toml

+
    +
  • [main].include_external_domain
    • +
+ +
+
+ +

◆ inf_bdr_id

+ +
+
+ + + + +
size_t stroid::config::MeshConfig::inf_bdr_id = 2
+
+ +

Boundary attribute id for infinity in kelvin mapping.

+

+toml

+
    +
  • [main].inf_bdr_id
    • +
@@ -208,7 +300,12 @@ Public Attributes
-

Polynomial order for high-order elements. @toml [main].order.

+

Polynomial order for high-order elements.

+

+toml

+
    +
  • [main].order
    • +
@@ -224,7 +321,12 @@ Public Attributes
-

Radius of the stellar core region. @toml [main].r_core.

+

Radius of the stellar core region.

+

+toml

+
    +
  • [main].r_core
    • +
@@ -240,7 +342,12 @@ Public Attributes
-

Outer radius of the external domain when enabled. @toml [main].r_infinity.

+

Outer radius of the external domain when enabled.

+

+toml

+
    +
  • [main].r_infinity
    • +
@@ -256,7 +363,12 @@ Public Attributes
-

Radius inside which transformations are skipped to avoid singularities. @toml [main].r_instability.

+

Radius inside which transformations are skipped to avoid singularities.

+

+toml

+
    +
  • [main].r_instability
    • +
@@ -272,7 +384,12 @@ Public Attributes
-

Radius of the stellar surface. @toml [main].r_star.

+

Radius of the stellar surface.

+

+toml

+
    +
  • [main].r_star
    • +
@@ -288,7 +405,54 @@ Public Attributes
-

Number of uniform refinement passes applied after topology creation. @toml [main].refinement_levels.

+

Number of uniform refinement passes applied after topology creation.

+

+toml

+
    +
  • [main].refinement_levels
    • +
+ +
+
+ +

◆ surface_bdr_id

+ +
+
+ + + + +
size_t stroid::config::MeshConfig::surface_bdr_id = 1
+
+ +

Boundary attribute id for stellar surface.

+

+toml

+
    +
  • [main].surface_bdr_id
    • +
+ +
+
+ +

◆ vacuum_id

+ +
+
+ + + + +
size_t stroid::config::MeshConfig::vacuum_id = 3
+
+ +

Material attribute id for the external domain (if enabled)

+

+toml

+
    +
  • [main].vacuum_id
    • +
diff --git a/docs/html/structstroid_1_1config_1_1_mesh_config.js b/docs/html/structstroid_1_1config_1_1_mesh_config.js index e123f5a..e08ceff 100644 --- a/docs/html/structstroid_1_1config_1_1_mesh_config.js +++ b/docs/html/structstroid_1_1config_1_1_mesh_config.js @@ -1,12 +1,17 @@ var structstroid_1_1config_1_1_mesh_config = [ + [ "core_id", "structstroid_1_1config_1_1_mesh_config.html#a2faa5aa1fef84ebbda30590d3fb2799b", null ], [ "core_steepness", "structstroid_1_1config_1_1_mesh_config.html#aed32864839b149c94842801b6413d94d", null ], + [ "envelope_id", "structstroid_1_1config_1_1_mesh_config.html#ac99aa48fe3e71e2ef57b09d48cacfef8", null ], [ "flattening", "structstroid_1_1config_1_1_mesh_config.html#affad4638b0ae7b710f2b2db992f6f584", null ], [ "include_external_domain", "structstroid_1_1config_1_1_mesh_config.html#a062652781f4f3ea0b7ca8764362a7368", null ], + [ "inf_bdr_id", "structstroid_1_1config_1_1_mesh_config.html#a64cb00c8cba27267279a52207a4b5be0", null ], [ "order", "structstroid_1_1config_1_1_mesh_config.html#a860e78f1906acb0c3aa08d55f94de3fd", null ], [ "r_core", "structstroid_1_1config_1_1_mesh_config.html#a5c68a895f73dc82a38a8daac22a83ad7", null ], [ "r_infinity", "structstroid_1_1config_1_1_mesh_config.html#ac7546899ebbfe191ea3a8bf2403b31eb", null ], [ "r_instability", "structstroid_1_1config_1_1_mesh_config.html#a4da6d99ff7ba24d2f917e1fd98ddd877", null ], [ "r_star", "structstroid_1_1config_1_1_mesh_config.html#a3fe80a30990d484dcc39b6f9a0befc05", null ], - [ "refinement_levels", "structstroid_1_1config_1_1_mesh_config.html#a8cafcbebf64ae251517118eb152de981", null ] + [ "refinement_levels", "structstroid_1_1config_1_1_mesh_config.html#a8cafcbebf64ae251517118eb152de981", null ], + [ "surface_bdr_id", "structstroid_1_1config_1_1_mesh_config.html#a33f25ff277aa8834065e04ccb9cdbdda", null ], + [ "vacuum_id", "structstroid_1_1config_1_1_mesh_config.html#a36c7b05405691393d381086a27ea36ad", null ] ]; \ No newline at end of file diff --git a/docs/html/topology_8cpp.html b/docs/html/topology_8cpp.html index 471e004..f684546 100644 --- a/docs/html/topology_8cpp.html +++ b/docs/html/topology_8cpp.html @@ -31,7 +31,7 @@ Logo -
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
diff --git a/docs/html/topology_8h.html b/docs/html/topology_8h.html index 9bfe801..4abe0c0 100644 --- a/docs/html/topology_8h.html +++ b/docs/html/topology_8h.html @@ -31,7 +31,7 @@ Logo -
stroid v0.1.0 +
stroid v0.2.0
Multi-block curvilinear mesh generation
diff --git a/docs/static/mainpage.md b/docs/static/mainpage.md index c1b920e..9f61eaa 100644 --- a/docs/static/mainpage.md +++ b/docs/static/mainpage.md @@ -77,15 +77,20 @@ file is found below ```toml [main] -core_steepness = 1.0 -flattening = 0.0 -include_external_domain = false +refinement_levels = 2 order = 3 +include_external_domain = true r_core = 1.5 +r_star = 5.0 +flattening = 0.08 r_infinity = 6.0 r_instability = 1e-14 -r_star = 5.0 -refinement_levels = 4 +core_steepness = 1.0 +surface_bdr_id = 1 +inf_bdr_id = 2 +core_id = 1 +envelope_id = 2 +vacuum_id = 3 ``` @@ -93,13 +98,18 @@ refinement_levels = 4 |-------------------------|-----------------------------------------------------------------------------------------------------|---------| | refinement_levels | Number of uniform refinement levels to apply to the mesh after generation | 4 | | order | The polynomial order of the finite elements in the mesh | 3 | -| include_external_domain | Whether to include an external domain extending to r_infinity | false | +| include_external_domain | Whether to include an external domain extending to r_infinity | true | | r_core | The radius of the core region of the star | 1.5 | | r_star | The radius of the star | 5.0 | | flattening | The flattening factor of the star (0 for spherical, >0 for oblate) | 0 | | r_infinity | The outer radius of the external domain (if included) | 6.0 | | r_instability | The radius at which no transformations are applied to the initial topology (to avoid singularities) | 1e-14 | | core_steepness | The steepness of the transition between the core and envelope regions of the star | 1.0 | +| surface_bdr_id | The boundary ID to assign to the surface of the star | 1 | +| inf_bdr_id | The boundary ID to assign to the outer boundary of the external domain (if included) | 2 | +| core_id | The material ID to assign to the core region of the star | 1 | +| envelope_id | The material ID to assign to the envelope region of the star | 2 | +| vacuum_id | The material ID to assign to the vacuum region of the star (if included) | 3 | If no configuration file is provided, stroid will use the default parameters listed above. Further, configuration files diff --git a/readme.md b/readme.md index 52affca..534cb22 100644 --- a/readme.md +++ b/readme.md @@ -78,15 +78,20 @@ file is found below ```toml [main] -core_steepness = 1.0 -flattening = 0.0 -include_external_domain = false +refinement_levels = 2 order = 3 +include_external_domain = true r_core = 1.5 +r_star = 5.0 +flattening = 0.08 r_infinity = 6.0 r_instability = 1e-14 -r_star = 5.0 -refinement_levels = 4 +core_steepness = 1.0 +surface_bdr_id = 1 +inf_bdr_id = 2 +core_id = 1 +envelope_id = 2 +vacuum_id = 3 ``` @@ -94,13 +99,18 @@ refinement_levels = 4 |-------------------------|-----------------------------------------------------------------------------------------------------|---------| | refinement_levels | Number of uniform refinement levels to apply to the mesh after generation | 4 | | order | The polynomial order of the finite elements in the mesh | 3 | -| include_external_domain | Whether to include an external domain extending to r_infinity | false | +| include_external_domain | Whether to include an external domain extending to r_infinity | true | | r_core | The radius of the core region of the star | 1.5 | | r_star | The radius of the star | 5.0 | | flattening | The flattening factor of the star (0 for spherical, >0 for oblate) | 0 | | r_infinity | The outer radius of the external domain (if included) | 6.0 | | r_instability | The radius at which no transformations are applied to the initial topology (to avoid singularities) | 1e-14 | | core_steepness | The steepness of the transition between the core and envelope regions of the star | 1.0 | +| surface_bdr_id | The boundary ID to assign to the surface of the star | 1 | +| inf_bdr_id | The boundary ID to assign to the outer boundary of the external domain (if included) | 2 | +| core_id | The material ID to assign to the core region of the star | 1 | +| envelope_id | The material ID to assign to the envelope region of the star | 2 | +| vacuum_id | The material ID to assign to the vacuum region of the star (if included) | 3 | If no configuration file is provided, stroid will use the default parameters listed above. Further, configuration files