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 paragraph

  • the mesh used by a MeshGeneratorComponent should be a saved mesh, using the "save_with_name" parameter of mesh generators

  • the mesh used should likely not be present in the [Mesh] block final mesh, as they would overlap with the MeshGeneratorComponent mesh. 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

  • mesh_generatorMesh generator providing the mesh

    C++ Type:MeshGeneratorName

    Unit:(no unit assumed)

    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

    Unit:(no unit assumed)

    Options:saved_mesh, final_generator

    Controllable:No

    Description:Whether the mesh generator providing the mesh is the final mesh generator, or simply provides a 'saved_mesh'

Required Parameters

  • active__all__ If specified only the blocks named will be visited and made active

    Default:__all__

    C++ Type:std::vector<std::string>

    Unit:(no unit assumed)

    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>

    Unit:(no unit assumed)

    Controllable:No

    Description:If specified blocks matching these identifiers will be skipped.

  • physicsPhysics object(s) active on the Component

    C++ Type:std::vector<PhysicsName>

    Unit:(no unit assumed)

    Controllable:No

    Description:Physics object(s) active on the Component

  • saved_mesh_nameName used to generate the mesh

    C++ Type:std::string

    Unit:(no unit assumed)

    Controllable:No

    Description:Name used to generate the mesh

  • verboseFalseWhether the component setup should be verbose

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    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>

    Unit:(no unit assumed)

    Controllable:No

    Description:Adds user-defined labels for accessing object parameters via control logic.

Advanced Parameters