PointInPolyhedronCheckUO

PointInPolyhedronCheckUO determines whether a point is inside, outside, or on a single closed surface mesh. It obtains the surface mesh and the surface-element wrappers from a BoundaryMeshBuilder named through the builder parameter, and reports a per-point classification. Points on the surface are treated as inside. The object overrides spatialValue() (1 for inside/on, 0 for outside), so it works directly with SpatialUserObjectAux.

Point-containment methods

The point_containment_method parameter selects the classification backend:

pca_ray (default) casts a ray from the query point and counts surface-element crossings, using a direction chosen automatically from a principal-component analysis of the surface. Supports 2-D EDGE2 and 3-D TRI3 surfaces.
user_selected_ray uses the same ray-casting engine but with the direction given by the ray_direction parameter, used exactly as supplied (no automatic selection or replacement). Any finite, non-zero direction is allowed, including oblique ones; for a 2-D surface the direction must lie in the mesh plane (zero z component). The user is responsible for avoiding directions that graze a vertex or edge or run tangent to the surface; such an ambiguous query is reported as an error rather than silently redirected. Supports 2-D EDGE2 and 3-D TRI3 surfaces.
fixed_x_ray uses the TriangleManifold engine (a fixed +x ray with a solid-angle fallback). This engine supports only 3-D TRI3 surfaces and does not produce OBB/ray debug files.

ray_direction is meaningful only for user_selected_ray; it must be non-zero there and must be left unset for the other methods. obb_file_name and ray_file_name request debug output from the ray-casting backends; with fixed_x_ray they are ignored and an informational message is emitted.

Usage

Set builder to the name of a BoundaryMeshBuilder user object. tolerance controls how close to the surface a point is treated as on it, and leaf_max_size tunes the KD-tree used by the ray-casting backends. Because the in-out test requires a closed, replicated surface mesh, run these cases with mesh_mode = REPLICATED.

The containment result is available through the standard spatial user object interface. A SpatialUserObjectAux evaluates it at mesh nodes or element centroids and stores the result in an auxiliary variable. A SpatialUserObjectVectorPostprocessor evaluates it at explicitly specified points and writes the values in the same order as the points parameter. Both interfaces report 1 for SurfaceSide::INSIDE or SurfaceSide::ON and 0 for SurfaceSide::OUTSIDE.

Composition into a union

PointInPolyhedronCheckUO implements the point-in-surface check interface, so it can be listed as a provider of a PointInUnionCheckUO to contribute a meshed closed surface to a composite geometry.

The following complete input creates a closed surface, configures a PointInPolyhedronCheckUO, stores mesh-wide classifications in the inside auxiliary variable, and evaluates one interior and one exterior point with a vector postprocessor:

# Framework point-in-polyhedron test using only MooseTestApp objects.
#
# A closed TRI3 surface (the shell of a TET4 sphere) is saved and handed to a
# BoundaryMeshBuilder. A PointInPolyhedronCheckUO with the fixed_x_ray backend
# (the TriangleManifold engine) classifies element centroids of the background
# mesh via a SpatialUserObjectAux (1 inside/on, 0 outside).
cx = 2.0
cy = 2.0
cz = 2.0

[Problem<<<{"href": "../../syntax/Problem/index.html"}>>>]
  solve = false
[]

[Mesh<<<{"href": "../../syntax/Mesh/index.html"}>>>]
  [ball]
    type = SphereMeshGenerator<<<{"description": "Generate a sphere (ball) mesh centered on the origin", "href": "../meshgenerators/SphereMeshGenerator.html"}>>>
    radius<<<{"description": "Sphere (ball) radius"}>>> = 1.0
    nr<<<{"description": "Number of refinements"}>>> = 1
    elem_type<<<{"description": "The type of element to generate"}>>> = TET4
  []
  [shell]
    type = LowerDBlockFromSidesetGenerator<<<{"description": "Adds lower dimensional elements on the specified sidesets.", "href": "../meshgenerators/LowerDBlockFromSidesetGenerator.html"}>>>
    input<<<{"description": "The mesh we want to modify"}>>> = ball
    sidesets<<<{"description": "The sidesets from which to create the new block"}>>> = '0'
    new_block_id<<<{"description": "The lower dimensional block id to create"}>>> = 100
  []
  [extract]
    type = BlockToMeshConverterGenerator<<<{"description": "Converts one or more blocks (subdomains) from a mesh into a stand-alone mesh with a single block in it.", "href": "../meshgenerators/BlockToMeshConverterGenerator.html"}>>>
    input<<<{"description": "The mesh we want to modify"}>>> = shell
    target_blocks<<<{"description": "The (list of) blocks (or 'subdomains') we wish to have moved to a new mesh (by name, not ID)"}>>> = '100'
  []
  [surface_mesh]
    type = TransformGenerator<<<{"description": "Applies a linear transform to the entire mesh.", "href": "../meshgenerators/TransformGenerator.html"}>>>
    transform<<<{"description": "The type of transformation to perform (TRANSLATE, TRANSLATE_CENTER_ORIGIN, TRANSLATE_MIN_ORIGIN, ROTATE, SCALE, ROTATE_WITH_MATRIX, ROTATE_EXT)"}>>> = TRANSLATE
    vector_value<<<{"description": "The value to use for the transformation. When using TRANSLATE or SCALE, the xyz coordinates are applied in each direction respectively. When using ROTATE, the values are interpreted as the Euler angles phi, theta and psi given in degrees. For ROTATE_EXT, an extrinsic rotation is carried out using prescribed Euler angles alpha, beta, and gamma in degrees."}>>> = '${cx} ${cy} ${cz}'
    input<<<{"description": "The mesh we want to modify"}>>> = extract
    save_with_name<<<{"description": "Keep the mesh from this mesh generator in memory with the name specified"}>>> = 'surface_mesh'
  []

  [gen]
    type = CartesianMeshGenerator<<<{"description": "This CartesianMeshGenerator creates a non-uniform Cartesian mesh.", "href": "../meshgenerators/CartesianMeshGenerator.html"}>>>
    dim<<<{"description": "The dimension of the mesh to be generated"}>>> = 3
    dx<<<{"description": "Intervals in the X direction"}>>> = '4'
    dy<<<{"description": "Intervals in the Y direction (required when dim>1 otherwise ignored)"}>>> = '4'
    dz<<<{"description": "Intervals in the Z direction (required when dim>2 otherwise ignored)"}>>> = '4'
    ix<<<{"description": "Number of grids in all intervals in the X direction (default to all one)"}>>> = '8'
    iy<<<{"description": "Number of grids in all intervals in the Y direction (default to all one)"}>>> = '8'
    iz<<<{"description": "Number of grids in all intervals in the Z direction (default to all one)"}>>> = '8'
    subdomain_id<<<{"description": "Block IDs (default to all zero)"}>>> = '1'
  []

  final_generator = 'gen'
[]

[AuxVariables<<<{"href": "../../syntax/AuxVariables/index.html"}>>>]
  [inside]
    family<<<{"description": "Specifies the family of FE shape functions to use for this variable"}>>> = MONOMIAL
    order<<<{"description": "Specifies the order of the FE shape function to use for this variable (additional orders not listed are allowed)"}>>> = CONSTANT
  []
[]

[AuxKernels<<<{"href": "../../syntax/AuxKernels/index.html"}>>>]
  [inside]
    type = SpatialUserObjectAux<<<{"description": "Populates an auxiliary variable with a spatial value returned from a UserObject spatialValue method.", "href": "../auxkernels/SpatialUserObjectAux.html"}>>>
    variable<<<{"description": "The name of the variable that this object applies to"}>>> = inside
    user_object<<<{"description": "The UserObject UserObject to get values from.  Note that the UserObject _must_ implement the spatialValue() virtual function!"}>>> = in_out_test
    execute_on<<<{"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."}>>> = 'initial'
  []
