- mesh_generatorMesh generator providing the mesh
C++ Type:MeshGeneratorName
Controllable:No
Description:Mesh generator providing the mesh
- mesh_generator_typeWhether the mesh generator providing the mesh is the final mesh generator, or simply provides a 'saved_mesh'
C++ Type:MooseEnum
Controllable:No
Description:Whether the mesh generator providing the mesh is the final mesh generator, or simply provides a 'saved_mesh'
MeshGeneratorComponent
The MeshGeneratorComponent is a geometrical component which lives on the mesh output by a mesh generator. The component's block restriction is set to the blocks of mesh generated by this mesh generator.
Using saved meshes
When using the 'saved_mesh' option for the "mesh_generator_type" parameter,
the final mesh generator should be specified in the
[Mesh]block, as explained in this paragraphthe mesh used by a
MeshGeneratorComponentshould be a saved mesh, using the "save_with_name" parameter of mesh generatorsthe mesh used should likely not be present in the
[Mesh]block final mesh, as they would overlap with theMeshGeneratorComponentmesh. The saved mesh is added to the final mesh.the blocks on the saved mesh must have different block IDs and names from the other parts of the simulation mesh, as the spatial definition of the component is based on the saved mesh's blocks. We strongly recommend using a prefix to distinguish the component's blocks' names. A RenameBlockGenerator can be used for that purpose.
Using the final mesh generator
When using the 'final_generator' option for the "mesh_generator_type" parameter, the mesh will not be duplicated; the final mesh from the Mesh block will be used.
Input Parameters
- physicsPhysics object(s) active on the Component
C++ Type:std::vector<PhysicsName>
Controllable:No
Description:Physics object(s) active on the Component
- saved_mesh_nameName used to generate the mesh
C++ Type:std::string
Controllable:No
Description:Name used to generate the mesh
- verboseFalseWhether the component setup should be verbose
Default:False
C++ Type:bool
Controllable:No
Description:Whether the component setup should be verbose
Optional 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
- define_functor_propertiesTrueIf true, define functor properties from the values provided
Default:True
C++ Type:bool
Controllable:No
Description:If true, define functor properties from the values provided
- define_material_propertiesTrueIf true, define material properties from the values provided
Default:True
C++ Type:bool
Controllable:No
Description:If true, define material properties from the values provided
- property_namesList of material properties that should be defined on this ActionComponent
C++ Type:std::vector<std::string>
Controllable:No
Description:List of material properties that should be defined on this ActionComponent
- property_valuesFunctors that provide the values of the material property on this ActionComponent
C++ Type:std::vector<MooseFunctorName>
Unit:(no unit assumed)
Controllable:No
Description:Functors that provide the values of the material property on this ActionComponent
- use_ad_for_propertiesTrueWhether to use automatic differentiation for the properties defined
Default:True
C++ Type:bool
Controllable:No
Description:Whether to use automatic differentiation for the properties defined
Material And Functor Property Parameters
- fixed_value_bc_boundariesBoundaries on which to apply the fixed value boundary condition(s). Outer ordering is variables, inner order is surfaces
C++ Type:std::vector<std::vector<BoundaryName>>
Controllable:No
Description:Boundaries on which to apply the fixed value boundary condition(s). Outer ordering is variables, inner order is surfaces
- fixed_value_bc_valuesFunctors that provide the fixed value boundary condition(s) values. Outer ordering is variables, inner order is surfaces
C++ Type:std::vector<std::vector<MooseFunctorName>>
Unit:(no unit assumed)
Controllable:No
Description:Functors that provide the fixed value boundary condition(s) values. Outer ordering is variables, inner order is surfaces
- fixed_value_bc_variablesList of variables that have fixed value boundary condition(s) defined on this component
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:List of variables that have fixed value boundary condition(s) defined on this component
- flux_bc_boundariesBoundaries on which to apply the flux boundary condition(s). Outer ordering is variables, inner order is surfaces
C++ Type:std::vector<std::vector<BoundaryName>>
Controllable:No
Description:Boundaries on which to apply the flux boundary condition(s). Outer ordering is variables, inner order is surfaces
- flux_bc_valuesFunctors that provide the flux boundary condition(s) values. Outer ordering is variables, inner order is surfaces
C++ Type:std::vector<std::vector<MooseFunctorName>>
Unit:(no unit assumed)
Controllable:No
Description:Functors that provide the flux boundary condition(s) values. Outer ordering is variables, inner order is surfaces
- flux_bc_variablesList of variables that have flux boundary condition(s) defined on this component
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:List of variables that have flux boundary condition(s) defined on this component
Variable Boundary Conditions Parameters
- initial_condition_valuesFunctors that provide the initial values of the variables on this ActionComponent
C++ Type:std::vector<MooseFunctorName>
Unit:(no unit assumed)
Controllable:No
Description:Functors that provide the initial values of the variables on this ActionComponent
- initial_condition_variablesList of variables that should have an initial condition defined on the blocks of this ActionComponent
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:List of variables that should have an initial condition defined on the blocks of this ActionComponent