Action.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 "ParallelParamObject.h"
#include "InputParameters.h"
#include "MeshMetaDataInterface.h"
#include "Registry.h"
#include "PerfGraphInterface.h"
#include "MooseObjectParameterName.h"
#include "SolutionInvalidInterface.h"
 
#include <string>
#include <ostream>
 
class ActionWarehouse;
class ActionFactory;
class MooseMesh;
class FEProblemBase;
class Executioner;
class MooseApp;
class Factory;
 
class Action : public ParallelParamObject,
               public MeshMetaDataInterface,
               public PerfGraphInterface,
               public SolutionInvalidInterface
{
public:
  static const std::string unique_action_name_param;
 
  static InputParameters validParams();
 
  Action(const InputParameters & parameters);
 
  virtual ~Action() = default;
 
  void timedAct();
 
  // To get warnings tracked in the SolutionInvalidityOutput
  usingCombinedWarningSolutionWarnings;
 
private:
  bool
  addRelationshipManager(Moose::RelationshipManagerType input_rm_type,
                         const InputParameters & moose_object_pars,
                         std::string rm_name,
                         Moose::RelationshipManagerType rm_type,
                         Moose::RelationshipManagerInputParameterCallback rm_input_parameter_func,
                         Moose::RMSystemType sys_type = Moose::RMSystemType::NONE);
 
protected:
  bool addRelationshipManagers(Moose::RelationshipManagerType when_type,
                               const InputParameters & moose_object_pars);
 
public:
  virtual void addRelationshipManagers(Moose::RelationshipManagerType when_type);
 
  MooseObjectName uniqueActionName() const { return uniqueName(); }
 
  const std::string & specificTaskName() const { return _specific_task_name; }
 
  const std::set<std::string> & getAllTasks() const { return _all_tasks; }
 
  void appendTask(const std::string & task) { _all_tasks.insert(task); }
 
protected:
  virtual void act() = 0;
 
  void associateWithParameter(const std::string & param_name, InputParameters & params) const;
 
  void associateWithParameter(const InputParameters & from_params,
                              const std::string & param_name,
                              InputParameters & params) const;
 
  // The registered syntax for this block if any
  std::string _registered_identifier;
 
  std::string _specific_task_name;
 
  std::set<std::string> _all_tasks;
 
  ActionWarehouse & _awh;
 
  const std::string & _current_task;
 
  std::shared_ptr<MooseMesh> & _mesh;
  std::shared_ptr<MooseMesh> & _displaced_mesh;
 
  std::shared_ptr<FEProblemBase> & _problem;
 
  PerfID _act_timer;
 
  // Base classes have the same name for that attribute, pick one
  using MooseBase::_app;
};