[]

[UserObjects<<<{"href": "../../syntax/UserObjects/index.html"}>>>]
  [surface_builder]
    type = BoundaryMeshBuilder<<<{"description": "Owns a saved surface (boundary) mesh and the SurfaceElement wrappers built from it, for use by point-containment and distance user objects.", "href": "BoundaryMeshBuilder.html"}>>>
    surface_mesh<<<{"description": "The name of the surface mesh saved via the MeshGenerator's `save_with_name` parameter."}>>> = surface_mesh
  []

  [in_out_test]
    type = PointInPolyhedronCheckUO<<<{"description": "Determines whether a point is inside a closed surface mesh provided by a BoundaryMeshBuilder.", "href": "PointInPolyhedronCheckUO.html"}>>>
    builder<<<{"description": "The BoundaryMeshBuilder providing the surface mesh and boundary elements."}>>> = surface_builder
    point_containment_method<<<{"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)."}>>> = fixed_x_ray
  []
[]

[VectorPostprocessors<<<{"href": "../../syntax/VectorPostprocessors/index.html"}>>>]
  [point_containment]
    type = SpatialUserObjectVectorPostprocessor<<<{"description": "Outputs the values of a spatial user object in the order of the specified spatial points", "href": "../vectorpostprocessors/SpatialUserObjectVectorPostprocessor.html"}>>>
    userobject<<<{"description": "The userobject whose values are to be reported"}>>> = in_out_test
    points<<<{"description": "Computations will be lumped into values at these points."}>>> = '${cx} ${cy} ${cz}
              0 0 0'
    execute_on<<<{"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."}>>> = initial
  []
[]

[Executioner<<<{"href": "../../syntax/Executioner/index.html"}>>>]
  type = Steady
[]

[Outputs<<<{"href": "../../syntax/Outputs/index.html"}>>>]
  exodus<<<{"description": "Output the results using the default settings for Exodus output."}>>> = true
  csv<<<{"description": "Output the scalar variable and postprocessors to a *.csv file using the default CSV output."}>>> = true
  execute_on<<<{"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."}>>> = initial
[]

Determines whether a point is inside a closed surface mesh provided by a BoundaryMeshBuilder.

Input Parameters

builderThe BoundaryMeshBuilder providing the surface mesh and boundary elements.
C++ Type:UserObjectName
Controllable:No
Description:The BoundaryMeshBuilder providing the surface mesh and boundary elements.

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/in_out_test/2D_enclosed_surface.i)
(test/tests/userobjects/point_in_union/union_two_meshes.i)
(test/tests/userobjects/point_in_union/union_mesh_and_function.i)
(test/tests/userobjects/point_in_polyhedron/pca_ray_2d_msh.i)
(test/tests/userobjects/point_in_polyhedron/pca_ray_2d.i)
(test/tests/userobjects/point_in_polyhedron/fixed_x_ray.i)
(modules/shifted_boundary_method/test/tests/distance_calc/2D_signed_distance.i)
(test/tests/userobjects/point_in_union/union_mesh_and_msh.i)
(modules/shifted_boundary_method/test/tests/in_out_test/2D_lambda0.i)
(modules/shifted_boundary_method/test/tests/in_out_test/2D_triangle_clip.i)
(modules/shifted_boundary_method/test/tests/in_out_test/2D_lambda0p5.i)
(modules/shifted_boundary_method/test/tests/in_out_test/3D_lambda0.i)
(modules/shifted_boundary_method/test/tests/in_out_test/2D_edge_clip.i)
(modules/shifted_boundary_method/test/tests/in_out_test/2D_obb_write.i)
(modules/shifted_boundary_method/test/tests/in_out_test/2D_mark_intercepted.i)
(test/tests/userobjects/point_in_polyhedron/pca_ray_3d_stl.i)
(test/tests/userobjects/point_in_polyhedron/fixed_x_ray_non_tri3.i)
(test/tests/userobjects/point_in_union/union_mesh_and_stl.i)
(test/tests/userobjects/point_in_polyhedron/user_ray_direction.i)
(modules/shifted_boundary_method/test/tests/in_out_test/3D_lambda1.i)
(modules/shifted_boundary_method/test/tests/in_out_test/2D_lambda1.i)
(modules/shifted_boundary_method/test/tests/in_out_test/3D_lambda0p5.i)

(test/tests/userobjects/point_in_polyhedron/fixed_x_ray.i)

# Framework point-in-polyhedron test using only MooseTestApp objects.
#
# A closed TRI3 surface (the shell of a TET4 sphere) is saved and handed to a
# BoundaryMeshBuilder. A PointInPolyhedronCheckUO with the fixed_x_ray backend
# (the TriangleManifold engine) classifies element centroids of the background
# mesh via a SpatialUserObjectAux (1 inside/on, 0 outside).
cx = 2.0
cy = 2.0
cz = 2.0

[Problem]
  solve = false
[]

[Mesh]
  [ball]
    type = SphereMeshGenerator
    radius = 1.0
    nr = 1
    elem_type = TET4
  []
  [shell]
    type = LowerDBlockFromSidesetGenerator
    input = ball
    sidesets = '0'
    new_block_id = 100
  []
  [extract]
    type = BlockToMeshConverterGenerator
    input = shell
    target_blocks = '100'
  []
  [surface_mesh]
    type = TransformGenerator
    transform = TRANSLATE
    vector_value = '${cx} ${cy} ${cz}'
    input = extract
    save_with_name = 'surface_mesh'
  []

  [gen]
    type = CartesianMeshGenerator
    dim = 3
    dx = '4'
    dy = '4'
    dz = '4'
    ix = '8'
    iy = '8'
    iz = '8'
    subdomain_id = '1'
  []

  final_generator = 'gen'
[]

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

[AuxKernels]
  [inside]
    type = SpatialUserObjectAux
    variable = inside
    user_object = in_out_test
    execute_on = 'initial'
  []
[]

[UserObjects]
  [surface_builder]
    type = BoundaryMeshBuilder
    surface_mesh = surface_mesh
  []

  [in_out_test]
    type = PointInPolyhedronCheckUO
    builder = surface_builder
    point_containment_method = fixed_x_ray
  []
[]

[VectorPostprocessors]
  [point_containment]
    type = SpatialUserObjectVectorPostprocessor
    userobject = in_out_test
    points = '${cx} ${cy} ${cz}
              0 0 0'
    execute_on = initial
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
  csv = true
  execute_on = initial
[]

(modules/shifted_boundary_method/test/tests/in_out_test/2D_enclosed_surface.i)

# A closed curve lies entirely within one coarse element, so every element node is outside while
# interior quadrature points are inside. The element must still be marked as intercepted.
radius = 0.3
n_seg = 32

[Problem]
  solve = false
[]

[Mesh]
  [surface]
    type = ParsedCurveGenerator
    x_formula = '0.5 + ${radius} * cos(t)'
    y_formula = '0.5 + ${radius} * sin(t)'
    section_bounding_t_values = '0 ${fparse 2*pi}'
    nums_segments = '${n_seg}'
    is_closed_loop = true
    save_with_name = surface
  []
  [domain]
    type = GeneratedMeshGenerator
    dim = 2
    nx = 1
    ny = 1
    subdomain_ids = 1
  []
  add_subdomain_ids = '2 3'
  final_generator = domain
[]

