www.mooseframework.org
FindValueOnLine.h
Go to the documentation of this file.
1 /****************************************************************/
2 /* DO NOT MODIFY THIS HEADER */
3 /* MOOSE - Multiphysics Object Oriented Simulation Environment */
4 /* */
5 /* (c) 2010 Battelle Energy Alliance, LLC */
6 /* ALL RIGHTS RESERVED */
7 /* */
8 /* Prepared by Battelle Energy Alliance, LLC */
9 /* Under Contract No. DE-AC07-05ID14517 */
10 /* With the U. S. Department of Energy */
11 /* */
12 /* See COPYRIGHT for full restrictions */
13 /****************************************************************/
14 
15 #ifndef FINDVALUEONLINE_H
16 #define FINDVALUEONLINE_H
17 
18 #include "GeneralPostprocessor.h"
19 #include "Coupleable.h"
20 
21 class FindValueOnLine;
22 
23 template <>
25 
34 {
35 public:
37 
38  virtual void initialize() override;
39  virtual void execute() override;
40 
41  virtual PostprocessorValue getValue() override;
42 
43 protected:
44  Real getValueAtPoint(const Point & p);
45 
47  const Point _start_point;
48  const Point _end_point;
49  const Real _length;
51 
53  const Real _target;
54 
56  const unsigned int _depth;
57 
59  const Real _tol;
60 
63 
65  Real _position;
66 
69 
71  std::vector<Point> _point_vec;
72 
74  std::unique_ptr<PointLocatorBase> _pl;
75 };
76 
77 #endif // FINDVALUEONLINE_H
const Point _start_point
line to sample along
virtual void execute() override
Execute method.
virtual void initialize() override
Called before execute() is ever called so that data can be cleared.
Class for stuff related to variables.
Definition: MooseVariable.h:43
const Real _tol
tolerance for comparison to the target value
InputParameters validParams< FindValueOnLine >()
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
virtual PostprocessorValue getValue() override
This will get called to actually grab the final value the postprocessor has calculated.
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
const Real _length
FindValueOnLine(const InputParameters &parameters)
Find a specific target value along a sampling line.
Real getValueAtPoint(const Point &p)
std::unique_ptr< PointLocatorBase > _pl
helper object to locate elements containing points
Real PostprocessorValue
MOOSE typedefs.
Definition: MooseTypes.h:73
MooseMesh wraps a libMesh::Mesh object and enhances its capabilities by caching additional data and s...
Definition: MooseMesh.h:74
const Point _end_point
MooseMesh & _mesh
The Mesh we&#39;re using.
const Real _target
value to find along the line
MooseVariable * _coupled_var
coupled variable
Interface for objects that needs coupling capabilities.
Definition: Coupleable.h:35
const unsigned int _depth
search depth
std::vector< Point > _point_vec
So we don&#39;t have to create and destroy the dummy vector.
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:53
Real _position
detected interface location