Chi-Tech
chi_mesh__FromFileMeshGenerator.h
Go to the documentation of this file.
1/** \defgroup chi_mesh__FromFileMeshGenerator chi_mesh.FromFileMeshGenerator
2
3
4\ingroup doc_MeshGenerators
5Generator for loading an unpartitioned mesh from a file.
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.FromFileMeshGenerator.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>filename</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspPath to the file</span></button>
41<div class="content" style="display: none;">
42 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. Path to the file.
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>boundary_id_fieldname</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspThe name of the field storing boundary-ids</span></button>
71<div class="content" style="display: none;">
72 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. The name of the field storing boundary-ids
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>inputs</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspA list of handles to MeshGenerator objects</span></button>
95<div class="content" style="display: none;">
96 <p><I>type=</I><span style="color: blue;"><TT>ARRAY</TT></span>. A list of handles to MeshGenerator objects
97</p>
98 <p>Default value: <TT style="color:grey"></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>material_id_fieldname</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspThe name of the field storing cell block/material ids</span></button>
119<div class="content" style="display: none;">
120 <p><I>type=</I><span style="color: blue;"><TT>STRING</TT></span>. The name of the field storing cell block/material ids. Only really used for .vtu, .pvtu and .e files.
121</p>
122 <p>Default value: <TT style="color:grey">"BlockID"</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>partitioner</B></TT><span style="color: #c4c1c0;">&nbsp &nbsp &nbsp &nbspHandle to a GraphPartitioner object to use for parallel partitioning</span></button>
143<div class="content" style="display: none;">
144 <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
145</p>
146 <p>Default value: <TT style="color:grey">0</TT></p>
147</div>
148
149<button type="button" class="droppy2" style=
150"
151background-color: #edf0f5;
152color: #9373A5;
153cursor: pointer;
154border: none;
155text-align: left;
156outline: none;
157font-size: 15px;
158margin: 2px 2px;
159border: 2px solid #687372;
160display: block;
161width: 100%;
162vertical-align: middle;
163padding-top: 4px;
164padding-bottom: 0px;
165"
166><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>
167<div class="content" style="display: none;">
168 <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
169</p>
170 <p>Default value: <TT style="color:grey">false</TT></p>
171</div>
172
173<button type="button" class="droppy2" style=
174"
175background-color: #edf0f5;
176color: #9373A5;
177cursor: pointer;
178border: none;
179text-align: left;
180outline: none;
181font-size: 15px;
182margin: 2px 2px;
183border: 2px solid #687372;
184display: block;
185width: 100%;
186vertical-align: middle;
187padding-top: 4px;
188padding-bottom: 0px;
189"
190><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>
191<div class="content" style="display: none;">
192 <p><I>type=</I><span style="color: blue;"><TT>FLOAT</TT></span>. Uniform scale to apply to the mesh after reading.
193</p>
194 <p>Default value: <TT style="color:grey">1(double)</TT></p>
195</div>
196
197</div>
198\endhtmlonly
199
200\htmlonly
201
202<script>
203
204{
205 var coll = document.getElementsByClassName("droppy2");
206 var i;
207
208 for (i = 0; i < coll.length; i++) {
209 coll[i].addEventListener("click", function() {
210 this.classList.toggle("active");
211 var content = this.nextElementSibling;
212 if (content.style.display === "block") {
213 content.style.display = "none";
214 this.childNodes[0].innerText = "►"
215 } else {
216 content.style.display = "block";
217 this.children[0].innerText = "▼"
218 }
219 });
220 }
221}</script>
222
223\endhtmlonly
224
225### Usage Examples:
226\ref test_framework_chi_math_SpatialDiscretization_CG_mesh_2dtri_lua
227\ref test_framework_chi_math_SpatialDiscretization_CG_mesh_3dprism_lua
228\ref test_framework_chi_math_SpatialDiscretization_CG_mesh_3dtets_lua
229\ref test_framework_chi_math_SpatialDiscretization_CG_mesh_3dhex_lua
230\ref test_framework_chi_math_SpatialDiscretization_DG_mesh_2dtri_lua
231\ref test_framework_chi_math_SpatialDiscretization_DG_mesh_3dprism_lua
232\ref test_framework_chi_math_SpatialDiscretization_DG_mesh_3dtets_lua
233\ref test_framework_chi_math_SpatialDiscretization_DG_mesh_3dhex_lua
234\ref test_framework_chi_mesh_ReadWavefrontObj1_lua
235\ref test_framework_chi_mesh_MeshGenerators_meshgen_exampleD_lua
236\ref test_framework_chi_mesh_MeshGenerators_meshgen_exampleB_lua
237\ref test_framework_chi_mesh_MeshGenerators_meshgen_exampleC_lua
238\ref test_framework_chi_mesh_MeshGenerators_meshgen_extruder_KBA_lua
239\ref test_modules_Diffusion_Diffusion3D_3Unstructured_IP_lua
240\ref test_modules_Diffusion_Diffusion3D_4VTU_lua
241\ref test_modules_Diffusion_Diffusion2D_2Unstructured_lua
242\ref test_modules_Diffusion_Diffusion2D_2Unstructured_IP_lua
243\ref test_modules_Diffusion_Diffusion3D_3Unstructured_lua
244\ref test_modules_LinearBoltzmannSolvers_Transport_SteadyCBC_Transport2D_1Poly_lua
245\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_3Poly_quad_mod_lua
246\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_5Cycles2_lua
247\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_1Poly_lua
248\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1a_Extruder_lua
249\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part1_lua
250\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_2Unstructured_lua
251\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_1Poly_qmom_part2_lua
252\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport3D_4Cycles1_lua
253\ref test_modules_LinearBoltzmannSolvers_Transport_Steady_Transport2D_2Unstructured_lua
254\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_c5g7_mesh_gmesh_coarse_lua
255\ref test_modules_LinearBoltzmannSolvers_Transport_Keigen_c5g7_mesh_gmesh_refined_lua
256*/