BatchMeshGeneratorAction

Overview

This Action is capable of batch generating a series of meshes using a single type of mesh generator with variation in one or multiple input parameters.

The type of mesh generator to be used for batch generation is provided by "mesh_generator_type". To batch generate meshes using the selected type of mesh generator, users need to provide both "fixed" input parameters, which keep constant throughout the batch mesh generation, and "batch" input parameters, which vary among generated meshes. For both "fixed" and "batch" input parameters, they can be either scalar or vector types.

Specifying Input Parameters

Fixed Input Parameters

Both scalar and vector types of fixed input parameters are supported by this Action.

Names of multiple fixed scalar input parameters can be defined by "fixed_scalar_input_param_names", with their corresponding types defined by "fixed_scalar_input_param_types". In the meantime, the values of these fixed scalar input parameters need to be provided through "fixed_scalar_input_param_values".

On the other hand, names and the corresponding types of multiple fixed vector input parameters can be specified by "fixed_vector_input_param_names" and "fixed_vector_input_param_types", respectively. The values of these fixed vector input parameters are provided through "fixed_vector_input_param_values".

Batch Input Parameters

Likewise, both scalar and vector types of batch input parameters are supported by this Action.

Similar to the scalar and vector types of fixed input parameters, the names, types, and values of the batch scalar and vector input parameters can be specified using "batch_scalar_input_param_names", "batch_scalar_input_param_types", "batch_scalar_input_param_values"; as well as "batch_vector_input_param_names", "batch_vector_input_param_types", "batch_vector_input_param_values", respectively. Note that for the batch input parameters, because variation is needed, the dimensions of "batch_scalar_input_param_values" and "batch_vector_input_param_values" are higher than their fixed counterparts by 1.

Types of Input Parameters

The supported input parameter types are summarized in Table 1 for both scalar and vector types.

Table 1: Summary of the symbols used for supported types of input parameters.

C++ Vector Data Type	C++ Scalar Data Type	Syntax
`vector<Real>`	`Real`	`REAL`
`vector<short>`	`short`	`SHORT`
`vector<unsigned short>`	`unsigned short`	`USHORT`
`vector<int>`	`int`	`INT`
`vector<unsigned int>`	`unsigned int`	`UINT`
`vector<string>`	`string`	`STRING`
`vector<SubdomainName>`	`SubdomainName`	`SDNAME`
`vector<BoundaryName>`	`BoundaryName`	`BDNAME`
`vector<MeshGeneratorName>`	`MeshGeneratorName`	`MGNAME`
`vector<MeshFileName>`	`MeshFileName`	`MFNAME`
`MultiMooseEnum`	`MooseEnum`	`ENUM`
`vector<bool>`	`bool`	`BOOL`

It it worth mentioning that some common input parameter types, such as subdomain_id_type and boundary_id_type, are subject to change at compile time. Users should check the documentation after compilation for the actual integer types. The error message generated by this action can also provide some information.

Methods to Process Multiple Batch Input Parameters

Cartesian Product and Corresponding Methods

If more than one batch input parameters (either scalar or vector) are provided, two methods can be selected using "multi_batch_params_method".

