SetupInterface Class Reference

#include <SetupInterface.h>

Inheritance diagram for SetupInterface:

Public Member Functions
	SetupInterface (const MooseObject *moose_object)
virtual	~SetupInterface ()
virtual void	initialSetup ()
	Gets called at the beginning of the simulation before this object is asked to do its job. More...
virtual void	timestepSetup ()
	Gets called at the beginning of the timestep before this object is asked to do its job. More...
virtual void	jacobianSetup ()
	Gets called just before the Jacobian is computed and before this object is asked to do its job. More...
virtual void	residualSetup ()
	Gets called just before the residual is computed and before this object is asked to do its job. More...
virtual void	subdomainSetup ()
	Gets called when the subdomain changes (i.e. More...
const ExecFlagEnum &	getExecuteOnEnum () const
	Return the execute on MultiMooseEnum for this object. More...
virtual const std::vector< ExecFlagType > &	execFlags () const
	(DEPRECATED) Get the execution flag for the object TODO: ExecFlagType More...
ExecFlagType	execBitFlags () const
	(DEPRECATED) Build and return the execution flags as a bitfield TODO: ExecFlagType More...

Static Public Member Functions
static ExecFlagEnum	getExecuteOptions ()
	(DEPRECATED) Returns the available options for the 'execute_on' input parameters TODO: ExecFlagType More...

Protected Attributes
const ExecFlagEnum &	_execute_enum
	Execute settings for this oejct. More...
const std::vector< ExecFlagType >	_exec_flags
	(DEPRECATED) execution flag (when is the object executed/evaluated) TODO: ExecFlagType More...
const ExecFlagType &	_current_execute_flag
	Reference to FEProblemBase. More...

Private Attributes
ExecFlagEnum	_empty_execute_enum
	Empty ExecFlagEnum for the case when the "execute_on" parameter is not included. More...

Friends
class	FEProblemBase

Detailed Description

Definition at line 29 of file SetupInterface.h.

Constructor & Destructor Documentation

SetupInterface()

SetupInterface::SetupInterface

(

const MooseObject *

moose_object

)

Definition at line 27 of file SetupInterface.C.

  : _execute_enum(moose_object->parameters().isParamValid("execute_on")
                      ? moose_object->parameters().get<ExecFlagEnum>("execute_on")
                      : _empty_execute_enum),
    _exec_flags(_execute_enum.begin(), _execute_enum.end()), // deprecated TODO: ExecFlagType
    _current_execute_flag(
        (moose_object->parameters().getCheckedPointerParam<FEProblemBase *>("_fe_problem_base"))
            ->getCurrentExecuteOnFlag())
{
  _empty_execute_enum.clear(); // remove any flags for the case when "execute_on" is not used
}

~SetupInterface()

SetupInterface::~SetupInterface ( )

virtual

Definition at line 39 of file SetupInterface.C.

{}

Member Function Documentation

execBitFlags()

ExecFlagType SetupInterface::execBitFlags

(

)

const

(DEPRECATED) Build and return the execution flags as a bitfield TODO: ExecFlagType

Definition at line 85 of file SetupInterface.C.

{
  // TODO: ExecFlagType
  mooseDeprecated("The execBitFlags method is being removed because MOOSE was updated to use a "
                  "ExecFlagEnum for execute flags. This method maintains the behavior of the "
                  "original method but the use of this method should be removed from your "
                  "application. The ExecFlagEnum should be inspected directly via the "
                  "getExecuteOnEnum() method.");

  unsigned int exec_bit_field = EXEC_NONE;
  for (const auto & flag : _exec_flags)
    exec_bit_field |= flag.id();
  return ExecFlagType("deprecated", exec_bit_field);
}

execFlags()

const std::vector< ExecFlagType > & SetupInterface::execFlags ( ) const

virtual

(DEPRECATED) Get the execution flag for the object TODO: ExecFlagType

Reimplemented in MultiAppTransfer.

Definition at line 73 of file SetupInterface.C.

{
  // TODO: ExecFlagType
  mooseDeprecated("The execFlags() method is being removed because MOOSE has been updated to use a "
                  "ExecFlagEnum for execute flags. The current flags should be retrieved from "
                  "the \"exeucte_on\" parameters of your object or by using the \"_execute_enum\" "
                  "reference to the parameter or the getExecuteOnEnum() method.");

  return _exec_flags;
}

getExecuteOnEnum()

const ExecFlagEnum & SetupInterface::getExecuteOnEnum

(

)

const

Return the execute on MultiMooseEnum for this object.

Definition at line 67 of file SetupInterface.C.

Referenced by ExecuteMooseObjectWarehouse< Transfer >::addObjectMask(), EigenExecutionerBase::init(), AttribExecOns::initFrom(), and MultiAppTransfer::MultiAppTransfer().

{
  return _execute_enum;
}

getExecuteOptions()

ExecFlagEnum SetupInterface::getExecuteOptions ( )

static

(DEPRECATED) Returns the available options for the 'execute_on' input parameters TODO: ExecFlagType

Returns

A MooseEnum with the available 'execute_on' options, the default is 'residual'

Definition at line 101 of file SetupInterface.C.

{
  // TODO: ExecFlagType
  ::mooseDeprecated("The 'getExecuteOptions' was replaced by the ExecFlagEnum class because MOOSE "
                    "was updated to use this for the execute flags and the new function provides "
                    "additional arguments for modification of the enum.");
  return MooseUtils::getDefaultExecFlagEnum();
}

initialSetup()

void SetupInterface::initialSetup ( )

virtual

Gets called at the beginning of the simulation before this object is asked to do its job.

Reimplemented in SolutionUserObject, AdvancedOutput, Output, MultiApp, MooseParsedFunction, MooseParsedGradFunction, SolutionFunction, Exodus, CSV, Transfer, Receiver, OversampleOutput, DerivativeFunctionMaterialBase, Nemesis, Axisymmetric2D3DSolutionFunction, ImageFunction, Console, MooseParsedVectorFunction, TimePeriod, TransientMultiApp, MultiAppCopyTransfer, GhostingUserObject, SolutionAux, MultiAppNearestNodeTransfer, MultiAppProjectionTransfer, PiecewiseBase, MatDiffusionBase< T >, MultiAppInterpolationTransfer, MultiAppMeshFunctionTransfer, MultiAppUserObjectTransfer, MatDiffusionBase< Real >, MultiAppVariableValueSampleTransfer, FullSolveMultiApp, and DerivativeSumMaterial.

Definition at line 42 of file SetupInterface.C.

Referenced by FunctionPeriodicBoundary::init().

{
}

jacobianSetup()

void SetupInterface::jacobianSetup ( )

virtual

Gets called just before the Jacobian is computed and before this object is asked to do its job.

Reimplemented in EqualValueEmbeddedConstraint.

Definition at line 52 of file SetupInterface.C.

{
}

residualSetup()

void SetupInterface::residualSetup ( )

virtual

Gets called just before the residual is computed and before this object is asked to do its job.

Definition at line 57 of file SetupInterface.C.

{
}

subdomainSetup()

void SetupInterface::subdomainSetup ( )

virtual

Gets called when the subdomain changes (i.e.

in a Jacobian or residual loop) and before this object is asked to do its job

Reimplemented in Material, Constraint, GeneralUserObject, NodalUserObject, and ThreadedGeneralUserObject.

Definition at line 62 of file SetupInterface.C.

{
}

timestepSetup()

void SetupInterface::timestepSetup ( )

virtual

Gets called at the beginning of the timestep before this object is asked to do its job.

Reimplemented in SolutionUserObject, Console, VectorPostprocessorVisualizationAux, NumNonlinearIterations, EqualValueEmbeddedConstraint, VectorMemoryUsage, and MemoryUsage.

Definition at line 47 of file SetupInterface.C.

{
}

Friends And Related Function Documentation

FEProblemBase

friend class FEProblemBase

friend

Definition at line 101 of file SetupInterface.h.

Member Data Documentation

_current_execute_flag

const ExecFlagType& SetupInterface::_current_execute_flag

protected

Reference to FEProblemBase.

Definition at line 98 of file SetupInterface.h.

_empty_execute_enum

ExecFlagEnum SetupInterface::_empty_execute_enum

private

Empty ExecFlagEnum for the case when the "execute_on" parameter is not included.

This is private because others should not be messing with it.

Definition at line 88 of file SetupInterface.h.

Referenced by SetupInterface().

_exec_flags

const std::vector<ExecFlagType> SetupInterface::_exec_flags

protected

(DEPRECATED) execution flag (when is the object executed/evaluated) TODO: ExecFlagType

Definition at line 95 of file SetupInterface.h.

Referenced by execBitFlags(), MultiAppTransfer::execFlags(), and execFlags().

_execute_enum

const ExecFlagEnum& SetupInterface::_execute_enum

protected

Execute settings for this oejct.

Definition at line 92 of file SetupInterface.h.

Referenced by ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), and getExecuteOnEnum().

---

The documentation for this class was generated from the following files:

• include/interfaces/SetupInterface.h
• src/interfaces/SetupInterface.C