tboudreaux/stroid
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
38150e3a8d0586ed00fbd2cfe127338a3fb76865
stroid/docs/html/structstroid_1_1config_1_1_mesh_config.html

309 lines
16 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>stroid: stroid::config::MeshConfig Struct Reference</title>
<link rel="icon" href="Logo.png" type="image/x-icon" />
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="Logo.png"/></td>
<td id="projectalign">
<div id="projectname">stroid<span id="projectnumber">&#160;v0.1.0</span>
</div>
<div id="projectbrief">Multi-block curvilinear mesh generation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',true);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('structstroid_1_1config_1_1_mesh_config.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structstroid_1_1config_1_1_mesh_config-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">stroid::config::MeshConfig Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Configuration parameters for stroid mesh generation.
<a href="#details">More...</a></p>
<p><code>#include &lt;config.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a8cafcbebf64ae251517118eb152de981" id="r_a8cafcbebf64ae251517118eb152de981"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8cafcbebf64ae251517118eb152de981">refinement_levels</a> = 4</td></tr>
<tr class="memdesc:a8cafcbebf64ae251517118eb152de981"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of uniform refinement passes applied after topology creation. @toml [main].refinement_levels. <br /></td></tr>
<tr class="separator:a8cafcbebf64ae251517118eb152de981"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a860e78f1906acb0c3aa08d55f94de3fd" id="r_a860e78f1906acb0c3aa08d55f94de3fd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a860e78f1906acb0c3aa08d55f94de3fd">order</a> = 3</td></tr>
<tr class="memdesc:a860e78f1906acb0c3aa08d55f94de3fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Polynomial order for high-order elements. @toml [main].order. <br /></td></tr>
<tr class="separator:a860e78f1906acb0c3aa08d55f94de3fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a062652781f4f3ea0b7ca8764362a7368" id="r_a062652781f4f3ea0b7ca8764362a7368"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a062652781f4f3ea0b7ca8764362a7368">include_external_domain</a> = false</td></tr>
<tr class="memdesc:a062652781f4f3ea0b7ca8764362a7368"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether to include an external domain extending to <code>r_infinity</code>. <br /></td></tr>
<tr class="separator:a062652781f4f3ea0b7ca8764362a7368"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c68a895f73dc82a38a8daac22a83ad7" id="r_a5c68a895f73dc82a38a8daac22a83ad7"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5c68a895f73dc82a38a8daac22a83ad7">r_core</a> = 1.5</td></tr>
<tr class="memdesc:a5c68a895f73dc82a38a8daac22a83ad7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Radius of the stellar core region. @toml [main].r_core. <br /></td></tr>
<tr class="separator:a5c68a895f73dc82a38a8daac22a83ad7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3fe80a30990d484dcc39b6f9a0befc05" id="r_a3fe80a30990d484dcc39b6f9a0befc05"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a3fe80a30990d484dcc39b6f9a0befc05">r_star</a> = 5.0</td></tr>
<tr class="memdesc:a3fe80a30990d484dcc39b6f9a0befc05"><td class="mdescLeft">&#160;</td><td class="mdescRight">Radius of the stellar surface. @toml [main].r_star. <br /></td></tr>
<tr class="separator:a3fe80a30990d484dcc39b6f9a0befc05"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:affad4638b0ae7b710f2b2db992f6f584" id="r_affad4638b0ae7b710f2b2db992f6f584"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#affad4638b0ae7b710f2b2db992f6f584">flattening</a> = 0</td></tr>
<tr class="memdesc:affad4638b0ae7b710f2b2db992f6f584"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flattening factor for spheroidal shaping (0 = spherical, &gt;0 = oblate). @toml [main].flattening. <br /></td></tr>
<tr class="separator:affad4638b0ae7b710f2b2db992f6f584"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7546899ebbfe191ea3a8bf2403b31eb" id="r_ac7546899ebbfe191ea3a8bf2403b31eb"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac7546899ebbfe191ea3a8bf2403b31eb">r_infinity</a> = 6.0</td></tr>
<tr class="memdesc:ac7546899ebbfe191ea3a8bf2403b31eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Outer radius of the external domain when enabled. @toml [main].r_infinity. <br /></td></tr>
<tr class="separator:ac7546899ebbfe191ea3a8bf2403b31eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4da6d99ff7ba24d2f917e1fd98ddd877" id="r_a4da6d99ff7ba24d2f917e1fd98ddd877"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4da6d99ff7ba24d2f917e1fd98ddd877">r_instability</a> = 1e-14</td></tr>
<tr class="memdesc:a4da6d99ff7ba24d2f917e1fd98ddd877"><td class="mdescLeft">&#160;</td><td class="mdescRight">Radius inside which transformations are skipped to avoid singularities. @toml [main].r_instability. <br /></td></tr>
<tr class="separator:a4da6d99ff7ba24d2f917e1fd98ddd877"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aed32864839b149c94842801b6413d94d" id="r_aed32864839b149c94842801b6413d94d"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aed32864839b149c94842801b6413d94d">core_steepness</a> = 1.0</td></tr>
<tr class="memdesc:aed32864839b149c94842801b6413d94d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Controls the smoothness/steepness of the core-to-envelope transition. @toml [main].core_steepness. <br /></td></tr>
<tr class="separator:aed32864839b149c94842801b6413d94d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Configuration parameters for stroid mesh generation. </p>
<p>These values are typically loaded via <code>fourdst::config::Config&lt;<a class="el" href="structstroid_1_1config_1_1_mesh_config.html" title="Configuration parameters for stroid mesh generation.">stroid::config::MeshConfig</a>&gt;</code> from a TOML file. The README shows the expected TOML layout under the <code>[main]</code> table. Unspecified keys use the defaults defined here. </p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="aed32864839b149c94842801b6413d94d" name="aed32864839b149c94842801b6413d94d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed32864839b149c94842801b6413d94d">&#9670;&#160;</a></span>core_steepness</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double stroid::config::MeshConfig::core_steepness = 1.0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Controls the smoothness/steepness of the core-to-envelope transition. @toml [main].core_steepness. </p>
</div>
</div>
<a id="affad4638b0ae7b710f2b2db992f6f584" name="affad4638b0ae7b710f2b2db992f6f584"></a>
<h2 class="memtitle"><span class="permalink"><a href="#affad4638b0ae7b710f2b2db992f6f584">&#9670;&#160;</a></span>flattening</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double stroid::config::MeshConfig::flattening = 0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Flattening factor for spheroidal shaping (0 = spherical, &gt;0 = oblate). @toml [main].flattening. </p>
</div>
</div>
<a id="a062652781f4f3ea0b7ca8764362a7368" name="a062652781f4f3ea0b7ca8764362a7368"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a062652781f4f3ea0b7ca8764362a7368">&#9670;&#160;</a></span>include_external_domain</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool stroid::config::MeshConfig::include_external_domain = false</td>
</tr>
</table>
</div><div class="memdoc">
<p>Whether to include an external domain extending to <code>r_infinity</code>. </p>
<p>Currently this flag does not affect mesh generation. @toml [main].include_external_domain </p>
</div>
</div>
<a id="a860e78f1906acb0c3aa08d55f94de3fd" name="a860e78f1906acb0c3aa08d55f94de3fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a860e78f1906acb0c3aa08d55f94de3fd">&#9670;&#160;</a></span>order</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int stroid::config::MeshConfig::order = 3</td>
</tr>
</table>
</div><div class="memdoc">
<p>Polynomial order for high-order elements. @toml [main].order. </p>
</div>
</div>
<a id="a5c68a895f73dc82a38a8daac22a83ad7" name="a5c68a895f73dc82a38a8daac22a83ad7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c68a895f73dc82a38a8daac22a83ad7">&#9670;&#160;</a></span>r_core</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double stroid::config::MeshConfig::r_core = 1.5</td>
</tr>
</table>
</div><div class="memdoc">
<p>Radius of the stellar core region. @toml [main].r_core. </p>
</div>
</div>
<a id="ac7546899ebbfe191ea3a8bf2403b31eb" name="ac7546899ebbfe191ea3a8bf2403b31eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac7546899ebbfe191ea3a8bf2403b31eb">&#9670;&#160;</a></span>r_infinity</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double stroid::config::MeshConfig::r_infinity = 6.0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Outer radius of the external domain when enabled. @toml [main].r_infinity. </p>
</div>
</div>
<a id="a4da6d99ff7ba24d2f917e1fd98ddd877" name="a4da6d99ff7ba24d2f917e1fd98ddd877"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4da6d99ff7ba24d2f917e1fd98ddd877">&#9670;&#160;</a></span>r_instability</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double stroid::config::MeshConfig::r_instability = 1e-14</td>
</tr>
</table>
</div><div class="memdoc">
<p>Radius inside which transformations are skipped to avoid singularities. @toml [main].r_instability. </p>
</div>
</div>
<a id="a3fe80a30990d484dcc39b6f9a0befc05" name="a3fe80a30990d484dcc39b6f9a0befc05"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3fe80a30990d484dcc39b6f9a0befc05">&#9670;&#160;</a></span>r_star</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double stroid::config::MeshConfig::r_star = 5.0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Radius of the stellar surface. @toml [main].r_star. </p>
</div>
</div>
<a id="a8cafcbebf64ae251517118eb152de981" name="a8cafcbebf64ae251517118eb152de981"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8cafcbebf64ae251517118eb152de981">&#9670;&#160;</a></span>refinement_levels</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int stroid::config::MeshConfig::refinement_levels = 4</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of uniform refinement passes applied after topology creation. @toml [main].refinement_levels. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/include/stroid/config/<a class="el" href="config_8h.html">config.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacestroid.html">stroid</a></li><li class="navelem"><a class="el" href="namespacestroid_1_1config.html">config</a></li><li class="navelem"><a class="el" href="structstroid_1_1config_1_1_mesh_config.html">MeshConfig</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.13.2 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink