www.mooseframework.org
PostprocessorInterface.h
Go to the documentation of this file.
1 //* This file is part of the MOOSE framework
2 //* https://www.mooseframework.org
3 //*
4 //* All rights reserved, see COPYRIGHT for full restrictions
5 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6 //*
7 //* Licensed under LGPL 2.1, please see LICENSE for details
8 //* https://www.gnu.org/licenses/lgpl-2.1.html
9 
10 #pragma once
11 
12 // Standard includes
13 #include <string>
14 
15 // MOOSE includes
16 #include "MooseTypes.h"
17 
18 // Forward Declarations
19 class FEProblemBase;
20 class InputParameters;
21 class PostprocessorName;
22 class MooseObject;
23 
29 {
30 public:
31  PostprocessorInterface(const MooseObject * moose_object);
32 
34 
46  const PostprocessorValue & getPostprocessorValue(const std::string & name);
47  const PostprocessorValue & getPostprocessorValueOld(const std::string & name);
48  const PostprocessorValue & getPostprocessorValueOlder(const std::string & name);
50 
52 
64  const PostprocessorValue & getPostprocessorValueByName(const PostprocessorName & name);
65  const PostprocessorValue & getPostprocessorValueOldByName(const PostprocessorName & name);
66  const PostprocessorValue & getPostprocessorValueOlderByName(const PostprocessorName & name);
68 
70 
75  const PostprocessorValue & getDefaultPostprocessorValue(const std::string & name);
77 
85  bool hasPostprocessor(const std::string & name) const;
86 
94  bool hasPostprocessorByName(const PostprocessorName & name);
95 
96 private:
99 
102 };
103 
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:42
const PostprocessorValue & getPostprocessorValueOldByName(const PostprocessorName &name)
Real PostprocessorValue
MOOSE typedefs.
Definition: MooseTypes.h:154
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.