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             : // MOOSE includes
      13             : #include "Postprocessor.h"
      14             : #include "GeneralUserObject.h"
      15             : 
      16             : /**
      17             :  * This class is here to combine the Postprocessor interface and the
      18             :  * base class Postprocessor object along with adding MooseObject to the inheritance tree.
      19             :  * GeneralPostprocessors have dependency resolution enabled with other GeneralPostprocessors.
      20             :  */
      21             : class GeneralPostprocessor : public GeneralUserObject, public Postprocessor
      22             : {
      23             : public:
      24             :   static InputParameters validParams();
      25             : 
      26             :   GeneralPostprocessor(const InputParameters & parameters);
      27             : 
      28             :   /**
      29             :    * This is called _after_ execute() and _after_ threadJoin()!  This is probably where you want to
      30             :    * do MPI communication!
      31             :    * We provide default finalize() as getValue() has been abused to perform the final aggregation
      32             :    * for a long time and we allowed not implementing finalize(). However, it is desired to do all
      33             :    * the finalization work such as communication in finalize() and let getValue() simply return the
      34             :    * final aggregated value, as getValue() is designed to be a const method.
      35             :    */
      36      160998 :   virtual void finalize() override {}
      37             : };