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

#ifdef MOOSE_MFEM_ENABLED

#pragma once

#include "MFEMObject.h"
#include "SetupInterface.h"
#include "DependencyResolverInterface.h"

#include <optional>
#include <set>

class MFEMExecutedObject : public MFEMObject,
                           public SetupInterface,
                           public DependencyResolverInterface
{
public:
  static InputParameters validParams();

  MFEMExecutedObject(const InputParameters & parameters);

  virtual void initialize() {}
  virtual void execute() {}
  virtual void finalize() {}

  virtual std::optional<std::string> suppliedVariableName() const;
  virtual std::optional<std::string> suppliedPostprocessorName() const;
  virtual std::optional<std::string> suppliedVectorPostprocessorName() const;

  virtual const std::set<std::string> & getRequestedItems() override;
  virtual const std::set<std::string> & getSuppliedItems() override;

  template <typename T>
  static void addDependencyParam(InputParameters & params,
                                 const std::string & param_name,
                                 const std::string & doc_string);

  template <typename T>
  static void addRequiredDependencyParam(InputParameters & params,
                                         const std::string & param_name,
                                         const std::string & doc_string);

protected:
  static std::string variableDependencyKey(const std::string & name);
  static std::string postprocessorDependencyKey(const std::string & name);
  static std::string vectorPostprocessorDependencyKey(const std::string & name);

  static void appendDependencyParam(InputParameters & params, const std::string & param_name);

private:
  std::optional<std::set<std::string>> _requested_items;
  std::optional<std::set<std::string>> _supplied_items;
};

template <typename T>
void
MFEMExecutedObject::addDependencyParam(InputParameters & params,
                                       const std::string & param_name,
                                       const std::string & doc_string)
{
  params.addParam<T>(param_name, doc_string);
  appendDependencyParam(params, param_name);
}

template <typename T>
void
MFEMExecutedObject::addRequiredDependencyParam(InputParameters & params,
                                               const std::string & param_name,
                                               const std::string & doc_string)
{
  params.addRequiredParam<T>(param_name, doc_string);
  appendDependencyParam(params, param_name);
}

#endif