FindValueOnLine

The FindValueOnLine Postprocessor is for sampling a line through a mesh or on a boundary looking for the point at which a specific value occurs. The values of the line must behave monotonically or an indeterminate solution may be found.

Find a specific target value along a sampling line. The variable values along the line should change monotonically. The target value is searched using a bisection algorithm.

Input Parameters

  • default_value-1Value to return if target value is not found on line and error_if_not_found is false.

    Default:-1

    C++ Type:double

    Options:

    Description:Value to return if target value is not found on line and error_if_not_found is false.

  • depth36Maximum number of bisections to perform.

    Default:36

    C++ Type:unsigned int

    Options:

    Description:Maximum number of bisections to perform.

  • end_pointEnd point of the sampling line.

    C++ Type:libMesh::Point

    Options:

    Description:End point of the sampling line.

  • error_if_not_foundTrueIf true, stop with error if target value is not found on the line. If false, return default_value.

    Default:True

    C++ Type:bool

    Options:

    Description:If true, stop with error if target value is not found on the line. If false, return default_value.

  • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

    Default:TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM, TRANSFER

    Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

  • start_pointStart point of the sampling line.

    C++ Type:libMesh::Point

    Options:

    Description:Start point of the sampling line.

  • targetTarget value to locate.

    C++ Type:double

    Options:

    Description:Target value to locate.

  • tol1e-10Stop search if a value is found that is equal to the target with this tolerance applied.

    Default:1e-10

    C++ Type:double

    Options:

    Description:Stop search if a value is found that is equal to the target with this tolerance applied.

  • vVariable to inspect

    C++ Type:std::vector<VariableName>

    Options:

    Description:Variable to inspect

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

    Options:

    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).

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector<std::string>

    Options:

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

  • force_preauxFalseForces the GeneralUserObject to be executed in PREAUX

    Default:False

    C++ Type:bool

    Options:

    Description:Forces the GeneralUserObject to be executed in PREAUX

  • force_preicFalseForces the GeneralUserObject to be executed in PREIC during initial setup

    Default:False

    C++ Type:bool

    Options:

    Description:Forces the GeneralUserObject to be executed in PREIC during initial setup

  • outputsVector of output names were you would like to restrict the output of variables(s) associated with this object

    C++ Type:std::vector<OutputName>

    Options:

    Description:Vector of output names were 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

    Options:

    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

Input Files

References