SetupInterface.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 "MooseTypes.h"
#include "ExecFlagEnum.h"
#include "MooseEnum.h"
#include "InputParameters.h"
 
// Forward declarations
class InputParameters;
class MooseObject;
template <typename T>
InputParameters validParams();
 
class SetupInterface
{
public:
  SetupInterface(const MooseObject * moose_object);
 
#ifdef MOOSE_KOKKOS_ENABLED
  SetupInterface(const SetupInterface & object, const Moose::Kokkos::FunctorCopy & key);
#endif
 
  virtual ~SetupInterface();
 
  static InputParameters validParams();
 
  virtual void initialSetup();
 
  virtual void timestepSetup();
 
  virtual void jacobianSetup();
 
  virtual void residualSetup();
 
  virtual void subdomainSetup();
 
  virtual void customSetup(const ExecFlagType & /*exec_type*/) {}
 
  const ExecFlagEnum & getExecuteOnEnum() const;
 
private:
  ExecFlagEnum _empty_execute_enum;
 
protected:
  const ExecFlagEnum & _execute_enum;
 
  const ExecFlagType & _current_execute_flag;
 
  // FEProblemBase::addMultiApp needs to reset the execution flags
  friend class FEProblemBase;
};