Chi-Tech
chi_mesh__OrthogonalMeshGenerator.h
Go to the documentation of this file.
1/** \defgroup chi_mesh__OrthogonalMeshGenerator chi_mesh.OrthogonalMeshGenerator
2
3
4\ingroup doc_MeshGenerators
5Creates orthogonal meshes.
6
7
8## Example usage:
9Create this object:
10\code
11params =
12{
13 param_name1 = value1,
14 param_name2 = value2,
15 --etc.
16}
17chi_mesh.OrthogonalMeshGenerator.Create(params)
18\endcode
19## Required Input parameters
20\htmlonly
21
22<div style="display: block;">
23<button type="button" class="droppy2" style=
24"
25background-color: #edf0f5;
26color: #9373A5;
27cursor: pointer;
28border: none;
29text-align: left;
30outline: none;
31font-size: 15px;
32margin: 2px 2px;
33border: 2px solid #687372;
34display: block;
35width: 100%;
36vertical-align: middle;
37padding-top: 4px;
38padding-bottom: 0px;
39"
40><span class="arrow" style="padding-left: 0px;">►</span><TT><B>node_sets</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspSets of nodes per dimension</span></button>
41<div class="content" style="display: none;">
42 <p><I>type=</I><span style="color: blue;"><TT>ARRAY</TT></span>. Sets of nodes per dimension. Node values must be monotonically increasing
43</p>
44</div>
45
46</div>
47\endhtmlonly
48
49## Optional Input parameters
50\htmlonly
51
52<div style="display: block;">
53<button type="button" class="droppy2" style=
54"
55background-color: #edf0f5;
56color: #9373A5;
57cursor: pointer;
58border: none;
59text-align: left;
60outline: none;
61font-size: 15px;
62margin: 2px 2px;
63border: 2px solid #687372;
64display: block;
65width: 100%;
66vertical-align: middle;
67padding-top: 4px;
68padding-bottom: 0px;
69"
70><span class="arrow" style="padding-left: 0px;">►</span><TT><B>inputs</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspA list of handles to MeshGenerator objects</span></button>
71<div class="content" style="display: none;">
72 <p><I>type=</I><span style="color: blue;"><TT>ARRAY</TT></span>. A list of handles to MeshGenerator objects
73</p>
74 <p>Default value: <TT style="color:grey"></TT></p>
75</div>
76
77<button type="button" class="droppy2" style=
78"
79background-color: #edf0f5;
80color: #9373A5;
81cursor: pointer;
82border: none;
83text-align: left;
84outline: none;
85font-size: 15px;
86margin: 2px 2px;
87border: 2px solid #687372;
88display: block;
89width: 100%;
90vertical-align: middle;
91padding-top: 4px;
92padding-bottom: 0px;
93"
94><span class="arrow" style="padding-left: 0px;">►</span><TT><B>partitioner</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspHandle to a GraphPartitioner object to use for parallel partitioning</span></button>
95<div class="content" style="display: none;">
96 <p><I>type=</I><span style="color: blue;"><TT>INTEGER</TT></span>. Handle to a GraphPartitioner object to use for parallel partitioning.This will default to PETScGraphPartitioner with a "parmetis" setting
97</p>
98 <p>Default value: <TT style="color:grey">0</TT></p>
99</div>
100
101<button type="button" class="droppy2" style=
102"
103background-color: #edf0f5;
104color: #9373A5;
105cursor: pointer;
106border: none;
107text-align: left;
108outline: none;
109font-size: 15px;
110margin: 2px 2px;
111border: 2px solid #687372;
112display: block;
113width: 100%;
114vertical-align: middle;
115padding-top: 4px;
116padding-bottom: 0px;
117"
118><span class="arrow" style="padding-left: 0px;">►</span><TT><B>replicated_mesh</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspFlag, when set, makes the mesh appear in full fidelity on each process</span></button>
119<div class="content" style="display: none;">
120 <p><I>type=</I><span style="color: blue;"><TT>BOOLEAN</TT></span>. Flag, when set, makes the mesh appear in full fidelity on each process
121</p>
122 <p>Default value: <TT style="color:grey">false</TT></p>
123</div>
124
125<button type="button" class="droppy2" style=
126"
127background-color: #edf0f5;
128color: #9373A5;
129cursor: pointer;
130border: none;
131text-align: left;
132outline: none;
133font-size: 15px;
134margin: 2px 2px;
135border: 2px solid #687372;
136display: block;
137width: 100%;
138vertical-align: middle;
139padding-top: 4px;
140padding-bottom: 0px;
141"
142><span class="arrow" style="padding-left: 0px;">►</span><TT><B>scale</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspUniform scale to apply to the mesh after reading</span></button>
143<div class="content" style="display: none;">
144 <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Uniform scale to apply to the mesh after reading.
145</p>
146 <p>Default value: <TT style="color:grey">1(double)</TT></p>
147</div>
148
149</div>
150\endhtmlonly
151
152\htmlonly
153
154<script>
155
156{
157 var coll = document.getElementsByClassName("droppy2");
158 var i;
159
160 for (i = 0; i < coll.length; i++) {
161 coll[i].addEventListener("click", function() {
162 this.classList.toggle("active");
163 var content = this.nextElementSibling;
164 if (content.style.display === "block") {
165 content.style.display = "none";
166 this.childNodes[0].innerText = "►"
167 } else {
168 content.style.display = "block";
169 this.children[0].innerText = "▼"
170 }
171 });
172 }
173}</script>
174
175\endhtmlonly
176
177### Usage Examples:
178\ref test_framework_tutorials_tutorial_93_raytracing_lua
179\ref test_framework_tutorials_fv_test2_lua
180\ref test_framework_tutorials_pwlc_test1_lua
181\ref test_framework_tutorials_pwlc_test2_lua
182\ref test_framework_tutorials_tutorial_91a_pwld_lua
183\ref test_framework_tutorials_fv_test1_lua
184\ref test_framework_tutorials_tutorial_06_wdd_lua
185\ref test_framework_chi_math_SpatialDiscretization_CG_mesh_3dortho_lua
186\ref test_framework_chi_math_SpatialDiscretization_CG_mesh_2dortho_lua
187\ref test_framework_chi_math_SpatialDiscretization_CG_mesh_1dortho_lua
188\ref test_framework_chi_math_SpatialDiscretization_DG_mesh_3dortho_lua
189\ref test_framework_chi_math_SpatialDiscretization_DG_mesh_2dortho_lua
190\ref test_framework_chi_math_SpatialDiscretization_DG_mesh_1dortho_lua
191\ref test_framework_chi_mesh_MeshGenerators_meshgen_exampleA_lua
192\ref test_framework_chi_mesh_LogicalVolume_lv_rcc_test1_lua
193\ref test_framework_chi_mesh_LogicalVolume_lv_boolean_test1_lua
194\ref test_modules_CFEM_Diffusion_cDiffusion_2D_3a_analytical_coef_lua
195\ref test_modules_CFEM_Diffusion_cDiffusion_2D_2b_RobinBCs_lua
196\ref test_modules_CFEM_Diffusion_cDiffusion_2D_3b_analytical_coef2_lua
197\ref test_modules_CFEM_Diffusion_cDiffusion_2D_2a_DirBCs_lua
198\ref test_modules_CFEM_Diffusion_cDiffusion_2D_1a_linear_lua
199\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2a_DirBCs_lua
200\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3a_analytical_coef_lua
201\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3b_analytical_coef2_lua
202\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2b_RobinBCs_lua
203\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3c_L2_error_MMS_lua
204\ref test_modules_DFEM_Diffusion_dDiffusion_2D_1a_linear_lua
205\ref test_modules_Diffusion_Diffusion1D_IP_lua
206\ref test_modules_Diffusion_Diffusion1D_lua
207\ref test_modules_Diffusion_Diffusion3D_1Poly_IP_lua
208\ref test_modules_Diffusion_Diffusion3D_2Ortho_lua
209\ref test_modules_Diffusion_Diffusion3D_1Poly_lua
210\ref test_modules_Diffusion_Diffusion2D_1Poly_lua
211\ref test_modules_Diffusion_Diffusion2D_1Poly_IP_lua
212\ref test_modules_Diffusion_Diffusion1D_KBA_lua
213\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua
214\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_2Multigroup_lua
215\ref test_modules_LinearBoltzmannSolvers_DSA_acceleration_diffusion_CFEM_lua
216\ref test_modules_LinearBoltzmannSolvers_DSA_acceleration_diffusion_DFEM_lua
217\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_KEigenvalueMIP1D_1G_lua
218\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_utils_QBlock_mesh_lua
219\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport1D_1_lua
220\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3c_response_lua
221\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1a_forward_lua
222\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2a_forward_lua
223\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2b_adjoint_lua
224\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1b_adjoint_lua
225\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2c_response_lua
226\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3a_forward_lua
227\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3b_adjoint_lua
228\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1c_response_lua
229\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
230\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
231\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
232\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
233\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
234\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_5PolyA_AniHeteroBndry_lua
235\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_Balance_lua
236\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4b_DSA_ortho_lua
237\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_BalanceMG_lua
238\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4a_DSA_ortho_lua
239\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_6ASplitMesh_lua
240\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_3a_DSA_ortho_lua
241\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_6BSplitMesh_lua
242\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_1_lua
243\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_3a_DSA_ortho_lua
244\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_4_DSA_ortho_inf_lua
245\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1b_Ortho_lua
246\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_parmetis_lua
247\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport1D_1G_CBC_lua
248\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport1D_1G_lua
249\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_utils_QBlock_mesh_lua
250\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_3a_DSA_ortho_lua
251\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_Steady_MIPDiffusion3D_1b_Ortho_lua
252*/