www.mooseframework.org
PostprocessorInterface.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 POSTPROCESSORINTERFACE_H
16 #define POSTPROCESSORINTERFACE_H
17 
18 // Standard includes
19 #include <string>
20 
21 // MOOSE includes
22 #include "MooseTypes.h"
23 
24 // Forward Declarations
25 class FEProblemBase;
26 class InputParameters;
27 class PostprocessorName;
28 class MooseObject;
29 
35 {
36 public:
37  PostprocessorInterface(const MooseObject * moose_object);
38 
40 
52  const PostprocessorValue & getPostprocessorValue(const std::string & name);
53  const PostprocessorValue & getPostprocessorValueOld(const std::string & name);
54  const PostprocessorValue & getPostprocessorValueOlder(const std::string & name);
56 
58 
70  const PostprocessorValue & getPostprocessorValueByName(const PostprocessorName & name);
71  const PostprocessorValue & getPostprocessorValueOldByName(const PostprocessorName & name);
72  const PostprocessorValue & getPostprocessorValueOlderByName(const PostprocessorName & name);
74 
76 
81  const PostprocessorValue & getDefaultPostprocessorValue(const std::string & name);
83 
91  bool hasPostprocessor(const std::string & name) const;
92 
100  bool hasPostprocessorByName(const PostprocessorName & name);
101 
102 private:
105 
108 };
109 
110 #endif // POSTPROCESSORINTERFACE_H
bool hasPostprocessor(const std::string &name) const
Determine if the Postprocessor exists.
const PostprocessorValue & getPostprocessorValueByName(const PostprocessorName &name)
Retrieve the value of the Postprocessor.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
FEProblemBase & _pi_feproblem
Reference the the FEProblemBase class.
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
const PostprocessorValue & getPostprocessorValue(const std::string &name)
Retrieve the value of a Postprocessor or one of it&#39;s old or older values.
bool hasPostprocessorByName(const PostprocessorName &name)
Determine if the Postprocessor exists.
Every object that can be built by the factory should be derived from this class.
Definition: MooseObject.h:36
const PostprocessorValue & getPostprocessorValueOldByName(const PostprocessorName &name)
Real PostprocessorValue
MOOSE typedefs.
Definition: MooseTypes.h:73
const PostprocessorValue & getPostprocessorValueOld(const std::string &name)
const PostprocessorValue & getPostprocessorValueOlderByName(const PostprocessorName &name)
const PostprocessorValue & getDefaultPostprocessorValue(const std::string &name)
Return the default postprocessor value.
PostprocessorInterface(const MooseObject *moose_object)
const InputParameters & _ppi_params
PostprocessorInterface Parameters.
const PostprocessorValue & getPostprocessorValueOlder(const std::string &name)
Interface class for classes which interact with Postprocessors.