The default method is cartesian_product, which batch generates mesh generators based on the Cartesian product of all the batch input parameters. For example, if m scalar input parameters are specified using "batch_scalar_input_param_names", with the corresponding "batch_scalar_input_param_values" containing $var element = document.getElementById("moose-equation-6c95ebc4-d64c-42f8-9a5a-fad2dbda47e0");katex.render("N_{s,1}", element, {displayMode:false,throwOnError:false});$ , $var element = document.getElementById("moose-equation-eca89f8f-1bf9-444d-9c9f-d1218923a567");katex.render("N_{s,2}", element, {displayMode:false,throwOnError:false});$ ,..., and $var element = document.getElementById("moose-equation-34bec3b6-3a79-4f4a-9baa-14a1c0785ce6");katex.render("N_{s,m}", element, {displayMode:false,throwOnError:false});$ variations, respectively. Meanwhile, if n vector input parameters are specified using "batch_vector_input_param_names", with the corresponding "batch_vector_input_param_values" containing $var element = document.getElementById("moose-equation-62ed199b-2f9f-4f57-8326-9062f1b70891");katex.render("N_{v,1}", element, {displayMode:false,throwOnError:false});$ , $var element = document.getElementById("moose-equation-c4a7e224-663e-444e-a847-ab8638a78e60");katex.render("N_{v,2}", element, {displayMode:false,throwOnError:false});$ ,..., and $var element = document.getElementById("moose-equation-d40fbc76-5445-4078-982e-de7bb7e0faaa");katex.render("N_{v,n}", element, {displayMode:false,throwOnError:false});$ variations. Using the Cartesian product approach leads to a total of $var element = document.getElementById("moose-equation-869066c0-6941-443b-a5c5-57328a45df24");katex.render("\\prod_{i=0}^{m} N_{s,i}\\prod_{j=0}^{n} N_{v,j}", element, {displayMode:false,throwOnError:false});$ mesh generators.

On the other hand, an alternative method is corresponding, which requires the numbers of variations for all "batch_scalar_input_param_names" and "batch_vector_input_param_names" to be the same (e.g., $var element = document.getElementById("moose-equation-12cb9179-ba7c-4f53-963a-3d4646c82151");katex.render("N", element, {displayMode:false,throwOnError:false});$ ). In that case, only $var element = document.getElementById("moose-equation-0e0a3a54-5b6a-45c6-a981-726241cd3a36");katex.render("N", element, {displayMode:false,throwOnError:false});$ mesh generators are created.

Naming and Indexing of the Generated Meshes

The generated meshes are named with a prefix as defined in "mesh_name_prefix", followed by an index.

For the corresponding method, the index is determined by the order of the provided batch input parameters starting from 0. For example, if $var element = document.getElementById("moose-equation-ee479d18-b8ce-4718-8d90-15a6c8b55134");katex.render("N", element, {displayMode:false,throwOnError:false});$ sets of batch input parameters are provided, the generated meshes are named as [mesh_name_prefix]_0, [mesh_name_prefix]_1, ..., [mesh_name_prefix]_{N-1}.

For the cartesian_product method, by default, a single index is used for all the batch input parameters. The indexing will first transverse the batch scalar input parameters from the first to the last, and then the batch vector input parameters from the first to the last. Optionally, users can choose to decompose the index into multiple indices for each batch input parameter by setting "use_decomposed_index" as true. In that case, the generated meshes are named as mesh_name_prefix_{ $var element = document.getElementById("moose-equation-b2e3ca31-01cb-42ef-8e52-d65686cb9daa");katex.render("i_{s_1}", element, {displayMode:false,throwOnError:false});$ }_{ $var element = document.getElementById("moose-equation-9ed3f9ca-ad87-40ae-acaf-0e5bdebf8f28");katex.render("i_{s_2}", element, {displayMode:false,throwOnError:false});$ }_..._{ $var element = document.getElementById("moose-equation-f62b9e35-cb67-46e3-b721-c9c7da06dbd2");katex.render("i_{s_m}", element, {displayMode:false,throwOnError:false});$ }_{ $var element = document.getElementById("moose-equation-1ec226ca-93d6-44f8-bd5d-0aae95d96157");katex.render("i_{v_1}", element, {displayMode:false,throwOnError:false});$ }_{ $var element = document.getElementById("moose-equation-ab15b6e9-7b19-435a-9150-67833a0b1e89");katex.render("i_{v_2}", element, {displayMode:false,throwOnError:false});$ }_..._{ $var element = document.getElementById("moose-equation-1a8178b7-ec30-44a5-9f58-dcf0ad8bbd19");katex.render("i_{v_n}", element, {displayMode:false,throwOnError:false});$ }, where $var element = document.getElementById("moose-equation-9381aea8-5cd2-4536-804e-3680f640067e");katex.render("i_{s_1}", element, {displayMode:false,throwOnError:false});$ , $var element = document.getElementById("moose-equation-4bbbe37b-4071-4687-88e7-3256a09bd9d9");katex.render("i_{s_2}", element, {displayMode:false,throwOnError:false});$ , ..., $var element = document.getElementById("moose-equation-48ec2701-3681-40d7-8418-c3bb2c9a2704");katex.render("i_{s_m}", element, {displayMode:false,throwOnError:false});$ are the indices for the batch scalar input parameters starting from 0, and $var element = document.getElementById("moose-equation-6731fc65-5af7-4c7a-8557-63a4c1e4478a");katex.render("i_{v_1}", element, {displayMode:false,throwOnError:false});$ , $var element = document.getElementById("moose-equation-051853ee-fa5d-4707-9328-140be149ae7b");katex.render("i_{v_2}", element, {displayMode:false,throwOnError:false});$ , ..., $var element = document.getElementById("moose-equation-5f23be12-d8f0-44d7-94c7-3ccf057163ba");katex.render("i_{v_n}", element, {displayMode:false,throwOnError:false});$ are the indices for the batch vector input parameters starting from 0.

