ClosestElemsToLine

Reports coordinates and element ids of the closest nodes to a line with unique domain_var values.

Example Input File Syntax

ClosestElemsToLine finds all element centroids within a projection_tolerance of a line segement. The two points defining the line segment are read from a reporter. The domain_var is the variable used for screening the elements i.e. each element selected must have a unique domain_var. domain_var are round to their nearest integer value.

[Reporters<<<{"href": "../../syntax/Reporters/index.html"}>>>]
  [differentID_out]
    type = ClosestElemsToLine<<<{"description": "Reports coordinates and element ids of the closest nodes to a line with unique domain_var values. ", "href": "ClosestElemsToLine.html"}>>>
    projection_tolerance<<<{"description": "Search tolerance between line and the closest node.  If a node is not found, an error will be produced"}>>> = 1
    point_x1<<<{"description": "input reporter of x-coordinate name for point.  This uses the reporter syntax <reporter>/<name>."}>>> = pt/pt1_x
    point_y1<<<{"description": "input reporter of y-coordinate name for point.  This uses the reporter syntax <reporter>/<name>."}>>> = pt/pt1_y
    point_z1<<<{"description": "input reporter of z-coordinate name for point.  This uses the reporter syntax <reporter>/<name>."}>>> = pt/pt1_z
    point_x2<<<{"description": "input reporter of x-coordinate name for point.  This uses the reporter syntax <reporter>/<name>."}>>> = pt/pt2_x
    point_y2<<<{"description": "input reporter of y-coordinate name for point.  This uses the reporter syntax <reporter>/<name>."}>>> = pt/pt2_y
    point_z2<<<{"description": "input reporter of z-coordinate name for point.  This uses the reporter syntax <reporter>/<name>."}>>> = pt/pt2_z
    variable<<<{"description": "Name for the variable in domain to determine uniqueness"}>>> = differentID
    outputs<<<{"description": "Vector of output names where you would like to restrict the output of variables(s) associated with this object"}>>> = out
  []
[]

Input Parameters

point_x1input reporter of x-coordinate name for point. This uses the reporter syntax /.
C++ Type:ReporterName
Controllable:No
Description:input reporter of x-coordinate name for point. This uses the reporter syntax /.
point_x2input reporter of x-coordinate name for point. This uses the reporter syntax /.
C++ Type:ReporterName
Controllable:No
Description:input reporter of x-coordinate name for point. This uses the reporter syntax /.
point_y1input reporter of y-coordinate name for point. This uses the reporter syntax /.
C++ Type:ReporterName
Controllable:No
Description:input reporter of y-coordinate name for point. This uses the reporter syntax /.
point_y2input reporter of y-coordinate name for point. This uses the reporter syntax /.
C++ Type:ReporterName
Controllable:No
Description:input reporter of y-coordinate name for point. This uses the reporter syntax /.
point_z1input reporter of z-coordinate name for point. This uses the reporter syntax /.
C++ Type:ReporterName
Controllable:No
Description:input reporter of z-coordinate name for point. This uses the reporter syntax /.
point_z2input reporter of z-coordinate name for point. This uses the reporter syntax /.
C++ Type:ReporterName
Controllable:No
Description:input reporter of z-coordinate name for point. This uses the reporter syntax /.

Required Parameters

blockThe list of blocks (ids or names) that this object will be applied
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:The list of blocks (ids or names) that this object will be applied
projection_tolerance1e-06Search tolerance between line and the closest node. If a node is not found, an error will be produced
Default:1e-06
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Search tolerance between line and the closest node. If a node is not found, an error will be produced
variableName for the variable in domain to determine uniqueness
C++ Type:VariableName
Unit:(no unit assumed)
Controllable:No
Description:Name for the variable in domain to determine uniqueness

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: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, FINAL, CUSTOM
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.
outputsVector of output names where you would like to restrict the output of variables(s) associated with this object
C++ Type:std::vector<OutputName>
Controllable:No
Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object
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

(test/tests/reporters/closest_elems_to_line/constant_line_projection.i)

Child Objects

(include/reporters/ClosestElemsToLineWithValues.h)

(test/tests/reporters/closest_elems_to_line/constant_line_projection.i)

#The line segment defined in the constant reporter intersects exactly at the
#element centroid at the correct location with this mesh density.
#The mesh used in these simulations is created using the following MeshGeneratorMesh and auxKernel

# [Mesh]
# type = MeshGeneratorMesh
# [dfn1]
#   type = GeneratedMeshGenerator
#   dim = 2
#   nx = 5
#   ny = 5
#   elem_type = QUAD4
# []
# [dfn2]
#   type = GeneratedMeshGenerator
#   dim = 2
#   nx = 5
#   ny = 5
#   elem_type = QUAD4
# []
# [dfn2_shift]
#   type = TransformGenerator
#   input = dfn2
#   transform = TRANSLATE
#   vector_value = '0 0 -4'
# []
# [dfn3]
#   type = GeneratedMeshGenerator
#   dim = 2
#   nx = 5
#   ny = 5
#   elem_type = QUAD4
# []
# [dfn3_shift]
#   type = TransformGenerator
#   input = dfn3
#   transform = TRANSLATE
#   vector_value = '0 0 2'
# []
# [dfns]
#   type = MeshCollectionGenerator
#   inputs = 'dfn1 dfn2_shift dfn3_shift'
# []
# []
# [AuxKernels]
# [differentID]
#   type = ParsedAux
#   variable = differentID
#   use_xyzt = true
#   function = 'z'
#   execute_on = INITIAL
# []
# []

[Mesh]
  [meshFromAboveCommands]
    type = FileMeshGenerator
    file = 'planes_with_fracIds.e'
    use_for_exodus_restart = true
  []
[]

[Problem]
  solve = false
[]

[AuxVariables]
  [oneID]
    family = MONOMIAL
    order = CONSTANT
    initial_condition = 3
  []
  [differentID]
    family = MONOMIAL
    order = CONSTANT
    initial_from_file_var = differentID
    initial_from_file_timestep = 'LATEST'
  []
[]

[AuxKernels]
  [oneID]
    type = ConstantAux
    variable = oneID
    value = 5
  []
[]

[Executioner]
  type = Steady
[]

[Reporters]
  [pt]
    type = ConstantReporter
    real_vector_names = 'pt1_x pt1_y pt1_z pt2_x pt2_y pt2_z'
    real_vector_values = '-0;0;-5; 1;1;5'
    outputs = none
  []

  [oneID_out]
    type = ClosestElemsToLine
    projection_tolerance = 1
    point_x1 = pt/pt1_x
    point_y1 = pt/pt1_y
    point_z1 = pt/pt1_z
    point_x2 = pt/pt2_x
    point_y2 = pt/pt2_y
    point_z2 = pt/pt2_z
    variable = oneID
    outputs = out
  []
  [differentID_out]
    type = ClosestElemsToLine
    projection_tolerance = 1
    point_x1 = pt/pt1_x
    point_y1 = pt/pt1_y
    point_z1 = pt/pt1_z
    point_x2 = pt/pt2_x
    point_y2 = pt/pt2_y
    point_z2 = pt/pt2_z
    variable = differentID
    outputs = out
  []
  [noID_out]
    type = ClosestElemsToLine
    projection_tolerance = 0.2
    point_x1 = pt/pt1_x
    point_y1 = pt/pt1_y
    point_z1 = pt/pt1_z
    point_x2 = pt/pt2_x
    point_y2 = pt/pt2_y
    point_z2 = pt/pt2_z
    outputs = out
  []
[]

[Outputs]
  [out]
    type = JSON
    execute_system_information_on = none
  []
[]