Shifted Boundary Method Failure Analysis Report

Introduction

The FAR for the Shifted Boundary Method module describes the system functional and non-functional requirements that describe the expected interactions that the software shall provide.

Dependencies

The Shifted Boundary Method module is developed using MOOSE and can itself be based on various MOOSE modules, as such the FAR for the Shifted Boundary Method module is dependent upon the following documents.

Framework Failure Analysis Report

Failure Analysis Requirements

The following is a complete list for all the requirements related to failure analysis for the Shifted Boundary Method module.

shifted_boundary_method: Distance Calc
18.2.2
The system shall throw an error
1. if ElementCentroidToSurfaceDistanceAux is applied to a nodal variable.
2. if ShortestDistanceToSurface receives a function whose type is not ParsedFunction, UnsignedDistanceToSurfaceMesh, or SignedDistanceToSurfaceMesh.
3. if the embedding mesh dimension does not match the SBM surface mesh dimension plus one.
4. if the SBM surface mesh contains element types other than EDGE2 or TRI3.
5. if the SBM surface mesh is distributed, since SBMSurfaceMeshBuilder requires a replicated mesh for its In-Out test.
6. if an UnsignedDistanceToSurfaceMesh function is paired with an SBMSurfaceMeshBuilder that was configured without a KDTree.
7. if a signed distance is requested from a function that is neither a ParsedFunction nor a SignedDistanceToSurfaceMesh.
8. if SignedDistanceToSurfaceMesh receives an in-out test user object that does not implement the point-in-surface check interface.
Specification(s): error_test/nodal_variable, error_test/unsupported_surface_function, error_test/dim_mismatch, error_test/unsupported_element_type, error_test/distributed_surface_mesh, error_test/unsigned_distance_without_kd_tree, error_test/signed_distance_invalid_strategy, error_test/signed_distance_in_out_test_wrong_type
Design: UnsignedDistanceToSurfaceMesh SignedDistanceToSurfaceMesh ShortestDistanceToSurface
Issue(s): #31937 #33397
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException

shifted_boundary_method: In Out Test
18.3.3The system shall reject an InterceptedElementModifier lambda outside the inclusive range from zero to one.
Specification(s): invalid_lambda
Design: InterceptedElementModifier PointInPolyhedronCheckUO SBMSurfaceMeshBuilder
Issue(s): #33397
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
18.3.4The system shall reject a non-positive tolerance for the point-in-polyhedron in-out test.
Specification(s): zero_tolerance
Design: InterceptedElementModifier PointInPolyhedronCheckUO SBMSurfaceMeshBuilder
Issue(s): #33397
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
18.3.14The system shall report an error when mark_intercepted is enabled without specifying the intercepted subdomain ID.
Specification(s): mark_intercepted_missing_id
Design: InterceptedElementModifier PointInPolyhedronCheckUO SBMSurfaceMeshBuilder
Issue(s): #33397
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
18.3.15The system shall report an error when an InterceptedElementModifier is configured with neither an in-out test user object nor a signed distance function.
Specification(s): no_in_out_test
Design: InterceptedElementModifier PointInPolyhedronCheckUO SBMSurfaceMeshBuilder
Issue(s): #33397
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
18.3.16The system shall report an error when an InterceptedElementModifier receives an in-out test user object that does not implement the point-in-surface check interface.
Specification(s): in_out_test_wrong_type
Design: InterceptedElementModifier PointInPolyhedronCheckUO SBMSurfaceMeshBuilder
Issue(s): #33397
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException
18.3.17The system shall report an error when an InterceptedElementModifier is configured with both an in-out test user object and a signed distance function.
Specification(s): both_geometry_sources
Design: InterceptedElementModifier PointInPolyhedronCheckUO SBMSurfaceMeshBuilder
Issue(s): #33397
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException

shifted_boundary_method: Subdomain Element Modifier
18.4.5
The system shall throw an error
1. if the SurfaceMeshBySubdomainBuilder surface mesh is distributed, since it requires a replicated mesh for its In-Out test.
2. if the embedding mesh dimension does not match the surface mesh dimension plus one.
3. if the SurfaceMeshBySubdomainBuilder surface mesh contains element types other than EDGE2 or TRI3.
4. if the fixed_x_ray method is requested for PointInSubdomainCheckUO, which performs per-subdomain ray-casting and cannot use the whole-mesh TriangleManifold engine.
5. if a point is contained in more than one subdomain of a PointInSubdomainCheckUO surface mesh, since a single-subdomain query is then ambiguous.
Specification(s): error_test/distributed_surface_mesh, error_test/dim_mismatch, error_test/unsupported_element_type, error_test/fixed_x_ray_unsupported, error_test/ambiguous_subdomain
Design: SubdomainElementModifier SurfaceMeshBySubdomainBuilder PointInSubdomainCheckUO
Issue(s): #33397
Collection(s): FAILURE_ANALYSISFUNCTIONAL
Type(s): RunException


