Postprocessor.h

Go to the documentation of this file.

//* This file is part of the MOOSE framework
//* https://mooseframework.inl.gov
//*
//* All rights reserved, see COPYRIGHT for full restrictions
//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
//*
//* Licensed under LGPL 2.1, please see LICENSE for details
//* https://www.gnu.org/licenses/lgpl-2.1.html
 
#pragma once
 
#include "OutputInterface.h"
#include "NonADFunctorInterface.h"
#include "libmesh/parallel.h"
 
class MooseObject;
 
class Postprocessor : public OutputInterface,
                      public NonADFunctorInterface,
                      public Moose::FunctorBase<Real>
{
public:
  static InputParameters validParams();
 
  Postprocessor(const MooseObject * moose_object);
 
#ifdef MOOSE_KOKKOS_ENABLED
  Postprocessor(const Postprocessor & object, const Moose::Kokkos::FunctorCopy & key);
#endif
 
  virtual PostprocessorValue getValue() const = 0;
 
  const PostprocessorValue & getCurrentValue() const { return _current_value; }
 
  const std::string & PPName() const { return _pp_name; }
 
  virtual bool hasBlocks(SubdomainID /* id */) const override { return true; }
 
  bool supportsFaceArg() const override final { return true; }
  bool supportsElemSideQpArg() const override final { return true; }
 
protected:
  const std::string & _pp_name;
 
  const PostprocessorValue & _current_value;
 
private:
  const PostprocessorValue & declareValue(const MooseObject & moose_object);
 
  using ElemArg = Moose::ElemArg;
  using ElemQpArg = Moose::ElemQpArg;
  using ElemSideQpArg = Moose::ElemSideQpArg;
  using FaceArg = Moose::FaceArg;
  using ElemPointArg = Moose::ElemPointArg;
  using NodeArg = Moose::NodeArg;
 
  ValueType evaluate(const ElemArg & elem, const Moose::StateArg & state) const override final;
  ValueType evaluate(const FaceArg & face, const Moose::StateArg & state) const override final;
  ValueType evaluate(const ElemQpArg & qp, const Moose::StateArg & state) const override final;
  ValueType evaluate(const ElemSideQpArg & elem_side_qp,
                     const Moose::StateArg & state) const override final;
  ValueType evaluate(const ElemPointArg & elem_point,
                     const Moose::StateArg & state) const override final;
  ValueType evaluate(const NodeArg & node, const Moose::StateArg & state) const override final;
 
  GradientType evaluateGradient(const ElemArg & elem,
                                const Moose::StateArg & state) const override final;
  GradientType evaluateGradient(const FaceArg & face,
                                const Moose::StateArg & state) const override final;
  GradientType evaluateGradient(const ElemQpArg & qp,
                                const Moose::StateArg & state) const override final;
  GradientType evaluateGradient(const ElemSideQpArg & elem_side_qp,
                                const Moose::StateArg & state) const override final;
  GradientType evaluateGradient(const ElemPointArg & elem_point,
                                const Moose::StateArg & state) const override final;
  GradientType evaluateGradient(const NodeArg & node,
                                const Moose::StateArg & state) const override final;
 
  DotType evaluateDot(const ElemArg & elem, const Moose::StateArg & state) const override final;
  DotType evaluateDot(const FaceArg & face, const Moose::StateArg & state) const override final;
  DotType evaluateDot(const ElemQpArg & qp, const Moose::StateArg & state) const override final;
  DotType evaluateDot(const ElemSideQpArg & elem_side_qp,
                      const Moose::StateArg & state) const override final;
  DotType evaluateDot(const ElemPointArg & elem_point,
                      const Moose::StateArg & state) const override final;
  DotType evaluateDot(const NodeArg & node, const Moose::StateArg & state) const override final;
 
  void evaluateDotWarning() const;
 
  const MooseObject & _pp_moose_object;
};