[UserObjects]
  [surface_builder]
    type = SBMSurfaceMeshBuilder
    check_watertightness = true
    surface_mesh = surface
  []
  [in_out_test]
    type = PointInPolyhedronCheckUO
    builder = surface_builder
  []
[]

[MeshModifiers]
  [intercepted]
    type = InterceptedElementModifier
    subdomain_id_inside = 1
    subdomain_id_outside = 2
    is_domain_inside_surface = true
    in_out_test = in_out_test
    mark_intercepted = true
    subdomain_id_intercepted = 3
    execute_on = INITIAL
  []
[]

[Variables]
  [u]
    initial_condition = 1
    block = 3
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
[]

(test/tests/userobjects/point_in_union/union_two_meshes.i)

# Boolean union of two closed surface meshes (same representation). Two circles are
# saved as EDGE2 curves and each handed to its own BoundaryMeshBuilder and
# PointInPolyhedronCheckUO; PointInUnionCheckUO reports a point contained when it is
# inside either circle. SpatialUserObjectAux stores 1 inside/on, 0 outside.

[Problem]
  solve = false
[]

[Mesh]
  [circle1]
    type = ParsedCurveGenerator
    x_formula = '1.0 + 0.8 * cos(t)'
    y_formula = '2.0 + 0.8 * sin(t)'
    section_bounding_t_values = '0 ${fparse 2*pi}'
    nums_segments = '48'
    is_closed_loop = true
    save_with_name = 'circle1'
  []
  [circle2]
    type = ParsedCurveGenerator
    x_formula = '3.0 + 0.8 * cos(t)'
    y_formula = '2.0 + 0.8 * sin(t)'
    section_bounding_t_values = '0 ${fparse 2*pi}'
    nums_segments = '48'
    is_closed_loop = true
    save_with_name = 'circle2'
  []
  [gen]
    type = CartesianMeshGenerator
    dim = 2
    dx = '4'
    dy = '4'
    ix = '16'
    iy = '16'
    subdomain_id = '1'
  []
  final_generator = 'gen'
[]

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

[AuxKernels]
  [inside]
    type = SpatialUserObjectAux
    variable = inside
    user_object = union
    execute_on = 'initial'
  []
[]

[UserObjects]
  [builder1]
    type = BoundaryMeshBuilder
    surface_mesh = circle1
  []
  [builder2]
    type = BoundaryMeshBuilder
    surface_mesh = circle2
  []
  [check1]
    type = PointInPolyhedronCheckUO
    builder = builder1
    point_containment_method = pca_ray
  []
  [check2]
    type = PointInPolyhedronCheckUO
    builder = builder2
    point_containment_method = pca_ray
  []
  [union]
    type = PointInUnionCheckUO
    providers = 'check1 check2'
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
[]

(test/tests/userobjects/point_in_union/union_mesh_and_function.i)

# Mixed-representation union. One geometry is a meshed closed surface (a circle
# handed to a BoundaryMeshBuilder and PointInPolyhedronCheckUO); the other is a
# signed level set (a circle signed-distance function checked by
# PointInSignedFunctionCheckUO). PointInUnionCheckUO reports a point contained when
# it is inside either. This exercises both checker types through one union.

[Problem]
  solve = false
[]

[Mesh]
  [circle1]
    type = ParsedCurveGenerator
    x_formula = '1.0 + 0.8 * cos(t)'
    y_formula = '2.0 + 0.8 * sin(t)'
    section_bounding_t_values = '0 ${fparse 2*pi}'
    nums_segments = '48'
    is_closed_loop = true
    save_with_name = 'circle1'
  []
  [gen]
    type = CartesianMeshGenerator
    dim = 2
    dx = '4'
    dy = '4'
    ix = '16'
    iy = '16'
    subdomain_id = '1'
  []
  final_generator = 'gen'
[]

[Functions]
  # Signed distance to a circle at (3, 2), radius 0.8 (negative inside).
  [circle2_sdf]
    type = ParsedFunction
    expression = 'sqrt((x - 3.0)^2 + (y - 2.0)^2) - 0.8'
  []
[]

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

[AuxKernels]
  [inside]
    type = SpatialUserObjectAux
    variable = inside
    user_object = union
    execute_on = 'initial'
  []
[]

[UserObjects]
  [builder1]
    type = BoundaryMeshBuilder
    surface_mesh = circle1
  []
  [check_mesh]
    type = PointInPolyhedronCheckUO
    builder = builder1
    point_containment_method = pca_ray
  []
  [check_func]
    type = PointInSignedFunctionCheckUO
    function = circle2_sdf
  []
  [union]
    type = PointInUnionCheckUO
    providers = 'check_mesh check_func'
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
[]

(test/tests/userobjects/point_in_polyhedron/pca_ray_2d_msh.i)

# Framework point-in-polyhedron test on a closed 2D EDGE2 surface read from a
# gmsh file, using only MooseTestApp objects. The surface is a non-convex L-shaped
# closed loop.

[Problem]
  solve = false
[]

[Mesh]
  [surface_mesh]
    type = FileMeshGenerator
    file = l_shape_boundary.msh
    save_with_name = 'surface_mesh'
  []

  [gen]
    type = CartesianMeshGenerator
    dim = 2
    dx = '4'
    dy = '4'
    ix = '16'
    iy = '16'
    subdomain_id = '1'
  []

  final_generator = 'gen'
[]

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

[AuxKernels]
  [inside]
    type = SpatialUserObjectAux
    variable = inside
    user_object = in_out_test
    execute_on = 'initial'
  []
[]

[UserObjects]
  [surface_builder]
    type = BoundaryMeshBuilder
    surface_mesh = surface_mesh
  []

  [in_out_test]
    type = PointInPolyhedronCheckUO
    builder = surface_builder
    point_containment_method = pca_ray
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
[]

(test/tests/userobjects/point_in_polyhedron/pca_ray_2d.i)

# Framework point-in-polyhedron test on a closed 2D EDGE2 surface using only
# MooseTestApp objects. A closed elliptical curve is saved and handed to a
# BoundaryMeshBuilder. A PointInPolyhedronCheckUO with the default pca_ray
# backend classifies background element centroids via a SpatialUserObjectAux
# (1 inside/on, 0 outside). This exercises the ray-casting engine's 2D EDGE2
# path through the framework input layer.
a = 1.6
b = 1.0
cx = 2.03
cy = 1.97

[Problem]
  solve = false
[]

[Mesh]
  [surface_mesh]
    type = ParsedCurveGenerator
    x_formula = '${cx} + ${a} * cos(t)'
    y_formula = '${cy} + ${b} * sin(t)'
    section_bounding_t_values = '0 ${fparse 2*pi}'
    nums_segments = '48'
    is_closed_loop = true
    save_with_name = 'surface_mesh'
  []

  [gen]
    type = CartesianMeshGenerator
    dim = 2
    dx = '4'
    dy = '4'
    ix = '16'
    iy = '16'
    subdomain_id = '1'
  []

  final_generator = 'gen'
[]

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

[AuxKernels]
  [inside]
    type = SpatialUserObjectAux
    variable = inside
    user_object = in_out_test
    execute_on = 'initial'
  []
[]

[UserObjects]
  [surface_builder]
    type = BoundaryMeshBuilder
    surface_mesh = surface_mesh
  []

  [in_out_test]
    type = PointInPolyhedronCheckUO
    builder = surface_builder
    point_containment_method = pca_ray
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
[]

(test/tests/userobjects/point_in_polyhedron/fixed_x_ray.i)