[nodal_variable]
  type = 'RunException'
  input = '2D_distance_refine.i'
  cli_args = 'AuxVariables/distance/order=FIRST AuxVariables/distance/family=LAGRANGE'
  expect_err = 'This AuxKernel only supports Elemental fields'
  mesh_mode = REPLICATED
  recover = false
  detail = 'if ElementCentroidToSurfaceDistanceAux is applied to a nodal variable.'
[]


[unsupported_surface_function]
  type = 'RunException'
  input = '2D_distance_refine.i'
  cli_args = 'Functions/const_fun/type=ConstantFunction Functions/const_fun/value=1.0 UserObjects/distance_to_surface/surfaces=const_fun'
  expect_err = 'SBM distance helpers only support ParsedFunction, UnsignedDistanceToSurfaceMesh, or SignedDistanceToSurfaceMesh'
  mesh_mode = REPLICATED
  recover = false
  detail = 'if ShortestDistanceToSurface receives a function whose type is not ParsedFunction, UnsignedDistanceToSurfaceMesh, or SignedDistanceToSurfaceMesh.'
[]


[dim_mismatch]
  type = 'RunException'
  input = '2D_distance_refine.i'
  cli_args = 'Mesh/boundary_mesh/file=quad_surface.msh'
  expect_err = 'does not match the surface mesh dimension'
  mesh_mode = REPLICATED
  recover = false
  detail = 'if the embedding mesh dimension does not match the SBM surface mesh dimension plus one.'
[]


[unsupported_element_type]
  type = 'RunException'
  input = '3D_distance_refine.i'
  cli_args = 'Mesh/boundary_mesh/file=quad_surface.msh'
  expect_err = 'unsupported element type'
  mesh_mode = REPLICATED
  recover = false
  detail = 'if the SBM surface mesh contains element types other than EDGE2 or TRI3.'
[]


[distributed_surface_mesh]
  type = 'RunException'
  input = '2D_distance_refine.i'
  cli_args = 'Mesh/parallel_type=DISTRIBUTED'
  expect_err = 'mesh is distributed'
  recover = false
  detail = 'if the SBM surface mesh is distributed, since SBMSurfaceMeshBuilder requires a replicated mesh for its In-Out test.'
[]


[unsigned_distance_without_kd_tree]
  type = 'RunException'
  input = '2D_distance_refine.i'
  cli_args = 'UserObjects/TreeBuilder/build_kd_tree=false'
  expect_err = "requires SBMSurfaceMeshBuilder"
  mesh_mode = REPLICATED
  recover = false
  detail = 'if an UnsignedDistanceToSurfaceMesh function is paired with an SBMSurfaceMeshBuilder that was configured without a KDTree.'
[]


[signed_distance_invalid_strategy]
  type = 'RunException'
  input = '2D_signed_distance.i'
  cli_args = 'UserObjects/signed_distance_to_surface/surfaces=dist_square'
  expect_err = 'was not a valid signed distance strategy'
  mesh_mode = REPLICATED
  recover = false
  detail = 'if a signed distance is requested from a function that is neither a ParsedFunction nor a SignedDistanceToSurfaceMesh.'
[]


[signed_distance_in_out_test_wrong_type]
  type = 'RunException'
  input = '2D_signed_distance.i'
  cli_args = 'Functions/sign_dist_square/in_out_test=TreeBuilder'
  expect_err = 'does not implement the point-in-surface check interface'
  mesh_mode = REPLICATED
  recover = false
  detail = 'if SignedDistanceToSurfaceMesh receives an in-out test user object that does not implement the point-in-surface check interface.'
[]


[invalid_lambda]
  type = 'RunException'
  input = '2D_lambda0p5.i'
  cli_args = 'MeshModifiers/IntercpetedESM/lambda=-0.1'
  expect_err = "Range check failed for parameter MeshModifiers/IntercpetedESM/lambda; expression = 'lambda >= 0 & lambda <= 1'"
  mesh_mode = REPLICATED
  recover = false
  requirement = 'The system shall reject an InterceptedElementModifier lambda outside the inclusive range from zero to one.'
[]


[zero_tolerance]
  type = 'RunException'
  input = '2D_lambda0p5.i'
  cli_args = 'UserObjects/inout_test/tolerance=0'
  expect_err = "tolerance.*must be greater than zero"
  mesh_mode = REPLICATED
  recover = false
  requirement = 'The system shall reject a non-positive tolerance for the point-in-polyhedron in-out test.'
