CoarseMeshExtraElementIDGenerator

Assign coarse element IDs for elements on a mesh based on a coarse mesh.

Overview

This mesh generator adds an extra element integer to an input mesh based on a coarse mesh. The extra element integer of an element on the input mesh is assigned with the element ID of the coarse element containing the centroid of the fine element by default. Users can use the "coarse_mesh_extra_element_id" parameter to use an extra element ID on the coarse mesh for the assignment instead of the default coarse element ID. A reserved name subdomain_id can be used for "coarse_mesh_extra_element_id" for using the subdomain ID on the coarse mesh. Users can optionally check if the fine mesh is embedded in the coarse mesh using the "enforce_mesh_embedding" parameter, i.e. every element on the fine mesh must be contained within one and only one coarse element or a region by "coarse_mesh_extra_element_id" of the coarse mesh. The extra element ID assignment can be restricted to subdomains in the fine mesh by specifying "subdomains". With this parameter, this mesh generator can be called multiple times with different coarse meshes. After the first assignment, subsequent IDs will be offset by the maximum ID found from previous calls.

Input Parameters

  • coarse_meshName of an existing mesh generator as the coarse mesh

    C++ Type:MeshGeneratorName

    Unit:(no unit assumed)

    Controllable:No

    Description:Name of an existing mesh generator as the coarse mesh

  • extra_element_id_nameName for the extra element ID that is added to the input mesh

    C++ Type:std::string

    Unit:(no unit assumed)

    Controllable:No

    Description:Name for the extra element ID that is added to the input mesh

  • inputName of an existing mesh generator to which we assign coarse element IDs

    C++ Type:MeshGeneratorName

    Unit:(no unit assumed)

    Controllable:No

    Description:Name of an existing mesh generator to which we assign coarse element IDs

Required Parameters

  • coarse_mesh_extra_element_idName for the extra element ID that is copied from the coarse mesh (default to element ID)

    C++ Type:std::string

    Unit:(no unit assumed)

    Controllable:No

    Description:Name for the extra element ID that is copied from the coarse mesh (default to element ID)

  • enforce_mesh_embeddingFalseTrue to error out when the input mesh is not embedded in the coarse mesh

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:True to error out when the input mesh is not embedded in the coarse mesh

  • subdomainsSubdomains to apply extra element IDs to.

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

    Unit:(no unit assumed)

    Controllable:No

    Description:Subdomains to apply extra element IDs to.

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.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Set the enabled status of the MooseObject.

  • save_with_nameKeep the mesh from this mesh generator in memory with the name specified

    C++ Type:std::string

    Unit:(no unit assumed)

    Controllable:No

    Description:Keep the mesh from this mesh generator in memory with the name specified

Advanced Parameters

  • nemesisFalseWhether or not to output the mesh file in the nemesisformat (only if output = true)

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Whether or not to output the mesh file in the nemesisformat (only if output = true)

  • outputFalseWhether or not to output the mesh file after generating the mesh

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Whether or not to output the mesh file after generating the mesh

  • show_infoFalseWhether or not to show mesh info after generating the mesh (bounding box, element types, sidesets, nodesets, subdomains, etc)

    Default:False

    C++ Type:bool

    Unit:(no unit assumed)

    Controllable:No

    Description:Whether or not to show mesh info after generating the mesh (bounding box, element types, sidesets, nodesets, subdomains, etc)

Debugging Parameters