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 "SideUserObject.h"
      13             : #include "Postprocessor.h"
      14             : 
      15             : /**
      16             :  * Base class for postprocessors executed on one or more sidesets
      17             :  */
      18             : class SidePostprocessor : public SideUserObject, public Postprocessor
      19             : {
      20             : public:
      21             :   static InputParameters validParams();
      22             : 
      23             :   SidePostprocessor(const InputParameters & parameters);
      24             : 
      25             :   /**
      26             :    * This is called _after_ execute() and _after_ threadJoin()!  This is probably where you want to
      27             :    * do MPI communication!
      28             :    * We provide default finalize() as getValue() has been abused to perform the final aggregation
      29             :    * for a long time and we allowed not implementing finalize(). However, it is desired to do all
      30             :    * the finalization work such as communication in finalize() and let getValue() simply return the
      31             :    * final aggregated value, as getValue() is designed to be a const method.
      32             :    */
      33           0 :   virtual void finalize() override {}
      34             : };