# Framework point-in-polyhedron test using only MooseTestApp objects.
#
# A closed TRI3 surface (the shell of a TET4 sphere) is saved and handed to a
# BoundaryMeshBuilder. A PointInPolyhedronCheckUO with the fixed_x_ray backend
# (the TriangleManifold engine) classifies element centroids of the background
# mesh via a SpatialUserObjectAux (1 inside/on, 0 outside).
cx = 2.0
cy = 2.0
cz = 2.0

[Problem]
  solve = false
[]

[Mesh]
  [ball]
    type = SphereMeshGenerator
    radius = 1.0
    nr = 1
    elem_type = TET4
  []
  [shell]
    type = LowerDBlockFromSidesetGenerator
    input = ball
    sidesets = '0'
    new_block_id = 100
  []
  [extract]
    type = BlockToMeshConverterGenerator
    input = shell
    target_blocks = '100'
  []
  [surface_mesh]
    type = TransformGenerator
    transform = TRANSLATE
    vector_value = '${cx} ${cy} ${cz}'
    input = extract
    save_with_name = 'surface_mesh'
  []

  [gen]
    type = CartesianMeshGenerator
    dim = 3
    dx = '4'
    dy = '4'
    dz = '4'
    ix = '8'
    iy = '8'
    iz = '8'
    subdomain_id = '1'
  []

  final_generator = 'gen'
[]

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

[AuxKernels]
  [inside]
    type = SpatialUserObjectAux
    variable = inside
    user_object = in_out_test
    execute_on = 'initial'
  []
[]

[UserObjects]
  [surface_builder]
    type = BoundaryMeshBuilder
    surface_mesh = surface_mesh
  []

  [in_out_test]
    type = PointInPolyhedronCheckUO
    builder = surface_builder
    point_containment_method = fixed_x_ray
  []
[]

[VectorPostprocessors]
  [point_containment]
    type = SpatialUserObjectVectorPostprocessor
    userobject = in_out_test
    points = '${cx} ${cy} ${cz}
              0 0 0'
    execute_on = initial
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
  csv = true
  execute_on = initial
[]

(modules/shifted_boundary_method/test/tests/distance_calc/2D_signed_distance.i)

nx = 16
# Asymmetric immersed geometry: a non-circular closed curve. A circle is maximally
# symmetric (every diameter is a symmetry axis), so an element centroid can sit
# exactly on a symmetry axis and become equidistant to two surface segments. That
# KDTree nearest-segment tie is broken only by floating-point round-off, which
# differs across platforms and flips the gradient direction. Deforming the boundary
# with a radial modulation removes all symmetry, so every centroid has a unique
# nearest segment and the in-out sign / gradient stay reproducible across platforms.
R = 1.3
cx = 2.03
cy = 1.97
# Control the boundary asymmetry (radial modulation amplitudes).
a = 0.18
b = 0.10
n_seg = 64
[Problem]
  solve = false
[]

[Mesh]
  [shift_boundary_mesh]
    type = ParsedCurveGenerator
    x_formula = '${cx} + ${R} * (1 + ${a} * cos(t) + ${b} * sin(2*t)) * cos(t)'
    y_formula = '${cy} + ${R} * (1 + ${a} * cos(t) + ${b} * sin(2*t)) * sin(t)'
    section_bounding_t_values = '0 ${fparse 2*pi}'
    nums_segments = '${n_seg}'
    is_closed_loop = true
    save_with_name = 'shift_boundary_mesh'
  []

  [gen]
    type = CartesianMeshGenerator
    dim = 2
    dx = '4'
    dy = '4'
    ix = '${nx}'
    iy = '${nx}'
    subdomain_id = '1'
  []

  add_subdomain_ids = 2 # outside block
  add_sideset_names = 'SBMinterface'
  final_generator = 'gen'
[]

[UserObjects]
  [TreeBuilder]
    type = SBMSurfaceMeshBuilder
    surface_mesh = shift_boundary_mesh
  []
  [signed_distance_to_surface]
    type = ShortestDistanceToSurface
    surfaces = 'sign_dist_square'
    signed_distance = true
  []
  [distance_to_surface]
    type = ShortestDistanceToSurface
    surfaces = 'dist_square'
  []
  [InOutTest]
    type = PointInPolyhedronCheckUO
    builder = TreeBuilder
    # A user-selected axis-aligned ray avoids the PCA/SVD direction ambiguity of
    # an isotropic shape (circle), which is not reproducible across platforms.
    point_containment_method = user_selected_ray
    ray_direction = '1 0 0'
  []
  [SignedFunctionTest]
    type = PointInSignedFunctionCheckUO
    function = level_set
  []
[]

[Functions]
  [level_set]
    # Const level set that is > 0, so if we union with this, it does not change any behavior
    # (IN/OUT/ON still remain).
    type = ConstantFunction
    value = 1
  []
  [dist_square]
    type = UnsignedDistanceToSurfaceMesh
    builder = TreeBuilder
  []
  [sign_dist_square]
    type = SignedDistanceToSurfaceMesh
    builder = TreeBuilder
    in_out_test = InOutTest
  []
[]

[Variables]
  [u]
    initial_condition = 1
    block = 1
  []
[]

[AuxVariables]
  [signed_distance]
    order = CONSTANT
    family = MONOMIAL
  []
  [unsigned_distance]
    order = CONSTANT
    family = MONOMIAL
  []
  # Vector field capturing the signed-distance gradient direction. Sampling the
  # gradient at every element centroid exercises points both inside and outside
  # the circle, so the gold pins down the outward-pointing direction on both sides.
  [signed_distance_grad]
    order = CONSTANT
    family = MONOMIAL_VEC
  []
[]

[AuxKernels]
  [signed_dist]
    type = ElementCentroidToSurfaceDistanceAux
    distance_to_surface = signed_distance_to_surface
    variable = signed_distance
    execute_on = 'INITIAL timestep_begin'
  []
  [unsigned_dist]
    type = ElementCentroidToSurfaceDistanceAux
    distance_to_surface = distance_to_surface
    variable = unsigned_distance
    execute_on = 'INITIAL timestep_begin'
  []
  [signed_dist_grad]
    type = FunctorElementalGradientAux
    functor = sign_dist_square
    variable = signed_distance_grad
    execute_on = 'INITIAL timestep_begin'
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
[]

(test/tests/userobjects/point_in_union/union_mesh_and_msh.i)

# Union of a generator-built circle and a non-convex L-shape read from
# l_shape_boundary.msh. A point is contained when inside either geometry.

[Problem]
  solve = false
[]

[Mesh]
  [circle1]
    type = ParsedCurveGenerator
    x_formula = '1.0 + 0.8 * cos(t)'
    y_formula = '2.0 + 0.8 * sin(t)'
    section_bounding_t_values = '0 ${fparse 2*pi}'
    nums_segments = '48'
    is_closed_loop = true
    save_with_name = 'circle1'
  []
  [lshape]
    type = FileMeshGenerator
    file = l_shape_boundary.msh
    save_with_name = 'lshape'
  []
  [gen]
    type = CartesianMeshGenerator
    dim = 2
    dx = '4'
    dy = '4'
    ix = '16'
    iy = '16'
    subdomain_id = '1'
  []
  final_generator = 'gen'
[]

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

[AuxKernels]
  [inside]
    type = SpatialUserObjectAux
    variable = inside
    user_object = union
    execute_on = 'initial'
  []
[]

[UserObjects]
  [builder1]
    type = BoundaryMeshBuilder
    surface_mesh = circle1
  []
  [builder2]
    type = BoundaryMeshBuilder
    surface_mesh = lshape
  []
  [check1]
    type = PointInPolyhedronCheckUO
    builder = builder1
    point_containment_method = pca_ray
  []
  [check2]
    type = PointInPolyhedronCheckUO
    builder = builder2
    point_containment_method = pca_ray
  []
  [union]
    type = PointInUnionCheckUO
    providers = 'check1 check2'
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
[]

