www.mooseframework.org
VectorPostprocessorInterface.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 VECTORPOSTPROCESSORINTERFACE_H
16 #define VECTORPOSTPROCESSORINTERFACE_H
17 
18 // MOOSE includes
19 #include "MooseTypes.h"
20 
21 // Forward Declarations
22 class FEProblemBase;
23 class InputParameters;
24 class MooseObject;
25 
27 {
28 public:
29  VectorPostprocessorInterface(const MooseObject * moose_object);
30 
34  virtual ~VectorPostprocessorInterface() = default;
35 
50  virtual const VectorPostprocessorValue &
51  getVectorPostprocessorValue(const std::string & name, const std::string & vector_name);
52 
67  virtual const VectorPostprocessorValue &
68  getVectorPostprocessorValueByName(const VectorPostprocessorName & name,
69  const std::string & vector_name);
70 
79  const VectorPostprocessorValue & getVectorPostprocessorValueOld(const std::string & name,
80  const std::string & vector_name);
81 
96  getVectorPostprocessorValueOldByName(const VectorPostprocessorName & name,
97  const std::string & vector_name);
98 
106  bool hasVectorPostprocessor(const std::string & name) const;
107 
115  bool hasVectorPostprocessorByName(const VectorPostprocessorName & name) const;
116 
117 private:
120 
123 
126 };
127 
128 #endif // VECTORPOSTPROCESSORINTERFACE_H
virtual ~VectorPostprocessorInterface()=default
This class has virtual methods, so it needs a virtual dtor.
virtual const VectorPostprocessorValue & getVectorPostprocessorValueByName(const VectorPostprocessorName &name, const std::string &vector_name)
Retrieve the value of the VectorPostprocessor.
FEProblemBase & _vpi_feproblem
Reference the the FEProblemBase class.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
VectorPostprocessorInterface(const MooseObject *moose_object)
Every object that can be built by the factory should be derived from this class.
Definition: MooseObject.h:36
const VectorPostprocessorValue & getVectorPostprocessorValueOld(const std::string &name, const std::string &vector_name)
Retrieve the old value of a VectorPostprocessor.
const InputParameters & _vpi_params
VectorPostprocessorInterface Parameters.
std::vector< Real > VectorPostprocessorValue
Definition: MooseTypes.h:74
virtual const VectorPostprocessorValue & getVectorPostprocessorValue(const std::string &name, const std::string &vector_name)
Retrieve the value of a VectorPostprocessor.
bool hasVectorPostprocessor(const std::string &name) const
Determine if the VectorPostprocessor exists.
bool hasVectorPostprocessorByName(const VectorPostprocessorName &name) const
Determine if the VectorPostprocessor exists.
unsigned int THREAD_ID
Definition: MooseTypes.h:79
const VectorPostprocessorValue & getVectorPostprocessorValueOldByName(const VectorPostprocessorName &name, const std::string &vector_name)
Retrieve the old value of a VectorPostprocessor.