www.mooseframework.org
Classes | Functions
FindValueOnLine.h File Reference

Go to the source code of this file.

Classes

class  FindValueOnLine
 Find a specific target value along a sampling line. More...
 

Functions

template<>
InputParameters validParams< FindValueOnLine > ()
 

Function Documentation

Definition at line 24 of file FindValueOnLine.C.

25 {
27  params.addClassDescription("Find a specific target value along a sampling line. The variable "
28  "values along the line should change monotonically. The target value "
29  "is searched using a bisection algorithm.");
30  params.addParam<Point>("start_point", "Start point of the sampling line.");
31  params.addParam<Point>("end_point", "End point of the sampling line.");
32  params.addParam<Real>("target", "Target value to locate.");
33  params.addParam<unsigned int>("depth", 36, "Maximum number of bisections to perform.");
34  params.addParam<Real>(
35  "tol",
36  1e-10,
37  "Stop search if a value is found that is equal to the target with this tolerance applied.");
38  params.addCoupledVar("v", "Variable to inspect");
39  return params;
40 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
InputParameters validParams< GeneralPostprocessor >()
void addCoupledVar(const std::string &name, const std::string &doc_string)
This method adds a coupled variable name pair.
void addClassDescription(const std::string &doc_string)
This method adds a description of the class that will be displayed in the input file syntax dump...
void addParam(const std::string &name, const S &value, const std::string &doc_string)
These methods add an option parameter and a documentation string to the InputParameters object...