(modules/shifted_boundary_method/test/tests/in_out_test/2D_lambda0.i)

nx = 16
lambda = 0
# Immersed ellipse geometry: distinct semi-axes make the boundary anisotropic so
# PCA has a well-separated minor axis, giving a reproducible auto ray direction.
# Off-grid center keeps the arc cutting elements at generic fractions with no
# node/quadrature point landing exactly on the surface.
a = 1.6
b = 1.0
cx = 2.03
cy = 1.97
n_seg = 48
[Problem]
  solve = false
[]

[Mesh]
  [shift_boundary_mesh]
    type = ParsedCurveGenerator
    x_formula = '${cx} + ${a} * cos(t)'
    y_formula = '${cy} + ${b} * sin(t)'
    section_bounding_t_values = '0 ${fparse 2*pi}'
    nums_segments = '${n_seg}'
    is_closed_loop = true
    save_with_name = 'shift_boundary_mesh'
  []

  [gen]
    type = CartesianMeshGenerator
    dim = 2
    dx = '4'
    dy = '4'
    ix = '${nx}'
    iy = '${nx}'
    subdomain_id = '1'
  []

  add_subdomain_ids = 2 # outside block
  add_sideset_names = 'SBMinterface'
  final_generator = 'gen'
[]

[UserObjects]
  [TreeBuilder]
    type = SBMSurfaceMeshBuilder
    check_watertightness = true
    surface_mesh = shift_boundary_mesh
  []

  [inout_test]
    type = PointInPolyhedronCheckUO
    builder = TreeBuilder
  []
[]

[MeshModifiers]
  [IntercpetedESM]
    type = InterceptedElementModifier
    subdomain_id_inside = 1
    subdomain_id_outside = 2
    lambda = ${lambda}
    is_domain_inside_surface = true
    in_out_test = inout_test
    execute_on = 'INITIAL'
    execution_order_group = 0
  []
  [SBMinterface]
    type = SidesetAroundSubdomainUpdater
    inner_subdomains = 1
    outer_subdomains = 2
    update_sideset_name = 'SBMinterface'
    assign_outer_surface_sides = false
    execute_on = 'INITIAL'
    execution_order_group = 1
    block = '1 2' # need to override default block
  []
[]

[Variables]
  [u]
    initial_condition = 1
    block = 1
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
[]

(modules/shifted_boundary_method/test/tests/in_out_test/2D_triangle_clip.i)

# Test a triangular closed surface with sharp corners and intercepted elements.

[Problem]
  solve = false
[]

[Mesh]
  [surface]
    type = ParsedCurveGenerator
    # Piecewise-linear triangle A->B->C; is_closed_loop adds the closing edge C->A.
    # Apex A sits at a cell center (0.5625, 0.8125) with a narrow wedge, so the apex cell has all
    # four nodes outside the triangle while a finite sliver is inside.
    constant_names = 'Ax Ay Bx By Cx Cy'
    constant_expressions = '0.5625 0.8125 0.30 0.20 0.72 0.20'
    x_formula = 'if(t < 1, Ax + t * (Bx - Ax), Bx + (t - 1) * (Cx - Bx))'
    y_formula = 'if(t < 1, Ay + t * (By - Ay), By + (t - 1) * (Cy - By))'
    section_bounding_t_values = '0 1 2'
    nums_segments = '10 10'
    is_closed_loop = true
    save_with_name = surface
  []
  [domain]
    type = GeneratedMeshGenerator
    dim = 2
    nx = 8
    ny = 8
    subdomain_ids = 1
  []
  add_subdomain_ids = '2 3'
  final_generator = domain
[]

[UserObjects]
  [surface_builder]
    type = SBMSurfaceMeshBuilder
    check_watertightness = true
    surface_mesh = surface
  []
  [in_out_test]
    type = PointInPolyhedronCheckUO
    builder = surface_builder
  []
[]

[MeshModifiers]
  [intercepted]
    type = InterceptedElementModifier
    subdomain_id_inside = 1
    subdomain_id_outside = 2
    is_domain_inside_surface = true
    in_out_test = in_out_test
    mark_intercepted = true
    subdomain_id_intercepted = 3
    execute_on = INITIAL
  []
[]

[Variables]
  [u]
    initial_condition = 1
    block = 3
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
[]

(modules/shifted_boundary_method/test/tests/in_out_test/2D_lambda0p5.i)

nx = 16
lambda = 0.5
# Immersed ellipse geometry: distinct semi-axes make the boundary anisotropic so
# PCA has a well-separated minor axis, giving a reproducible auto ray direction.
# Off-grid center keeps the arc cutting elements at generic fractions with no
# node/quadrature point landing exactly on the surface.
a = 1.6
b = 1.0
cx = 2.03
cy = 1.97
n_seg = 48
[Problem]
  solve = false
[]

[Mesh]
  [shift_boundary_mesh]
    type = ParsedCurveGenerator
    x_formula = '${cx} + ${a} * cos(t)'
    y_formula = '${cy} + ${b} * sin(t)'
    section_bounding_t_values = '0 ${fparse 2*pi}'
    nums_segments = '${n_seg}'
    is_closed_loop = true
    save_with_name = 'shift_boundary_mesh'
  []

  [gen]
    type = CartesianMeshGenerator
    dim = 2
    dx = '4'
    dy = '4'
    ix = '${nx}'
    iy = '${nx}'
    subdomain_id = '1'
  []

  add_subdomain_ids = 2 # outside block
  add_sideset_names = 'SBMinterface'
  final_generator = 'gen'
[]

[Functions]
  [level_set]
    type = ParsedFunction
    expression = '((x - ${cx}) / ${a})^2 + ((y - ${cy}) / ${b})^2 - 1'
  []
[]

[UserObjects]
  [TreeBuilder]
    type = SBMSurfaceMeshBuilder
    check_watertightness = true
    surface_mesh = shift_boundary_mesh
  []

  [inout_test]
    type = PointInPolyhedronCheckUO
    builder = TreeBuilder
  []
  [signed_function_test]
    type = PointInSignedFunctionCheckUO
    function = level_set
  []
[]

[MeshModifiers]
  [IntercpetedESM]
    type = InterceptedElementModifier
    subdomain_id_inside = 1
    subdomain_id_outside = 2
    lambda = ${lambda}
    is_domain_inside_surface = true
    in_out_test = inout_test
    execute_on = 'INITIAL'
    execution_order_group = 0
  []
  [SBMinterface]
    type = SidesetAroundSubdomainUpdater
    inner_subdomains = 1
    outer_subdomains = 2
    update_sideset_name = 'SBMinterface'
    assign_outer_surface_sides = false
    execute_on = 'INITIAL'
    execution_order_group = 1
    block = '1 2' # need to override default block
  []
[]

[Variables]
  [u]
    initial_condition = 1
    block = 1
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
[]

(modules/shifted_boundary_method/test/tests/in_out_test/3D_lambda0.i)

nx = 16
lambda = 0
# Immersed triaxial ellipsoid: three distinct semi-axes make the boundary
# anisotropic so PCA has a well-separated shortest axis, giving a reproducible
# auto ray direction. Off-grid center keeps the surface cutting elements at
# generic fractions with no node/quadrature point landing exactly on it.
ax = 1.5
ay = 1.15
az = 0.85
cx = 2.03
cy = 1.97
cz = 2.05
[Problem]
  solve = false
[]

