PointInSubdomainCheckUO

PointInSubdomainCheckUO performs point-in-polyhedron (in-out) tests for several closed surfaces at once and identifies which subdomain a point belongs to. It builds one ray-casting in-out test per subdomain from the subdomain-grouped boundary elements supplied by a SurfaceMeshBySubdomainBuilder. In addition to a plain inside/outside query, it exposes whichSubdomain, which returns the ID of the first subdomain whose surface contains the point (or the invalid subdomain ID when the point lies outside every surface).

This object is the in-out tester consumed by SubdomainElementModifier to assign background-mesh elements to subdomains.

Usage

Set the builder parameter to the name of a SurfaceMeshBySubdomainBuilder user object. The tolerance parameter controls how close to a surface a point is treated as on it, and leaf_max_size tunes the per-subdomain KDTree. Because the in-out test requires closed, replicated surface meshes, run these tests with mesh_mode = REPLICATED.

In-Out test with subdomain_id identification based on SurfaceMeshBySubdomainBuilder.

Input Parameters

builderThe SurfaceMeshBySubdomainBuilder providing SurfaceElementSets by subdomain_id.
C++ Type:UserObjectName
Controllable:No
Description:The SurfaceMeshBySubdomainBuilder providing SurfaceElementSets by subdomain_id.

Required Parameters

leaf_max_size10Maximum number of elements in a leaf node of the KD-tree.
Default:10
C++ Type:int
Controllable:No
Description:Maximum number of elements in a leaf node of the KD-tree.
obb_file_nameOriented Bounding Box (OBB) debug file name.
C++ Type:FileName
Controllable:No
Description:Oriented Bounding Box (OBB) debug file name.
point_containment_methodpca_rayAlgorithm used for point-containment queries. 'pca_ray' (default) uses the ray-casting engine with a PCA-selected ray; 'user_selected_ray' uses the ray-casting engine with the 'ray_direction' parameter; 'fixed_x_ray' uses the TriangleManifold engine (fixed +x ray, TRI3 surfaces only).
Default:pca_ray
C++ Type:MooseEnum
Options:pca_ray, user_selected_ray, fixed_x_ray
Controllable:No
Description:Algorithm used for point-containment queries. 'pca_ray' (default) uses the ray-casting engine with a PCA-selected ray; 'user_selected_ray' uses the ray-casting engine with the 'ray_direction' parameter; 'fixed_x_ray' uses the TriangleManifold engine (fixed +x ray, TRI3 surfaces only).
ray_direction0 0 0Ray direction for the 'user_selected_ray' method, used exactly as given (no auto-selection). Any finite non-zero direction is allowed, including oblique; for a 2D surface it must lie in the mesh plane (zero z component). The user is responsible for avoiding directions that graze vertices/edges or are tangent to the surface. Other methods ignore this parameter.
Default:0 0 0
C++ Type:libMesh::Point
Controllable:No
Description:Ray direction for the 'user_selected_ray' method, used exactly as given (no auto-selection). Any finite non-zero direction is allowed, including oblique; for a 2D surface it must lie in the mesh plane (zero z component). The user is responsible for avoiding directions that graze vertices/edges or are tangent to the surface. Other methods ignore this parameter.
ray_file_nameRay debug file name.
C++ Type:FileName
Controllable:No
Description:Ray debug file name.
tolerance1e-06Tolerance used for intersection or surface-proximity checks. Determines whether a point is considered on the surface.
Default:1e-06
C++ Type:Real
Unit:(no unit assumed)
Controllable:No
Description:Tolerance used for intersection or surface-proximity checks. Determines whether a point is considered on the surface.

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
Options:XFEM_MARK, FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, NONE, INITIAL, LINEAR, LINEAR_CONVERGENCE, NONLINEAR, NONLINEAR_CONVERGENCE, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, MULTIAPP_FIXED_POINT_CONVERGENCE, MULTISYSTEM_FIXED_POINT_ITERATION_END, FINAL, CUSTOM, TRANSFER
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.

Material Property Retrieval Parameters

Input Files

(modules/shifted_boundary_method/test/tests/subdomain_element_modifier/subdomain_point_query.i)
(modules/shifted_boundary_method/test/tests/subdomain_element_modifier/grain_marking.i)

