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             : #ifdef MOOSE_MFEM_ENABLED
      11             : 
      12             : #pragma once
      13             : 
      14             : #include "Postprocessor.h"
      15             : #include "MFEMExecutedObject.h"
      16             : 
      17             : /**
      18             :  * Postprocessor for MFEM results. Must inherit from Postprocessor in
      19             :  * order for MOOSE to call it.
      20             :  */
      21             : class MFEMPostprocessor : public MFEMExecutedObject, public Postprocessor
      22             : {
      23             : public:
      24             :   static InputParameters validParams();
      25             : 
      26             :   MFEMPostprocessor(const InputParameters & parameters);
      27             : 
      28             :   virtual std::optional<std::string> suppliedPostprocessorName() const override;
      29             : 
      30             :   /**
      31             :    * This is called _after_ execute() and _after_ threadJoin()!  This is probably where you want to
      32             :    * do MPI communication!
      33             :    * We provide default finalize() as getValue() has been abused to perform the final aggregation
      34             :    * for a long time and we allowed not implementing finalize(). However, it is desired to do all
      35             :    * the finalization work such as communication in finalize() and let getValue() simply return the
      36             :    * final aggregated value, as getValue() is designed to be a const method.
      37             :    */
      38         591 :   virtual void finalize() override {}
      39             : };
      40             : 
      41             : #endif