[Mesh]
  [ball]
    type = SphereMeshGenerator
    radius = 1.0
    nr = 1
    elem_type = TET4
  []
  [shell]
    type = LowerDBlockFromSidesetGenerator
    input = ball
    sidesets = '0'
    new_block_id = 100
  []
  [extract]
    type = BlockToMeshConverterGenerator
    input = shell
    target_blocks = '100'
  []
  [scale]
    type = TransformGenerator
    transform = SCALE
    vector_value = '${ax} ${ay} ${az}'
    input = extract
  []
  [shift_boundary_mesh]
    type = TransformGenerator
    transform = TRANSLATE
    vector_value = '${cx} ${cy} ${cz}'
    input = scale
    save_with_name = 'shift_boundary_mesh'
  []

  [gen]
    type = CartesianMeshGenerator
    dim = 3
    dx = '4'
    dy = '4'
    dz = '4'
    ix = '${nx}'
    iy = '${nx}'
    iz = '${nx}'
    subdomain_id = '1'
  []

  add_subdomain_ids = 2 # outside block
  add_sideset_names = 'SBMinterface'
  final_generator = 'gen'
[]

[UserObjects]
  [TreeBuilder]
    type = SBMSurfaceMeshBuilder
    check_watertightness = true
    surface_mesh = shift_boundary_mesh
  []
  [inout_test]
    type = PointInPolyhedronCheckUO
    builder = TreeBuilder
  []
[]

[MeshModifiers]
  [IntercpetedESM]
    type = InterceptedElementModifier
    subdomain_id_inside = 1
    subdomain_id_outside = 2
    lambda = ${lambda}
    is_domain_inside_surface = true
    in_out_test = inout_test
    execute_on = 'INITIAL'
    execution_order_group = 0
  []
  [SBMinterface]
    type = SidesetAroundSubdomainUpdater
    inner_subdomains = 1
    outer_subdomains = 2
    update_sideset_name = 'SBMinterface'
    assign_outer_surface_sides = false
    execute_on = 'INITIAL'
    execution_order_group = 1
    block = '1 2' # need to override default block
  []
[]

[Variables]
  [u]
    initial_condition = 1
    block = 1
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
[]

(modules/shifted_boundary_method/test/tests/in_out_test/2D_edge_clip.i)

# A single coarse element whose four nodes all lie outside a circle, while the circle bulges
# through the bottom edge so a finite interior region is inside. The node-only test would call
# the element fully outside; the occupied-ratio guard in the GEOMETRY branch (active_nodes == 0
# requires ratio_active == 0.0) must instead classify it as intercepted.
radius = 0.4
n_seg = 64

[Problem]
  solve = false
[]

[Mesh]
  [surface]
    type = ParsedCurveGenerator
    # Circle centered below the domain so the top cap crosses the element's bottom edge.
    x_formula = '0.5 + ${radius} * cos(t)'
    y_formula = '-0.3 + ${radius} * sin(t)'
    section_bounding_t_values = '0 ${fparse 2*pi}'
    nums_segments = '${n_seg}'
    is_closed_loop = true
    save_with_name = surface
  []
  [domain]
    type = GeneratedMeshGenerator
    dim = 2
    nx = 1
    ny = 1
    subdomain_ids = 1
  []
  add_subdomain_ids = '2 3'
  final_generator = domain
[]

[UserObjects]
  [surface_builder]
    type = SBMSurfaceMeshBuilder
    check_watertightness = true
    surface_mesh = surface
  []
  [in_out_test]
    type = PointInPolyhedronCheckUO
    builder = surface_builder
  []
[]

[MeshModifiers]
  [intercepted]
    type = InterceptedElementModifier
    subdomain_id_inside = 1
    subdomain_id_outside = 2
    is_domain_inside_surface = true
    in_out_test = in_out_test
    mark_intercepted = true
    subdomain_id_intercepted = 3
    execute_on = INITIAL
  []
[]

[Variables]
  [u]
    initial_condition = 1
    block = 3
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
[]

(modules/shifted_boundary_method/test/tests/in_out_test/2D_obb_write.i)

# Minimal input exercising OrientedBoundingBox::writeMesh / writeRayAlongShortestAxis.
# An anisotropic ellipse gives PCA a well-separated minor axis, so the oriented
# bounding box and the ray along the shortest axis are reproducible. The in-out
# user object builds the OBB and writes the OBB (QUAD4) and ray (EDGE2) meshes
# to file when it is constructed, so no solve, mesh modifier, or variable is
# needed to trigger the write.
a = 1.6
b = 1.0
cx = 2.03
cy = 1.97
n_seg = 48

[Problem]
  solve = false
[]

[Mesh]
  [shift_boundary_mesh]
    type = ParsedCurveGenerator
    x_formula = '${cx} + ${a} * cos(t)'
    y_formula = '${cy} + ${b} * sin(t)'
    section_bounding_t_values = '0 ${fparse 2*pi}'
    nums_segments = '${n_seg}'
    is_closed_loop = true
    save_with_name = 'shift_boundary_mesh'
  []

  [gen]
    type = CartesianMeshGenerator
    dim = 2
    dx = '4'
    dy = '4'
    ix = '16'
    iy = '16'
    subdomain_id = '1'
  []

  final_generator = 'gen'
[]

[UserObjects]
  [TreeBuilder]
    type = SBMSurfaceMeshBuilder
    surface_mesh = shift_boundary_mesh
  []

  [inout_test]
    type = PointInPolyhedronCheckUO
    builder = TreeBuilder
    obb_file_name = 'obb_bounds.e'
    ray_file_name = 'ray_bounds.e'
  []
[]

[Executioner]
  type = Steady
[]

(modules/shifted_boundary_method/test/tests/in_out_test/2D_mark_intercepted.i)

# Same immersed ellipse as 2D_lambda0p5.i, but with mark_intercepted = true so
# elements the surface cuts through are assigned a dedicated subdomain
# (subdomain_id_intercepted) instead of being resolved by the lambda fraction.
# This exercises the mark_intercepted return path in
# InterceptedElementModifier::computeSubdomainID and the corresponding branch of
# SBMElementSubdomainModifierBase.
nx = 16
lambda = 0.5
a = 1.6
b = 1.0
cx = 2.03
cy = 1.97
n_seg = 48
[Problem]
  solve = false
[]

[Mesh]
  [shift_boundary_mesh]
    type = ParsedCurveGenerator
    x_formula = '${cx} + ${a} * cos(t)'
    y_formula = '${cy} + ${b} * sin(t)'
    section_bounding_t_values = '0 ${fparse 2*pi}'
    nums_segments = '${n_seg}'
    is_closed_loop = true
    save_with_name = 'shift_boundary_mesh'
  []

  [gen]
    type = CartesianMeshGenerator
    dim = 2
    dx = '4'
    dy = '4'
    ix = '${nx}'
    iy = '${nx}'
    subdomain_id = '1'
  []

  add_subdomain_ids = '2 3' # outside block and intercepted block
  final_generator = 'gen'
[]

[UserObjects]
  [TreeBuilder]
    type = SBMSurfaceMeshBuilder
    check_watertightness = true
    surface_mesh = shift_boundary_mesh
  []

  [inout_test]
    type = PointInPolyhedronCheckUO
    builder = TreeBuilder
  []
[]

[MeshModifiers]
  [IntercpetedESM]
    type = InterceptedElementModifier
    subdomain_id_inside = 1
    subdomain_id_outside = 2
    lambda = ${lambda}
    is_domain_inside_surface = true
    in_out_test = inout_test
    mark_intercepted = true
    subdomain_id_intercepted = 3
    execute_on = 'INITIAL'
    execution_order_group = 0
  []
[]