For example, if there are two batch scalar input parameters, $var element = document.getElementById("moose-equation-16cff8b3-d46f-4997-811f-905ef7b59717");katex.render("s_1", element, {displayMode:false,throwOnError:false});$ with 2 variations and $var element = document.getElementById("moose-equation-3fdc5e18-eb0d-47ad-bd0f-eb48a51ca388");katex.render("s_2", element, {displayMode:false,throwOnError:false});$ with 3 variations, and one batch vector input parameter, $var element = document.getElementById("moose-equation-91ccb210-fc86-4db7-8a4b-0b45637e6620");katex.render("v_1", element, {displayMode:false,throwOnError:false});$ with 2 variations, the generated meshes are named and indexed as shown in Table 2.

Table 2: Comparison between single and decomposed indexing.

$var element = document.getElementById("moose-equation-af3b8993-1a5c-43df-916e-a17c0104cde9");katex.render("s_1", element, {displayMode:false,throwOnError:false});$	$var element = document.getElementById("moose-equation-8b8ae479-4cd9-4016-ac50-f784ce5cf099");katex.render("s_2", element, {displayMode:false,throwOnError:false});$	$var element = document.getElementById("moose-equation-79e78387-153d-4dc4-a9b6-de6e12c1c19a");katex.render("v_1", element, {displayMode:false,throwOnError:false});$	Single Indexing	Decomposed Indexing
0	0	0	`mesh_name_prefix_0`	`mesh_name_prefix_0_0_0`
1	0	0	`mesh_name_prefix_1`	`mesh_name_prefix_1_0_0`
0	1	0	`mesh_name_prefix_2`	`mesh_name_prefix_0_1_0`
1	1	0	`mesh_name_prefix_3`	`mesh_name_prefix_1_1_0`
0	2	0	`mesh_name_prefix_4`	`mesh_name_prefix_0_2_0`
1	2	0	`mesh_name_prefix_5`	`mesh_name_prefix_1_2_0`
0	0	1	`mesh_name_prefix_6`	`mesh_name_prefix_0_0_1`
1	0	1	`mesh_name_prefix_7`	`mesh_name_prefix_1_0_1`
0	1	1	`mesh_name_prefix_8`	`mesh_name_prefix_0_1_1`
1	1	1	`mesh_name_prefix_9`	`mesh_name_prefix_1_1_1`
0	2	1	`mesh_name_prefix_10`	`mesh_name_prefix_0_2_1`
1	2	1	`mesh_name_prefix_11`	`mesh_name_prefix_1_2_1`

Input Parameters

mesh_generator_typeType of the mesh generator to be batch generated.
C++ Type:std::string
Controllable:No
Description:Type of the mesh generator to be batch generated.
mesh_name_prefixPrefix name of the meshes to be batch generated.
C++ Type:std::string
Controllable:No
Description:Prefix name of the meshes to be batch generated.

Required Parameters