[]


[mark_intercepted_missing_id]
  type = 'RunException'
  input = '2D_lambda0p5.i'
  cli_args = 'MeshModifiers/IntercpetedESM/mark_intercepted=true'
  expect_err = "This parameter must be specified when 'mark_intercepted' is true."
  mesh_mode = REPLICATED
  recover = false
  requirement = 'The system shall report an error when mark_intercepted is enabled without specifying the intercepted subdomain ID.'
[]


[no_in_out_test]
  type = 'RunException'
  input = 'intercepted_no_test.i'
  expect_err = 'provide exactly one geometry source, but neither'
  mesh_mode = REPLICATED
  recover = false
  requirement = 'The system shall report an error when an InterceptedElementModifier is configured with neither an in-out test user object nor a signed distance function.'
[]


[in_out_test_wrong_type]
  type = 'RunException'
  input = '2D_lambda0p5.i'
  cli_args = 'MeshModifiers/IntercpetedESM/in_out_test=TreeBuilder'
  expect_err = 'does not implement the point-in-surface check interface'
  mesh_mode = REPLICATED
  recover = false
  requirement = 'The system shall report an error when an InterceptedElementModifier receives an in-out test user object that does not implement the point-in-surface check interface.'
[]


[both_geometry_sources]
  type = 'RunException'
  input = '2D_lambda0p5.i'
  cli_args = 'Functions/level_set/type=ParsedFunction Functions/level_set/expression=x MeshModifiers/IntercpetedESM/signed_dist_function=level_set'
  expect_err = 'provide exactly one geometry source, but both'
  mesh_mode = REPLICATED
  recover = false
  requirement = 'The system shall report an error when an InterceptedElementModifier is configured with both an in-out test user object and a signed distance function.'
[]


[distributed_surface_mesh]
  type = RunException
  input = 'grain_marking.i'
  cli_args = 'Mesh/parallel_type=DISTRIBUTED'
  expect_err = 'mesh is distributed'
  recover = false
  detail = 'if the SurfaceMeshBySubdomainBuilder surface mesh is distributed, since it requires a replicated mesh for its In-Out test.'
[]


[dim_mismatch]
  type = RunException
  input = 'grain_marking.i'
  cli_args = 'Mesh/boundary_mesh/file=../distance_calc/cube_surface.msh'
  expect_err = 'does not match the surface mesh dimension'
  mesh_mode = REPLICATED
  recover = false
  detail = 'if the embedding mesh dimension does not match the surface mesh dimension plus one.'
[]


[unsupported_element_type]
  type = RunException
  input = 'grain_marking.i'
  cli_args = 'Mesh/background_mesh/dim=3 Mesh/background_mesh/zmin=-0.4 Mesh/background_mesh/zmax=0.4 Mesh/background_mesh/nz=6 Mesh/boundary_mesh/file=../distance_calc/quad_surface.msh'
  expect_err = 'unsupported element type'
  mesh_mode = REPLICATED
  recover = false
  detail = 'if the SurfaceMeshBySubdomainBuilder surface mesh contains element types other than EDGE2 or TRI3.'
[]


[fixed_x_ray_unsupported]
  type = RunException
  input = 'grain_marking.i'
  cli_args = 'UserObjects/subdomain_tester/point_containment_method=fixed_x_ray'
  expect_err = 'fixed_x_ray is not supported by PointInSubdomainCheckUO'
  mesh_mode = REPLICATED
  recover = false
  detail = 'if the fixed_x_ray method is requested for PointInSubdomainCheckUO, which performs per-subdomain ray-casting and cannot use the whole-mesh TriangleManifold engine.'
[]


[ambiguous_subdomain]
  type = RunException
  input = 'subdomain_point_query.i'
  # Single background element whose centroid is the midpoint of the edge shared by grains 1 and
  # 2, so whichSubdomain() reports the point ON both subdomains.
  cli_args = 'Mesh/background_mesh/nx=1 Mesh/background_mesh/ny=1 Mesh/background_mesh/xmin=0.3543469099322497 Mesh/background_mesh/xmax=0.5543469099322497 Mesh/background_mesh/ymin=-0.08224820222176318 Mesh/background_mesh/ymax=0.11775179777823683'
  expect_err = 'is contained in multiple subdomains'
  allow_test_objects = true
  mesh_mode = REPLICATED
  recover = false
  detail = 'if a point is contained in more than one subdomain of a PointInSubdomainCheckUO surface mesh, since a single-subdomain query is then ambiguous.'
[]

Introduction
Dependencies
Failure Analysis Requirements