[Variables]
  [u]
    initial_condition = 1
    block = 1
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
[]

(test/tests/userobjects/point_in_polyhedron/pca_ray_3d_stl.i)

# Framework point-in-polyhedron test on a closed 3D TRI3 surface read from an
# STL file, using only MooseTestApp objects. The surface is a simple tetrahedron
# with four triangular facets, read in with FileMeshGenerator.

[Problem]
  solve = false
[]

[Mesh]
  [surface_mesh]
    type = FileMeshGenerator
    file = tetrahedron.stl
    save_with_name = 'surface_mesh'
  []

  [gen]
    type = CartesianMeshGenerator
    dim = 3
    dx = '4'
    dy = '4'
    dz = '4'
    ix = '16'
    iy = '16'
    iz = '16'
    subdomain_id = '1'
  []

  final_generator = 'gen'
[]

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

[AuxKernels]
  [inside]
    type = SpatialUserObjectAux
    variable = inside
    user_object = in_out_test
    execute_on = 'initial'
  []
[]

[UserObjects]
  [surface_builder]
    type = BoundaryMeshBuilder
    surface_mesh = surface_mesh
  []

  [in_out_test]
    type = PointInPolyhedronCheckUO
    builder = surface_builder
    point_containment_method = pca_ray
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
[]

(test/tests/userobjects/point_in_polyhedron/fixed_x_ray_non_tri3.i)

# The fixed_x_ray backend (TriangleManifold engine) supports TRI3 surfaces only.
# Here the saved surface is the QUAD4 boundary of a hex cube (mesh_dimension 2 but
# not TRI3), so PointInPolyhedronCheckUO must reject it up front with a
# method-aware message rather than failing later inside TriangleManifold.
[Problem]
  solve = false
[]

[Mesh]
  [cube]
    type = GeneratedMeshGenerator
    dim = 3
    nx = 2
    ny = 2
    nz = 2
    xmin = 1
    xmax = 3
    ymin = 1
    ymax = 3
    zmin = 1
    zmax = 3
  []
  [shell]
    type = LowerDBlockFromSidesetGenerator
    input = cube
    sidesets = 'left right bottom top back front'
    new_block_id = 100
  []
  [surface_mesh]
    type = BlockToMeshConverterGenerator
    input = shell
    target_blocks = '100'
    save_with_name = 'surface_mesh'
  []

  [gen]
    type = CartesianMeshGenerator
    dim = 3
    dx = '4'
    dy = '4'
    dz = '4'
    ix = '4'
    iy = '4'
    iz = '4'
    subdomain_id = '1'
  []

  final_generator = 'gen'
[]

[UserObjects]
  [surface_builder]
    type = BoundaryMeshBuilder
    surface_mesh = surface_mesh
  []

  [in_out_test]
    type = PointInPolyhedronCheckUO
    builder = surface_builder
    point_containment_method = fixed_x_ray
  []
[]

[Executioner]
  type = Steady
[]

(test/tests/userobjects/point_in_union/union_mesh_and_stl.i)

# Three-dimensional union of two closed TRI3 surfaces given in mixed
# representations: a generator-built sphere shell (the boundary of a TET4 sphere)
# and a tetrahedron read from tetrahedron.stl. A point is contained when it is
# inside either surface.

[Problem]
  solve = false
[]

[Mesh]
  # Generator-built closed surface: extract the outer TRI3 shell of a TET4 sphere
  # and translate it to sit well above the STL tetrahedron, leaving a clear gap so
  # the two contained regions are visually distinct.
  [ball]
    type = SphereMeshGenerator
    radius = 1.0
    nr = 2
    elem_type = TET4
  []
  [shell]
    type = LowerDBlockFromSidesetGenerator
    input = ball
    sidesets = '0'
    new_block_id = 100
  []
  [extract]
    type = BlockToMeshConverterGenerator
    input = shell
    target_blocks = '100'
  []
  [sphere_surf]
    type = TransformGenerator
    transform = TRANSLATE
    vector_value = '2.0 2.0 4.5'
    input = extract
    save_with_name = 'sphere_surf'
  []

  # Closed surface read from an STL file (a tetrahedron spanning z in [1, 3]).
  [tet_surf]
    type = FileMeshGenerator
    file = tetrahedron.stl
    save_with_name = 'tet_surf'
  []

  [gen]
    type = CartesianMeshGenerator
    dim = 3
    dx = '4'
    dy = '4'
    dz = '6'
    ix = '8'
    iy = '8'
    iz = '12'
    subdomain_id = '1'
  []
  final_generator = 'gen'
[]

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

[AuxKernels]
  [inside]
    type = SpatialUserObjectAux
    variable = inside
    user_object = union
    execute_on = 'initial'
  []
[]

[UserObjects]
  [builder1]
    type = BoundaryMeshBuilder
    surface_mesh = sphere_surf
  []
  [builder2]
    type = BoundaryMeshBuilder
    surface_mesh = tet_surf
  []
  [check1]
    type = PointInPolyhedronCheckUO
    builder = builder1
    point_containment_method = pca_ray
  []
  [check2]
    type = PointInPolyhedronCheckUO
    builder = builder2
    point_containment_method = pca_ray
  []
  [union]
    type = PointInUnionCheckUO
    providers = 'check1 check2'
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
[]

(test/tests/userobjects/point_in_polyhedron/user_ray_direction.i)

# Framework point-in-polyhedron test proving the user_selected_ray method uses the caller's
# ray_direction exactly, rather than silently replacing it with the PCA auto direction. The
# anisotropic ellipse (a > b) makes the PCA direction ~ the y axis, so a user x-direction is
# discriminating: if the direction were swapped for PCA, the reported direction would differ.
# A PointInPolyhedronRayDirectionPostprocessor (test-only) reports the resolved ray direction
# components to CSV.
a = 1.6
b = 1.0
cx = 2.03
cy = 1.97

[Problem]
  solve = false
[]

[Mesh]
  [surface_mesh]
    type = ParsedCurveGenerator
    x_formula = '${cx} + ${a} * cos(t)'
    y_formula = '${cy} + ${b} * sin(t)'
    section_bounding_t_values = '0 ${fparse 2*pi}'
    nums_segments = '48'
    is_closed_loop = true
    save_with_name = 'surface_mesh'
  []

  [gen]
    type = CartesianMeshGenerator
    dim = 2
    dx = '4'
    dy = '4'
    ix = '16'
    iy = '16'
    subdomain_id = '1'
  []

  final_generator = 'gen'
[]

[UserObjects]
  [surface_builder]
    type = BoundaryMeshBuilder
    surface_mesh = surface_mesh
  []

  [in_out_test]
    type = PointInPolyhedronCheckUO
    builder = surface_builder
    point_containment_method = user_selected_ray
    ray_direction = '1 0 0' # overridden per test via cli_args
  []
[]

[Postprocessors]
  [ray_x]
    type = PointInPolyhedronRayDirectionPostprocessor
    user_object = in_out_test
    component = x
    execute_on = 'initial'
  []
  [ray_y]
    type = PointInPolyhedronRayDirectionPostprocessor
    user_object = in_out_test
    component = y
    execute_on = 'initial'
  []
  [ray_z]
    type = PointInPolyhedronRayDirectionPostprocessor
    user_object = in_out_test
    component = z
    execute_on = 'initial'
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  csv = true
  execute_on = 'initial'
[]

(modules/shifted_boundary_method/test/tests/in_out_test/3D_lambda1.i)