active__all__ If specified only the blocks named will be visited and made active
Default:__all__
C++ Type:std::vector<std::string>
Controllable:No
Description:If specified only the blocks named will be visited and made active
inactiveIf specified blocks matching these identifiers will be skipped.
C++ Type:std::vector<std::string>
Controllable:No
Description:If specified blocks matching these identifiers will be skipped.
multi_batch_params_methodcartesian_productMethod to generate multiple batch parameters.Options: corresponding cartesian_product
Default:cartesian_product
C++ Type:MooseEnum
Options:corresponding, cartesian_product
Controllable:No
Description:Method to generate multiple batch parameters.Options: corresponding cartesian_product
use_decomposed_indexFalseWhether to use the decomposed index for the mesh name (only effective for the cartesian_product method).
Default:False
C++ Type:bool
Controllable:No
Description:Whether to use the decomposed index for the mesh name (only effective for the cartesian_product method).

Optional Parameters

batch_scalar_input_param_namesNames of the scalar input parameters to be altered.
C++ Type:std::vector<std::string>
Controllable:No
Description:Names of the scalar input parameters to be altered.
batch_scalar_input_param_typesTypes of the scalar input parameters to be altered in each generator of the batch.
C++ Type:MultiMooseEnum
Options:BOOL, REAL, SHORT, USHORT, INT, UINT, STRING, SDNAME, BDRYNAME, MGNAME, MFNAME, ENUM
Controllable:No
Description:Types of the scalar input parameters to be altered in each generator of the batch.
batch_scalar_input_param_valuesValues of the scalar input parameters to be assigned.
C++ Type:std::vector<std::vector<std::string>>
Controllable:No
Description:Values of the scalar input parameters to be assigned.
batch_vector_input_param_namesName of the vector input parameters to be altered.
C++ Type:std::vector<std::string>
Controllable:No
Description:Name of the vector input parameters to be altered.
batch_vector_input_param_typesType of the vector input parameters to be altered.
C++ Type:MultiMooseEnum
Options:BOOL, REAL, SHORT, USHORT, INT, UINT, STRING, SDNAME, BDRYNAME, MGNAME, MFNAME, ENUM
Controllable:No
Description:Type of the vector input parameters to be altered.
batch_vector_input_param_valuesValues of the vector input parameters to be assigned.
C++ Type:std::vector<std::vector<std::vector<std::string, std::allocator<std::string>>>>
Controllable:No
Description:Values of the vector input parameters to be assigned.

Batch Input Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.

Advanced Parameters

fixed_scalar_input_param_namesNames of the input parameters to be fixed.
C++ Type:std::vector<std::string>
Controllable:No
Description:Names of the input parameters to be fixed.
fixed_scalar_input_param_typesTypes of the input parameters to be fixed.
C++ Type:MultiMooseEnum
Options:BOOL, REAL, SHORT, USHORT, INT, UINT, STRING, SDNAME, BDRYNAME, MGNAME, MFNAME, ENUM
Controllable:No
Description:Types of the input parameters to be fixed.
fixed_scalar_input_param_valuesValues of the input parameters to be fixed.
C++ Type:std::vector<std::string>
Controllable:No
Description:Values of the input parameters to be fixed.
fixed_vector_input_param_namesNames of the input vector parameters to be fixed.
C++ Type:std::vector<std::string>
Controllable:No
Description:Names of the input vector parameters to be fixed.
fixed_vector_input_param_typesTypes of the input vector parameters to be fixed.
C++ Type:MultiMooseEnum
Options:BOOL, REAL, SHORT, USHORT, INT, UINT, STRING, SDNAME, BDRYNAME, MGNAME, MFNAME, ENUM
Controllable:No
Description:Types of the input vector parameters to be fixed.
fixed_vector_input_param_valuesValues of the input vector parameters to be fixed.
C++ Type:std::vector<std::vector<std::string>>
Controllable:No
Description:Values of the input vector parameters to be fixed.

Fixed Input Parameters

Overview
Specifying Input Parameters
Methods to Process Multiple Batch Input Parameters
Input Parameters