Line data    Source code

       1             : //* This file is part of the MOOSE framework
       2             : //* https://mooseframework.inl.gov
       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             : /**
      15             :  * A class for storing data, it allows the user to change the value of the
      16             :  * postprocessor by altering the _my_value reference
      17             :  */
      18             : class Receiver : public GeneralPostprocessor
      19             : {
      20             : public:
      21             :   static InputParameters validParams();
      22             : 
      23             :   /**
      24             :    * Class constructor
      25             :    * @param parameters The input parameters
      26             :    */
      27             :   Receiver(const InputParameters & parameters);
      28             : 
      29             :   ///@{
      30             :   /**
      31             :    * No action taken
      32             :    */
      33       63136 :   virtual void initialize() override {}
      34       63136 :   virtual void execute() override {}
      35             :   ///@}
      36             : 
      37             :   /**
      38             :    * Returns the value stored in _my_value
      39             :    * @return A const reference to the value of the postprocessor
      40             :    */
      41             :   virtual Real getValue() const override;
      42             : 
      43             : private:
      44             :   /// Flag for initializing the old value
      45             :   bool _initialize_old;
      46             : 
      47             :   /// Reference to the value being stored in the associated PostprocessorData class
      48             :   const PostprocessorValue & _my_value;
      49             : };