nx = 16
lambda = 1
# Immersed triaxial ellipsoid: three distinct semi-axes make the boundary
# anisotropic so PCA has a well-separated shortest axis, giving a reproducible
# auto ray direction. Off-grid center keeps the surface cutting elements at
# generic fractions with no node/quadrature point landing exactly on it.
ax = 1.5
ay = 1.15
az = 0.85
cx = 2.03
cy = 1.97
cz = 2.05
[Problem]
  solve = false
[]

[Mesh]
  [ball]
    type = SphereMeshGenerator
    radius = 1.0
    nr = 1
    elem_type = TET4
  []
  [shell]
    type = LowerDBlockFromSidesetGenerator
    input = ball
    sidesets = '0'
    new_block_id = 100
  []
  [extract]
    type = BlockToMeshConverterGenerator
    input = shell
    target_blocks = '100'
  []
  [scale]
    type = TransformGenerator
    transform = SCALE
    vector_value = '${ax} ${ay} ${az}'
    input = extract
  []
  [shift_boundary_mesh]
    type = TransformGenerator
    transform = TRANSLATE
    vector_value = '${cx} ${cy} ${cz}'
    input = scale
    save_with_name = 'shift_boundary_mesh'
  []

  [gen]
    type = CartesianMeshGenerator
    dim = 3
    dx = '4'
    dy = '4'
    dz = '4'
    ix = '${nx}'
    iy = '${nx}'
    iz = '${nx}'
    subdomain_id = '1'
  []

  add_subdomain_ids = 2 # outside block
  add_sideset_names = 'SBMinterface'
  final_generator = 'gen'
[]

[UserObjects]
  [TreeBuilder]
    type = SBMSurfaceMeshBuilder
    check_watertightness = true
    surface_mesh = shift_boundary_mesh
  []
  [inout_test]
    type = PointInPolyhedronCheckUO
    builder = TreeBuilder
  []
[]

[MeshModifiers]
  [IntercpetedESM]
    type = InterceptedElementModifier
    subdomain_id_inside = 1
    subdomain_id_outside = 2
    lambda = ${lambda}
    is_domain_inside_surface = true
    in_out_test = inout_test
    execute_on = 'INITIAL'
    execution_order_group = 0
  []
  [SBMinterface]
    type = SidesetAroundSubdomainUpdater
    inner_subdomains = 1
    outer_subdomains = 2
    update_sideset_name = 'SBMinterface'
    assign_outer_surface_sides = false
    execute_on = 'INITIAL'
    execution_order_group = 1
    block = '1 2' # need to override default block
  []
[]

[Variables]
  [u]
    initial_condition = 1
    block = 1
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
[]

(modules/shifted_boundary_method/test/tests/in_out_test/2D_lambda1.i)

nx = 16
lambda = 1
# Immersed ellipse geometry: distinct semi-axes make the boundary anisotropic so
# PCA has a well-separated minor axis, giving a reproducible auto ray direction.
# Off-grid center keeps the arc cutting elements at generic fractions with no
# node/quadrature point landing exactly on the surface.
a = 1.6
b = 1.0
cx = 2.03
cy = 1.97
n_seg = 48
[Problem]
  solve = false
[]

[Mesh]
  [shift_boundary_mesh]
    type = ParsedCurveGenerator
    x_formula = '${cx} + ${a} * cos(t)'
    y_formula = '${cy} + ${b} * sin(t)'
    section_bounding_t_values = '0 ${fparse 2*pi}'
    nums_segments = '${n_seg}'
    is_closed_loop = true
    save_with_name = 'shift_boundary_mesh'
  []

  [gen]
    type = CartesianMeshGenerator
    dim = 2
    dx = '4'
    dy = '4'
    ix = '${nx}'
    iy = '${nx}'
    subdomain_id = '1'
  []

  add_subdomain_ids = 2 # outside block
  add_sideset_names = 'SBMinterface'
  final_generator = 'gen'
[]

[UserObjects]
  [TreeBuilder]
    type = SBMSurfaceMeshBuilder
    check_watertightness = true
    surface_mesh = shift_boundary_mesh
  []

  [inout_test]
    type = PointInPolyhedronCheckUO
    builder = TreeBuilder
  []
[]

[MeshModifiers]
  [IntercpetedESM]
    type = InterceptedElementModifier
    subdomain_id_inside = 1
    subdomain_id_outside = 2
    lambda = ${lambda}
    is_domain_inside_surface = true
    in_out_test = inout_test
    execute_on = 'INITIAL'
    execution_order_group = 0
  []
  [SBMinterface]
    type = SidesetAroundSubdomainUpdater
    inner_subdomains = 1
    outer_subdomains = 2
    update_sideset_name = 'SBMinterface'
    assign_outer_surface_sides = false
    execute_on = 'INITIAL'
    execution_order_group = 1
    block = '1 2' # need to override default block
  []
[]

[Variables]
  [u]
    initial_condition = 1
    block = 1
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
[]

(modules/shifted_boundary_method/test/tests/in_out_test/3D_lambda0p5.i)

nx = 16
lambda = 0.5
# Immersed triaxial ellipsoid: three distinct semi-axes make the boundary
# anisotropic so PCA has a well-separated shortest axis, giving a reproducible
# auto ray direction. Off-grid center keeps the surface cutting elements at
# generic fractions with no node/quadrature point landing exactly on it.
ax = 1.5
ay = 1.15
az = 0.85
cx = 2.03
cy = 1.97
cz = 2.05
[Problem]
  solve = false
[]

[Mesh]
  [ball]
    type = SphereMeshGenerator
    radius = 1.0
    nr = 1
    elem_type = TET4
  []
  [shell]
    type = LowerDBlockFromSidesetGenerator
    input = ball
    sidesets = '0'
    new_block_id = 100
  []
  [extract]
    type = BlockToMeshConverterGenerator
    input = shell
    target_blocks = '100'
  []
  [scale]
    type = TransformGenerator
    transform = SCALE
    vector_value = '${ax} ${ay} ${az}'
    input = extract
  []
  [shift_boundary_mesh]
    type = TransformGenerator
    transform = TRANSLATE
    vector_value = '${cx} ${cy} ${cz}'
    input = scale
    save_with_name = 'shift_boundary_mesh'
  []

  [gen]
    type = CartesianMeshGenerator
    dim = 3
    dx = '4'
    dy = '4'
    dz = '4'
    ix = '${nx}'
    iy = '${nx}'
    iz = '${nx}'
    subdomain_id = '1'
  []

  add_subdomain_ids = 2 # outside block
  add_sideset_names = 'SBMinterface'
  final_generator = 'gen'
[]

[UserObjects]
  [TreeBuilder]
    type = SBMSurfaceMeshBuilder
    check_watertightness = true
    surface_mesh = shift_boundary_mesh
  []
  [inout_test]
    type = PointInPolyhedronCheckUO
    builder = TreeBuilder
  []
[]

[MeshModifiers]
  [IntercpetedESM]
    type = InterceptedElementModifier
    subdomain_id_inside = 1
    subdomain_id_outside = 2
    lambda = ${lambda}
    is_domain_inside_surface = true
    in_out_test = inout_test
    execute_on = 'INITIAL'
    execution_order_group = 0
  []
  [SBMinterface]
    type = SidesetAroundSubdomainUpdater
    inner_subdomains = 1
    outer_subdomains = 2
    update_sideset_name = 'SBMinterface'
    assign_outer_surface_sides = false
    execute_on = 'INITIAL'
    execution_order_group = 1
    block = '1 2' # need to override default block
  []
[]

[Variables]
  [u]
    initial_condition = 1
    block = 1
  []
[]

[Executioner]
  type = Steady
[]

[Outputs]
  exodus = true
[]

Point - containment methods
Usage
Composition into a union
Input Parameters
Input Files