Chi-Tech
chi_mesh__MeshGenerator.h
Go to the documentation of this file.
1/** \defgroup chi_mesh__MeshGenerator chi_mesh.MeshGenerator
2
3
4\ingroup doc_MeshGenerators
5The base class for all mesh generators
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.MeshGenerator.Create(params)
18\endcode
19## Optional 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>inputs</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspA list of handles to MeshGenerator objects</span></button>
41<div class="content" style="display: none;">
42 <p><I>type=</I><span style="color: blue;"><TT>ARRAY</TT></span>. A list of handles to MeshGenerator objects
43</p>
44 <p>Default value: <TT style="color:grey"></TT></p>
45</div>
46
47<button type="button" class="droppy2" style=
48"
49background-color: #edf0f5;
50color: #9373A5;
51cursor: pointer;
52border: none;
53text-align: left;
54outline: none;
55font-size: 15px;
56margin: 2px 2px;
57border: 2px solid #687372;
58display: block;
59width: 100%;
60vertical-align: middle;
61padding-top: 4px;
62padding-bottom: 0px;
63"
64><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>
65<div class="content" style="display: none;">
66 <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
67</p>
68 <p>Default value: <TT style="color:grey">0</TT></p>
69</div>
70
71<button type="button" class="droppy2" style=
72"
73background-color: #edf0f5;
74color: #9373A5;
75cursor: pointer;
76border: none;
77text-align: left;
78outline: none;
79font-size: 15px;
80margin: 2px 2px;
81border: 2px solid #687372;
82display: block;
83width: 100%;
84vertical-align: middle;
85padding-top: 4px;
86padding-bottom: 0px;
87"
88><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>
89<div class="content" style="display: none;">
90 <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
91</p>
92 <p>Default value: <TT style="color:grey">false</TT></p>
93</div>
94
95<button type="button" class="droppy2" style=
96"
97background-color: #edf0f5;
98color: #9373A5;
99cursor: pointer;
100border: none;
101text-align: left;
102outline: none;
103font-size: 15px;
104margin: 2px 2px;
105border: 2px solid #687372;
106display: block;
107width: 100%;
108vertical-align: middle;
109padding-top: 4px;
110padding-bottom: 0px;
111"
112><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>
113<div class="content" style="display: none;">
114 <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Uniform scale to apply to the mesh after reading.
115</p>
116 <p>Default value: <TT style="color:grey">1(double)</TT></p>
117</div>
118
119</div>
120\endhtmlonly
121
122\htmlonly
123
124<script>
125
126{
127 var coll = document.getElementsByClassName("droppy2");
128 var i;
129
130 for (i = 0; i < coll.length; i++) {
131 coll[i].addEventListener("click", function() {
132 this.classList.toggle("active");
133 var content = this.nextElementSibling;
134 if (content.style.display === "block") {
135 content.style.display = "none";
136 this.childNodes[0].innerText = "►"
137 } else {
138 content.style.display = "block";
139 this.children[0].innerText = "▼"
140 }
141 });
142 }
143}</script>
144
145\endhtmlonly
146
147### Usage Examples:
148\ref test_framework_tutorials_tutorial_93_raytracing_lua
149\ref test_framework_tutorials_fv_test2_lua
150\ref test_framework_tutorials_pwlc_test1_lua
151\ref test_framework_tutorials_pwlc_test2_lua
152\ref test_framework_tutorials_tutorial_91a_pwld_lua
153\ref test_framework_tutorials_fv_test1_lua
154\ref test_framework_tutorials_tutorial_06_wdd_lua
155\ref test_framework_chi_math_SpatialDiscretization_CG_mesh_2dtri_lua
156\ref test_framework_chi_math_SpatialDiscretization_CG_mesh_3dprism_lua
157\ref test_framework_chi_math_SpatialDiscretization_CG_mesh_3dtets_lua
158\ref test_framework_chi_math_SpatialDiscretization_CG_mesh_3dortho_lua
159\ref test_framework_chi_math_SpatialDiscretization_CG_mesh_2dortho_lua
160\ref test_framework_chi_math_SpatialDiscretization_CG_mesh_1dortho_lua
161\ref test_framework_chi_math_SpatialDiscretization_CG_mesh_3dhex_lua
162\ref test_framework_chi_math_SpatialDiscretization_DG_mesh_2dtri_lua
163\ref test_framework_chi_math_SpatialDiscretization_DG_mesh_3dprism_lua
164\ref test_framework_chi_math_SpatialDiscretization_DG_mesh_3dtets_lua
165\ref test_framework_chi_math_SpatialDiscretization_DG_mesh_3dortho_lua
166\ref test_framework_chi_math_SpatialDiscretization_DG_mesh_2dortho_lua
167\ref test_framework_chi_math_SpatialDiscretization_DG_mesh_1dortho_lua
168\ref test_framework_chi_math_SpatialDiscretization_DG_mesh_3dhex_lua
169\ref test_framework_chi_mesh_ReadWavefrontObj1_lua
170\ref test_framework_chi_mesh_MeshGenerators_meshgen_exampleA_lua
171\ref test_framework_chi_mesh_MeshGenerators_meshgen_exampleD_lua
172\ref test_framework_chi_mesh_MeshGenerators_meshgen_exampleB_lua
173\ref test_framework_chi_mesh_MeshGenerators_meshgen_exampleC_lua
174\ref test_framework_chi_mesh_MeshGenerators_meshgen_extruder_KBA_lua
175\ref test_framework_chi_mesh_LogicalVolume_lv_rcc_test1_lua
176\ref test_framework_chi_mesh_LogicalVolume_lv_boolean_test1_lua
177\ref test_modules_CFEM_Diffusion_cDiffusion_2D_3a_analytical_coef_lua
178\ref test_modules_CFEM_Diffusion_cDiffusion_2D_2b_RobinBCs_lua
179\ref test_modules_CFEM_Diffusion_cDiffusion_2D_3b_analytical_coef2_lua
180\ref test_modules_CFEM_Diffusion_cDiffusion_2D_2a_DirBCs_lua
181\ref test_modules_CFEM_Diffusion_cDiffusion_2D_1a_linear_lua
182\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2a_DirBCs_lua
183\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3a_analytical_coef_lua
184\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3b_analytical_coef2_lua
185\ref test_modules_DFEM_Diffusion_dDiffusion_2D_2b_RobinBCs_lua
186\ref test_modules_DFEM_Diffusion_dDiffusion_2D_3c_L2_error_MMS_lua
187\ref test_modules_DFEM_Diffusion_dDiffusion_2D_1a_linear_lua
188\ref test_modules_Diffusion_Diffusion1D_IP_lua
189\ref test_modules_Diffusion_Diffusion1D_lua
190\ref test_modules_Diffusion_Diffusion3D_1Poly_IP_lua
191\ref test_modules_Diffusion_Diffusion3D_2Ortho_lua
192\ref test_modules_Diffusion_Diffusion3D_3Unstructured_IP_lua
193\ref test_modules_Diffusion_Diffusion3D_1Poly_lua
194\ref test_modules_Diffusion_Diffusion2D_1Poly_lua
195\ref test_modules_Diffusion_Diffusion2D_1Poly_IP_lua
196\ref test_modules_Diffusion_Diffusion3D_4VTU_lua
197\ref test_modules_Diffusion_Diffusion2D_2Unstructured_lua
198\ref test_modules_Diffusion_Diffusion1D_KBA_lua
199\ref test_modules_Diffusion_Diffusion2D_2Unstructured_IP_lua
200\ref test_modules_Diffusion_Diffusion3D_3Unstructured_lua
201\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_1Monoenergetic_lua
202\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Cyl_Transport2DCyl_2Multigroup_lua
203\ref test_modules_LinearBoltzmannSolvers_DSA_acceleration_diffusion_CFEM_lua
204\ref test_modules_LinearBoltzmannSolvers_DSA_acceleration_diffusion_DFEM_lua
205\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_KEigenvalueMIP1D_1G_lua
206\ref test_modules_LinearBoltzmannSolvers_MGDiffusion_KEigen_utils_QBlock_mesh_lua
207\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport2D_1Poly_lua
208\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport1D_1_lua
209\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3c_response_lua
210\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1a_forward_lua
211\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2a_forward_lua
212\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2b_adjoint_lua
213\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1b_adjoint_lua
214\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_2c_response_lua
215\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3a_forward_lua
216\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_3b_adjoint_lua
217\ref test_modules_LinearBoltzmannSolvers_Transport_Adjoint_Adjoint2D_1c_response_lua
218\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_1_lua
219\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_3_lua
220\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_3_lua
221\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport2D_2_lua
222\ref test_modules_LinearBoltzmannSolvers_Transport_Transient_TransientTransport1D_2_lua
223\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_3Poly_quad_mod_lua
224\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_5PolyA_AniHeteroBndry_lua
225\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_Balance_lua
226\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_5Cycles2_lua
227\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4b_DSA_ortho_lua
228\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_BalanceMG_lua
229\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_lua
230\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1a_Extruder_lua
231\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_4a_DSA_ortho_lua
232\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_6ASplitMesh_lua
233\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_3a_DSA_ortho_lua
234\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part1_lua
235\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_2Unstructured_lua
236\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_6BSplitMesh_lua
237\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_1_lua
238\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_3a_DSA_ortho_lua
239\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part2_lua
240\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport1D_4_DSA_ortho_inf_lua
241\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_4Cycles1_lua
242\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1b_Ortho_lua
243\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_2Unstructured_lua
244\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_parmetis_lua
245\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport1D_1G_CBC_lua
246\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_KEigenvalueTransport1D_1G_lua
247\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_utils_QBlock_mesh_lua
248\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_c5g7_mesh_gmesh_coarse_lua
249\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_c5g7_mesh_gmesh_refined_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*/