(modules/shifted_boundary_method/test/tests/subdomain_element_modifier/subdomain_point_query.i)

# Exercises the PointInSubdomainCheckUO point-query accessors directly.
#
# Uses the same five-grain boundary mesh as grain_marking.i, but instead of
# reassigning element subdomains with SubdomainElementModifier, it evaluates the
# in-out test at each background element centroid:
#   - 'which_sub' records whichSubdomain(centroid): the grain (subdomain) ID that
#     contains the centroid, or the invalid-subdomain sentinel if none does.
#   - 'inside' records ifInside(centroid): 1 if the centroid lies in any grain,
#     0 otherwise.
# The resulting elemental fields are written to Exodus for comparison.

[Problem]
  solve = false
[]

[Mesh]
  [boundary_mesh]
    type = FileMeshGenerator
    file = 'grain_5_boundary.msh'
    save_with_name = 'boundary_mesh'
  []
  # Deliberately larger than the grain region [-0.6, 0.6] x [-0.4, 0.4] so that
  # border elements fall outside every grain. This exercises both the matched
  # branch (a grain contains the centroid) and the exhausted-loop branch
  # (no grain does) of whichSubdomain() and ifInside().
  [background_mesh]
    type = GeneratedMeshGenerator
    dim = 2
    xmin = -0.8
    xmax = 0.8
    ymin = -0.55
    ymax = 0.55
    nx = 10
    ny = 8
    subdomain_ids = 0
  []
  final_generator = background_mesh
[]

[UserObjects]
  [surface_builder]
    type = SurfaceMeshBySubdomainBuilder
    surface_mesh = boundary_mesh
  []
  [subdomain_tester]
    type = PointInSubdomainCheckUO
    builder = surface_builder
  []
[]

[AuxVariables]
  [which_sub]
    family = MONOMIAL
    order = CONSTANT
  []
  [inside]
    family = MONOMIAL
    order = CONSTANT
  []
[]

[AuxKernels]
  [which_sub]
    type = PointInSubdomainTestAux
    variable = which_sub
    subdomain_checker = subdomain_tester
    method = which_subdomain
    execute_on = INITIAL
  []
  [inside]
    type = PointInSubdomainTestAux
    variable = inside
    subdomain_checker = subdomain_tester
    method = if_inside
    execute_on = INITIAL
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
[]

(modules/shifted_boundary_method/test/tests/subdomain_element_modifier/grain_marking.i)

# Marks a background mesh with grain (subdomain) IDs using SubdomainElementModifier.
#
# The boundary mesh 'grain_5_boundary.msh' holds five grain-boundary loops
# (subdomains 1-5) that tile the domain [-0.6, 0.6] x [-0.4, 0.4] and meet at
# interior corners. SubdomainElementModifier assigns each background element to
# the grain that contains it; elements straddling a grain corner are assigned to
# the grain occupying the largest active-area fraction (ties broken by lowest
# subdomain ID). The resulting per-subdomain (element block) assignment is written
# to Exodus for comparison.

[Problem]
  solve = false
[]

[Mesh]
  [boundary_mesh]
    type = FileMeshGenerator
    file = 'grain_5_boundary.msh'
    save_with_name = 'boundary_mesh'
  []
  [background_mesh]
    type = GeneratedMeshGenerator
    dim = 2
    xmin = -0.6
    xmax = 0.6
    ymin = -0.4
    ymax = 0.4
    nx = 9
    ny = 6
    subdomain_ids = 0
  []
  final_generator = background_mesh
  add_subdomain_ids = '1 2 3 4 5'
[]

# Unused variable so the Exodus output has a field to write; the test compares the
# per-element subdomain (block) assignment produced by the mesh modifier.
[Variables]
  [u]
  []
[]

[UserObjects]
  [surface_builder]
    type = SurfaceMeshBySubdomainBuilder
    surface_mesh = boundary_mesh
  []
  [subdomain_tester]
    type = PointInSubdomainCheckUO
    builder = surface_builder
  []
[]

[MeshModifiers]
  [assign_subdomains]
    type = SubdomainElementModifier
    subdomain_id_tester = subdomain_tester
    lambda = 0.5
    execute_on = INITIAL
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
[]

Usage
Input Parameters
Input Files