- closed_subdomainThe name of the subdomain attribute to be created comprised of the set of all elements of the closed geometry, including the new transition region.
C++ Type:SubdomainName
Controllable:No
Description:The name of the subdomain attribute to be created comprised of the set of all elements of the closed geometry, including the new transition region.
- cut_boundaryThe boundary associated with the mesh cut.
C++ Type:BoundaryName
Controllable:No
Description:The boundary associated with the mesh cut.
- transition_subdomainThe name of the subdomain to be created on the mesh comprised of the set of elements adjacent to the cut surface on one side.
C++ Type:SubdomainName
Controllable:No
Description:The name of the subdomain to be created on the mesh comprised of the set of elements adjacent to the cut surface on one side.
- transition_subdomain_boundaryName to assign boundary of transition subdomain not shared with cut surface.
C++ Type:BoundaryName
Controllable:No
Description:Name to assign boundary of transition subdomain not shared with cut surface.
MFEMCutTransitionSubMesh
Summary
Class to construct an MFEMSubMesh formed from the set of elements that have least one vertex on the specified cut plane, that lie on one side of the plane, and that are restricted to the set of user-specified subdomains.
Overview
An MFEMCutTransitionSubMesh specifies and builds an mfem::ParSubMesh object from a user-specified (interior or exterior) planar cut boundary in a specified closed volumetric subdomain, consisting of all elements that:
Have at least one vertex that lies on the boundary,
Lie on one side of the boundary, and
Are members of the user-specified volumetric subdomain.
These elements are collectively referred to as a 'transition' subdomain of the parent mesh, due to their role in defining minimal domains of support for scalar 'transition' variables used in some methods to enforce global topological constraints on domains with non-trivial topologies.
In addition, MFEMCutTransitionSubMesh modifies attributes on the parent mfem::ParMesh to allow the new transition region and its boundary to be referenced by other kernels and boundary conditions in the problem. Specifically, new domain attribute IDs are added to the mesh, with each unique domain attribute ID belonging to elements now comprising the transition region mapped to a (unique) new domain attribute ID. A new boundary attribute ID is also added, to label the boundary of the transition domain excluding the cut boundary.
For convenience, the following new named attribute sets are added, with names given by the following user-specified parameters:
transition_subdomain, naming the set of all domain attribute IDs consisting the transition regionclosed_subdomain, naming the set of all domain attribute IDs comprising entire closed domain (including the transition region)transition_subdomain_boundary, naming the new boundary attribute ID for the boundary of the transition domain excluding the cut surface.
Existing attribute sets on the mesh, with one or more members labelling subdomains that are split by the new transition subdomain, are also updated to add the new subdomain IDs of the transition region member(s) that previously belonged to those sets. This is to ensure block-restricted properties, like material coefficients, apply to the sets of elements expected whether or not an MFEMCutTransitionSubMesh object is present in the problem.
Further information on the usage of such subdomains to enforce global topological constraints can be found in P. Dular. International Compumag Society Newsletter, 7, no. 2 (2000):4-7.
Example Input File Syntax
[SubMeshes<<<{"href": "../../../syntax/SubMeshes/index.html"}>>>]
[cut]
type = MFEMCutTransitionSubMesh<<<{"description": "Class to construct an MFEMSubMesh formed from the set of elements that have least one vertex on the specified cut plane, that lie on one side of the plane, and that are restricted to the set of user-specified subdomains.", "href": "MFEMCutTransitionSubMesh.html"}>>>
cut_boundary<<<{"description": "The boundary associated with the mesh cut."}>>> = ${coil_cut_surface}
block<<<{"description": "The list of subdomains (names or ids) that this object will be restricted to. Leave empty to apply to all subdomains."}>>> = ${initial_coil_domains}
transition_subdomain<<<{"description": "The name of the subdomain to be created on the mesh comprised of the set of elements adjacent to the cut surface on one side."}>>> = transition_dom
transition_subdomain_boundary<<<{"description": "Name to assign boundary of transition subdomain not shared with cut surface."}>>> = transition_bdr
closed_subdomain<<<{"description": "The name of the subdomain attribute to be created comprised of the set of all elements of the closed geometry, including the new transition region."}>>> = coil_dom
[]
[coil]
type = MFEMDomainSubMesh<<<{"description": "Class to construct an MFEMSubMesh formed from the subspace of the parent mesh restricted to the set of user-specified subdomains.", "href": "MFEMDomainSubMesh.html"}>>>
block<<<{"description": "The list of subdomains (names or ids) that this object will be restricted to. Leave empty to apply to all subdomains."}>>> = coil_dom
execution_order_group<<<{"description": "Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group."}>>> = 2
[]
[]Input Parameters
- blockThe list of subdomains (names or ids) that this object will be restricted to. Leave empty to apply to all subdomains.
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:The list of subdomains (names or ids) that this object will be restricted to. Leave empty to apply to all subdomains.
Optional Parameters
- allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
Default:False
C++ Type:bool
Controllable:No
Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
- execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
Default:TIMESTEP_END
C++ Type:ExecFlagEnum
Controllable:No
Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
- execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
Default:0
C++ Type:int
Controllable:No
Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
- force_postauxFalseForces the UserObject to be executed in POSTAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in POSTAUX
- force_preauxFalseForces the UserObject to be executed in PREAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREAUX
- force_preicFalseForces the UserObject to be executed in PREIC during initial setup
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREIC during initial setup
Execution Scheduling 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.
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Controllable:Yes
Description:Set the enabled status of the MooseObject.
- use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
Default:False
C++ Type:bool
Controllable:No
Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
Advanced Parameters
- prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
C++ Type:MaterialPropertyName
Unit:(no unit assumed)
Controllable:No
Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
- use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
Default:False
C++ Type:bool
Controllable:No
Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.