VectorPostprocessorInterface.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

// MOOSE includes
#include "MooseTypes.h"

// Forward Declarations
class FEProblemBase;
class InputParameters;
class MooseObject;
template <typename T>
class VectorPostprocessorContext;

class VectorPostprocessorInterface
{
public:
  static InputParameters validParams();

  VectorPostprocessorInterface(const MooseObject * moose_object, bool broadcast_by_default = false);

#ifdef MOOSE_KOKKOS_ENABLED

  VectorPostprocessorInterface(const VectorPostprocessorInterface & object,
                               const Moose::Kokkos::FunctorCopy & key);
#endif

  virtual ~VectorPostprocessorInterface() = default;

  const VectorPostprocessorValue &
  getVectorPostprocessorValue(const std::string & param_name,
                              const std::string & vector_name) const;

  const VectorPostprocessorValue &
  getVectorPostprocessorValueByName(const VectorPostprocessorName & name,
                                    const std::string & vector_name) const;

  const VectorPostprocessorValue &
  getVectorPostprocessorValueOld(const std::string & param_name,
                                 const std::string & vector_name) const;

  const VectorPostprocessorValue &
  getVectorPostprocessorValueOldByName(const VectorPostprocessorName & name,
                                       const std::string & vector_name) const;

  // doco-normal-methods-begin
  const VectorPostprocessorValue & getVectorPostprocessorValue(const std::string & param_name,
                                                               const std::string & vector_name,
                                                               bool needs_broadcast) const;
  // doco-normal-methods-end

  const VectorPostprocessorValue &
  getVectorPostprocessorValueByName(const VectorPostprocessorName & name,
                                    const std::string & vector_name,
                                    bool needs_broadcast) const;

  const VectorPostprocessorValue & getVectorPostprocessorValueOld(const std::string & param_name,
                                                                  const std::string & vector_name,
                                                                  bool needs_broadcast) const;

  const VectorPostprocessorValue &
  getVectorPostprocessorValueOldByName(const VectorPostprocessorName & name,
                                       const std::string & vector_name,
                                       bool needs_broadcast) const;

  const ScatterVectorPostprocessorValue &
  getScatterVectorPostprocessorValue(const std::string & param_name,
                                     const std::string & vector_name) const;

  const ScatterVectorPostprocessorValue &
  getScatterVectorPostprocessorValueByName(const VectorPostprocessorName & name,
                                           const std::string & vector_name) const;

  const ScatterVectorPostprocessorValue &
  getScatterVectorPostprocessorValueOld(const std::string & param_name,
                                        const std::string & vector_name) const;

  const ScatterVectorPostprocessorValue &
  getScatterVectorPostprocessorValueOldByName(const VectorPostprocessorName & name,
                                              const std::string & vector_name) const;

  bool hasVectorPostprocessor(const std::string & param_name,
                              const std::string & vector_name) const;

  bool hasVectorPostprocessorByName(const VectorPostprocessorName & name,
                                    const std::string & vector_name) const;

  bool hasVectorPostprocessor(const std::string & param_name) const;

  bool hasVectorPostprocessorByName(const VectorPostprocessorName & name) const;


  bool isVectorPostprocessorDistributed(const std::string & param_name) const;
  bool isVectorPostprocessorDistributedByName(const VectorPostprocessorName & name) const;

  const VectorPostprocessorName & getVectorPostprocessorName(const std::string & param_name) const;

protected:
  virtual void
  addVectorPostprocessorDependencyHelper(const VectorPostprocessorName & /* name */) const
  {
  }

private:
  const VectorPostprocessorValue &
  getVectorPostprocessorByNameHelper(const VectorPostprocessorName & name,
                                     const std::string & vector_name,
                                     bool broadcast,
                                     std::size_t t_index) const;

  const VectorPostprocessorContext<VectorPostprocessorValue> &
  getVectorPostprocessorContextByNameHelper(const VectorPostprocessorName & name,
                                            const std::string & vector_name) const;


  void possiblyCheckHasVectorPostprocessor(const std::string & param_name,
                                           const std::string & vector_name) const;
  void possiblyCheckHasVectorPostprocessorByName(const VectorPostprocessorName & name,
                                                 const std::string & vector_name) const;

  bool vectorPostprocessorsAdded() const;

  const bool _broadcast_by_default;

  const MooseObject & _vpi_moose_object;

  const FEProblemBase & _vpi_feproblem;

  const THREAD_ID _vpi_tid;
};