www.mooseframework.org
Receiver.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 #include "GeneralPostprocessor.h"
13 
14 // Forward Declarations
15 class Receiver;
16 
17 template <>
19 
25 {
26 public:
28 
34 
36 
39  virtual void initialize() override {}
40  virtual void execute() override {}
42 
47  virtual Real getValue() override;
48 
52  virtual void initialSetup() override;
53 
54 private:
57 
60 };
61 
Receiver::initialSetup
virtual void initialSetup() override
Initial setup function for applying the default value.
Definition: Receiver.C:44
Receiver::validParams
static InputParameters validParams()
Definition: Receiver.C:17
Receiver::_initialize_old
bool _initialize_old
Flag for initializing the old value.
Definition: Receiver.h:56
MooseObject::parameters
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:76
Receiver::execute
virtual void execute() override
Execute method.
Definition: Receiver.h:40
Receiver
A class for storing data, it allows the user to change the value of the postprocessor by altering the...
Definition: Receiver.h:24
validParams< Receiver >
InputParameters validParams< Receiver >()
InputParameters
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system.
Definition: InputParameters.h:53
PostprocessorValue
Real PostprocessorValue
MOOSE typedefs.
Definition: MooseTypes.h:189
GeneralPostprocessor.h
GeneralPostprocessor
This class is here to combine the Postprocessor interface and the base class Postprocessor object alo...
Definition: GeneralPostprocessor.h:27
Receiver::Receiver
Receiver(const InputParameters &parameters)
Class constructor.
Definition: Receiver.C:29
Receiver::getValue
virtual Real getValue() override
Returns the value stored in _my_value.
Definition: Receiver.C:37
Receiver::_my_value
const PostprocessorValue & _my_value
Reference to the value being stored in the associated PostprocessorData class.
Definition: Receiver.h:59
Receiver::initialize
virtual void initialize() override
No action taken.
Definition: Receiver.h:39