#include <MFEMTransient.h>

Inheritance diagram for MFEMTransient:

Public Types
using	DataFileParameterType = DataFileName
	The parameter type this interface expects for a data file name.

Public Member Functions
	MFEMTransient (const InputParameters &params)

virtual void	init () override
	Initialize the executioner.

virtual SolveObject *	timeStepSolveObject () override
	Return the solve object wrapped by time stepper.

virtual void	takeStep (Real input_dt=-1.0) override
	Do whatever is necessary to advance one step.

virtual Real	relativeSolutionDifferenceNorm (bool) const override
	Not supported for MFEM problems, so error if called.

virtual std::set< TimeIntegrator * >	getTimeIntegrators () const override
	MFEM problems have no libMesh based TimeIntegrators attached, so return empty set.

virtual std::vector< std::string >	getTimeIntegratorNames () const override
	MFEM problems have no libMesh based TimeIntegrators attached, so return empty vector.

virtual void	execute () override
	Pure virtual execute function MUST be overridden by children classes.

virtual Real	computeConstrainedDT ()

virtual void	estimateTimeError ()

virtual Real	getDT ()

virtual bool	keepGoing ()
	Transient loop will continue as long as this keeps returning true.

virtual bool	lastSolveConverged () const override
	Whether or not the last solve converged.

virtual void	preExecute () override
	Override this for actions that should take place before execution.

virtual void	postExecute () override
	Override this for actions that should take place after execution.

void	computeDT ()

virtual void	preStep ()

virtual void	postStep ()

virtual void	incrementStepOrReject ()
	This is where the solve step is actually incremented.

virtual void	endStep (Real input_time=-1.0)

virtual void	setTargetTime (Real target_time)
	Can be used to set the next "target time" which is a time to nail perfectly.

virtual Real	getTime () const
	Get the current time.

virtual Real	getTargetTime ()
	Get the current target time.

virtual void	setTime (Real t)
	Set the current time.

virtual void	setTimeOld (Real t)
	Set the old time.

Real	computeSolutionChangeNorm (bool check_aux, bool normalize_by_dt) const
	Compute the relative L2 norm of the change in the solution.

TimeStepper *	getTimeStepper ()
	Pointer to the TimeStepper.

const TimeStepper *	getTimeStepper () const

void	setTimeStepper (TimeStepper &ts)
	Set the timestepper to use.

virtual std::string	getTimeStepperName () const override
	Get the name of the timestepper.

Moose::TimeIntegratorType	getTimeScheme () const
	Get the time scheme used.

std::set< Real > &	syncTimes ()
	Get the set of sync times.

Real &	dtMax ()
	Get the maximum dt.

Real &	dtMin ()
	Get the minimal dt.

Real	getStartTime () const
	Return the start time.

Real	getEndTime () const
	Get the end time.

Real &	endTime ()
	Get a modifiable reference to the end time.

Real &	timestepTol ()
	Get the timestep tolerance.

virtual void	setTimestepTolerance (const Real &tolerance)
	Set the timestep tolerance.

bool	atSyncPoint ()
	Is the current step at a sync point (sync times, time interval, target time, etc)?

Real	unconstrainedDT ()
	Get the unconstrained dt.

void	parentOutputPositionChanged () override
	Can be used by subclasses to call parentOutputPositionChanged() on the underlying FEProblemBase.

virtual void	forceNumSteps (const unsigned int num_steps)
	Set the number of time steps.

bool	convergedToSteadyState () const
	Determines whether the problem has converged to steady state.

virtual void	preProblemInit ()
	Perform initializations during executing actions right before init_problem task.

virtual void	preSolve ()
	Override this for actions that should take place before execution, called by FixedPointSolve.

virtual void	postSolve ()
	Override this for actions that should take place after execution, called by FixedPointSolve.

virtual Problem &	problem ()
	Deprecated: Return a reference to this Executioner's Problem instance.

FEProblemBase &	feProblem ()
	Return a reference to this Executioner's FEProblemBase instance.

FixedPointSolve &	fixedPointSolve ()

const bool &	verbose () const
	Get the verbose output flag.

void	registerSolveObject (const SolveObject &so)
	Register a solve object to the executioner so that we can check whether a solve object has been built by the executioner.

template<class T >
bool	hasSolveObject () const
	Whether a solve object in a certain type has been built by the executioner.

virtual bool	enabled () const
	Return the enabled status of the object.

std::shared_ptr< MooseObject >	getSharedPtr ()
	Get another shared pointer to this object that has the same ownership group.

std::shared_ptr< const MooseObject >	getSharedPtr () const

bool	isKokkosObject () const
	Get whether this object is a Kokkos functor The parameter MooseBase::kokkos_object_param is set by the Kokkos base classes.

MooseApp &	getMooseApp () const
	Get the MooseApp this class is associated with.

const std::string &	type () const
	Get the type of this class.

const std::string &	name () const
	Get the name of the class.

std::string	typeAndName () const
	Get the class's combined type and name; useful in error handling.

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const
	Get the parameters of the object.

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

template<typename T >
const T &	getParam (const std::string &name) const
	Retrieve a parameter for the object.

template<typename T1 , typename T2 >
std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const
	Retrieve two parameters and provide pair of parameters for the object.

template<typename T >
const T *	queryParam (const std::string &name) const
	Query a parameter for the object.

template<typename T >
const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const
	Retrieve a renamed parameter for the object.

template<typename T >
T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
	Verifies that the requested parameter exists and is not NULL and returns it to the caller.

bool	isParamValid (const std::string &name) const
	Test if the supplied parameter is valid.

bool	isParamSetByUser (const std::string &name) const
	Test if the supplied parameter is set by a user, as opposed to not set or set to default.

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
	Connect controllable parameter of this action with the controllable parameters of the objects added by this action.

template<typename... Args>
void	paramError (const std::string &param, Args... args) const
	Emits an error prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

template<typename... Args>
void	paramWarning (const std::string &param, Args... args) const
	Emits a warning prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

template<typename... Args>
void	paramWarning (const std::string &param, Args... args) const

template<typename... Args>
void	paramInfo (const std::string &param, Args... args) const
	Emits an informational message prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const
	Deprecated message prefix; the error type is no longer used.

template<typename... Args>
void	mooseError (Args &&... args) const
	Emits an error prefixed with object name and type and optionally a file path to the top-level block parameter if available.

template<typename... Args>
void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

template<typename... Args>
void	mooseErrorNonPrefixed (Args &&... args) const
	Emits an error without the prefixing included in mooseError().

template<typename... Args>
void	mooseWarning (Args &&... args) const
	Emits a warning prefixed with object name and type.

template<typename... Args>
void	mooseWarning (Args &&... args) const

template<typename... Args>
void	mooseWarningNonPrefixed (Args &&... args) const
	Emits a warning without the prefixing included in mooseWarning().

template<typename... Args>
void	mooseWarningNonPrefixed (Args &&... args) const

template<typename... Args>
void	mooseDeprecated (Args &&... args) const
	Emits a deprecation warning prefixed with the object name and type, and a stack trace.

template<typename... Args>
void	mooseDeprecated (Args &&... args) const

template<typename... Args>
void	mooseDeprecatedNoTrace (Args &&... args) const
	Emits a deprecation warning prefixed with the object name and type, and no stack trace.

template<typename... Args>
void	mooseInfo (Args &&... args) const

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const
	External method for calling moose error with added object context.

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

std::string	getDataFileName (const std::string &param) const
	Deprecated method.

std::string	getDataFileNameByName (const std::string &relative_path) const
	Deprecated method.

std::string	getDataFilePath (const std::string &relative_path) const
	Returns the path of a data file for a given relative file path.

UserObjectName	getUserObjectName (const std::string &param_name) const

template<class T >
const T &	getUserObject (const std::string &param_name, bool is_dependency=true) const
	Get an user object with a given parameter `param_name`.

template<class T >
const T &	getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const
	Get an user object with the name `object_name`.

const UserObjectBase &	getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
	Get an user object with a given parameter `param_name`.

const UserObjectBase &	getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const
	Get an user object with the name `object_name`.

bool	isDefaultPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
	Determine whether or not the Postprocessor is a default value.

bool	hasPostprocessor (const std::string &param_name, const unsigned int index=0) const
	Determine if the Postprocessor data exists.

bool	hasPostprocessorByName (const PostprocessorName &name) const
	Determine if the Postprocessor data exists.

std::size_t	coupledPostprocessors (const std::string &param_name) const
	Returns number of Postprocessors coupled under parameter name.

const PostprocessorName &	getPostprocessorName (const std::string &param_name, const unsigned int index=0) const
	Get the name of a postprocessor.

PerfGraph &	perfGraph ()
	Get the PerfGraph.

virtual std::vector< std::shared_ptr< ProblemOperatorBase > > &	getProblemOperators ()
	Returns a pointer to the operator's equation system.

virtual void	addProblemOperator (std::shared_ptr< ProblemOperatorBase > problem_operator)
	Add an MFEM problem operator. Takes ownership.


bool	hasUserObject (const std::string &param_name) const

template<class T >
bool	hasUserObject (const std::string &param_name) const


bool	hasUserObjectByName (const UserObjectName &object_name) const

template<class T >
bool	hasUserObjectByName (const UserObjectName &object_name) const


const PostprocessorValue &	getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const
	doco-normal-methods-begin Retrieve the value of a Postprocessor or one of it's old or older values

const PostprocessorValue &	getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const


virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name) const
	Retrieve the value of the Postprocessor.

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const

Static Public Member Functions
static InputParameters	validParams ()

static InputParameters	defaultSteadyStateConvergenceParams ()

static MooseEnum	iterationMethods ()
	Return supported iteration methods that can work with MultiApps on timestep_begin and timestep_end.

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)
	External method for calling moose error with added object context.

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console
	An instance of helper class to write streams to the Console objects.

Static Public Attributes
static const std::string	type_param = "_type"
	The name of the parameter that contains the object type.

static const std::string	name_param = "_object_name"
	The name of the parameter that contains the object name.

static const std::string	unique_name_param = "_unique_name"
	The name of the parameter that contains the unique object name.

static const std::string	app_param = "_moose_app"
	The name of the parameter that contains the MooseApp.

static const std::string	moose_base_param = "_moose_base"
	The name of the parameter that contains the moose system base.

static const std::string	kokkos_object_param = "_kokkos_object"
	The name of the parameter that indicates an object is a Kokkos functor.

Protected Member Functions
void	setupTimeIntegrator ()

virtual PostprocessorValue &	addAttributeReporter (const std::string &name, Real initial_value=0)
	Adds a postprocessor that the executioner can directly assign values to.

template<bool warning>
void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const
	Set solution invalid mark for the given solution ID.

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

virtual void	addUserObjectDependencyHelper (const UserObjectBase &) const
	Helper for deriving classes to override to add dependencies when a UserObject is requested.

virtual void	addPostprocessorDependencyHelper (const PostprocessorName &) const
	Helper for deriving classes to override to add dependencies when a Postprocessor is requested.

template<typename T , typename... Args>
T &	declareRestartableData (const std::string &data_name, Args &&... args)
	Declare a piece of data as "restartable" and initialize it.

template<typename T , typename... Args>
ManagedValue< T >	declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
	Declares a piece of "managed" restartable data and initialize it.

template<typename T , typename... Args>
const T &	getRestartableData (const std::string &data_name) const
	Declare a piece of data as "restartable" and initialize it Similar to `declareRestartableData` but returns a const reference to the object.

template<typename T , typename... Args>
T &	declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
	Declare a piece of data as "restartable" and initialize it.

template<typename T , typename... Args>
T &	declareRecoverableData (const std::string &data_name, Args &&... args)
	Declare a piece of data as "recoverable" and initialize it.

template<typename T , typename... Args>
T &	declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)
	Declare a piece of data as "restartable".

template<typename T , typename... Args>
T &	declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)
	Declare a piece of data as "restartable".

std::string	restartableName (const std::string &data_name) const
	Gets the name of a piece of restartable data given a data name, adding the system name and object name prefix.

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const
	Call to register a named section for timing.

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const
	Call to register a named section for timing.

std::string	timedSectionName (const std::string &section_name) const

Protected Attributes
FEProblemBase &	_problem
	Here for backward compatibility.

AuxiliarySystem &	_aux
	Reference to auxiliary system base for faster access.

Moose::TimeIntegratorType	_time_scheme

TimeStepper *	_time_stepper

int &	_t_step
	Current timestep.

Real &	_time
	Current time.

Real &	_time_old
	Previous time.

Real &	_dt
	Current delta t... or timestep size.

Real &	_dt_old

Real &	_unconstrained_dt

bool &	_at_sync_point

bool &	_last_solve_converged
	Whether or not the last solve converged.

bool	_xfem_repeat_step
	Whether step should be repeated due to xfem modifying the mesh.

Real	_end_time

Real	_dtmin

Real	_dtmax

unsigned int	_num_steps

int	_n_startup_steps

const bool	_steady_state_detection
	Steady state detection variables:

const Real	_steady_state_start_time

std::set< Real > &	_sync_times

bool	_abort

const bool	_error_on_dtmin
	This parameter controls how the system will deal with _dt <= _dtmin If true, the time stepper is expected to throw an error If false, the executioner will continue through EXEC_FINAL.

bool &	_time_interval
	if to use time interval output

Real	_next_interval_output_time

Real	_time_interval_output_interval

Real	_start_time

Real	_timestep_tolerance

Real &	_target_time

bool	_use_multiapp_dt

FEProblemBase &	_fe_problem

MooseEnum	_iteration_method

std::unique_ptr< FixedPointSolve >	_fixed_point_solve

std::string	_restart_file_base

const bool &	_verbose
	True if printing out additional information.

const bool &	_enabled
	Reference to the "enable" InputParameters, used by Controls for toggling on/off MooseObjects.

MooseApp &	_app
	The MOOSE application this is associated with.

Factory &	_factory
	The Factory associated with the MooseApp.

ActionFactory &	_action_factory
	Builds Actions.

const std::string &	_type
	The type of this class.

const std::string &	_name
	The name of this class.

const InputParameters &	_pars
	The object's parameters.

const Parallel::Communicator &	_communicator

MooseApp &	_restartable_app
	Reference to the application.

const std::string	_restartable_system_name
	The system name this object is in.

const THREAD_ID	_restartable_tid
	The thread ID for this object.

const bool	_restartable_read_only
	Flag for toggling read only status (see ReporterData)

MooseApp &	_pg_moose_app
	The MooseApp that owns the PerfGraph.

const std::string	_prefix
	A prefix to use for all sections.

Private Member Functions
void	constrainDTFromMultiApp (Real &dt_cur, std::ostringstream &diag, const ExecFlagType &execute_on) const
	Constrain the timestep dt_cur by looking at the timesteps for the MultiApps on execute_on.

virtual void	store (nlohmann::json &json) const

virtual bool	shouldStore () const

virtual void	declareLateValues ()
	Method that can be overriden to declare "late" Reporter values.

template<typename T , typename... Args>
T &	declareUnusedValue (Args &&... args)
	Declare a unused value with type T.

const ReporterValueName &	getReporterValueName (const std::string &param_name) const

void	buildOutputHideVariableList (std::set< std::string > variable_names)
	Builds hide lists for output objects NOT listed in the 'outputs' parameter.

const std::set< OutputName > &	getOutputs ()
	Get the list of output objects that this class is restricted.

const ReporterContextBase &	getReporterContextBaseByName (const ReporterName &reporter_name) const
	Get the reporter context to allow non-typed operations with the data.

const ReporterName &	getReporterName (const std::string &param_name) const

virtual void	addReporterDependencyHelper (const ReporterName &)
	A method that can be overridden to update the UO dependencies.

bool	reportersAdded () const

template<typename T >
void	possiblyCheckHasReporter (const ReporterName &reporter_name, const std::string &param_name="") const
	Helpers for "possibly" checking if a Reporter value exists.

const UserObjectBase &	getUserObjectFromFEProblem (const UserObjectName &object_name, const THREAD_ID tid=0) const
	Go directly to the FEProblem for the requested `object_name` for thread ID `tid`.

template<class T >
const T &	castUserObject (const UserObjectBase &uo_base, const std::string &param_name="") const
	Internal helper that casts the UserObject `uo_base` to the requested type.

void	mooseObjectError (const std::string &param_name, std::stringstream &oss) const
	emit an error for the given parameter

const std::string &	userObjectType (const UserObjectBase &uo) const
	Gets a UserObject's type; avoids including UserObject.h in the UserObjectInterface.

const std::string &	userObjectName (const UserObjectBase &uo) const
	Gets a UserObject's name; avoids including UserObject.h in the UserObjectInterface.

const PostprocessorName &	getPostprocessorNameInternal (const std::string &param_name, const unsigned int index, const bool allow_default_value=true) const
	Internal method for getting the PostprocessorName associated with a paremeter.

bool	isDefaultPostprocessorValueByName (const PostprocessorName &name) const

PostprocessorValue	getDefaultPostprocessorValueByName (const PostprocessorName &name) const

void	checkParam (const std::string &param_name, const unsigned int index=std::numeric_limits< unsigned int >::max()) const
	Checks the parameters relating to a Postprocessor.

bool	postprocessorsAdded () const

RestartableDataValue &	registerRestartableDataOnApp (std::unique_ptr< RestartableDataValue > data, THREAD_ID tid) const
	Helper function for actually registering the restartable data.

void	registerRestartableNameWithFilterOnApp (const std::string &name, Moose::RESTARTABLE_FILTER filter)
	Helper function for actually registering the restartable data.

template<typename T , typename... Args>
RestartableData< T > &	declareRestartableDataHelper (const std::string &data_name, void *context, Args &&... args) const
	Helper function for declaring restartable data.


template<typename T , template< typename > class S = ReporterGeneralContext, typename... Args>
T &	declareValue (const std::string &param_name, Args &&... args)
	Method to define a value that the Reporter object is to produced.

template<typename T , template< typename > class S = ReporterGeneralContext, typename... Args>
T &	declareValue (const std::string &param_name, ReporterMode mode, Args &&... args)

template<typename T , typename S , typename... Args>
T &	declareValue (const std::string &param_name, Args &&... args)

template<typename T , typename S , typename... Args>
T &	declareValue (const std::string &param_name, ReporterMode mode, Args &&... args)

template<typename T , template< typename > class S = ReporterGeneralContext, typename... Args>
T &	declareValueByName (const ReporterValueName &value_name, Args &&... args)

template<typename T , template< typename > class S = ReporterGeneralContext, typename... Args>
T &	declareValueByName (const ReporterValueName &value_name, ReporterMode mode, Args &&... args)

template<typename T , typename S , typename... Args>
T &	declareValueByName (const ReporterValueName &value_name, Args &&... args)

template<typename T , typename S , typename... Args>
T &	declareValueByName (const ReporterValueName &value_name, ReporterMode mode, Args &&... args)


template<typename T >
const T &	getReporterValue (const std::string &param_name, const std::size_t time_index=0)
	doco-normal-methods-begin Returns read-only reference to a Reporter value that is provided by an input parameter.

template<typename T >
const T &	getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)


template<typename T >
const T &	getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)
	Returns read-only reference to a Reporter value that is provided by name directly.

template<typename T >
const T &	getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)


bool	hasReporterValue (const std::string &param_name) const
	Return True if the Reporter value exists.

template<typename T >
bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

template<typename T >
bool	hasReporterValueByName (const ReporterName &reporter_name) const


const PostprocessorValue &	getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const
	Internal methods for getting Postprocessor values.

const PostprocessorValue &	getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)
	Internal method for getting a hit node (if available) given a set of parameters.

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)
	Internal method for getting the message prefix for an object (object type, name, etc).

Private Attributes
MFEMProblem &	_mfem_problem

MFEMProblemData &	_mfem_problem_data

MFEMProblemSolve	_mfem_problem_solve

std::optional< int >	_test_restep_step
	The timestep we fail and repeat if –test-restep is enabled.

std::optional< Real >	_test_restep_time
	If the time is greater than this then we fail and repeat if –test-restep is enabled.

bool	_testing_restep
	Whether or not the last timestep we solved is being repeated with –test-restep.

std::vector< const SolveObject * >	_solve_objects
	All solve objects built by this executioner.

const ParallelParamObject &	_parent

const MooseBase &	_si_moose_base
	The MooseBase that owns this interface.

const FEProblemBase *	_si_problem
	A pointer to FEProblem base.

const MooseObject &	_reporter_moose_object
	The MooseObject creating this Reporter.

const InputParameters &	_reporter_params
	Ref. to MooseObject params.

const std::string &	_reporter_name
	The name of the MooseObject, from "_object_name" param.

FEProblemBase &	_reporter_fe_problem
	Needed for access to FEProblemBase::getReporterData.

ReporterData &	_reporter_data
	Data storage.

std::vector< std::unique_ptr< UnusedWrapperBase > >	_unused_values
	Storage for unused values declared with declareUnusedValue().

MooseApp &	_oi_moose_app
	Reference the the MooseApp; neede for access to the OutputWarehouse.

OutputWarehouse &	_oi_output_warehouse
	Reference to the OutputWarehouse for populating the Output object hide lists.

std::set< OutputName >	_oi_outputs
	The set of Output object names listed in the 'outputs' parameter.

const InputParameters &	_ri_params
	Parameters for the MooseObject inherting from this interface.

FEProblemBase &	_ri_fe_problem_base
	Provides access to FEProblemBase::getReporterData.

const ReporterData &	_ri_reporter_data
	The ReporterData.

const MooseObject &	_ri_moose_object
	The MooseObject needing this interface.

const MooseObject &	_uoi_moose_object
	Moose object using the interface.

const FEProblemBase &	_uoi_feproblem
	Reference to the FEProblemBase instance.

const THREAD_ID	_uoi_tid
	Thread ID.

const MooseObject &	_ppi_moose_object
	The MooseObject that uses this interface.

const InputParameters &	_ppi_params
	PostprocessorInterface Parameters.

const FEProblemBase &	_ppi_feproblem
	Reference the the FEProblemBase class.

std::map< PostprocessorName, std::unique_ptr< PostprocessorValue > >	_default_values
	Holds the default postprocessor values that are requested (key is PostprocessorName)

const RestartableDataMapName	_metaname
	Restartable metadata name.

std::string	_restartable_name
	The name of the object.

std::vector< std::shared_ptr< ProblemOperatorBase > >	_problem_operators

Detailed Description

Definition at line 19 of file MFEMTransient.h.

Member Typedef Documentation

◆ DataFileParameterType

using DataFileInterface::DataFileParameterType = DataFileName

inherited

The parameter type this interface expects for a data file name.

Definition at line 27 of file DataFileInterface.h.

Constructor & Destructor Documentation

◆ MFEMTransient()

MFEMTransient::MFEMTransient ( const InputParameters & params )

explicit

Definition at line 28 of file MFEMTransient.C.

  : TransientBase(params),
    _mfem_problem(dynamic_cast<MFEMProblem &>(feProblem())),
    _mfem_problem_data(_mfem_problem.getProblemData()),
    _mfem_problem_solve(*this, getProblemOperators())
{
  // If no ProblemOperators have been added by the user, add a default
  if (getProblemOperators().empty())
  {
    _mfem_problem_data.eqn_system = std::make_shared<Moose::MFEM::TimeDependentEquationSystem>(
        _mfem_problem_data.time_derivative_map);
    auto problem_operator =
        std::make_shared<Moose::MFEM::TimeDependentEquationSystemProblemOperator>(_mfem_problem);
    addProblemOperator(std::move(problem_operator));
  }
}

Member Function Documentation

◆ addAttributeReporter()

PostprocessorValue & Executioner::addAttributeReporter	(	const std::string &	name,
		Real	initial_value = `0`
	)

protectedvirtualinherited

Adds a postprocessor that the executioner can directly assign values to.

Parameters

name	The name of the postprocessor to create
initial_value	The initial value of the postprocessor value

Returns: Reference to the postprocessor data that to be used by this executioner

Definition at line 126 of file Executioner.C.

{
  // Get a reference to the value
  PostprocessorValue & value = declareValueByName<PostprocessorValue>(name, initial_value);
 
  // Create storage for the old/older values
  ReporterName r_name(this->name(), name);
  getReporterValueByName<PostprocessorValue>(r_name, 1);
  getReporterValueByName<PostprocessorValue>(r_name, 2);
 
  return value;
}

◆ addPostprocessorDependencyHelper()

virtual void PostprocessorInterface::addPostprocessorDependencyHelper ( const PostprocessorName & ) const

inlineprotectedvirtualinherited

Helper for deriving classes to override to add dependencies when a Postprocessor is requested.

Reimplemented in UserObjectBase, AuxKernelBase, and InitialConditionBase.

Definition at line 149 of file PostprocessorInterface.h.

149{}

Referenced by PostprocessorInterface::getPostprocessorValueByNameInternal().

◆ addProblemOperator()

virtual void Moose::MFEM::ProblemOperatorInterface::addProblemOperator ( std::shared_ptr< ProblemOperatorBase > problem_operator )

inlinevirtualinherited

Add an MFEM problem operator. Takes ownership.

Definition at line 36 of file ProblemOperatorInterface.h.

  {
    _problem_operators.push_back(std::move(problem_operator));
  }

Referenced by MFEMTransient().

◆ addReporterDependencyHelper()

virtual void ReporterInterface::addReporterDependencyHelper ( const ReporterName & )

inlineprotectedvirtualinherited

A method that can be overridden to update the UO dependencies.

This is needed because the get methods for this interface cannot be virtual because of the template parameter. See GeneralUserObject for how it is utilized.

Reimplemented in UserObjectBase.

Definition at line 112 of file ReporterInterface.h.

112{}

Referenced by ReporterInterface::getReporterValueByName().

◆ addUserObjectDependencyHelper()

virtual void UserObjectInterface::addUserObjectDependencyHelper ( const UserObjectBase & ) const

inlineprotectedvirtualinherited

Helper for deriving classes to override to add dependencies when a UserObject is requested.

Reimplemented in UserObjectBase, AuxKernelBase, and InitialConditionBase.

Definition at line 111 of file UserObjectInterface.h.

111{}

Referenced by UserObjectInterface::getUserObjectBaseByName().

◆ atSyncPoint()

bool TransientBase::atSyncPoint ( )

inlineinherited

Is the current step at a sync point (sync times, time interval, target time, etc)?

Returns: Bool indicating whether we are at a sync point

Definition at line 215 of file TransientBase.h.

215{ return _at_sync_point; }

TransientBase::_at_sync_point

bool & _at_sync_point

Definition TransientBase.h:258

Referenced by IterationAdaptiveDT::acceptStep().

◆ buildOutputHideVariableList()

void OutputInterface::buildOutputHideVariableList ( std::set< std::string > variable_names )

inherited

Builds hide lists for output objects NOT listed in the 'outputs' parameter.

Parameters

variable_names A set of variables for which the 'outputs' parameter controls

By default this is called by the constructor and passes the block name as the list of variables. This needs to be called explicitly if the build_list flag is set to False in the constructor. The latter cases is needed by the Material object to work correctly with the automatic material output capability.

Definition at line 68 of file OutputInterface.C.

{
  // Set of available names
  const std::set<OutputName> & avail = _oi_output_warehouse.getOutputNames();
 
  // Check for 'none'; hide variables on all outputs
  if (_oi_outputs.find("none") != _oi_outputs.end())
    for (const auto & name : avail)
      _oi_output_warehouse.addInterfaceHideVariables(name, variable_names);
 
  // Check for empty and 'all' in 'outputs' parameter; do not perform any variable restrictions in
  // these cases
  else if (_oi_outputs.empty() || _oi_outputs.find("all") != _oi_outputs.end())
    return;
 
  // Limit the variable output to Output objects listed
  else
  {
    // Create a list of outputs where the variable should be hidden
    std::set<OutputName> hide;
    std::set_difference(avail.begin(),
                        avail.end(),
                        _oi_outputs.begin(),
                        _oi_outputs.end(),
                        std::inserter(hide, hide.begin()));
 
    // If 'outputs' is specified add the object name to the list of items to hide
    for (const auto & name : hide)
      _oi_output_warehouse.addInterfaceHideVariables(name, variable_names);
  }
}

Referenced by ReporterTransferInterface::hideVariableHelper(), and OutputInterface::OutputInterface().

◆ callMooseError() [1/2]

void MooseBase::callMooseError	(	MooseApp *const	app,
		const InputParameters &	params,
		std::string	msg,
		const bool	with_prefix,
		const hit::Node *	node,
		const bool	show_trace = `true`
	)

staticinherited

External method for calling moose error with added object context.

Needed so that objects without the MooseBase context (InputParameters) can call errors with context

Parameters

app	The app pointer (if available); adds multiapp context and clears the console
params	The parameters, needed to obtain object information
msg	The message
with_prefix	If true, add the prefix from messagePrefix(), which is the object information (type, name, etc)
node	Optional hit node to add file path context as a prefix
show_trace	Whether or not to show a stack trace, defaults to true

Definition at line 114 of file MooseBase.C.

{
  if (!node)
    node = MooseBase::getHitNode(params);
 
  std::string multiapp_prefix = "";
  if (app)
  {
    if (!app->isUltimateMaster())
      multiapp_prefix = app->name();
    app->getOutputWarehouse().mooseConsole();
  }
 
  if (with_prefix)
    // False here because the hit context will get processed by the node
    msg = messagePrefix(params, false) + msg;
 
  moose::internal::mooseErrorRaw(msg, multiapp_prefix, node, show_trace);
}

◆ callMooseError() [2/2]

void MooseBase::callMooseError	(	std::string	msg,
		const bool	with_prefix,
		const hit::Node *	node = `nullptr`,
		const bool	show_trace = `true`
	)		const

inherited

External method for calling moose error with added object context.

Parameters

msg	The message
with_prefix	If true, add the prefix from messagePrefix(), which is the object information (type, name, etc)
node	Optional hit node to add file path context as a prefix
show_trace	Whether or not to show a stack trace, defaults to true

Definition at line 105 of file MooseBase.C.

{
  callMooseError(&_app, _pars, msg, with_prefix, node, show_trace);
}

Referenced by MooseBase::callMooseError(), InputParameters::callMooseError(), MooseBase::mooseDocumentedError(), MooseBase::mooseError(), and MooseBase::mooseErrorNonPrefixed().

◆ castUserObject()

template<class T >

const T & UserObjectInterface::castUserObject	(	const UserObjectBase &	uo_base,
		const std::string &	param_name = `""`
	)		const

privateinherited

Internal helper that casts the UserObject uo_base to the requested type.

Exits with a useful error if the casting failed. If the parameter param_name is provided and is valid, a paramError() will be used instead.

Definition at line 151 of file UserObjectInterface.h.

{
  const T * uo = dynamic_cast<const T *>(&uo_base);
 
  if (!uo)
  {
    std::stringstream oss;
    oss << "The provided UserObject \"" << userObjectName(uo_base) << "\" of type "
        << userObjectType(uo_base)
        << " is not derived from the required type.\n\nThe UserObject must derive from "
        << MooseUtils::prettyCppType<T>() << ".";
 
    mooseObjectError(param_name, oss);
  }
 
  return *uo;
}

◆ checkParam()

void PostprocessorInterface::checkParam	(	const std::string &	param_name,
		const unsigned int	index = `std::numeric_limits<unsigned int>::max()`
	)		const

privateinherited

Checks the parameters relating to a Postprocessor.

If index is not set, index checking is not performed.

Definition at line 149 of file PostprocessorInterface.C.

{
  const bool check_index = index != std::numeric_limits<unsigned int>::max();
 
  if (!_ppi_params.isParamValid(param_name))
    _ppi_moose_object.mooseError(
        "When getting a Postprocessor, failed to get a parameter with the name \"",
        param_name,
        "\".",
        "\n\nKnown parameters:\n",
        _ppi_moose_object.parameters());
 
  if (_ppi_params.isType<PostprocessorName>(param_name))
  {
    if (check_index && index > 0)
      _ppi_moose_object.paramError(param_name,
                                   "A Postprocessor was requested with index ",
                                   index,
                                   " but a single Postprocessor is coupled.");
  }
  else if (_ppi_params.isType<std::vector<PostprocessorName>>(param_name))
  {
    const auto & names = _ppi_params.get<std::vector<PostprocessorName>>(param_name);
    if (check_index && names.size() <= index)
      _ppi_moose_object.paramError(param_name,
                                   "A Postprocessor was requested with index ",
                                   index,
                                   " but only ",
                                   names.size(),
                                   " Postprocessors are coupled.");
  }
  else
  {
    _ppi_moose_object.mooseError(
        "Supplied parameter with name \"",
        param_name,
        "\" of type \"",
        _ppi_params.type(param_name),
        "\" is not an expected type for getting a Postprocessor.\n\n",
        "Allowed types are \"PostprocessorName\" and \"std::vector<PostprocessorName>\".");
  }
}

Referenced by PostprocessorInterface::coupledPostprocessors(), and PostprocessorInterface::getPostprocessorNameInternal().

◆ computeConstrainedDT()

Real TransientBase::computeConstrainedDT ( )

virtualinherited

Returns: The fully constrained dt for this timestep

Definition at line 564 of file TransientBase.C.

{
  //  // If start up steps are needed
  //  if (_t_step == 1 && _n_startup_steps > 1)
  //    _dt = _input_dt/(double)(_n_startup_steps);
  //  else if (_t_step == 1+_n_startup_steps && _n_startup_steps > 1)
  //    _dt = _input_dt;
 
  Real dt_cur = _dt;
  std::ostringstream diag;
 
  // After startup steps, compute new dt
  if (_t_step > _n_startup_steps)
    dt_cur = getDT();
 
  else
  {
    diag << "Timestep < n_startup_steps, using old dt: " << std::setw(9) << std::setprecision(6)
         << std::setfill('0') << std::showpoint << std::left << _dt << " tstep: " << _t_step
         << " n_startup_steps: " << _n_startup_steps << std::endl;
  }
  _unconstrained_dt = dt_cur;
 
  if (_verbose)
    _console << diag.str();
 
  diag.str("");
  diag.clear();
 
  // Allow the time stepper to limit the time step
  _at_sync_point = _time_stepper->constrainStep(dt_cur);
 
  // Don't let time go beyond next time interval output if specified
  if ((_time_interval) && (_time + dt_cur + _timestep_tolerance >= _next_interval_output_time))
  {
    dt_cur = _next_interval_output_time - _time;
    _at_sync_point = true;
 
    diag << "Limiting dt for time interval output at time: " << std::setw(9) << std::setprecision(6)
         << std::setfill('0') << std::showpoint << std::left << _next_interval_output_time
         << " dt: " << std::setw(9) << std::setprecision(6) << std::setfill('0') << std::showpoint
         << std::left << dt_cur << std::endl;
  }
 
  // If a target time is set and the current dt would exceed it, limit dt to match the target
  if (_target_time > -std::numeric_limits<Real>::max() + _timestep_tolerance &&
      _time + dt_cur + _timestep_tolerance >= _target_time)
  {
    dt_cur = _target_time - _time;
    _at_sync_point = true;
 
    diag << "Limiting dt for target time: " << std::setw(9) << std::setprecision(6)
         << std::setfill('0') << std::showpoint << std::left << _next_interval_output_time
         << " dt: " << std::setw(9) << std::setprecision(6) << std::setfill('0') << std::showpoint
         << std::left << dt_cur << std::endl;
  }
 
  // Constrain by what the multi apps are doing
  constrainDTFromMultiApp(dt_cur, diag, EXEC_MULTIAPP_FIXED_POINT_BEGIN);
  constrainDTFromMultiApp(dt_cur, diag, EXEC_TIMESTEP_BEGIN);
  constrainDTFromMultiApp(dt_cur, diag, EXEC_TIMESTEP_END);
  constrainDTFromMultiApp(dt_cur, diag, EXEC_MULTIAPP_FIXED_POINT_END);
 
  if (_verbose)
    _console << diag.str();
 
  return dt_cur;
}

Referenced by TransientBase::takeStep(), and takeStep().

◆ computeDT()

void TransientBase::computeDT ( )

inherited

Definition at line 376 of file TransientBase.C.

{
  // We're repeating the solve of the previous timestep,
  // so we use the same dt
  if (_testing_restep)
  {
    mooseAssert(!_test_restep_step && !_test_restep_time, "Should not be set");
    return;
  }
 
  _time_stepper->computeStep(); // This is actually when DT gets computed
}

Referenced by TransientMultiApp::computeDT(), TransientBase::execute(), TransientBase::preExecute(), and TransientMultiApp::solveStep().

◆ computeSolutionChangeNorm()

Real TransientBase::computeSolutionChangeNorm	(	bool	check_aux,
		bool	normalize_by_dt
	)		const

inherited

Compute the relative L2 norm of the change in the solution.

Parameters

[in]	check_aux	Whether to use the aux variables instead of solution variables
[in]	normalize_by_dt	Whether to divide by time step size

Definition at line 722 of file TransientBase.C.

{
  return relativeSolutionDifferenceNorm(check_aux) / (normalize_by_dt ? _dt : Real(1));
}

Referenced by DefaultSteadyStateConvergence::checkConvergence().

◆ connectControllableParams()

void MooseBase::connectControllableParams	(	const std::string &	parameter,
		const std::string &	object_type,
		const std::string &	object_name,
		const std::string &	object_parameter
	)		const

inherited

Connect controllable parameter of this action with the controllable parameters of the objects added by this action.

Parameters

parameter	Name of the controllable parameter of this action
object_type	Type of the object added by this action.
object_name	Name of the object added by this action.
object_parameter	Name of the parameter of the object.

Definition at line 77 of file MooseBase.C.

{
  auto & factory = _app.getFactory();
  auto & ip_warehouse = _app.getInputParameterWarehouse();
 
  MooseObjectParameterName primary_name(uniqueName(), parameter);
  const auto base_type = factory.getValidParams(object_type).getBase();
  MooseObjectParameterName secondary_name(base_type, object_name, object_parameter);
  ip_warehouse.addControllableParameterConnection(primary_name, secondary_name);
 
  const auto & tags = _pars.get<std::vector<std::string>>("control_tags");
  for (const auto & tag : tags)
  {
    if (!tag.empty())
    {
      // Only adds the parameter with the different control tags if the derived class
      // properly registers the parameter to its own syntax
      MooseObjectParameterName tagged_name(tag, name(), parameter);
      ip_warehouse.addControllableParameterConnection(
          tagged_name, secondary_name, /*error_on_empty=*/false);
    }
  }
}

◆ constrainDTFromMultiApp()

void TransientBase::constrainDTFromMultiApp	(	Real &	dt_cur,
		std::ostringstream &	diag,
		const ExecFlagType &	execute_on
	)		const

privateinherited

Constrain the timestep dt_cur by looking at the timesteps for the MultiApps on execute_on.

Definition at line 634 of file TransientBase.C.

{
  Real multi_app_dt = _problem.computeMultiAppsDT(execute_on);
  if (_use_multiapp_dt || multi_app_dt < dt_cur)
  {
    dt_cur = multi_app_dt;
    _at_sync_point = false;
    diag << "Limiting dt for MultiApps on " << execute_on.name() << ": " << std::setw(9)
         << std::setprecision(6) << std::setfill('0') << std::showpoint << std::left << dt_cur
         << std::endl;
  }
}

Referenced by TransientBase::computeConstrainedDT().

◆ convergedToSteadyState()

bool TransientBase::convergedToSteadyState ( ) const

inherited

Determines whether the problem has converged to steady state.

Definition at line 830 of file TransientBase.C.

{
  auto & convergence = _problem.getConvergence(_problem.getSteadyStateConvergenceName());
  const auto status = convergence.checkConvergence(_t_step);
 
  if (status == Convergence::MooseConvergenceStatus::DIVERGED)
    mooseError(
        "The steady-state Convergence object (", convergence.name(), ") reported divergence.");
  else if (status == Convergence::MooseConvergenceStatus::CONVERGED)
    return true;
  else // status == Convergence::MooseConvergenceStatus::ITERATING
    return false;
}

Referenced by TransientBase::keepGoing(), and TransientMultiApp::solveStep().

◆ coupledPostprocessors()

std::size_t PostprocessorInterface::coupledPostprocessors ( const std::string & param_name ) const

inherited

Returns number of Postprocessors coupled under parameter name.

Parameters

param_name The name of the Postprocessor parameter

Returns: Number of coupled post-processors, 1 if it's a single

Definition at line 139 of file PostprocessorInterface.C.

{
  checkParam(param_name);
 
  if (_ppi_params.isType<PostprocessorName>(param_name))
    return 1;
  return _ppi_params.get<std::vector<PostprocessorName>>(param_name).size();
}

Referenced by FunctionValuePostprocessor::FunctionValuePostprocessor().

◆ declareLateValues()

virtual void Reporter::declareLateValues ( )

inlinevirtualinherited

Method that can be overriden to declare "late" Reporter values.

Values are considered "late" when they need to be declared after all other Reporters have been instantiated. This is called by the "declare_late_reporters" task, which should be called right after the "add_reporters" task.

Reimplemented in AccumulateReporter.

Definition at line 79 of file Reporter.h.

79{}

◆ declareManagedRestartableDataWithContext()

template<typename T , typename... Args>

Restartable::ManagedValue< T > Restartable::declareManagedRestartableDataWithContext	(	const std::string &	data_name,
		void *	context,
		Args &&...	args
	)

protectedinherited

Declares a piece of "managed" restartable data and initialize it.

Here, "managed" restartable data means that the caller can destruct this data upon destruction of the return value of this method. Therefore, this ManagedValue<T> wrapper should survive after the final calls to dataStore() for it. That is... at the very end.

This is needed for objects whose destruction ordering is important, and enables natural c++ destruction in reverse construction order of the object that declares it.

See delcareRestartableData and declareRestartableDataWithContext for more information.

Definition at line 283 of file Restartable.h.

{
  auto & data_ptr =
      declareRestartableDataHelper<T>(data_name, context, std::forward<Args>(args)...);
  return Restartable::ManagedValue<T>(data_ptr);
}

◆ declareRecoverableData()

template<typename T , typename... Args>

T & Restartable::declareRecoverableData	(	const std::string &	data_name,
		Args &&...	args
	)

protectedinherited

Declare a piece of data as "recoverable" and initialize it.

This means that in the event of a restart this piece of data will be restored back to its previous value.

Note - this data will NOT be restored on Restart!

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
args	Arguments to forward to the constructor of the data

Definition at line 358 of file Restartable.h.

{
  const auto full_name = restartableName(data_name);
 
  registerRestartableNameWithFilterOnApp(full_name, Moose::RESTARTABLE_FILTER::RECOVERABLE);
 
  return declareRestartableDataWithContext<T>(data_name, nullptr, std::forward<Args>(args)...);
}

◆ declareRestartableData()

template<typename T , typename... Args>

T & Restartable::declareRestartableData	(	const std::string &	data_name,
		Args &&...	args
	)

protectedinherited

Declare a piece of data as "restartable" and initialize it.

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
args	Arguments to forward to the constructor of the data

Definition at line 276 of file Restartable.h.

{
  return declareRestartableDataWithContext<T>(data_name, nullptr, std::forward<Args>(args)...);
}

◆ declareRestartableDataHelper()

template<typename T , typename... Args>

RestartableData< T > & Restartable::declareRestartableDataHelper	(	const std::string &	data_name,
		void *	context,
		Args &&...	args
	)		const

privateinherited

Helper function for declaring restartable data.

We use this function to reduce code duplication when returning const/nonconst references to the data.

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
context	Context pointer that will be passed to the load and store functions
args	Arguments to forward to the constructor of the data

Definition at line 310 of file Restartable.h.

{
  const auto full_name = restartableName(data_name);
 
  // Here we will create the RestartableData even though we may not use this instance.
  // If it's already in use, the App will return a reference to the existing instance and we'll
  // return that one instead. We might refactor this to have the app create the RestartableData
  // at a later date.
  auto data_ptr =
      std::make_unique<RestartableData<T>>(full_name, context, std::forward<Args>(args)...);
  auto & restartable_data_ref = static_cast<RestartableData<T> &>(
      registerRestartableDataOnApp(std::move(data_ptr), _restartable_tid));
 
  return restartable_data_ref;
}

◆ declareRestartableDataWithContext()

template<typename T , typename... Args>

T & Restartable::declareRestartableDataWithContext	(	const std::string &	data_name,
		void *	context,
		Args &&...	args
	)

protectedinherited

Declare a piece of data as "restartable" and initialize it.

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
context	Context pointer that will be passed to the load and store functions
args	Arguments to forward to the constructor of the data

Definition at line 301 of file Restartable.h.

{
  return declareRestartableDataHelper<T>(data_name, context, std::forward<Args>(args)...).set();
}

◆ declareRestartableDataWithObjectName()

template<typename T , typename... Args>

T & Restartable::declareRestartableDataWithObjectName	(	const std::string &	data_name,
		const std::string &	object_name,
		Args &&...	args
	)

protectedinherited

Declare a piece of data as "restartable".

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
object_name	A supplied name for the object that is declaring this data.
args	Arguments to forward to the constructor of the data

Definition at line 330 of file Restartable.h.

{
  return declareRestartableDataWithObjectNameWithContext<T>(
      data_name, object_name, nullptr, std::forward<Args>(args)...);
}

◆ declareRestartableDataWithObjectNameWithContext()

template<typename T , typename... Args>

T & Restartable::declareRestartableDataWithObjectNameWithContext	(	const std::string &	data_name,
		const std::string &	object_name,
		void *	context,
		Args &&...	args
	)

protectedinherited

Declare a piece of data as "restartable".

This means that in the event of a restart this piece of data will be restored back to its previous value.

NOTE: This returns a reference! Make sure you store it in a reference!

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
object_name	A supplied name for the object that is declaring this data.
context	Context pointer that will be passed to the load and store functions
args	Arguments to forward to the constructor of the data

Definition at line 340 of file Restartable.h.

{
  std::string old_name = _restartable_name;
 
  _restartable_name = object_name;
 
  T & value = declareRestartableDataWithContext<T>(data_name, context, std::forward<Args>(args)...);
 
  _restartable_name = old_name;
 
  return value;
}

◆ declareUnusedValue()

template<typename T , typename... Args>

T & Reporter::declareUnusedValue ( Args &&... args )

protectedinherited

Declare a unused value with type T.

This is useful when you have a reporter that has optional values. In this case, you want to create references to all reporter values. However, because some values are optional, you need something to fill into the reference. This helper will create a unused value. It also allows for the passing of arguments in the case that your value is not trivially default constructable (constructable by default without arguments).

Definition at line 278 of file Reporter.h.

{
  _unused_values.emplace_back(std::make_unique<UnusedWrapper<T>>(std::forward(args)...));
  UnusedWrapper<T> * wrapper = dynamic_cast<UnusedWrapper<T> *>(_unused_values.back().get());
  return wrapper->value;
}

◆ declareValue() [1/4]

template<typename T , typename S , typename... Args>

T & Reporter::declareValue	(	const std::string &	param_name,
		Args &&...	args
	)

protectedinherited

Method to define a value that the Reporter object is to produced.

Template Parameters

T	The C++ type of the value to be produced
S	(optional) Context type for performing special operations. For example using the ReporterBroadcastContext will automatically broadcast the produced value from the root processor.

Parameters

name	A unique name for the value to be produced.
mode	(optional) The mode that indicates how the value produced is represented in parallel, there is more information about this below
args	(optional) Any number of optional arguments passed into the ReporterContext given by the S template parameter. If S = ReporterContext then the first argument can be used as the default value (see ReporterContext.h).

The 'mode' indicates how the value that is produced is represented in parallel. It is the responsibility of the Reporter object to get it to that state. The ReporterContext objects are designed to help with this. The mode can be one of the following:

ReporterMode::ROOT Indicates that the value produced is complete/correct on the
                   root processor for the object.
ReporterMode::REPLICATED Indicates that the value produced is complete/correct on
                         all processors AND that the value is the same on all
                         processors
ReporterMode::DISTRIBUTED Indicates that the value produced is complete/correct on
                          all processors AND that the value is NOT the same on all
                          processors

WARNING! Using the "default value" in ReporterContext: The Reporter system, like the systems before it, allow for objects that consume values to be constructed prior to the produce objects. When a value is requested either by a producer (Reporter) or consumer (ReporterInterface) the data is allocated. As such the assigned default value from the producer should not be relied upon on the consumer side during object construction.

NOTE: The ReporterContext is just a mechanism to allow for handling of values in special ways. In practice it might be better to have specific methods for these special cases. For example, a declareBroadcastValue, etc. Please refer to the ReporterData object for more information on how the data system operates for Reporter values.

Definition at line 206 of file Reporter.h.

{
  return declareValue<T, S<T>>(param_name, REPORTER_MODE_UNSET, args...);
}

◆ declareValue() [2/4]

template<typename T , typename S , typename... Args>

T & Reporter::declareValue	(	const std::string &	param_name,
		Args &&...	args
	)

protectedinherited

◆ declareValue() [3/4]

template<typename T , typename S , typename... Args>

T & Reporter::declareValue	(	const std::string &	param_name,
		ReporterMode	mode,
		Args &&...	args
	)

protectedinherited

Definition at line 213 of file Reporter.h.

{
  return declareValue<T, S<T>>(param_name, mode, args...);
}

◆ declareValue() [4/4]

template<typename T , typename S , typename... Args>

T & Reporter::declareValue	(	const std::string &	param_name,
		ReporterMode	mode,
		Args &&...	args
	)

protectedinherited

◆ declareValueByName() [1/4]

template<typename T , typename S , typename... Args>

T & Reporter::declareValueByName	(	const ReporterValueName &	value_name,
		Args &&...	args
	)

protectedinherited

Definition at line 234 of file Reporter.h.

{
  return declareValueByName<T, S<T>>(value_name, REPORTER_MODE_UNSET, args...);
}

◆ declareValueByName() [2/4]

template<typename T , typename S , typename... Args>

T & Reporter::declareValueByName	(	const ReporterValueName &	value_name,
		Args &&...	args
	)

protectedinherited

◆ declareValueByName() [3/4]

template<typename T , typename S , typename... Args>

T & Reporter::declareValueByName	(	const ReporterValueName &	value_name,
		ReporterMode	mode,
		Args &&...	args
	)

protectedinherited

Definition at line 241 of file Reporter.h.

{
  return declareValueByName<T, S<T>>(value_name, mode, args...);
}

◆ declareValueByName() [4/4]

template<typename T , typename S , typename... Args>

T & Reporter::declareValueByName	(	const ReporterValueName &	value_name,
		ReporterMode	mode,
		Args &&...	args
	)

protectedinherited

◆ defaultSteadyStateConvergenceParams()

InputParameters TransientBase::defaultSteadyStateConvergenceParams ( )

staticinherited

Definition at line 42 of file TransientBase.C.

{
  InputParameters params = emptyInputParameters();
 
  params.addParam<Real>("steady_state_tolerance",
                        1.0e-08,
                        "Whenever the relative residual changes by less "
                        "than this the solution will be considered to be "
                        "at steady state.");
  params.addParam<bool>("check_aux",
                        false,
                        "Whether to check the auxiliary system for convergence to steady-state. If "
                        "false, then the solution vector from the solver system is used.");
  params.addParam<bool>(
      "normalize_solution_diff_norm_by_dt",
      true,
      "Whether to divide the solution difference norm by dt. If taking 'small' "
      "time steps you probably want this to be true. If taking very 'large' timesteps in an "
      "attempt to *reach* a steady-state, you probably want this parameter to be false.");
 
  params.addParamNamesToGroup("steady_state_tolerance check_aux normalize_solution_diff_norm_by_dt",
                              "Steady State Detection");
 
  return params;
}

Referenced by AddDefaultConvergenceAction::checkUnusedSteadyStateConvergenceParameters(), DefaultSteadyStateConvergence::validParams(), and TransientBase::validParams().

◆ dtMax()

Real & TransientBase::dtMax ( )

inlineinherited

Get the maximum dt.

Returns: The maximum dt

Definition at line 173 of file TransientBase.h.

173{ return _dtmax; }

TransientBase::_dtmax

Real _dtmax

Definition TransientBase.h:268

◆ dtMin()

Real & TransientBase::dtMin ( )

inlineinherited

Get the minimal dt.

Returns: The minimal dt

Definition at line 179 of file TransientBase.h.

179{ return _dtmin; }

TransientBase::_dtmin

Real _dtmin

Definition TransientBase.h:267

◆ enabled()

virtual bool MooseObject::enabled ( ) const

inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 49 of file MooseObject.h.

49{ return _enabled; }

MooseObject::_enabled

const bool & _enabled

Reference to the "enable" InputParameters, used by Controls for toggling on/off MooseObjects.

Definition MooseObject.h:71

Referenced by EigenKernel::enabled(), BlockRestrictionDebugOutput::printBlockRestrictionGroups(), BlockRestrictionDebugOutput::printBoundaryRestrictionGroups(), and NodeFaceConstraint::validParams().

◆ endStep()

void TransientBase::endStep ( Real input_time = -1.0 )

virtualinherited

Definition at line 531 of file TransientBase.C.

{
  if (input_time == -1.0)
    _time = _time_old + _dt;
  else
    _time = input_time;
 
  if (lastSolveConverged())
  {
    if (_xfem_repeat_step)
      _time = _time_old;
    else
    {
      // TODO: add linear system support
      const auto & tis = getTimeIntegrators();
      for (auto & ti : tis)
        ti->postStep();
 
      // Compute the Error Indicators and Markers
      _problem.computeIndicators();
      _problem.computeMarkers();
 
      // Perform the output of the current time step
      _problem.outputStep(EXEC_TIMESTEP_END);
 
      // output
      if (_time_interval && (_time + _timestep_tolerance >= _next_interval_output_time))
        _next_interval_output_time += _time_interval_output_interval;
    }
  }
}

Referenced by TransientBase::execute(), TransientMultiApp::finishStep(), and TransientMultiApp::solveStep().

◆ endTime()

Real & TransientBase::endTime ( )

inlineinherited

Get a modifiable reference to the end time.

Returns: The end time

Definition at line 197 of file TransientBase.h.

197{ return _end_time; }

TransientBase::_end_time

Real _end_time

Definition TransientBase.h:266

Referenced by TimeSequenceStepperBase::buildSequence(), CompositionDT::init(), TimeSequenceStepperBase::setupSequence(), and TransientMultiApp::solveStep().

◆ errorPrefix()

std::string MooseBase::errorPrefix ( const std::string & ) const

inlineinherited

Deprecated message prefix; the error type is no longer used.

Definition at line 264 of file MooseBase.h.

264{ return messagePrefix(); }

◆ estimateTimeError()

void TransientBase::estimateTimeError ( )

virtualinherited

Definition at line 699 of file TransientBase.C.

700{

701}

◆ execute()

void TransientBase::execute ( )

overridevirtualinherited

Pure virtual execute function MUST be overridden by children classes.

This is where the Executioner actually does it's work.

Implements Executioner.

Definition at line 315 of file TransientBase.C.

{
  preExecute();
 
  // Start time loop...
  while (keepGoing())
  {
    incrementStepOrReject();
    preStep();
    computeDT();
    takeStep();
    endStep();
    postStep();
  }
 
  if (lastSolveConverged())
  {
    _t_step++;
 
    /*
     * Call the multi-app executioners endStep and
     * postStep methods when doing Picard or when not automatically advancing sub-applications for
     * some other reason. We do not perform these calls for loose-coupling/auto-advancement
     * problems because TransientBase::endStep and TransientBase::postStep get called from
     * TransientBaseMultiApp::solveStep in that case.
     */
    if (!_fixed_point_solve->autoAdvance())
    {
      _problem.finishMultiAppStep(EXEC_MULTIAPP_FIXED_POINT_BEGIN,
                                  /*recurse_through_multiapp_levels=*/true);
      _problem.finishMultiAppStep(EXEC_TIMESTEP_BEGIN, /*recurse_through_multiapp_levels=*/true);
      _problem.finishMultiAppStep(EXEC_TIMESTEP_END, /*recurse_through_multiapp_levels=*/true);
      _problem.finishMultiAppStep(EXEC_MULTIAPP_FIXED_POINT_END,
                                  /*recurse_through_multiapp_levels=*/true);
    }
  }
 
  if (!_app.testCheckpointHalfTransient())
  {
    TIME_SECTION("final", 1, "Executing Final Objects");
    _problem.execMultiApps(EXEC_FINAL);
    _problem.finalizeMultiApps();
    _problem.execute(EXEC_FINAL);
    _problem.outputStep(EXEC_FINAL);
  }
 
  // This method is to finalize anything else we want to do on the problem side.
  _problem.postExecute();
 
  // This method can be overridden for user defined activities in the Executioner.
  postExecute();
 
  if (_test_restep_step || _test_restep_time)
    mooseError((_test_restep_step ? "Timestep " : "Time "),
               (_test_restep_step ? *_test_restep_step : *_test_restep_time),
               " was never retried because the simulation did not get to this timestep.\n\nTo "
               "support restep testing, specify `num_steps` in the input.\nOtherwise, set "
               "`restep = false` in this test specification.");
}

◆ feProblem()

FEProblemBase & Executioner::feProblem ( )

inherited

Return a reference to this Executioner's FEProblemBase instance.

Definition at line 120 of file Executioner.C.

{
  return _fe_problem;
}

Referenced by TransientMultiApp::finishStep(), MultiApp::preTransfer(), and MultiApp::restore().

◆ fixedPointSolve()

FixedPointSolve & Executioner::fixedPointSolve ( )

inlineinherited

Definition at line 124 of file Executioner.h.

124{ return *_fixed_point_solve; }

Referenced by FixedPointIterationAdaptiveDT::acceptStep(), PIDTransientControl::execute(), IterationInfo::execute(), Terminator::execute(), ChangeOverFixedPointPostprocessor::finalize(), and NumFixedPointIterations::getValue().

◆ flagInvalidSolutionInternal()

template<bool warning>

template void SolutionInvalidInterface::flagInvalidSolutionInternal< false > ( const InvalidSolutionID invalid_solution_id ) const

protectedinherited

Set solution invalid mark for the given solution ID.

Definition at line 41 of file SolutionInvalidInterface.C.

{
  mooseAssert(
      warning == moose::internal::getSolutionInvalidityRegistry().item(invalid_solution_id).warning,
      "Inconsistent warning flag");
  auto & solution_invalidity = _si_moose_base.getMooseApp().solutionInvalidity();
  if constexpr (!warning)
    if (!_si_problem || _si_problem->immediatelyPrintInvalidSolution())
      solution_invalidity.printDebug(invalid_solution_id);
  return solution_invalidity.flagInvalidSolutionInternal(invalid_solution_id);
}

◆ forceNumSteps()

virtual void TransientBase::forceNumSteps ( const unsigned int num_steps )

inlinevirtualinherited

Set the number of time steps.

Parameters

num_steps number of time steps

Definition at line 229 of file TransientBase.h.

229{ _num_steps = num_steps; }

TransientBase::_num_steps

unsigned int _num_steps

Definition TransientBase.h:269

Referenced by TimeStepper::forceNumSteps().

◆ getBase()

const std::string & MooseBase::getBase ( ) const

inlineinherited

Returns: The registered base for this object (set via InputParameters::registerBase())

Definition at line 147 of file MooseBase.h.

147{ return _pars.getBase(); }

InputParameters::getBase

const std::string & getBase() const

Definition InputParameters.C:505

Referenced by Factory::copyConstruct(), and MooseBase::uniqueParameterName().

◆ getCheckedPointerParam()

template<typename T >

T MooseBase::getCheckedPointerParam	(	const std::string &	name,
		const std::string &	error_string = `""`
	)		const

inherited

Verifies that the requested parameter exists and is not NULL and returns it to the caller.

The template parameter must be a pointer or an error will be thrown.

Definition at line 450 of file MooseBase.h.

{
  return _pars.getCheckedPointerParam<T>(name, error_string);
}

◆ getDataFileName()

std::string DataFileInterface::getDataFileName ( const std::string & param ) const

inherited

Deprecated method.

The data file paths are now automatically set within the InputParameters object, so using getParam<DataFileName>("param_name") is now sufficient.

Definition at line 21 of file DataFileInterface.C.

{
  _parent.mooseDeprecated("getDataFileName() is deprecated. The file path is now directly set "
                          "within the InputParameters.\nUse getParam<DataFileName>(\"",
                          param,
                          "\") instead.");
  return _parent.getParam<DataFileName>(param);
}

◆ getDataFileNameByName()

std::string DataFileInterface::getDataFileNameByName ( const std::string & relative_path ) const

inherited

Deprecated method.

Use getDataFilePath() instead.

Definition at line 31 of file DataFileInterface.C.

{
  _parent.mooseDeprecated("getDataFileNameByName() is deprecated. Use getDataFilePath(\"",
                          relative_path,
                          "\") instead.");
  return getDataFilePath(relative_path);
}

◆ getDataFilePath()

std::string DataFileInterface::getDataFilePath ( const std::string & relative_path ) const

inherited

Returns the path of a data file for a given relative file path.

This can be used for hardcoded datafile names and will search the same locations as getDataFileName

Definition at line 40 of file DataFileInterface.C.

{
  // This should only ever be used with relative paths. There is no point to
  // use this search path with an absolute path.
  if (std::filesystem::path(relative_path).is_absolute())
    _parent.mooseWarning("While using getDataFilePath(\"",
                         relative_path,
                         "\"): This API should not be used for absolute paths.");
 
  // This will search the data paths for this relative path
  std::optional<std::string> error;
  Moose::DataFileUtils::Path found_path;
  {
    // Throw on error so that if getPath() fails, we can throw an error
    // with the context of _parent.mooseError()
    Moose::ScopedThrowOnError scoped_throw_on_error;
 
    try
    {
      found_path = Moose::DataFileUtils::getPath(relative_path);
    }
    catch (std::exception & e)
    {
      error = e.what();
    }
  }
 
  if (error)
    _parent.mooseError(*error);
 
  mooseAssert(found_path.context == Moose::DataFileUtils::Context::DATA,
              "Should only ever obtain data");
  mooseAssert(found_path.data_name, "Should be set");
 
  const std::string msg =
      "Using data file '" + found_path.path + "' from " + *found_path.data_name + " data";
  _parent.mooseInfo(msg);
 
  return found_path.path;
}

Referenced by DataFileInterface::getDataFileNameByName().

◆ getDefaultPostprocessorValueByName()

PostprocessorValue PostprocessorInterface::getDefaultPostprocessorValueByName ( const PostprocessorName & name ) const

privateinherited

Returns: The default value stored in the PostprocessorName name.

Definition at line 106 of file PostprocessorInterface.C.

{
  mooseAssert(isDefaultPostprocessorValueByName(name), "Not a default value");
 
  Real real_value = -std::numeric_limits<Real>::max();
  std::istringstream ss(name);
  ss >> real_value;
  return real_value;
}

Referenced by PostprocessorInterface::getPostprocessorValueInternal().

◆ getDT()

Real TransientBase::getDT ( )

virtualinherited

Returns: The the computed dt to use for this timestep.

Definition at line 650 of file TransientBase.C.

{
  return _time_stepper->getCurrentDT();
}

Referenced by TransientBase::computeConstrainedDT(), TransientMultiApp::computeDT(), PseudoTimestep::execute(), TransientBase::preExecute(), and TransientMultiApp::solveStep().

◆ getEndTime()

Real TransientBase::getEndTime ( ) const

inlineinherited

Get the end time.

Returns: The end time

Definition at line 191 of file TransientBase.h.

191{ return _end_time; }

Referenced by ProgressOutput::output().

◆ getHitNode() [1/2]

const hit::Node * MooseBase::getHitNode ( ) const

inlineinherited

Returns: The block-level hit node for this object, if any

Definition at line 136 of file MooseBase.h.

136{ return getHitNode(_pars); }

Referenced by MooseBase::callMooseError(), MooseBase::getHitNode(), and MooseBase::messagePrefix().

◆ getHitNode() [2/2]

const hit::Node * MooseBase::getHitNode ( const InputParameters & params )

staticprivateinherited

Internal method for getting a hit node (if available) given a set of parameters.

Needs to be static so that we can call it externally from InputParameters for errors that do not have context of the MooseBase

Definition at line 167 of file MooseBase.C.

{
  if (const auto hit_node = params.getHitNode())
    if (!hit_node->isRoot())
      return hit_node;
  return nullptr;
}

◆ getMooseApp()

MooseApp & MooseBase::getMooseApp ( ) const

inlineinherited

Get the MooseApp this class is associated with.

Definition at line 87 of file MooseBase.h.

87{ return _app; }

Referenced by ChainControlSetupAction::act(), AddDefaultConvergenceAction::addDefaultMultiAppFixedPointConvergence(), AddDefaultConvergenceAction::addDefaultNonlinearConvergence(), AddDefaultConvergenceAction::addDefaultSteadyStateConvergence(), FEProblemBase::advanceState(), ParsedChainControl::buildFunction(), ReporterTransferInterface::checkHasReporterValue(), AddDefaultConvergenceAction::checkUnusedMultiAppFixedPointConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedNonlinearConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedSteadyStateConvergenceParameters(), Coupleable::checkWritableVar(), ComponentPhysicsInterface::ComponentPhysicsInterface(), Coupleable::Coupleable(), MortarInterfaceWarehouse::createMortarInterface(), EigenProblem::doFreeNonlinearPowerIterations(), Terminator::execute(), FEProblemSolve::FEProblemSolve(), SolutionInvalidInterface::flagInvalidSolutionInternal(), ChainControl::getChainControlDataSystem(), FEProblemBase::getDistribution(), FEProblemBase::getFunction(), FEProblemBase::getFVInterpolationMethod(), FEProblemBase::getMultiApp(), FEProblemBase::getSampler(), DefaultConvergenceBase::getSharedExecutionerParam(), FEProblemBase::getUserObjectBase(), FEProblemBase::getVectorPostprocessorObjectByName(), ChainControlDataPostprocessor::initialSetup(), MaterialPropertyInterface::MaterialPropertyInterface(), MooseVariableDataFV< OutputType >::MooseVariableDataFV(), ProgressOutput::output(), PetscOutputInterface::petscLinearOutput(), PetscOutputInterface::petscNonlinearOutput(), Moose::PetscSupport::PetscOptionsScope::PetscOptionsScope(), PetscOutputInterface::PetscOutputInterface(), PostprocessorInterface::postprocessorsAdded(), MultiApp::preTransfer(), Reporter::Reporter(), ReporterInterface::reportersAdded(), MultiApp::restore(), and VectorPostprocessorInterface::vectorPostprocessorsAdded().

◆ getOutputs()

const std::set< OutputName > & OutputInterface::getOutputs ( )

inherited

Get the list of output objects that this class is restricted.

Returns: A set of OutputNames

Definition at line 101 of file OutputInterface.C.

{
  return _oi_outputs;
}

◆ getParam() [1/2]

template<typename T >

const T & MooseBase::getParam ( const std::string & name ) const

inherited

Retrieve a parameter for the object.

Parameters

name	The name of the parameter

Returns: The value of the parameter

Definition at line 406 of file MooseBase.h.

{
  return InputParameters::getParamHelper<T>(name, _pars);
}

◆ getParam() [2/2]

template<typename T1 , typename T2 >

std::vector< std::pair< T1, T2 > > MooseBase::getParam	(	const std::string &	param1,
		const std::string &	param2
	)		const

inherited

Retrieve two parameters and provide pair of parameters for the object.

Parameters

param1	The name of first parameter
param2	The name of second parameter

Returns: Vector of pairs of first and second parameters

Definition at line 443 of file MooseBase.h.

{
  return _pars.get<T1, T2>(param1, param2);
}

◆ getPostprocessorName()

const PostprocessorName & PostprocessorInterface::getPostprocessorName	(	const std::string &	param_name,
		const unsigned int	index = `0`
	)		const

inherited

Get the name of a postprocessor.

This can only be used if the postprocessor parameter does not have a default value set (see isDefaultPostprocessorValue()), in which case the "name" is actually the default value.

Parameters

param_name	The name of the Postprocessor parameter
index	The index of the Postprocessor

Returns: The name of the given Postprocessor

Definition at line 195 of file PostprocessorInterface.C.

{
  return getPostprocessorNameInternal(param_name, index, /* allow_default_value = */ false);
}

Referenced by EigenKernel::EigenKernel().

◆ getPostprocessorNameInternal()

const PostprocessorName & PostprocessorInterface::getPostprocessorNameInternal	(	const std::string &	param_name,
		const unsigned int	index,
		const bool	allow_default_value = `true`
	)		const

privateinherited

Internal method for getting the PostprocessorName associated with a paremeter.

Needed in order to allow the return of a name that is a default value.

Definition at line 202 of file PostprocessorInterface.C.

{
  checkParam(param_name, index);
 
  const auto & name = _ppi_params.isType<PostprocessorName>(param_name)
                          ? _ppi_params.get<PostprocessorName>(param_name)
                          : _ppi_params.get<std::vector<PostprocessorName>>(param_name)[index];
 
  if (!allow_default_value && isDefaultPostprocessorValueByName(name))
  {
    std::stringstream oss;
    oss << "Cannot get the name associated with PostprocessorName parameter \"" << param_name
        << "\"";
    if (index)
      oss << " at index " << index;
    oss << ",\nbecause said parameter is a default Postprocessor value.";
    _ppi_moose_object.paramError(param_name, oss.str());
  }
 
  return name;
}

Referenced by PostprocessorInterface::getPostprocessorName(), PostprocessorInterface::getPostprocessorValueInternal(), PostprocessorInterface::hasPostprocessor(), and PostprocessorInterface::isDefaultPostprocessorValue().

◆ getPostprocessorValue()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValue	(	const std::string &	param_name,
		const unsigned int	index = `0`
	)		const

inherited

doco-normal-methods-begin Retrieve the value of a Postprocessor or one of it's old or older values

Parameters

param_name	The name of the Postprocessor parameter (see below)
index	The index of the Postprocessor

Returns: A reference to the desired value

The name required by this method is the name that is hard-coded into your source code. For example, if you have a Kernel that requires a Postprocessor you may have an input file with "pp = my_pp", this function requires the "pp" name as input (see .../moose_test/functions/PostprocessorFunction.C)

see getPostprocessorValueByName getPostprocessorValueOldByName getPostprocessorValueOlderByName

Definition at line 46 of file PostprocessorInterface.C.

{
  return getPostprocessorValueInternal(param_name, index, /* t_index = */ 0);
}

Referenced by EigenKernel::EigenKernel(), FunctionValuePostprocessor::FunctionValuePostprocessor(), LinearCombinationPostprocessor::LinearCombinationPostprocessor(), and ParsedPostprocessor::ParsedPostprocessor().

◆ getPostprocessorValueByName()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValueByName ( const PostprocessorName & name ) const

virtualinherited

Retrieve the value of the Postprocessor.

Parameters

name	Postprocessor name (see below)

Returns: A reference to the desired value

The name required by this method is the name defined in the input file. For example, if you have a Kernel that requires a Postprocessor you may have an input file with "pp = my_pp", this method requires the "my_pp" name as input (see .../moose_test/functions/PostprocessorFunction.C)

see getPostprocessorValue getPostprocessorValueOld getPostprocessorValueOlder

Definition at line 67 of file PostprocessorInterface.C.

{
  return getPostprocessorValueByNameInternal(name, /* t_index = */ 0);
}

Referenced by EigenKernel::EigenKernel(), PIDTransientControl::execute(), IterationAdaptiveDT::IterationAdaptiveDT(), LibtorchNeuralNetControl::LibtorchNeuralNetControl(), MultiPostprocessorConvergence::MultiPostprocessorConvergence(), ParsedODEKernel::ParsedODEKernel(), PicardSolve::savePostprocessorValues(), SecantSolve::savePostprocessorValues(), SteffensenSolve::savePostprocessorValues(), SumPostprocessor::SumPostprocessor(), Terminator::Terminator(), PicardSolve::transformPostprocessors(), SecantSolve::transformPostprocessors(), SteffensenSolve::transformPostprocessors(), and VectorOfPostprocessors::VectorOfPostprocessors().

◆ getPostprocessorValueByNameInternal()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValueByNameInternal	(	const PostprocessorName &	name,
		std::size_t	t_index
	)		const

privateinherited

Definition at line 256 of file PostprocessorInterface.C.

{
  mooseAssert(t_index < 3, "Invalid time index");
  mooseAssert(!isDefaultPostprocessorValueByName(name), "Should not be default");
 
  // If all pps have been added, we can check for existance
  if (postprocessorsAdded() && !hasPostprocessorByName(name))
    _ppi_moose_object.mooseError("A Postprocessor with the name \"", name, "\" was not found.");
 
  if (t_index == 0)
    addPostprocessorDependencyHelper(name);
 
  return _ppi_feproblem.getReporterData().getReporterValue<PostprocessorValue>(
      PostprocessorReporterName(name), _ppi_moose_object, REPORTER_MODE_ROOT, t_index);
}

Referenced by PostprocessorInterface::getPostprocessorValueByName(), PostprocessorInterface::getPostprocessorValueInternal(), PostprocessorInterface::getPostprocessorValueOldByName(), and PostprocessorInterface::getPostprocessorValueOlderByName().

◆ getPostprocessorValueInternal()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValueInternal	(	const std::string &	param_name,
		unsigned int	index,
		std::size_t	t_index
	)		const

privateinherited

Internal methods for getting Postprocessor values.

Definition at line 228 of file PostprocessorInterface.C.

{
  const auto & name = getPostprocessorNameInternal(param_name, index);
 
  // If the Postprocessor is a default value (either set by addParam or set to a constant
  // value by the user in input/an action), we covert the name to a value, store said
  // value locally, and return it so that it fits in with the rest of the interface
  // (needing a reference to a value)
  if (isDefaultPostprocessorValueByName(name))
  {
    const auto value = getDefaultPostprocessorValueByName(name);
    const auto & value_ref =
        *_default_values.emplace(name, std::make_unique<PostprocessorValue>(value))
             .first->second; // first is inserted pair, second is value in pair
    mooseAssert(value == value_ref, "Inconsistent default value");
    return value_ref;
  }
  // If not a default and all pps have been added, we check check for existance
  else if (postprocessorsAdded() && !hasPostprocessorByName(name))
    _ppi_moose_object.paramError(
        param_name, "A Postprocessor with the name \"", name, "\" was not found.");
 
  return getPostprocessorValueByNameInternal(name, t_index);
}

Referenced by PostprocessorInterface::getPostprocessorValue(), PostprocessorInterface::getPostprocessorValueOld(), and PostprocessorInterface::getPostprocessorValueOlder().

◆ getPostprocessorValueOld()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValueOld	(	const std::string &	param_name,
		const unsigned int	index = `0`
	)		const

inherited

Definition at line 53 of file PostprocessorInterface.C.

{
  return getPostprocessorValueInternal(param_name, index, /* t_index = */ 1);
}

◆ getPostprocessorValueOldByName()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValueOldByName ( const PostprocessorName & name ) const

inherited

Definition at line 73 of file PostprocessorInterface.C.

{
  return getPostprocessorValueByNameInternal(name, /* t_index = */ 1);
}

Referenced by EigenKernel::EigenKernel().

◆ getPostprocessorValueOlder()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValueOlder	(	const std::string &	param_name,
		const unsigned int	index = `0`
	)		const

inherited

Definition at line 60 of file PostprocessorInterface.C.

{
  return getPostprocessorValueInternal(param_name, index, /* t_index = */ 2);
}

◆ getPostprocessorValueOlderByName()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValueOlderByName ( const PostprocessorName & name ) const

inherited

Definition at line 79 of file PostprocessorInterface.C.

{
  return getPostprocessorValueByNameInternal(name, /* t_index = */ 2);
}

◆ getProblemOperators()

virtual std::vector< std::shared_ptr< ProblemOperatorBase > > & Moose::MFEM::ProblemOperatorInterface::getProblemOperators ( )

inlinevirtualinherited

Returns a pointer to the operator's equation system.

Definition at line 30 of file ProblemOperatorInterface.h.

  {
    return _problem_operators;
  }

Referenced by MFEMSteady::init(), init(), and MFEMTransient().

◆ getRenamedParam()

template<typename T >

const T & MooseBase::getRenamedParam	(	const std::string &	old_name,
		const std::string &	new_name
	)		const

inherited

Retrieve a renamed parameter for the object.

This helper makes sure we check both names before erroring, and that only one parameter is passed to avoid silent errors

Parameters

old_name	the old name for the parameter
new_name	the new name for the parameter

Definition at line 420 of file MooseBase.h.

{
  // Most important: accept new parameter
  if (isParamSetByUser(new_name) && !isParamValid(old_name))
    return getParam<T>(new_name);
  // Second most: accept old parameter
  if (isParamValid(old_name) && !isParamSetByUser(new_name))
    return getParam<T>(old_name);
  // Third most: accept default for new parameter
  if (isParamValid(new_name) && !isParamValid(old_name))
    return getParam<T>(new_name);
  // Refuse: no default, no value passed
  if (!isParamValid(old_name) && !isParamValid(new_name))
    mooseError("parameter '" + new_name +
               "' is being retrieved without being set.\nDid you misspell it?");
  // Refuse: both old and new parameters set by user
  else
    mooseError("Parameter '" + new_name + "' may not be provided alongside former parameter '" +
               old_name + "'");
}

◆ getReporterContextBaseByName()

const ReporterContextBase & ReporterInterface::getReporterContextBaseByName ( const ReporterName & reporter_name ) const

protectedinherited

Get the reporter context to allow non-typed operations with the data.

Parameters

reporter_name A ReporterName object that for the desired Reporter context.

Returns: ReporterContextBase of the reporter value

Definition at line 60 of file ReporterInterface.C.

{
  if (!reportersAdded())
    _ri_moose_object.mooseError(
        "Cannot call getReporterContextBaseByName() until all Reporters have been constructed.");
 
  return _ri_reporter_data.getReporterContextBase(reporter_name);
}

◆ getReporterName()

const ReporterName & ReporterInterface::getReporterName ( const std::string & param_name ) const

protectedinherited

Returns: The ReporterName associated with the parametre param_name.

Performs error checking to mak sure that the parameter is valid.

Definition at line 70 of file ReporterInterface.C.

{
  if (!_ri_params.isParamValid(param_name))
    _ri_moose_object.mooseError(
        "When getting a Reporter, failed to get a parameter with the name \"",
        param_name,
        "\".",
        "\n\nKnown parameters:\n",
        _ri_moose_object.parameters());
 
  if (_ri_params.isType<ReporterName>(param_name))
    return _ri_params.get<ReporterName>(param_name);
 
  _ri_moose_object.mooseError("Supplied parameter with name \"",
                              param_name,
                              "\" of type \"",
                              _ri_params.type(param_name),
                              "\" is not an expected type for getting a Reporter.\n\n",
                              "The expected type is \"ReporterName\".");
}

Referenced by ReporterInterface::getReporterValue(), and ReporterInterface::hasReporterValue().

◆ getReporterValue() [1/2]

template<typename T >

const T & ReporterInterface::getReporterValue	(	const std::string &	param_name,
		const std::size_t	time_index = `0`
	)

protectedinherited

doco-normal-methods-begin Returns read-only reference to a Reporter value that is provided by an input parameter.

Template Parameters

T	The C++ type of the Reporter value being consumed

Parameters

param_name	The name of the parameter that gives the name of the Reporter, which must be a ReporterName parameter (i.e., getParam<ReporterName>(param_name)).
mode	The mode that the object will consume the Reporter value @pararm time_index (optional) If zero is provided the current value is returned. Use a positive index to return previous values (1 = older, 2 = older, etc.). The maximum number of old values is dictated by the ReporterData object.

Definition at line 148 of file ReporterInterface.h.

{
  return getReporterValue<T>(param_name, REPORTER_MODE_UNSET, time_index);
}

◆ getReporterValue() [2/2]

template<typename T >

const T & ReporterInterface::getReporterValue	(	const std::string &	param_name,
		ReporterMode	mode,
		const std::size_t	time_index = `0`
	)

protectedinherited

Definition at line 155 of file ReporterInterface.h.

{
  const auto & reporter_name = getReporterName(param_name);
 
  possiblyCheckHasReporter<T>(reporter_name, param_name);
 
  return getReporterValueByName<T>(reporter_name, mode, time_index);
}

◆ getReporterValueByName() [1/2]

template<typename T >

const T & ReporterInterface::getReporterValueByName	(	const ReporterName &	reporter_name,
		const std::size_t	time_index = `0`
	)

protectedinherited

Returns read-only reference to a Reporter value that is provided by name directly.

Template Parameters

T	The C++ type of the Reporter value being consumed

Parameters

reporter_name	A ReporterName object that for the desired Reporter value.
mode	The mode that the object will consume the Reporter value @pararm time_index (optional) If zero is provided the current value is returned. Use a positive index to return previous values (1 = older, 2 = older, etc.). The maximum number of old values is dictated by the ReporterData object.

Definition at line 168 of file ReporterInterface.h.

{
  return getReporterValueByName<T>(reporter_name, REPORTER_MODE_UNSET, time_index);
}

Referenced by ParsedVectorReporter::ParsedVectorReporter().

◆ getReporterValueByName() [2/2]

template<typename T >

const T & ReporterInterface::getReporterValueByName	(	const ReporterName &	reporter_name,
		ReporterMode	mode,
		const std::size_t	time_index = `0`
	)

protectedinherited

Definition at line 176 of file ReporterInterface.h.

{
  possiblyCheckHasReporter<T>(reporter_name);
 
  addReporterDependencyHelper(reporter_name);
 
  return _ri_reporter_data.getReporterValue<T>(reporter_name, _ri_moose_object, mode, time_index);
}

◆ getReporterValueName()

const ReporterValueName & Reporter::getReporterValueName ( const std::string & param_name ) const

privateinherited

Returns: The ReporterValueName associated with the parameter param_name.

Performs error checking on if the parameter is valid.

Definition at line 61 of file Reporter.C.

{
  if (!_reporter_params.isParamValid(param_name))
    _reporter_moose_object.mooseError(
        "When getting a ReporterValueName, failed to get a parameter with the name \"",
        param_name,
        "\".",
        "\n\nKnown parameters:\n",
        _reporter_moose_object.parameters());
 
  if (_reporter_params.isType<ReporterValueName>(param_name))
    return _reporter_params.get<ReporterValueName>(param_name);
 
  _reporter_moose_object.mooseError("Supplied parameter with name \"",
                                    param_name,
                                    "\" of type \"",
                                    _reporter_params.type(param_name),
                                    "\" is not an expected type for getting a Reporter value.\n\n",
                                    "The expected type is \"ReporterValueName\".");
}

◆ getRestartableData()

template<typename T , typename... Args>

const T & Restartable::getRestartableData ( const std::string & data_name ) const

protectedinherited

Declare a piece of data as "restartable" and initialize it Similar to declareRestartableData but returns a const reference to the object.

Forwarded arguments are not allowed in this case because we assume that the object is restarted and we won't need different constructors to initialize it.

NOTE: This returns a const reference! Make sure you store it in a const reference!

Parameters

data_name The name of the data (usually just use the same name as the member variable)

Definition at line 294 of file Restartable.h.

{
  return declareRestartableDataHelper<T>(data_name, nullptr).get();
}

◆ getSharedPtr() [1/2]

std::shared_ptr< MooseObject > MooseObject::getSharedPtr ( )

inherited

Get another shared pointer to this object that has the same ownership group.

Wrapper around shared_from_this().

Definition at line 70 of file MooseObject.C.

{
  try
  {
    return shared_from_this();
  }
  catch (std::bad_weak_ptr &)
  {
    mooseError(not_shared_error);
  }
}

Referenced by MFEMProblem::addImagComponentToBC(), MFEMProblem::addImagComponentToKernel(), MFEMProblem::addRealComponentToBC(), MFEMProblem::addRealComponentToKernel(), and WebServerControl::addServerAction().

◆ getSharedPtr() [2/2]

std::shared_ptr< const MooseObject > MooseObject::getSharedPtr ( ) const

inherited

Definition at line 83 of file MooseObject.C.

{
  try
  {
    return shared_from_this();
  }
  catch (std::bad_weak_ptr &)
  {
    mooseError(not_shared_error);
  }
}

◆ getStartTime()

Real TransientBase::getStartTime ( ) const

inlineinherited

Return the start time.

Returns: The start time

Definition at line 185 of file TransientBase.h.

185{ return _start_time; }

TransientBase::_start_time

Real _start_time

Definition TransientBase.h:291

Referenced by TimeSequenceStepperBase::buildSequence(), ProgressOutput::output(), and TimeSequenceStepperBase::setupSequence().

◆ getTargetTime()

virtual Real TransientBase::getTargetTime ( )

inlinevirtualinherited

Get the current target time.

Returns: target time

Definition at line 97 of file TransientBase.h.

97{ return _target_time; }

◆ getTime()

virtual Real TransientBase::getTime ( ) const

inlinevirtualinherited

Get the current time.

Definition at line 91 of file TransientBase.h.

91{ return _time; };

Referenced by ProgressOutput::output(), and TransientMultiApp::solveStep().

◆ getTimeIntegratorNames()

virtual std::vector< std::string > MFEMTransient::getTimeIntegratorNames ( ) const

inlineoverridevirtual

MFEM problems have no libMesh based TimeIntegrators attached, so return empty vector.

Reimplemented from TransientBase.

Definition at line 46 of file MFEMTransient.h.

46{ return {}; }

◆ getTimeIntegrators()

virtual std::set< TimeIntegrator * > MFEMTransient::getTimeIntegrators ( ) const

inlineoverridevirtual

MFEM problems have no libMesh based TimeIntegrators attached, so return empty set.

Implements TransientBase.

Definition at line 43 of file MFEMTransient.h.

43{ return {}; }

◆ getTimeScheme()

Moose::TimeIntegratorType TransientBase::getTimeScheme ( ) const

inlineinherited

Get the time scheme used.

Returns: MooseEnum with the time scheme

Definition at line 161 of file TransientBase.h.

161{ return _time_scheme; }

TransientBase::_time_scheme

Moose::TimeIntegratorType _time_scheme

Definition TransientBase.h:244

Referenced by init().

◆ getTimeStepper() [1/2]

TimeStepper * TransientBase::getTimeStepper ( )

inlineinherited

Pointer to the TimeStepper.

Returns: Pointer to the time stepper for this Executioner

Definition at line 128 of file TransientBase.h.

128{ return _time_stepper; }

Referenced by TransientBase::init().

◆ getTimeStepper() [2/2]

const TimeStepper * TransientBase::getTimeStepper ( ) const

inlineinherited

Definition at line 129 of file TransientBase.h.

129{ return _time_stepper; }

◆ getTimeStepperName()

std::string TransientBase::getTimeStepperName ( ) const

overridevirtualinherited

Get the name of the timestepper.

Reimplemented from Executioner.

Definition at line 777 of file TransientBase.C.

{
  if (_time_stepper)
  {
    TimeStepper & ts = *_time_stepper;
    return demangle(typeid(ts).name());
  }
  else
    return std::string();
}

◆ getUserObject()

template<class T >

const T & UserObjectInterface::getUserObject	(	const std::string &	param_name,
		bool	is_dependency = `true`
	)		const

inherited

Get an user object with a given parameter param_name.

Parameters

param_name	The name of the parameter key of the user object to retrieve
is_dependency	Whether the user object we are retrieving should be viewed as a dependency, e.g. whether the retrieved user object should be sorted and executed before this object (if we are a user object)

Returns: The user object with name associated with the parameter param_name

Definition at line 172 of file UserObjectInterface.h.

{
  return castUserObject<T>(getUserObjectBase(param_name, is_dependency), param_name);
}

◆ getUserObjectBase()

const UserObjectBase & UserObjectInterface::getUserObjectBase	(	const std::string &	param_name,
		bool	is_dependency = `true`
	)		const

inherited

Get an user object with a given parameter param_name.

Parameters

param_name	The name of the parameter key of the user object to retrieve
is_dependency	Whether the user object we are retrieving should be viewed as a dependency, e.g. whether the retrieved user object should be sorted and executed before this object (if we are a user object)

Returns: The user object with name associated with the parameter param_name

Definition at line 115 of file UserObjectInterface.C.

{
  const auto object_name = getUserObjectName(param_name);
  if (!hasUserObjectByName(object_name))
    _uoi_moose_object.paramError(
        param_name, "The requested UserObject with the name \"", object_name, "\" was not found.");
 
  return getUserObjectBaseByName(object_name, is_dependency);
}

Referenced by MultiAppGeneralFieldUserObjectTransfer::evaluateInterpValuesWithUserObjects(), MultiAppUserObjectTransfer::execute(), and UserObjectInterface::getUserObject().

◆ getUserObjectBaseByName()

const UserObjectBase & UserObjectInterface::getUserObjectBaseByName	(	const UserObjectName &	object_name,
		bool	is_dependency = `true`
	)		const

inherited

Get an user object with the name object_name.

Parameters

object_name	The name of the user object to retrieve
is_dependency	Whether the user object we are retrieving should be viewed as a dependency, e.g. whether the retrieved user object should be sorted and executed before this object (if we are a user object)

Returns: The user object with the name object_name

Definition at line 127 of file UserObjectInterface.C.

{
  if (!hasUserObjectByName(object_name))
    _uoi_moose_object.mooseError(
        "The requested UserObject with the name \"", object_name, "\" was not found.");
 
  const auto & uo_base_tid0 = getUserObjectFromFEProblem(object_name);
  if (is_dependency)
    addUserObjectDependencyHelper(uo_base_tid0);
 
  const THREAD_ID tid = uo_base_tid0.needThreadedCopy() ? _uoi_tid : 0;
  return getUserObjectFromFEProblem(object_name, tid);
}

Referenced by AuxKernelBase::addPostprocessorDependencyHelper(), AuxKernelBase::addVectorPostprocessorDependencyHelper(), FunctorAux::FunctorAux(), UserObjectBase::getDependObjects(), UserObjectInterface::getUserObjectBase(), and UserObjectInterface::getUserObjectByName().

◆ getUserObjectByName()

template<class T >

const T & UserObjectInterface::getUserObjectByName	(	const UserObjectName &	object_name,
		bool	is_dependency = `true`
	)		const

inherited

Get an user object with the name object_name.

Parameters

object_name	The name of the user object to retrieve
is_dependency	Whether the user object we are retrieving should be viewed as a dependency, e.g. whether the retrieved user object should be sorted and executed before this object (if we are a user object)

Returns: The user object with the name object_name

Definition at line 179 of file UserObjectInterface.h.

{
  return castUserObject<T>(getUserObjectBaseByName(object_name, is_dependency));
}

◆ getUserObjectFromFEProblem()

const UserObjectBase & UserObjectInterface::getUserObjectFromFEProblem	(	const UserObjectName &	object_name,
		const THREAD_ID	tid = `0`
	)		const

privateinherited

Go directly to the FEProblem for the requested object_name for thread ID tid.

Definition at line 96 of file UserObjectInterface.C.

{
  const UserObjectBase * uo = nullptr;
 
  if (_uoi_feproblem.hasUserObject(object_name))
    uo = &_uoi_feproblem.getUserObjectBase(object_name, tid);
 
#ifdef MOOSE_KOKKOS_ENABLED
  if (_uoi_feproblem.hasKokkosUserObject(object_name))
    uo = &_uoi_feproblem.getKokkosUserObject<UserObjectBase>(object_name);
#endif
 
  mooseAssert(uo, "getUserObjectFromFEProblem() could not find user object");
 
  return *uo;
}

Referenced by UserObjectInterface::getUserObjectBaseByName(), and UserObjectInterface::hasUserObjectByName().

◆ getUserObjectName()

UserObjectName UserObjectInterface::getUserObjectName ( const std::string & param_name ) const

inherited

Returns: The name of the user object associated with the parameter param_name

Definition at line 45 of file UserObjectInterface.C.

{
  const auto & params = _uoi_moose_object.parameters();
 
  if (!params.isParamValid(param_name))
    _uoi_moose_object.mooseError("Failed to get a parameter with the name \"",
                                 param_name,
                                 "\" when getting a UserObjectName.",
                                 "\n\nKnown parameters:\n",
                                 _uoi_moose_object.parameters());
 
  // Other interfaces will use this interface (PostprocessorInterface, VectorPostprocessorInterface)
  // to grab UOs with a specialized name, so we need to check them all
  UserObjectName name;
  if (params.isType<UserObjectName>(param_name))
    name = params.get<UserObjectName>(param_name);
  else if (params.isType<PostprocessorName>(param_name))
    name = params.get<PostprocessorName>(param_name);
  else if (params.isType<VectorPostprocessorName>(param_name))
    name = params.get<VectorPostprocessorName>(param_name);
  else if (params.isType<std::string>(param_name))
    name = params.get<std::string>(param_name);
  else
    _uoi_moose_object.paramError(
        param_name,
        "Parameter of type \"",
        params.type(param_name),
        "\" is not an expected type for getting the name of a UserObject.");
 
  return name;
}

Referenced by UserObjectInterface::getUserObjectBase(), and UserObjectInterface::hasUserObject().

◆ hasBase()

bool MooseBase::hasBase ( ) const

inlineinherited

Returns: Whether or not this object has a registered base (set via InputParameters::registerBase())

Definition at line 142 of file MooseBase.h.

142{ return _pars.hasBase(); }

InputParameters::hasBase

bool hasBase() const

Definition InputParameters.C:499

◆ hasPostprocessor()

bool PostprocessorInterface::hasPostprocessor	(	const std::string &	param_name,
		const unsigned int	index = `0`
	)		const

inherited

Determine if the Postprocessor data exists.

Parameters

param_name	The name of the Postprocessor parameter
index	The index of the Postprocessor

Returns: True if the Postprocessor exists

See also: hasPostprocessorByName getPostprocessorValue

Definition at line 117 of file PostprocessorInterface.C.

{
  if (!postprocessorsAdded())
    _ppi_moose_object.mooseError(
        "Cannot call hasPostprocessor() until all Postprocessors have been constructed.");
 
  return hasPostprocessorByName(getPostprocessorNameInternal(param_name, index));
}

◆ hasPostprocessorByName()

bool PostprocessorInterface::hasPostprocessorByName ( const PostprocessorName & name ) const

inherited

Determine if the Postprocessor data exists.

Parameters

name	The name of the Postprocessor

Returns: True if the Postprocessor exists

See also: hasPostprocessor getPostprocessorValueByName

Definition at line 128 of file PostprocessorInterface.C.

{
  if (!postprocessorsAdded())
    _ppi_moose_object.mooseError(
        "Cannot call hasPostprocessorByName() until all Postprocessors have been constructed.");
 
  return _ppi_feproblem.getReporterData().hasReporterValue<PostprocessorValue>(
      PostprocessorReporterName(name));
}

Referenced by PostprocessorInterface::getPostprocessorValueByNameInternal(), PostprocessorInterface::getPostprocessorValueInternal(), PostprocessorInterface::hasPostprocessor(), AdvancedOutput::initShowHideLists(), Exodus::outputReporters(), and TableOutput::outputReporters().

◆ hasReporterValue() [1/2]

bool ReporterInterface::hasReporterValue ( const std::string & param_name ) const

protectedinherited

Return True if the Reporter value exists.

Template Parameters

T	The C++ type of the Reporter value being consumed

Parameters

reporter_name A ReporterName object that for the desired Reporter value.

Definition at line 40 of file ReporterInterface.C.

{
  if (!reportersAdded())
    _ri_moose_object.mooseError(
        "Cannot call hasReporterValue() until all Reporters have been constructed.");
 
  return hasReporterValueByName(getReporterName(param_name));
}

◆ hasReporterValue() [2/2]

template<typename T >

bool ReporterInterface::hasReporterValue ( const std::string & param_name ) const

protectedinherited

Definition at line 189 of file ReporterInterface.h.

{
  if (!reportersAdded())
    _ri_moose_object.mooseError(
        "Cannot call hasReporterValue() until all Reporters have been constructed.");
 
  return hasReporterValueByName<T>(getReporterName(param_name));
}

◆ hasReporterValueByName() [1/2]

bool ReporterInterface::hasReporterValueByName ( const ReporterName & reporter_name ) const

protectedinherited

Definition at line 50 of file ReporterInterface.C.

{
  if (!reportersAdded())
    _ri_moose_object.mooseError(
        "Cannot call hasReporterValueByName() until all Reporters have been constructed.");
 
  return _ri_reporter_data.hasReporterValue(reporter_name);
}

Referenced by ReporterInterface::hasReporterValue(), and AdvancedOutput::initShowHideLists().

◆ hasReporterValueByName() [2/2]

template<typename T >

bool ReporterInterface::hasReporterValueByName ( const ReporterName & reporter_name ) const

protectedinherited

Definition at line 200 of file ReporterInterface.h.

{
  if (!reportersAdded())
    _ri_moose_object.mooseError(
        "Cannot call hasReporterValueByName() until all Reporters have been constructed.");
 
  return _ri_reporter_data.hasReporterValue<T>(reporter_name);
}

◆ hasSolveObject()

template<class T >

bool Executioner::hasSolveObject ( ) const

inlineinherited

Whether a solve object in a certain type has been built by the executioner.

Definition at line 148 of file Executioner.h.

  {
    for (const auto & so : _solve_objects)
    {
      const T * tso = dynamic_cast<const T *>(so);
      if (tso)
        return true;
    }
    return false;
  }

◆ hasUserObject() [1/2]

bool UserObjectInterface::hasUserObject ( const std::string & param_name ) const

inherited

Returns: Whether or not a UserObject exists with the name given by the parameter param_name.

Definition at line 78 of file UserObjectInterface.C.

{
  return hasUserObjectByName(getUserObjectName(param_name));
}

◆ hasUserObject() [2/2]

template<class T >

bool UserObjectInterface::hasUserObject ( const std::string & param_name ) const

inherited

Definition at line 187 of file UserObjectInterface.h.

{
  return hasUserObjectByName<T>(getUserObjectName(param_name));
}

◆ hasUserObjectByName() [1/2]

bool UserObjectInterface::hasUserObjectByName ( const UserObjectName & object_name ) const

inherited

Definition at line 84 of file UserObjectInterface.C.

{
  bool flag = _uoi_feproblem.hasUserObject(object_name);
 
#ifdef MOOSE_KOKKOS_ENABLED
  flag = flag || _uoi_feproblem.hasKokkosUserObject(object_name);
#endif
 
  return flag;
}

Referenced by FunctorAux::FunctorAux(), UserObjectInterface::getUserObjectBase(), UserObjectInterface::getUserObjectBaseByName(), UserObjectInterface::hasUserObject(), and UserObjectInterface::hasUserObjectByName().

◆ hasUserObjectByName() [2/2]

template<class T >

bool UserObjectInterface::hasUserObjectByName ( const UserObjectName & object_name ) const

inherited

Definition at line 194 of file UserObjectInterface.h.

{
  if (!hasUserObjectByName(object_name))
    return false;
  return dynamic_cast<const T *>(&getUserObjectFromFEProblem(object_name));
}

◆ incrementStepOrReject()

void TransientBase::incrementStepOrReject ( )

virtualinherited

This is where the solve step is actually incremented.

Definition at line 390 of file TransientBase.C.

{
  if (lastSolveConverged())
  {
    if (!_xfem_repeat_step)
    {
#ifdef LIBMESH_ENABLE_AMR
      if (_t_step != 0)
        _problem.adaptMesh();
#endif
 
      _time_old = _time;
      _t_step++;
 
      bool advance_problem_state = true;
      const auto & tis = getTimeIntegrators();
      for (auto & ti : tis)
        // We do not want to advance the problem state here if a time integrator is already doing so
        // itself
        if (ti->advancesProblemState())
        {
          advance_problem_state = false;
          break;
        }
 
      if (advance_problem_state)
        _problem.advanceState();
      else if (tis.size() > 1)
        mooseError("Either there must be a single time integrator which advances state or none of "
                   "the time integrators should advance state.");
 
      if (_t_step == 1)
        return;
 
      /*
       * Call the multi-app executioners endStep and
       * postStep methods when doing Picard or when not automatically advancing sub-applications for
       * some other reason. We do not perform these calls for loose-coupling/auto-advancement
       * problems because TransientBase::endStep and TransientBase::postStep get called from
       * TransientBaseMultiApp::solveStep in that case.
       */
      if (!_fixed_point_solve->autoAdvance())
      {
        _problem.finishMultiAppStep(EXEC_MULTIAPP_FIXED_POINT_BEGIN);
        _problem.finishMultiAppStep(EXEC_TIMESTEP_BEGIN);
        _problem.finishMultiAppStep(EXEC_TIMESTEP_END);
        _problem.finishMultiAppStep(EXEC_MULTIAPP_FIXED_POINT_END);
      }
 
      /*
       * Ensure that we increment the sub-application time steps so that
       * when dt selection is made in the master application, we are using
       * the correct time step information
       */
      _problem.incrementMultiAppTStep(EXEC_MULTIAPP_FIXED_POINT_BEGIN);
      _problem.incrementMultiAppTStep(EXEC_TIMESTEP_BEGIN);
      _problem.incrementMultiAppTStep(EXEC_TIMESTEP_END);
      _problem.incrementMultiAppTStep(EXEC_MULTIAPP_FIXED_POINT_END);
    }
  }
  else
  {
    _problem.restoreMultiApps(EXEC_MULTIAPP_FIXED_POINT_BEGIN, true);
    _problem.restoreMultiApps(EXEC_TIMESTEP_BEGIN, true);
    _problem.restoreMultiApps(EXEC_TIMESTEP_END, true);
    _problem.restoreMultiApps(EXEC_MULTIAPP_FIXED_POINT_END, true);
    _time_stepper->rejectStep();
    _time = _time_old;
  }
}

Referenced by TransientBase::execute(), TransientMultiApp::incrementTStep(), and TransientMultiApp::solveStep().

◆ init()

void MFEMTransient::init ( )

overridevirtual

Initialize the executioner.

Reimplemented from TransientBase.

Definition at line 46 of file MFEMTransient.C.

{
  TransientBase::init();
 
  // verify that the requested time integration scheme is actually supported by MFEM transient
  if (getTimeScheme() != Moose::TimeIntegratorType::TI_IMPLICIT_EULER)
    paramError("scheme",
               "Time Integration scheme \"" + stringify(getTimeScheme()) +
                   "\" is not supported by MFEMTransient Executioner.");
 
  if (_mfem_problem_data.nonlinear_solver)
    _mfem_problem_data.eqn_system->SetGradientRequired(
        _mfem_problem_data.nonlinear_solver->RequiresGradient());
 
  _mfem_problem_data.eqn_system->SetCoefficientManager(_mfem_problem_data.coefficients);
 
  // Set up initial conditions
  _mfem_problem_data.eqn_system->Init(
      _mfem_problem_data.gridfunctions,
      _mfem_problem_data.cmplx_gridfunctions,
      getParam<MooseEnum>("assembly_level").getEnum<mfem::AssemblyLevel>());
 
  for (const auto & problem_operator : getProblemOperators())
  {
    problem_operator->SetGridFunctions();
    problem_operator->Init(_mfem_problem_data.true_solution);
  }
}

◆ isDefaultPostprocessorValue()

bool PostprocessorInterface::isDefaultPostprocessorValue	(	const std::string &	param_name,
		const unsigned int	index = `0`
	)		const

inherited

Determine whether or not the Postprocessor is a default value.

A default value is when the value is either the value set by addParam, or is a user-set value in input instead of a name to a postprocessor.

Parameters

param_name	The name of the Postprocessor parameter
index	The index of the postprocessor

Returns: True if the Postprocessor is a default value, false if the Postprocessor is the name of a Postprocessor

Definition at line 85 of file PostprocessorInterface.C.

{
  return isDefaultPostprocessorValueByName(getPostprocessorNameInternal(param_name, index));
}

Referenced by EigenKernel::EigenKernel().

◆ isDefaultPostprocessorValueByName()

bool PostprocessorInterface::isDefaultPostprocessorValueByName ( const PostprocessorName & name ) const

privateinherited

Returns: True if the PostprocessorName name repesents a default value: the name converts to a value (set by addParam or set via input), and a Postprocessor does not exist with the same name (we do allow Postprocessors with numbered names...)

Definition at line 92 of file PostprocessorInterface.C.

{
  // We do allow actual Postprocessor objects to have names that will succeed in being
  // represented as a double... so if the name does actually exist as a PP, it's not a default
  if (_ppi_feproblem.getReporterData().hasReporterValue<PostprocessorValue>(
          PostprocessorReporterName(name)))
    return false;
 
  std::istringstream ss(name);
  Real real_value = -std::numeric_limits<Real>::max();
  return (ss >> real_value && ss.eof());
}

Referenced by PostprocessorInterface::getDefaultPostprocessorValueByName(), PostprocessorInterface::getPostprocessorNameInternal(), PostprocessorInterface::getPostprocessorValueByNameInternal(), PostprocessorInterface::getPostprocessorValueInternal(), and PostprocessorInterface::isDefaultPostprocessorValue().

◆ isKokkosObject()

bool MooseObject::isKokkosObject ( ) const

inlineinherited

Get whether this object is a Kokkos functor The parameter MooseBase::kokkos_object_param is set by the Kokkos base classes.

Definition at line 63 of file MooseObject.h.

63{ return parameters().isKokkosObject(); }

InputParameters::isKokkosObject

bool isKokkosObject() const

Returns whether this InputParameters belongs to a Kokkos object Checks whether MooseBase::kokkos_obje...

Definition InputParameters.C:433

Referenced by AttribKokkos::initFrom(), BlockRestrictable::initializeBlockRestrictable(), and BoundaryRestrictable::initializeBoundaryRestrictable().

◆ isParamSetByUser()

bool MooseBase::isParamSetByUser ( const std::string & name ) const

inlineinherited

Test if the supplied parameter is set by a user, as opposed to not set or set to default.

Parameters

name	The name of the parameter to test

Definition at line 205 of file MooseBase.h.

  {
    return _pars.isParamSetByUser(name);
  }

Referenced by DiffusionCG::addFEBCs(), DiffusionPhysicsBase::addInitialConditions(), CylinderComponent::addMeshGenerators(), AdvancedExtruderGenerator::AdvancedExtruderGenerator(), MFEMMesh::buildMesh(), MFEMBoundarySubMesh::buildSubMesh(), MFEMDomainSubMesh::buildSubMesh(), LibtorchNeuralNetControl::conditionalParameterError(), ConservativeAdvectionBCTempl< is_ad >::ConservativeAdvectionBCTempl(), MooseApp::copyInputs(), DiffusionPhysicsBase::DiffusionPhysicsBase(), MooseApp::errorCheck(), FileMesh::FileMesh(), FullSolveMultiApp::FullSolveMultiApp(), OrientSurfaceMeshGenerator::generate(), SurfaceSubdomainsFromAllNormalsGenerator::generate(), MFEMVectorFESpace::getFECName(), MooseBase::getRenamedParam(), DefaultConvergenceBase::getSharedExecutionerParam(), AddVariableAction::init(), MFEMMesh::init(), PhysicsBase::initializePhysics(), ElementSubdomainModifierBase::initialSetup(), MatrixSymmetryCheck::MatrixSymmetryCheck(), MeshDiagnosticsGenerator::MeshDiagnosticsGenerator(), MFEMVariable::MFEMVariable(), MortarConstraintBase::MortarConstraintBase(), MultiAppGeneralFieldFunctorTransfer::MultiAppGeneralFieldFunctorTransfer(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), OrientSurfaceMeshGenerator::OrientSurfaceMeshGenerator(), SolutionInvalidityOutput::output(), Output::Output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), PetscExternalPartitioner::partition(), PolyLineMeshFollowingNodeSetGenerator::PolyLineMeshFollowingNodeSetGenerator(), MooseMesh::prepare(), SolutionUserObjectBase::readXda(), ReferenceResidualConvergence::ReferenceResidualConvergence(), PhysicsBase::reportPotentiallyMissedParameters(), MooseApp::run(), MooseApp::runInputFile(), MooseApp::runInputs(), Moose::MFEM::LinearSolverBase::SetPreconditioner(), SetupMeshAction::setupMesh(), MooseApp::setupOptions(), SideSetsFromBoundingBoxGenerator::SideSetsFromBoundingBoxGenerator(), SmoothMeshGenerator::SmoothMeshGenerator(), SurfaceSubdomainsDelaunayRemesher::SurfaceSubdomainsDelaunayRemesher(), SurfaceSubdomainsFromAllNormalsGenerator::SurfaceSubdomainsFromAllNormalsGenerator(), TagVectorAux::TagVectorAux(), TimedSubdomainModifier::TimedSubdomainModifier(), TimeIntegratedPostprocessor::TimeIntegratedPostprocessor(), XYDelaunayGenerator::XYDelaunayGenerator(), and XYZDelaunayGenerator::XYZDelaunayGenerator().

◆ isParamValid()

bool MooseBase::isParamValid ( const std::string & name ) const

inlineinherited

Test if the supplied parameter is valid.

Parameters

name	The name of the parameter to test

Definition at line 199 of file MooseBase.h.

199{ return _pars.isParamValid(name); }

◆ iterationMethods()

static MooseEnum Executioner::iterationMethods ( )

inlinestaticinherited

Return supported iteration methods that can work with MultiApps on timestep_begin and timestep_end.

Definition at line 136 of file Executioner.h.

136{ return MooseEnum("picard secant steffensen", "picard"); }

MooseEnum

This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...

Definition MooseEnum.h:55

Referenced by Executioner::validParams().

◆ keepGoing()

bool TransientBase::keepGoing ( )

virtualinherited

Transient loop will continue as long as this keeps returning true.

Definition at line 656 of file TransientBase.C.

{
  bool keep_going = !_problem.isSolveTerminationRequested();
 
  // Check for stop condition based upon steady-state check flag:
  if (lastSolveConverged())
  {
    if (!_xfem_repeat_step)
    {
      if (_steady_state_detection == true && _time > _steady_state_start_time)
      {
        // Check solution difference relative norm against steady-state tolerance
        if (convergedToSteadyState())
        {
          _console << "Steady-State Solution Achieved at time: " << _time << std::endl;
          // Output last solve if not output previously by forcing it
          keep_going = false;
        }
      }
 
      // Check for stop condition based upon number of simulation steps and/or solution end time:
      if (static_cast<unsigned int>(_t_step) >= _num_steps)
        keep_going = false;
 
      if ((_time >= _end_time) || (fabs(_time - _end_time) <= _timestep_tolerance))
        keep_going = false;
    }
  }
  else if (_abort)
  {
    _console << "Aborting as solve did not converge and input selected to abort" << std::endl;
    keep_going = false;
  }
  else if (!_error_on_dtmin && _dt <= _dtmin)
  {
    _console << "Aborting as timestep already at or below dtmin" << std::endl;
    keep_going = false;
  }
 
  return keep_going;
}

Referenced by TransientBase::execute().

◆ lastSolveConverged()

bool TransientBase::lastSolveConverged ( ) const

overridevirtualinherited

Whether or not the last solve converged.

Implements Executioner.

Definition at line 704 of file TransientBase.C.

{
  return _last_solve_converged;
}

Referenced by TransientBase::endStep(), TransientBase::execute(), TransientBase::incrementStepOrReject(), SamplerBase::initialize(), TransientBase::keepGoing(), TransientMultiApp::solveStep(), TransientBase::takeStep(), and takeStep().

◆ messagePrefix() [1/2]

std::string MooseBase::messagePrefix ( const bool hit_prefix = true ) const

inlineinherited

Returns: A prefix to be used in messages that contain the input file location associated with this object (if any) and the name and type of the object.

Definition at line 256 of file MooseBase.h.

  {
    return messagePrefix(_pars, hit_prefix);
  }

Referenced by MooseBase::callMooseError(), MooseBase::errorPrefix(), MooseBase::messagePrefix(), MooseBase::mooseDeprecated(), MooseBase::mooseDeprecatedNoTrace(), MooseBase::mooseInfo(), and MooseBase::mooseWarning().

◆ messagePrefix() [2/2]

std::string MooseBase::messagePrefix	(	const InputParameters &	params,
		const bool	hit_prefix
	)

staticprivateinherited

Internal method for getting the message prefix for an object (object type, name, etc).

Needs to be static so that we can call it externally from InputParameters for errors that do not have context of the MooseBase

Definition at line 140 of file MooseBase.C.

{
  std::string prefix = "";
 
  if (hit_prefix)
    if (const auto node = MooseBase::getHitNode(params))
      prefix += Moose::hitMessagePrefix(*node);
 
  // Don't have context without type and name
  if (!params.isMooseBaseObject())
    return prefix;
 
  const auto & name = params.getObjectName();
  const std::string base = params.hasBase() ? params.getBase() : "object";
  const bool is_main_app = base == "Application" && name == AppFactory::main_app_name;
  prefix += "The following occurred in the ";
  if (is_main_app)
    prefix += "main " + base;
  else
    prefix += base;
  if (base != params.getObjectName() && name.size() && !is_main_app)
    prefix += " '" + name + "'";
  prefix += " of type " + params.getObjectType() + ".";
  return prefix + "\n\n";
}

◆ mooseDeprecated() [1/2]

template<typename... Args>

void MooseBase::mooseDeprecated ( Args &&... args ) const

inlineinherited

Emits a deprecation warning prefixed with the object name and type, and a stack trace.

Definition at line 317 of file MooseBase.h.

  {
    moose::internal::mooseDeprecatedStream(
        _console, false, true, true, messagePrefix(true), std::forward<Args>(args)...);
  }

Referenced by MooseApp::addCapability(), DataFileInterface::getDataFileName(), DataFileInterface::getDataFileNameByName(), MooseApp::getRecoverFileBase(), MooseApp::hasRecoverFileBase(), and MooseApp::setupOptions().

◆ mooseDeprecated() [2/2]

template<typename... Args>

void SolutionInvalidInterface::mooseDeprecated ( Args &&... args ) const

inlineinherited

Definition at line 87 of file SolutionInvalidInterface.h.

  {
    _si_moose_base.MooseBase::mooseDeprecated(std::forward<Args>(args)...);
    flagSolutionWarningMultipleRegistration(_si_moose_base.name() + ": deprecation");
  }

Referenced by MultiApp::appProblem(), AddVariableAction::determineType(), MooseMesh::elem(), MooseMesh::elem(), FunctionDT::FunctionDT(), MooseMesh::getBoundariesToElems(), Control::getExecuteOptions(), MooseMesh::isTranslatedPeriodic(), MooseMesh::minPeriodicDistance(), MooseMesh::minPeriodicVector(), MooseMesh::node(), MooseMesh::node(), FixedPointSolve::numPicardIts(), RelationshipManager::operator>=(), and MooseMesh::setBoundaryToNormalMap().

◆ mooseDeprecatedNoTrace()

template<typename... Args>

void MooseBase::mooseDeprecatedNoTrace ( Args &&... args ) const

inlineinherited

Emits a deprecation warning prefixed with the object name and type, and no stack trace.

Definition at line 327 of file MooseBase.h.

  {
    moose::internal::mooseDeprecatedStream(
        _console, false, true, false, messagePrefix(true), std::forward<Args>(args)...);
  }

◆ mooseDocumentedError()

template<typename... Args>

void MooseBase::mooseDocumentedError	(	const std::string &	repo_name,
		const unsigned int	issue_num,
		Args &&...	args
	)		const

inlineinherited

Definition at line 277 of file MooseBase.h.

  {
    callMooseError(moose::internal::formatMooseDocumentedError(
                       repo_name, issue_num, argumentsToString(std::forward<Args>(args)...)),
                   /* with_prefix = */ true);
  }

Referenced by ManifoldSubdomainGenerator::ManifoldSubdomainGenerator().

◆ mooseError()

template<typename... Args>

void MooseBase::mooseError ( Args &&... args ) const

inlineinherited

Emits an error prefixed with object name and type and optionally a file path to the top-level block parameter if available.

Definition at line 271 of file MooseBase.h.

  {
    callMooseError(argumentsToString(std::forward<Args>(args)...), /* with_prefix = */ true);
  }

◆ mooseErrorNonPrefixed()

template<typename... Args>

void MooseBase::mooseErrorNonPrefixed ( Args &&... args ) const

inlineinherited

Emits an error without the prefixing included in mooseError().

Definition at line 290 of file MooseBase.h.

  {
    callMooseError(argumentsToString(std::forward<Args>(args)...), /* with_prefix = */ false);
  }

◆ mooseInfo()

template<typename... Args>

void MooseBase::mooseInfo ( Args &&... args ) const

inlineinherited

Definition at line 334 of file MooseBase.h.

  {
    moose::internal::mooseInfoStream(_console, messagePrefix(true), std::forward<Args>(args)...);
  }

Referenced by SetupRecoverFileBaseAction::act(), AStableDirk4::AStableDirk4(), MeshDiagnosticsGenerator::checkNonConformalMeshFromAdaptivity(), PIDTransientControl::execute(), Executioner::Executioner(), Executioner::Executioner(), ExplicitRK2::ExplicitRK2(), ExplicitTVDRK2::ExplicitTVDRK2(), FixedPointSolve::findTransformedSystem(), ManifoldSubdomainGenerator::generate(), PolyLineMeshFollowingNodeSetGenerator::generate(), DataFileInterface::getDataFilePath(), ImplicitMidpoint::ImplicitMidpoint(), LStableDirk2::LStableDirk2(), LStableDirk3::LStableDirk3(), LStableDirk4::LStableDirk4(), MultiAppTransfer::mapBackWithoutCollapsing(), SolutionInvalidityOutput::output(), MooseBase::paramInfo(), MooseApp::setupOptions(), SymmetryTransformGenerator::SymmetryTransformGenerator(), TransientBase::takeStep(), and TransientBase::TransientBase().

◆ mooseObjectError()

void UserObjectInterface::mooseObjectError	(	const std::string &	param_name,
		std::stringstream &	oss
	)		const

privateinherited

emit an error for the given parameter

Definition at line 155 of file UserObjectInterface.C.

{
  if (_uoi_moose_object.parameters().isParamValid(param_name))
    _uoi_moose_object.paramError(param_name, oss.str());
  else
    _uoi_moose_object.mooseError(oss.str());
}

Referenced by UserObjectInterface::castUserObject().

◆ mooseWarning() [1/2]

template<typename... Args>

void MooseBase::mooseWarning ( Args &&... args ) const

inlineinherited

Emits a warning prefixed with object name and type.

Definition at line 299 of file MooseBase.h.

  {
    moose::internal::mooseWarningStream(_console, messagePrefix(true), std::forward<Args>(args)...);
  }

Referenced by DiracKernelInfo::findPoint(), DataFileInterface::getDataFilePath(), MooseApp::loadLibraryAndDependencies(), and MooseBase::paramWarning().

◆ mooseWarning() [2/2]

template<typename... Args>

void SolutionInvalidInterface::mooseWarning ( Args &&... args ) const

inlineinherited

Definition at line 73 of file SolutionInvalidInterface.h.

  {
    _si_moose_base.MooseBase::mooseWarning(std::forward<Args>(args)...);
    flagSolutionWarningMultipleRegistration(_si_moose_base.name() + ": warning");
  }

Referenced by CopyMeshPartitioner::_do_partition(), AddFunctionAction::act(), AddKernelAction::act(), CommonOutputAction::act(), MaterialOutputAction::act(), MeshOnlyAction::act(), MooseMesh::addPeriodicVariable(), BoundaryMarker::BoundaryMarker(), DistributedRectilinearMeshGenerator::buildCube(), CartesianMeshGenerator::CartesianMeshGenerator(), CheckOutputAction::checkConsoleOutput(), MultiAppTransfer::checkMultiAppExecuteOn(), MeshDiagnosticsGenerator::checkNonMatchingEdges(), MeshDiagnosticsGenerator::checkPolygons(), ActionComponent::checkRequiredTasks(), PhysicsBase::checkRequiredTasks(), MultiApp::createApp(), MeshDiagnosticsGenerator::diagnosticsLog(), CartesianGridDivision::divisionIndex(), CylindricalGridDivision::divisionIndex(), SphericalGridDivision::divisionIndex(), Postprocessor::evaluateDotWarning(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), FixedPointSolve::FixedPointSolve(), BSplineCurveGenerator::generate(), RenumberBySubdomainGenerator::generate(), SubdomainPerElementGenerator::generate(), SurfaceMeshGeneratorBase::get2DElemNormal(), MultiAppTransfer::getAppInfo(), FunctorBinnedValuesDivision::getBinIndex(), IndicatorMarker::IndicatorMarker(), CartesianGridDivision::initialize(), CylindricalGridDivision::initialize(), SphericalGridDivision::initialize(), MFEMRefinementMarker::initialSetup(), MaterialBase::initStatefulProperties(), IterationAdaptiveDT::limitDTToPostprocessorValue(), NewmarkBeta::NewmarkBeta(), Output::Output(), MaterialOutputAction::outputHelper(), Executioner::problem(), TestSourceStepper::rejectStep(), PhysicsBase::reportPotentiallyMissedParameters(), MaterialBase::resetQpProperties(), MooseMesh::setCoordSystem(), TransientMultiApp::solveStep(), MeshRepairGenerator::splitNonConvexPolygons(), and VariableCondensationPreconditioner::VariableCondensationPreconditioner().

◆ mooseWarningNonPrefixed() [1/2]

template<typename... Args>

void MooseBase::mooseWarningNonPrefixed ( Args &&... args ) const

inlineinherited

Emits a warning without the prefixing included in mooseWarning().

Definition at line 308 of file MooseBase.h.

  {
    moose::internal::mooseWarningStream(_console, std::forward<Args>(args)...);
  }

◆ mooseWarningNonPrefixed() [2/2]

template<typename... Args>

void SolutionInvalidInterface::mooseWarningNonPrefixed ( Args &&... args ) const

inlineinherited

Definition at line 80 of file SolutionInvalidInterface.h.

  {
    _si_moose_base.MooseBase::mooseWarningNonPrefixed(std::forward<Args>(args)...);
    flagSolutionWarningMultipleRegistration(_si_moose_base.name() + ": warning");
  }

◆ name()

const std::string & MooseBase::name ( ) const

inlineinherited

Get the name of the class.

Returns: The name of the class

Definition at line 103 of file MooseBase.h.

  {
    mooseAssert(_name.size(), "Empty name");
    return _name;
  }

◆ paramError()

template<typename... Args>

void MooseBase::paramError	(	const std::string &	param,
		Args...	args
	)		const

inherited

Emits an error prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseError - only printing a message using the given args.

Definition at line 457 of file MooseBase.h.

{
  _pars.paramError(param, std::forward<Args>(args)...);
}

◆ parameters()

const InputParameters & MooseBase::parameters ( ) const

inlineinherited

Get the parameters of the object.

Returns: The parameters of the object

Definition at line 131 of file MooseBase.h.

131{ return _pars; }

◆ paramInfo()

template<typename... Args>

void MooseBase::paramInfo	(	const std::string &	param,
		Args...	args
	)		const

inherited

Emits an informational message prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseInfo - only printing a message using the given args.

Definition at line 471 of file MooseBase.h.

{
  mooseInfo(_pars.paramMessage(param, std::forward<Args>(args)...));
}

Referenced by GridPartitioner::_do_partition(), ComboMarker::ComboMarker(), Control::Control(), FunctorIC::FunctorIC(), and TransientMultiApp::TransientMultiApp().

◆ paramWarning() [1/2]

template<typename... Args>

void MooseBase::paramWarning	(	const std::string &	param,
		Args...	args
	)		const

inherited

Emits a warning prefixed with the file and line number of the given param (from the input file) along with the full parameter path+name followed by the given args as the message.

If this object's parameters were not created directly by the Parser, then this function falls back to the normal behavior of mooseWarning - only printing a message using the given args.

Definition at line 464 of file MooseBase.h.

{
  mooseWarning(_pars.paramMessage(param, std::forward<Args>(args)...));
}

◆ paramWarning() [2/2]

template<typename... Args>

void SolutionInvalidInterface::paramWarning	(	const std::string &	param,
		Args...	args
	)		const

inlineinherited

Definition at line 94 of file SolutionInvalidInterface.h.

  {
    _si_moose_base.MooseBase::paramWarning(param, std::forward<Args>(args)...);
    flagSolutionWarningMultipleRegistration(_si_moose_base.name() + ": warning for parameter '" +
                                            param + "'");
  }

Referenced by GridPartitioner::_do_partition(), CartesianMeshGenerator::CartesianMeshGenerator(), MultiAppTransfer::checkParentAppUserObjectExecuteOn(), EigenProblem::checkProblemIntegrity(), MooseMeshUtils::copyIntoMesh(), DefaultMultiAppFixedPointConvergence::DefaultMultiAppFixedPointConvergence(), MultiAppNearestNodeTransfer::execute(), FEProblemSolve::FEProblemSolve(), PlaneIDMeshGenerator::generate(), SubdomainsFromPartitionerGenerator::generate(), UniqueExtraIDMeshGenerator::generate(), ReferenceResidualConvergence::initialSetup(), FullSolveMultiApp::initialSetup(), Terminator::initialSetup(), SampledOutput::initSample(), MooseMesh::MooseMesh(), PNGOutput::PNGOutput(), FEProblemBase::setPreserveMatrixSparsityPattern(), and Terminator::Terminator().

◆ parentOutputPositionChanged()

void TransientBase::parentOutputPositionChanged ( )

overridevirtualinherited

Can be used by subclasses to call parentOutputPositionChanged() on the underlying FEProblemBase.

Reimplemented from Executioner.

Definition at line 845 of file TransientBase.C.

{
  _fe_problem.parentOutputPositionChanged();
}

◆ perfGraph()

PerfGraph & PerfGraphInterface::perfGraph ( )

inherited

Get the PerfGraph.

Definition at line 86 of file PerfGraphInterface.C.

{
  return _pg_moose_app.perfGraph();
}

Referenced by CommonOutputAction::act(), PerfGraphData::finalize(), PerfGraphReporter::finalize(), and PerfGraphOutput::output().

◆ possiblyCheckHasReporter()

template<typename T >

void ReporterInterface::possiblyCheckHasReporter	(	const ReporterName &	reporter_name,
		const std::string &	param_name = `""`
	)		const

privateinherited

Helpers for "possibly" checking if a Reporter value exists.

This is only able to check for existance after all Reporters have been added (after the task creating them has been called). If called before said task, this will do nothing, hence the "possibly". This allows us to have errors reported directly by the object requesting the Reporter instead of through a system with less context.

Definition at line 211 of file ReporterInterface.h.

{
  if (reportersAdded() && !hasReporterValueByName<T>(reporter_name))
  {
    std::stringstream oss;
    oss << "A Reporter value with the name \"" << reporter_name << "\" and type \""
        << MooseUtils::prettyCppType<T>() << "\" was not found.";
 
    if (_ri_params.isParamValid(param_name))
      _ri_moose_object.paramError(param_name, oss.str());
    else
      _ri_moose_object.mooseError(oss.str());
  }
}

◆ postExecute()

void TransientBase::postExecute ( )

overridevirtualinherited

Override this for actions that should take place after execution.

Reimplemented from Executioner.

Definition at line 710 of file TransientBase.C.

{
  _time_stepper->postExecute();
}

Referenced by TransientBase::execute().

◆ postprocessorsAdded()

bool PostprocessorInterface::postprocessorsAdded ( ) const

privateinherited

Returns: True if all pps have been added (the task associated with adding them is complete)

Definition at line 274 of file PostprocessorInterface.C.

{
  return _ppi_feproblem.getMooseApp().actionWarehouse().isTaskComplete("add_postprocessor");
}

Referenced by PostprocessorInterface::getPostprocessorValueByNameInternal(), PostprocessorInterface::getPostprocessorValueInternal(), PostprocessorInterface::hasPostprocessor(), and PostprocessorInterface::hasPostprocessorByName().

◆ postSolve()

virtual void Executioner::postSolve ( )

inlinevirtualinherited

Override this for actions that should take place after execution, called by FixedPointSolve.

Definition at line 88 of file Executioner.h.

88{}

Referenced by FixedPointSolve::solveStep(), InversePowerMethod::takeStep(), and NonlinearEigen::takeStep().

◆ postStep()

void TransientBase::postStep ( )

virtualinherited

Definition at line 309 of file TransientBase.C.

{
  _time_stepper->postStep();
}

Referenced by TransientBase::execute(), TransientMultiApp::finishStep(), and TransientMultiApp::solveStep().

◆ preExecute()

void TransientBase::preExecute ( )

overridevirtualinherited

Override this for actions that should take place before execution.

Reimplemented from Executioner.

Definition at line 274 of file TransientBase.C.

{
  _time_stepper->preExecute();
 
  if (!_app.isRecovering())
  {
    _t_step = 0;
    _dt = 0;
    _next_interval_output_time = 0.0;
    if (!_app.isRestarting())
      _time = _time_old = _start_time;
 
    _problem.outputStep(EXEC_INITIAL);
 
    computeDT();
    _dt = getDT();
    if (_dt == 0)
      mooseError("Time stepper computed zero time step size on initial which is not allowed.\n"
                 "1. If you are using an existing time stepper, double check the values in your "
                 "input file or report an error.\n"
                 "2. If you are developing a new time stepper, make sure that initial time step "
                 "size in your code is computed correctly.");
    const auto & tis = getTimeIntegrators();
    for (auto & ti : tis)
      ti->init();
  }
}

Referenced by TransientBase::execute(), and TransientMultiApp::setupApp().

◆ preProblemInit()

virtual void Executioner::preProblemInit ( )

inlinevirtualinherited

Perform initializations during executing actions right before init_problem task.

Definition at line 57 of file Executioner.h.

57{}

Referenced by FEProblemBase::init().

◆ preSolve()

virtual void Executioner::preSolve ( )

inlinevirtualinherited

Override this for actions that should take place before execution, called by FixedPointSolve.

Definition at line 83 of file Executioner.h.

83{}

Referenced by FixedPointSolve::solveStep(), InversePowerMethod::takeStep(), and NonlinearEigen::takeStep().

◆ preStep()

void TransientBase::preStep ( )

virtualinherited

Definition at line 303 of file TransientBase.C.

{
  _time_stepper->preStep();
}

Referenced by TransientBase::execute(), and TransientMultiApp::solveStep().

◆ problem()

Problem & Executioner::problem ( )

virtualinherited

Deprecated: Return a reference to this Executioner's Problem instance.

Definition at line 113 of file Executioner.C.

{
  mooseDoOnce(mooseWarning("This method is deprecated, use feProblem() instead"));
  return _fe_problem;
}

◆ queryParam()

template<typename T >

const T * MooseBase::queryParam ( const std::string & name ) const

inherited

Query a parameter for the object.

If a parameter of the given name and type does not exist or if the parameter is not valid, nullptr will be returned

Parameters

name	The name of the parameter

Returns: A pointer to the parameter value, if it exists

Definition at line 413 of file MooseBase.h.

{
  return _pars.queryParam<T>(name);
}

Referenced by MFEMExecutedObject::getRequestedItems(), and MFEMGeometricMultigridSolver::MFEMGeometricMultigridSolver().

◆ registerInvalidSolutionInternal()

InvalidSolutionID SolutionInvalidInterface::registerInvalidSolutionInternal	(	const std::string &	message,
		const bool	warning
	)		const

protectedinherited

Definition at line 55 of file SolutionInvalidInterface.C.

{
  return moose::internal::getSolutionInvalidityRegistry().registerInvalidity(
      _si_moose_base.type(), message, warning);
}

◆ registerRestartableDataOnApp()

RestartableDataValue & Restartable::registerRestartableDataOnApp	(	std::unique_ptr< RestartableDataValue >	data,
		THREAD_ID	tid
	)		const

privateinherited

Helper function for actually registering the restartable data.

Definition at line 63 of file Restartable.C.

{
  return _restartable_app.registerRestartableData(
      std::move(data), tid, _restartable_read_only, _metaname);
}

Referenced by Restartable::declareRestartableDataHelper().

◆ registerRestartableNameWithFilterOnApp()

void Restartable::registerRestartableNameWithFilterOnApp	(	const std::string &	name,
		Moose::RESTARTABLE_FILTER	filter
	)

privateinherited

Helper function for actually registering the restartable data.

Definition at line 71 of file Restartable.C.

{
  _restartable_app.registerRestartableNameWithFilter(name, filter);
}

Referenced by Restartable::declareRecoverableData().

◆ registerSolveObject()

void Executioner::registerSolveObject ( const SolveObject & so )

inlineinherited

Register a solve object to the executioner so that we can check whether a solve object has been built by the executioner.

Definition at line 142 of file Executioner.h.

142{ _solve_objects.push_back(&so); }

Referenced by SolveObject::SolveObject().

◆ registerTimedSection() [1/2]

PerfID PerfGraphInterface::registerTimedSection	(	const std::string &	section_name,
		const unsigned int	level
	)		const

protectedinherited

Call to register a named section for timing.

Parameters

section_name	The name of the code section to be timed
level	The importance of the timer - lower is more important (0 will always come out)

Returns: The ID of the section - use when starting timing

Definition at line 61 of file PerfGraphInterface.C.

{
  const auto timed_section_name = timedSectionName(section_name);
  if (!moose::internal::getPerfGraphRegistry().sectionExists(timed_section_name))
    return moose::internal::getPerfGraphRegistry().registerSection(timed_section_name, level);
  else
    return moose::internal::getPerfGraphRegistry().sectionID(timed_section_name);
}

◆ registerTimedSection() [2/2]

PerfID PerfGraphInterface::registerTimedSection	(	const std::string &	section_name,
		const unsigned int	level,
		const std::string &	live_message,
		const bool	print_dots = `true`
	)		const

protectedinherited

Call to register a named section for timing.

Parameters

section_name	The name of the code section to be timed
level	The importance of the timer - lower is more important (0 will always come out)
live_message	The message to be printed to the screen during execution
print_dots	Whether or not progress dots should be printed for this section

Returns: The ID of the section - use when starting timing

Definition at line 72 of file PerfGraphInterface.C.

{
  const auto timed_section_name = timedSectionName(section_name);
  if (!moose::internal::getPerfGraphRegistry().sectionExists(timed_section_name))
    return moose::internal::getPerfGraphRegistry().registerSection(
        timedSectionName(section_name), level, live_message, print_dots);
  else
    return moose::internal::getPerfGraphRegistry().sectionID(timed_section_name);
}

◆ relativeSolutionDifferenceNorm()

virtual Real MFEMTransient::relativeSolutionDifferenceNorm ( bool ) const

inlineoverridevirtual

Not supported for MFEM problems, so error if called.

Implements TransientBase.

Definition at line 35 of file MFEMTransient.h.

  {
    mooseError("MFEMTransient executioner does not yet support evaluating the relative solution "
               "difference norm at each timestep.");
    return 0.0;
  }

◆ reportersAdded()

bool ReporterInterface::reportersAdded ( ) const

privateinherited

Returns: True if all Reporters have been added (the task associated with adding them is complete)

Definition at line 92 of file ReporterInterface.C.

{
  return _ri_fe_problem_base.getMooseApp().actionWarehouse().isTaskComplete("add_reporter");
}

Referenced by ReporterInterface::getReporterContextBaseByName(), ReporterInterface::hasReporterValue(), ReporterInterface::hasReporterValueByName(), and ReporterInterface::possiblyCheckHasReporter().

◆ restartableName()

std::string Restartable::restartableName ( const std::string & data_name ) const

protectedinherited

Gets the name of a piece of restartable data given a data name, adding the system name and object name prefix.

This should only be used in this interface and in testing.

Definition at line 78 of file Restartable.C.

{
  return _restartable_system_name + "/" + _restartable_name + "/" + data_name;
}

Referenced by Restartable::declareRecoverableData(), and Restartable::declareRestartableDataHelper().

◆ setTargetTime()

void TransientBase::setTargetTime ( Real target_time )

virtualinherited

Can be used to set the next "target time" which is a time to nail perfectly.

Useful for driving MultiApps.

Definition at line 716 of file TransientBase.C.

{
  _target_time = target_time;
}

Referenced by TransientMultiApp::solveStep().

◆ setTime()

virtual void TransientBase::setTime ( Real t )

inlinevirtualinherited

Set the current time.

Definition at line 102 of file TransientBase.h.

102{ _time = t; };

◆ setTimeOld()

virtual void TransientBase::setTimeOld ( Real t )

inlinevirtualinherited

Set the old time.

Definition at line 107 of file TransientBase.h.

107{ _time_old = t; };

◆ setTimeStepper()

void TransientBase::setTimeStepper ( TimeStepper & ts )

inherited

Set the timestepper to use.

Parameters

ts	The TimeStepper to use

Definition at line 823 of file TransientBase.C.

{
  mooseAssert(!_time_stepper, "Already set");
  _time_stepper = &ts;
}

◆ setTimestepTolerance()

virtual void TransientBase::setTimestepTolerance ( const Real & tolerance )

inlinevirtualinherited

Set the timestep tolerance.

Parameters

tolerance timestep tolerance

Definition at line 209 of file TransientBase.h.

209{ _timestep_tolerance = tolerance; }

◆ setupTimeIntegrator()

void TransientBase::setupTimeIntegrator ( )

protectedinherited

Definition at line 728 of file TransientBase.C.

{
  if (_pars.isParamSetByUser("scheme") && _problem.hasTimeIntegrator())
    mooseError("You cannot specify time_scheme in the Executioner and independently add a "
               "TimeIntegrator to the system at the same time");
 
  if (!_problem.hasTimeIntegrator())
  {
    // backwards compatibility
    std::string ti_str;
    using namespace Moose;
 
    switch (_time_scheme)
    {
      case TI_IMPLICIT_EULER:
        ti_str = "ImplicitEuler";
        break;
      case TI_EXPLICIT_EULER:
        ti_str = "ExplicitEuler";
        break;
      case TI_CRANK_NICOLSON:
        ti_str = "CrankNicolson";
        break;
      case TI_BDF2:
        ti_str = "BDF2";
        break;
      case TI_EXPLICIT_MIDPOINT:
        ti_str = "ExplicitMidpoint";
        break;
      case TI_LSTABLE_DIRK2:
        ti_str = "LStableDirk2";
        break;
      case TI_EXPLICIT_TVD_RK_2:
        ti_str = "ExplicitTVDRK2";
        break;
      case TI_NEWMARK_BETA:
        ti_str = "NewmarkBeta";
        break;
      default:
        mooseError("Unknown scheme: ", _time_scheme);
        break;
    }
 
    InputParameters params = _app.getFactory().getValidParams(ti_str);
    _problem.addTimeIntegrator(ti_str, ti_str, params);
  }
}

Referenced by TransientBase::TransientBase().

◆ shouldStore()

virtual bool Reporter::shouldStore ( ) const

inlinevirtualinherited

Returns: Whether or not this Reporter should store its value at this specific time.

Basic Reporters (those that are not GeneralReporters) will store at all times when requested.

Reimplemented in ElementReporter, GeneralReporter, and NodalReporter.

Definition at line 69 of file Reporter.h.

69{ return true; }

◆ store()

void Reporter::store ( nlohmann::json & json ) const

virtualinherited

Definition at line 55 of file Reporter.C.

{
  json["type"] = _reporter_moose_object.type();
}

◆ syncTimes()

std::set< Real > & TransientBase::syncTimes ( )

inlineinherited

Get the set of sync times.

Returns: The reference to the set of sync times

Definition at line 167 of file TransientBase.h.

167{ return _sync_times; }

TransientBase::_sync_times

std::set< Real > & _sync_times

Definition TransientBase.h:278

◆ takeStep()

void MFEMTransient::takeStep ( Real input_dt = -1.0 )

overridevirtual

Do whatever is necessary to advance one step.

Reimplemented from TransientBase.

Definition at line 76 of file MFEMTransient.C.

{
  _dt_old = _dt;
 
  if (input_dt == -1.0)
    _dt = computeConstrainedDT();
  else
    _dt = input_dt;
 
  _time_stepper->preSolve();
 
  // Unfortunately, time needs to be temporarily incremented so we get
  // meaningful console output in timestepSetup(). We decrement it back
  // immediately after so step() below behaves as expected.
  _time += _dt;
  _problem.timestepSetup();
  _time -= _dt;
 
  _problem.onTimestepBegin();
  _problem.execTransfers(EXEC_TIMESTEP_BEGIN);
  if (!_problem.execMultiApps(EXEC_TIMESTEP_BEGIN, true))
  {
    _last_solve_converged = false;
    return;
  }
  _problem.execute(EXEC_TIMESTEP_BEGIN);
 
  // Advance time step of the MFEM problem. Time is also updated here, and
  // _problem_operator->SetTime is called inside the ode_solver->Step method to
  // update the time used by time dependent (function) coefficients.
  _time_stepper->step();
 
  // Continue with usual TransientBase::takeStep() finalisation
  _last_solve_converged = _time_stepper->converged();
 
  if (!lastSolveConverged())
  {
    _console << "Aborting as solve did not converge" << std::endl;
    return;
  }
 
  _problem.execute(EXEC_TIMESTEP_END);
  _problem.execTransfers(EXEC_TIMESTEP_END);
  _problem.execMultiApps(EXEC_TIMESTEP_END, true);
 
  if (lastSolveConverged())
    _time_stepper->acceptStep();
  else
    _time_stepper->rejectStep();
 
  // Set time to time old, since final time is updated in TransientBase::endStep()
  _time = _time_old;
 
  _time_stepper->postSolve();
}

◆ timedSectionName()

std::string PerfGraphInterface::timedSectionName ( const std::string & section_name ) const

protectedinherited

Returns: The name of the timed section with the name section_name.

Optionally adds a prefix if one is defined.

Definition at line 55 of file PerfGraphInterface.C.

{
  return _prefix.empty() ? "" : (_prefix + "::") + section_name;
}

Referenced by PerfGraphInterface::registerTimedSection(), and PerfGraphInterface::registerTimedSection().

◆ timeStepSolveObject()

virtual SolveObject * MFEMTransient::timeStepSolveObject ( )

inlineoverridevirtual

Return the solve object wrapped by time stepper.

Reimplemented from TransientBase.

Definition at line 29 of file MFEMTransient.h.

29{ return &_mfem_problem_solve; }

◆ timestepTol()

Real & TransientBase::timestepTol ( )

inlineinherited

Get the timestep tolerance.

Returns: The timestep tolerance

Definition at line 203 of file TransientBase.h.

203{ return _timestep_tolerance; }

Referenced by TransientMultiApp::solveStep().

◆ type()

const std::string & MooseBase::type ( ) const

inlineinherited

Get the type of this class.

Returns: the name of the type of this class

Definition at line 93 of file MooseBase.h.

  {
    mooseAssert(_type.size(), "Empty type");
    return _type;
  }

◆ typeAndName()

std::string MooseBase::typeAndName ( ) const

inherited

Get the class's combined type and name; useful in error handling.

Returns: The type and name of this class in the form '<type()> "<name()>"'.

Definition at line 57 of file MooseBase.C.

{
  return type() + std::string(" \"") + name() + std::string("\"");
}

Referenced by MaterialPropertyStorage::addProperty(), FEProblemBase::checkUserObjectNameCollision(), MeshGeneratorSystem::dataDrivenError(), ReporterContext< T >::finalize(), ReporterData::getReporterInfo(), MFEMSamplerBase::initialSetup(), MFEMVariableSamplerBase::initialSetup(), WebServerControl::outputMessage(), and Action::timedAct().

◆ unconstrainedDT()

Real TransientBase::unconstrainedDT ( )

inlineinherited

Get the unconstrained dt.

Returns: Value of dt before constraints were applied

Definition at line 221 of file TransientBase.h.

221{ return _unconstrained_dt; }

Referenced by IterationAdaptiveDT::acceptStep(), and IterationAdaptiveDT::computeDT().

◆ uniqueName()

MooseObjectName MooseBase::uniqueName ( ) const

inherited

Returns: The unique name for accessing input parameters of this object in the InputParameterWarehouse

Definition at line 69 of file MooseBase.C.

{
  if (!_pars.have_parameter<std::string>(unique_name_param))
    mooseError("uniqueName(): Object does not have a unique name");
  return MooseObjectName(_pars.get<std::string>(unique_name_param));
}

Referenced by MooseBase::connectControllableParams(), and Action::uniqueActionName().

◆ uniqueParameterName()

MooseObjectParameterName MooseBase::uniqueParameterName ( const std::string & parameter_name ) const

inherited

Returns: The unique parameter name of a valid parameter of this object for accessing parameter controls

Definition at line 63 of file MooseBase.C.

{
  return MooseObjectParameterName(getBase(), name(), parameter_name);
}

◆ userObjectName()

const std::string & UserObjectInterface::userObjectName ( const UserObjectBase & uo ) const

privateinherited

Gets a UserObject's name; avoids including UserObject.h in the UserObjectInterface.

Definition at line 149 of file UserObjectInterface.C.

{
  return uo.name();
}

Referenced by UserObjectInterface::castUserObject().

◆ userObjectType()

const std::string & UserObjectInterface::userObjectType ( const UserObjectBase & uo ) const

privateinherited

Gets a UserObject's type; avoids including UserObject.h in the UserObjectInterface.

Definition at line 143 of file UserObjectInterface.C.

{
  return uo.type();
}

Referenced by UserObjectInterface::castUserObject().

◆ validParams()

InputParameters MFEMTransient::validParams ( )

static

Definition at line 20 of file MFEMTransient.C.

{
  InputParameters params = MFEMProblemSolve::validParams();
  params += TransientBase::validParams();
  params.addClassDescription("Executioner for transient MFEM problems.");
  return params;
}

◆ verbose()

const bool & Executioner::verbose ( ) const

inlineinherited

Get the verbose output flag.

Returns: The verbose output flag

Definition at line 130 of file Executioner.h.

130{ return _verbose; }

Member Data Documentation

◆ _abort

bool TransientBase::_abort

protectedinherited

Definition at line 280 of file TransientBase.h.

Referenced by TransientBase::keepGoing().

◆ _action_factory

ActionFactory& ParallelParamObject::_action_factory

protectedinherited

Builds Actions.

Definition at line 40 of file ParallelParamObject.h.

Referenced by AddActionComponentAction::act(), CreateMeshSetupActionsForComponents::act(), ActionComponent::checkRequiredTasks(), PhysicsBase::checkRequiredTasks(), CommonOutputAction::create(), AddVariableAction::createInitialConditionAction(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), CreateExecutionerAction::setupAutoPreconditioning(), and ReadExecutorParamsAction::setupAutoPreconditioning().

◆ _app

MooseApp& MooseBase::_app

protectedinherited

The MOOSE application this is associated with.

Definition at line 375 of file MooseBase.h.

Referenced by AB2PredictorCorrector::AB2PredictorCorrector(), FEProblemBase::acceptInvalidSolution(), FEProblemBase::addAnyRedistributers(), MeshGenerator::addChildMeshGenerator(), FEProblemBase::addMaterialHelper(), MeshGenerator::addMeshSubgenerator(), MeshGenerator::addMeshSubgenerator(), FEProblemBase::addOutput(), MeshGenerator::addParentMeshGenerator(), FEProblemBase::allowOutput(), AStableDirk4::AStableDirk4(), FileMesh::buildMesh(), MooseMesh::buildTypedMesh(), MooseMesh::cacheFaceInfoVariableOwnership(), MooseMesh::cacheFVElementalDoFs(), DefaultNonlinearConvergence::checkConvergence(), MeshGenerator::checkGetMesh(), FEProblemBase::checkICRestartError(), FEProblemBase::checkProblemIntegrity(), LibmeshPartitioner::clone(), BlockWeightedPartitioner::clone(), CopyMeshPartitioner::clone(), GridPartitioner::clone(), HierarchicalGridPartitioner::clone(), PetscExternalPartitioner::clone(), RandomPartitioner::clone(), SingleRankPartitioner::clone(), ElementPointNeighborLayers::clone(), ElementSideNeighborLayers::clone(), GhostAllPointNeighbors::clone(), GhostBoundary::clone(), GhostEverything::clone(), GhostHigherDLowerDPointNeighbors::clone(), GhostLowerDElems::clone(), GhostPrimaryFace::clone(), ProxyRelationshipManager::clone(), RedistributeProperties::clone(), SampledOutput::cloneMesh(), FEProblemBase::computeJacobianSys(), FEProblemBase::computeJacobianTags(), FEProblemBase::computeLinearSystemTags(), FEProblemBase::computeResidualAndJacobian(), FEProblemBase::computeResidualSys(), FEProblemBase::computeResidualTags(), Console::Console(), TimeStepper::constrainStep(), Control::Control(), CopyMeshPartitioner::CopyMeshPartitioner(), MultiApp::createApp(), MultiApp::createApps(), FEProblemBase::customSetup(), MeshGenerator::declareMeshProperty(), MeshGenerator::declareNullMeshName(), MooseMesh::determineUseDistributedMesh(), DumpObjectsProblem::dumpObjectHelper(), DumpObjectsProblem::DumpObjectsProblem(), DumpObjectsProblem::dumpVariableHelper(), EigenExecutionerBase::EigenExecutionerBase(), EigenKernel::EigenKernel(), PIDTransientControl::execute(), Eigenvalue::execute(), InversePowerMethod::execute(), NonlinearEigen::execute(), SteadyBase::execute(), TransientBase::execute(), MFEMSteady::execute(), PseudoTimestep::execute(), IterationInfo::execute(), EigenProblem::execute(), Executioner::Executioner(), Executioner::Executioner(), ExtraIDIntegralReporter::ExtraIDIntegralReporter(), FEProblemBase::FEProblemBase(), FileOutput::FileOutput(), NEML2Assembly::finalize(), ChangeOverFixedPointPostprocessor::finalize(), RadialAverage::finalize(), FixedPointSolve::FixedPointSolve(), FEProblemBase::forceOutput(), FullSolveMultiApp::FullSolveMultiApp(), FunctorSmootherTempl< T >::FunctorSmootherTempl(), FVAdvection::FVAdvection(), FileMeshGenerator::generate(), MeshGenerator::generateInternal(), MeshGenerator::generateInternalCSG(), MeshGenerator::getCSGBaseByName(), FEProblemBase::getExecutor(), MeshGenerator::getMeshByName(), NumFixedPointIterations::getValue(), NumRelationshipManagers::getValue(), GhostingUserObject::GhostingUserObject(), MooseMesh::init(), Eigenvalue::init(), InversePowerMethod::init(), NonlinearEigen::init(), TransientBase::init(), MFEMMesh::init(), FEProblemBase::init(), CompositionDT::init(), SubProblem::initialSetup(), PIDTransientControl::initialSetup(), RealFunctionControl::initialSetup(), TimePeriod::initialSetup(), EigenProblemSolve::initialSetup(), FEProblemSolve::initialSetup(), Console::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initOutputList(), FEProblemBase::initPetscOutputAndSomeSolverSettings(), EigenProblem::initPetscOutputAndSomeSolverSettings(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), FEProblemBase::meshChanged(), MeshGenerator::MeshGenerator(), MFEMProblemSolve::MFEMProblemSolve(), MooseMesh::MooseMesh(), MooseMesh::MooseMesh(), MooseObject::MooseObject(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), EigenExecutionerBase::normalizeSolution(), NumFailedTimeSteps::NumFailedTimeSteps(), Checkpoint::output(), Exodus::output(), Nemesis::output(), PerfGraphOutput::output(), Tecplot::output(), MortarNodalGeometryOutput::output(), ControlOutput::outputActiveObjects(), ControlOutput::outputChangedControls(), ControlOutput::outputControls(), Exodus::outputEmptyTimestep(), Console::outputInput(), Exodus::outputInput(), Exodus::outputNodalVariables(), JSONOutput::outputReporters(), Output::outputStep(), SampledOutput::outputStep(), FEProblemBase::outputStep(), Console::outputSystemInformation(), JSONOutput::outputSystemInformation(), OverlayMeshGenerator::OverlayMeshGenerator(), MultiApp::parentOutputPositionChanged(), TransientBase::preExecute(), FEProblemBase::projectSolution(), AnnularMesh::safeClone(), ConcentricCircleMesh::safeClone(), FileMesh::safeClone(), GeneratedMesh::safeClone(), ImageMesh::safeClone(), MeshGeneratorMesh::safeClone(), PatternedMesh::safeClone(), RinglebMesh::safeClone(), SpiralAnnularMesh::safeClone(), StitchedMesh::safeClone(), TiledMesh::safeClone(), MFEMMesh::safeClone(), MultiApp::setAppOutputFileBase(), FileOutput::setFileBaseInternal(), MeshGenerator::setMeshProperty(), MeshGenerator::setMeshPropertyHelper(), FEProblemBase::setRestartFile(), TransientMultiApp::setupApp(), TimeSequenceStepperBase::setupSequence(), TransientBase::setupTimeIntegrator(), Output::setWallTimeIntervalFromCommandLineParam(), SideSetExtruderGenerator::SideSetExtruderGenerator(), SolutionInvalidityReporter::SolutionInvalidityReporter(), FixedPointSolve::solve(), FEProblemBase::solve(), EigenProblem::solve(), FEProblemBase::solveLinearSystem(), PetscOutput::solveSetup(), FixedPointSolve::solveStep(), TransientMultiApp::solveStep(), FEProblemBase::subdomainSetup(), FEProblemBase::theWarehouse(), TimeExtremeValue::TimeExtremeValue(), TimeIntegratedPostprocessor::TimeIntegratedPostprocessor(), TimeIntervalTimes::TimeIntervalTimes(), TimePeriod::TimePeriod(), SubProblem::timestepSetup(), PIDTransientControl::timestepSetup(), FEProblemBase::timestepSetup(), TransientBase::TransientBase(), MooseMesh::update(), NEML2FEInterpolation::updateDofMap(), NEML2FEInterpolation::updateGradPhi(), NEML2FEInterpolation::updateInterpolations(), FEProblemBase::updateMortarMesh(), NEML2FEInterpolation::updatePhi(), Console::write(), and FEProblemBase::~FEProblemBase().

◆ _at_sync_point

bool& TransientBase::_at_sync_point

protectedinherited

Definition at line 258 of file TransientBase.h.

Referenced by TransientBase::atSyncPoint(), TransientBase::computeConstrainedDT(), and TransientBase::constrainDTFromMultiApp().

◆ _aux

AuxiliarySystem& TransientBase::_aux

protectedinherited

Reference to auxiliary system base for faster access.

Definition at line 242 of file TransientBase.h.

Referenced by Transient::relativeSolutionDifferenceNorm().

◆ _console

const ConsoleStream ConsoleStreamInterface::_console

inherited

An instance of helper class to write streams to the Console objects.

Definition at line 31 of file ConsoleStreamInterface.h.

◆ _default_values

std::map<PostprocessorName, std::unique_ptr<PostprocessorValue> > PostprocessorInterface::_default_values

mutableprivateinherited

Holds the default postprocessor values that are requested (key is PostprocessorName)

Definition at line 162 of file PostprocessorInterface.h.

Referenced by PostprocessorInterface::getPostprocessorValueInternal().

◆ _dt

Real& TransientBase::_dt

protectedinherited

Current delta t... or timestep size.

Definition at line 254 of file TransientBase.h.

Referenced by TransientBase::computeConstrainedDT(), TransientBase::computeSolutionChangeNorm(), TransientBase::endStep(), TransientBase::init(), TransientBase::keepGoing(), TransientBase::preExecute(), TransientBase::takeStep(), takeStep(), and TransientBase::TransientBase().

◆ _dt_old

Real& TransientBase::_dt_old

protectedinherited

Definition at line 255 of file TransientBase.h.

Referenced by TransientBase::init(), TransientBase::takeStep(), and takeStep().

◆ _dtmax

Real TransientBase::_dtmax

protectedinherited

Definition at line 268 of file TransientBase.h.

Referenced by TransientBase::dtMax().

◆ _dtmin

Real TransientBase::_dtmin

protectedinherited

Definition at line 267 of file TransientBase.h.

Referenced by TransientBase::dtMin(), and TransientBase::keepGoing().

◆ _enabled

const bool& MooseObject::_enabled

protectedinherited

Reference to the "enable" InputParameters, used by Controls for toggling on/off MooseObjects.

Definition at line 71 of file MooseObject.h.

Referenced by MooseObject::enabled().

◆ _end_time

Real TransientBase::_end_time

protectedinherited

Definition at line 266 of file TransientBase.h.

Referenced by TransientBase::endTime(), TransientBase::getEndTime(), TransientBase::keepGoing(), and TransientBase::TransientBase().

◆ _error_on_dtmin

const bool TransientBase::_error_on_dtmin

protectedinherited

This parameter controls how the system will deal with _dt <= _dtmin If true, the time stepper is expected to throw an error If false, the executioner will continue through EXEC_FINAL.

Definition at line 284 of file TransientBase.h.

Referenced by TransientBase::keepGoing().

◆ _factory

Factory& ParallelParamObject::_factory

protectedinherited

The Factory associated with the MooseApp.

Definition at line 37 of file ParallelParamObject.h.

Referenced by ElementIDOutputAction::act(), AdaptivityAction::act(), AddControlAction::act(), AddNodalNormalsAction::act(), AddPeriodicBCAction::act(), AutoCheckpointAction::act(), CombineComponentsMeshes::act(), CommonOutputAction::act(), ComposeTimeStepperAction::act(), CreateDisplacedProblemAction::act(), CreateExecutionerAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), DisplayGhostingAction::act(), MaterialDerivativeTestAction::act(), MaterialOutputAction::act(), PartitionerAction::act(), SetAdaptivityOptionsAction::act(), SetupDebugAction::act(), SetupMeshAction::act(), SetupPreconditionerAction::act(), SetupPredictorAction::act(), SetupResidualDebugAction::act(), SetupTimeStepperAction::act(), ComponentJunction::addMeshGenerators(), ComponentMeshTransformHelper::addMeshGenerators(), CylinderComponent::addMeshGenerators(), DiffusionPhysicsBase::addPostprocessors(), CreateDisplacedProblemAction::addProxyRelationshipManagers(), AddActionComponentAction::addRelationshipManagers(), SampledOutput::cloneMesh(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), PhysicsBase::getFactory(), ActionComponent::getFactory(), PhysicsBase::getFactory(), MaterialOutputAction::getParams(), and ProjectedStatefulMaterialStorageAction::processProperty().

◆ _fe_problem

FEProblemBase& Executioner::_fe_problem

protectedinherited

Definition at line 169 of file Executioner.h.

Referenced by EigenExecutionerBase::EigenExecutionerBase(), Executor::exec(), Executioner::Executioner(), Executioner::Executioner(), Executioner::feProblem(), TransientBase::parentOutputPositionChanged(), and Executioner::problem().

◆ _fixed_point_solve

std::unique_ptr<FixedPointSolve> Executioner::_fixed_point_solve

protectedinherited

Definition at line 172 of file Executioner.h.

Referenced by Eigenvalue::Eigenvalue(), Eigenvalue::execute(), SteadyBase::execute(), TransientBase::execute(), Executioner::Executioner(), Executioner::fixedPointSolve(), TransientBase::incrementStepOrReject(), Eigenvalue::init(), Steady::init(), TransientBase::init(), Steady::Steady(), TransientBase::takeStep(), TransientBase::timeStepSolveObject(), and Transient::Transient().

◆ _iteration_method

MooseEnum Executioner::_iteration_method

protectedinherited

Definition at line 171 of file Executioner.h.

Referenced by Executioner::Executioner().

◆ _last_solve_converged

bool& TransientBase::_last_solve_converged

protectedinherited

Whether or not the last solve converged.

Definition at line 261 of file TransientBase.h.

Referenced by TransientBase::lastSolveConverged(), TransientBase::takeStep(), and takeStep().

◆ _metaname

const RestartableDataMapName Restartable::_metaname

privateinherited

Restartable metadata name.

Definition at line 247 of file Restartable.h.

Referenced by Restartable::registerRestartableDataOnApp().

◆ _mfem_problem

MFEMProblem& MFEMTransient::_mfem_problem

private

Definition at line 49 of file MFEMTransient.h.

Referenced by MFEMTransient().

◆ _mfem_problem_data

MFEMProblemData& MFEMTransient::_mfem_problem_data

private

Definition at line 50 of file MFEMTransient.h.

Referenced by init(), and MFEMTransient().

◆ _mfem_problem_solve

MFEMProblemSolve MFEMTransient::_mfem_problem_solve

private

Definition at line 51 of file MFEMTransient.h.

Referenced by timeStepSolveObject().

◆ _n_startup_steps

int TransientBase::_n_startup_steps

protectedinherited

Definition at line 270 of file TransientBase.h.

Referenced by TransientBase::computeConstrainedDT().

◆ _name

const std::string& MooseBase::_name

protectedinherited

The name of this class.

Definition at line 381 of file MooseBase.h.

◆ _next_interval_output_time

Real TransientBase::_next_interval_output_time

protectedinherited

Definition at line 288 of file TransientBase.h.

Referenced by TransientBase::computeConstrainedDT(), TransientBase::endStep(), TransientBase::preExecute(), and TransientBase::TransientBase().

◆ _num_steps

unsigned int TransientBase::_num_steps

protectedinherited

Definition at line 269 of file TransientBase.h.

Referenced by TransientBase::forceNumSteps(), TransientBase::keepGoing(), and TransientBase::TransientBase().

◆ _oi_moose_app

MooseApp& OutputInterface::_oi_moose_app

privateinherited

Reference the the MooseApp; neede for access to the OutputWarehouse.

Definition at line 72 of file OutputInterface.h.

◆ _oi_output_warehouse

OutputWarehouse& OutputInterface::_oi_output_warehouse

privateinherited

Reference to the OutputWarehouse for populating the Output object hide lists.

Definition at line 75 of file OutputInterface.h.

Referenced by OutputInterface::buildOutputHideVariableList().

◆ _oi_outputs

std::set<OutputName> OutputInterface::_oi_outputs

privateinherited

The set of Output object names listed in the 'outputs' parameter.

Definition at line 78 of file OutputInterface.h.

Referenced by OutputInterface::buildOutputHideVariableList(), and OutputInterface::getOutputs().

◆ _parent

const ParallelParamObject& DataFileInterface::_parent

privateinherited

Definition at line 58 of file DataFileInterface.h.

Referenced by DataFileInterface::getDataFileName(), DataFileInterface::getDataFileNameByName(), and DataFileInterface::getDataFilePath().

◆ _pars

const InputParameters& MooseBase::_pars

protectedinherited

The object's parameters.

Definition at line 384 of file MooseBase.h.

Referenced by AddAuxKernelAction::act(), AddFVICAction::act(), AddICAction::act(), CommonOutputAction::act(), ComposeTimeStepperAction::act(), CreateProblemAction::act(), CreateProblemDefaultAction::act(), SetupDebugAction::act(), SetupMeshAction::act(), AddMFEMComplexBCComponentAction::act(), AddMFEMComplexKernelComponentAction::act(), FunctorMaterial::addFunctorPropertyByBlocks(), BreakMeshByBlockGenerator::BreakMeshByBlockGenerator(), PNGOutput::calculateRescalingValues(), MooseBase::callMooseError(), MooseBase::connectControllableParams(), Console::Console(), MooseApp::copyInputs(), MaterialBase::declareADProperty(), Moose::Kokkos::MaterialBase::declareKokkosOnDemandProperty(), Moose::Kokkos::MaterialBase::declareKokkosProperty(), MaterialBase::declareProperty(), FEProblemSolve::FEProblemSolve(), FileMeshGenerator::generate(), MooseBase::getBase(), MooseBase::getCheckedPointerParam(), MaterialBase::getGenericZeroMaterialProperty(), MooseBase::getHitNode(), MeshGenerator::getMeshGeneratorNameFromParam(), MeshGenerator::getMeshGeneratorNamesFromParam(), MooseBase::getParam(), MooseBase::getParam(), MooseBase::hasBase(), MeshGenerator::hasGenerateCSG(), MeshGenerator::hasGenerateData(), AddVariableAction::init(), AdvancedOutput::initExecutionTypes(), EigenProblemSolve::initialSetup(), Console::initialSetup(), MooseBase::isParamSetByUser(), MooseBase::isParamValid(), MultiApp::keepSolutionDuringRestore(), MooseBase::messagePrefix(), MooseBase::MooseBase(), MultiSystemSolveObject::MultiSystemSolveObject(), MooseApp::outputMachineReadableData(), MooseBase::paramError(), MooseBase::parameters(), MooseBase::paramInfo(), MooseBase::paramWarning(), MooseMesh::prepare(), MooseBase::queryParam(), MooseMesh::setCoordSystem(), MooseMesh::setPartitionerHelper(), SetupMeshAction::setupMesh(), TransientBase::setupTimeIntegrator(), MooseApp::showInputs(), and MooseBase::uniqueName().

◆ _pg_moose_app

MooseApp& PerfGraphInterface::_pg_moose_app

protectedinherited

The MooseApp that owns the PerfGraph.

Definition at line 135 of file PerfGraphInterface.h.

Referenced by PerfGraphInterface::perfGraph().

◆ _ppi_feproblem

const FEProblemBase& PostprocessorInterface::_ppi_feproblem

privateinherited

Reference the the FEProblemBase class.

Definition at line 159 of file PostprocessorInterface.h.

Referenced by PostprocessorInterface::getPostprocessorValueByNameInternal(), PostprocessorInterface::hasPostprocessorByName(), PostprocessorInterface::isDefaultPostprocessorValueByName(), and PostprocessorInterface::postprocessorsAdded().

◆ _ppi_moose_object

const MooseObject& PostprocessorInterface::_ppi_moose_object

privateinherited

The MooseObject that uses this interface.

Definition at line 153 of file PostprocessorInterface.h.

Referenced by PostprocessorInterface::checkParam(), PostprocessorInterface::getPostprocessorNameInternal(), PostprocessorInterface::getPostprocessorValueByNameInternal(), PostprocessorInterface::getPostprocessorValueInternal(), PostprocessorInterface::hasPostprocessor(), and PostprocessorInterface::hasPostprocessorByName().

◆ _ppi_params

const InputParameters& PostprocessorInterface::_ppi_params

privateinherited

PostprocessorInterface Parameters.

Definition at line 156 of file PostprocessorInterface.h.

Referenced by PostprocessorInterface::checkParam(), PostprocessorInterface::coupledPostprocessors(), and PostprocessorInterface::getPostprocessorNameInternal().

◆ _prefix

const std::string PerfGraphInterface::_prefix

protectedinherited

A prefix to use for all sections.

Definition at line 138 of file PerfGraphInterface.h.

Referenced by PerfGraphInterface::timedSectionName().

◆ _problem

FEProblemBase& TransientBase::_problem

protectedinherited

Here for backward compatibility.

Definition at line 239 of file TransientBase.h.

Referenced by TransientBase::constrainDTFromMultiApp(), TransientBase::convergedToSteadyState(), TransientBase::endStep(), TransientBase::execute(), TransientBase::getTimeIntegratorNames(), TransientBase::incrementStepOrReject(), TransientBase::init(), TransientBase::keepGoing(), TransientBase::preExecute(), TransientBase::setupTimeIntegrator(), TransientBase::takeStep(), takeStep(), and TransientBase::TransientBase().

◆ _problem_operators

std::vector<std::shared_ptr<ProblemOperatorBase> > Moose::MFEM::ProblemOperatorInterface::_problem_operators

privateinherited

Definition at line 42 of file ProblemOperatorInterface.h.

Referenced by Moose::MFEM::ProblemOperatorInterface::addProblemOperator(), and Moose::MFEM::ProblemOperatorInterface::getProblemOperators().

◆ _reporter_data

ReporterData& Reporter::_reporter_data

privateinherited

Data storage.

Definition at line 198 of file Reporter.h.

◆ _reporter_fe_problem

FEProblemBase& Reporter::_reporter_fe_problem

privateinherited

Needed for access to FEProblemBase::getReporterData.

Definition at line 195 of file Reporter.h.

◆ _reporter_moose_object

const MooseObject& Reporter::_reporter_moose_object

privateinherited

The MooseObject creating this Reporter.

Definition at line 186 of file Reporter.h.

Referenced by Reporter::getReporterValueName(), Reporter::Reporter(), and Reporter::store().

◆ _reporter_name

const std::string& Reporter::_reporter_name

privateinherited

The name of the MooseObject, from "_object_name" param.

Definition at line 192 of file Reporter.h.

◆ _reporter_params

const InputParameters& Reporter::_reporter_params

privateinherited

Ref. to MooseObject params.

Definition at line 189 of file Reporter.h.

Referenced by Reporter::getReporterValueName().

◆ _restart_file_base

std::string Executioner::_restart_file_base

protectedinherited

Definition at line 175 of file Executioner.h.

Referenced by Executioner::Executioner(), and Executioner::Executioner().

◆ _restartable_app

MooseApp& Restartable::_restartable_app

protectedinherited

Reference to the application.

Definition at line 234 of file Restartable.h.

Referenced by Restartable::registerRestartableDataOnApp(), and Restartable::registerRestartableNameWithFilterOnApp().

◆ _restartable_name

std::string Restartable::_restartable_name

privateinherited

The name of the object.

Definition at line 250 of file Restartable.h.

Referenced by Restartable::declareRestartableDataWithObjectNameWithContext(), and Restartable::restartableName().

◆ _restartable_read_only

const bool Restartable::_restartable_read_only

protectedinherited

Flag for toggling read only status (see ReporterData)

Definition at line 243 of file Restartable.h.

Referenced by Restartable::registerRestartableDataOnApp().

◆ _restartable_system_name

const std::string Restartable::_restartable_system_name

protectedinherited

The system name this object is in.

Definition at line 237 of file Restartable.h.

Referenced by Restartable::restartableName().

◆ _restartable_tid

const THREAD_ID Restartable::_restartable_tid

protectedinherited

The thread ID for this object.

Definition at line 240 of file Restartable.h.

Referenced by Restartable::declareRestartableDataHelper().

◆ _ri_fe_problem_base

FEProblemBase& ReporterInterface::_ri_fe_problem_base

privateinherited

Provides access to FEProblemBase::getReporterData.

Definition at line 137 of file ReporterInterface.h.

Referenced by ReporterInterface::reportersAdded().

◆ _ri_moose_object

const MooseObject& ReporterInterface::_ri_moose_object

privateinherited

The MooseObject needing this interface.

Definition at line 143 of file ReporterInterface.h.

Referenced by ReporterInterface::getReporterContextBaseByName(), ReporterInterface::getReporterName(), ReporterInterface::getReporterValueByName(), ReporterInterface::hasReporterValue(), ReporterInterface::hasReporterValueByName(), and ReporterInterface::possiblyCheckHasReporter().

◆ _ri_params

const InputParameters& ReporterInterface::_ri_params

privateinherited

Parameters for the MooseObject inherting from this interface.

Definition at line 134 of file ReporterInterface.h.

Referenced by ReporterInterface::getReporterName(), and ReporterInterface::possiblyCheckHasReporter().

◆ _ri_reporter_data

const ReporterData& ReporterInterface::_ri_reporter_data

privateinherited

The ReporterData.

Definition at line 140 of file ReporterInterface.h.

Referenced by ReporterInterface::getReporterContextBaseByName(), ReporterInterface::getReporterValueByName(), and ReporterInterface::hasReporterValueByName().

◆ _si_moose_base

const MooseBase& SolutionInvalidInterface::_si_moose_base

privateinherited

The MooseBase that owns this interface.

Definition at line 111 of file SolutionInvalidInterface.h.

Referenced by SolutionInvalidInterface::flagInvalidSolutionInternal(), SolutionInvalidInterface::mooseDeprecated(), SolutionInvalidInterface::mooseWarning(), SolutionInvalidInterface::mooseWarningNonPrefixed(), SolutionInvalidInterface::paramWarning(), and SolutionInvalidInterface::registerInvalidSolutionInternal().

◆ _si_problem

const FEProblemBase* SolutionInvalidInterface::_si_problem

privateinherited

A pointer to FEProblem base.

Definition at line 114 of file SolutionInvalidInterface.h.

Referenced by SolutionInvalidInterface::flagInvalidSolutionInternal().

◆ _solve_objects

std::vector<const SolveObject *> Executioner::_solve_objects

privateinherited

All solve objects built by this executioner.

Definition at line 182 of file Executioner.h.

Referenced by Executioner::hasSolveObject(), and Executioner::registerSolveObject().

◆ _start_time

Real TransientBase::_start_time

protectedinherited

Definition at line 291 of file TransientBase.h.

Referenced by TransientBase::getStartTime(), TransientBase::preExecute(), and TransientBase::TransientBase().

◆ _steady_state_detection

const bool TransientBase::_steady_state_detection

protectedinherited

Steady state detection variables:

Definition at line 275 of file TransientBase.h.

Referenced by TransientBase::keepGoing(), and TransientBase::TransientBase().

◆ _steady_state_start_time

const Real TransientBase::_steady_state_start_time

protectedinherited

Definition at line 276 of file TransientBase.h.

Referenced by TransientBase::keepGoing().

◆ _sync_times

std::set<Real>& TransientBase::_sync_times

protectedinherited

Definition at line 278 of file TransientBase.h.

Referenced by TransientBase::syncTimes().

◆ _t_step

int& TransientBase::_t_step

protectedinherited

Current timestep.

Definition at line 248 of file TransientBase.h.

Referenced by TransientBase::computeConstrainedDT(), TransientBase::convergedToSteadyState(), TransientBase::execute(), TransientBase::incrementStepOrReject(), TransientBase::init(), TransientBase::keepGoing(), TransientBase::preExecute(), TransientBase::takeStep(), and TransientBase::TransientBase().

◆ _target_time

Real& TransientBase::_target_time

protectedinherited

Definition at line 293 of file TransientBase.h.

Referenced by TransientBase::computeConstrainedDT(), TransientBase::getTargetTime(), and TransientBase::setTargetTime().

◆ _test_restep_step

std::optional<int> TransientBase::_test_restep_step

privateinherited

The timestep we fail and repeat if –test-restep is enabled.

Definition at line 305 of file TransientBase.h.

Referenced by TransientBase::computeDT(), TransientBase::execute(), TransientBase::takeStep(), and TransientBase::TransientBase().

◆ _test_restep_time

std::optional<Real> TransientBase::_test_restep_time

privateinherited

If the time is greater than this then we fail and repeat if –test-restep is enabled.

Definition at line 307 of file TransientBase.h.

Referenced by TransientBase::computeDT(), TransientBase::execute(), TransientBase::takeStep(), and TransientBase::TransientBase().

◆ _testing_restep

bool TransientBase::_testing_restep

privateinherited

Whether or not the last timestep we solved is being repeated with –test-restep.

Definition at line 309 of file TransientBase.h.

Referenced by TransientBase::computeDT(), and TransientBase::takeStep().

◆ _time

Real& TransientBase::_time

protectedinherited

Current time.

Definition at line 250 of file TransientBase.h.

Referenced by TransientBase::computeConstrainedDT(), TransientBase::endStep(), TransientBase::getTime(), TransientBase::incrementStepOrReject(), TransientBase::keepGoing(), TransientBase::preExecute(), TransientBase::setTime(), TransientBase::takeStep(), takeStep(), and TransientBase::TransientBase().

◆ _time_interval

bool& TransientBase::_time_interval

protectedinherited

if to use time interval output

Definition at line 287 of file TransientBase.h.

Referenced by TransientBase::computeConstrainedDT(), and TransientBase::endStep().

◆ _time_interval_output_interval

Real TransientBase::_time_interval_output_interval

protectedinherited

Definition at line 289 of file TransientBase.h.

Referenced by TransientBase::endStep().

◆ _time_old

Real& TransientBase::_time_old

protectedinherited

Previous time.

Definition at line 252 of file TransientBase.h.

Referenced by TransientBase::endStep(), TransientBase::incrementStepOrReject(), TransientBase::preExecute(), TransientBase::setTimeOld(), TransientBase::takeStep(), takeStep(), and TransientBase::TransientBase().

◆ _time_scheme

Moose::TimeIntegratorType TransientBase::_time_scheme

protectedinherited

Definition at line 244 of file TransientBase.h.

Referenced by TransientBase::getTimeScheme(), and TransientBase::setupTimeIntegrator().

◆ _time_stepper

TimeStepper* TransientBase::_time_stepper

protectedinherited

Definition at line 245 of file TransientBase.h.

Referenced by TransientBase::computeConstrainedDT(), TransientBase::computeDT(), TransientBase::getDT(), TransientBase::getTimeStepper(), TransientBase::getTimeStepper(), TransientBase::getTimeStepperName(), TransientBase::incrementStepOrReject(), TransientBase::init(), TransientBase::postExecute(), TransientBase::postStep(), TransientBase::preExecute(), TransientBase::preStep(), TransientBase::setTimeStepper(), TransientBase::takeStep(), and takeStep().

◆ _timestep_tolerance

Real TransientBase::_timestep_tolerance

protectedinherited

Definition at line 292 of file TransientBase.h.

Referenced by TransientBase::computeConstrainedDT(), TransientBase::endStep(), TransientBase::keepGoing(), TransientBase::setTimestepTolerance(), and TransientBase::timestepTol().

◆ _type

const std::string& MooseBase::_type

protectedinherited

The type of this class.

Definition at line 378 of file MooseBase.h.

Referenced by FillBetweenCurvesGenerator::generate(), FillBetweenPointVectorsGenerator::generate(), FillBetweenSidesetsGenerator::generate(), MooseBase::MooseBase(), FEProblemBase::solverTypeString(), and MooseBase::type().

◆ _unconstrained_dt

Real& TransientBase::_unconstrained_dt

protectedinherited

Definition at line 257 of file TransientBase.h.

Referenced by TransientBase::computeConstrainedDT(), and TransientBase::unconstrainedDT().

◆ _unused_values

std::vector<std::unique_ptr<UnusedWrapperBase> > Reporter::_unused_values

privateinherited

Storage for unused values declared with declareUnusedValue().

Definition at line 201 of file Reporter.h.

Referenced by Reporter::declareUnusedValue().

◆ _uoi_feproblem

const FEProblemBase& UserObjectInterface::_uoi_feproblem

privateinherited

Reference to the FEProblemBase instance.

Definition at line 143 of file UserObjectInterface.h.

Referenced by UserObjectInterface::getUserObjectFromFEProblem(), and UserObjectInterface::hasUserObjectByName().

◆ _uoi_moose_object

const MooseObject& UserObjectInterface::_uoi_moose_object

privateinherited

Moose object using the interface.

Definition at line 140 of file UserObjectInterface.h.

Referenced by UserObjectInterface::getUserObjectBase(), UserObjectInterface::getUserObjectBaseByName(), UserObjectInterface::getUserObjectName(), and UserObjectInterface::mooseObjectError().

◆ _uoi_tid

const THREAD_ID UserObjectInterface::_uoi_tid

privateinherited

Thread ID.

Definition at line 146 of file UserObjectInterface.h.

Referenced by UserObjectInterface::getUserObjectBaseByName().

◆ _use_multiapp_dt

bool TransientBase::_use_multiapp_dt

protectedinherited

Definition at line 294 of file TransientBase.h.

Referenced by TransientBase::constrainDTFromMultiApp().

◆ _verbose

const bool& Executioner::_verbose

protectedinherited

True if printing out additional information.

Definition at line 178 of file Executioner.h.

Referenced by TransientBase::computeConstrainedDT(), Executioner::Executioner(), and Executioner::verbose().

◆ _xfem_repeat_step

bool TransientBase::_xfem_repeat_step

protectedinherited

Whether step should be repeated due to xfem modifying the mesh.

Definition at line 264 of file TransientBase.h.

Referenced by TransientBase::endStep(), TransientBase::incrementStepOrReject(), TransientBase::keepGoing(), and TransientBase::takeStep().

◆ app_param

const std::string MooseBase::app_param = "_moose_app"

staticinherited

The name of the parameter that contains the MooseApp.

Definition at line 59 of file MooseBase.h.

Referenced by FEProblemBase::addAnyRedistributers(), MeshGenerator::addMeshSubgenerator(), InputParameters::callMooseError(), ActionFactory::create(), ActionFactory::getValidParams(), Factory::getValidParams(), AutomaticMortarGeneration::initOutput(), SetupMeshAction::modifyParamsForUseSplit(), and MortarNodalGeometryOutput::validParams().

◆ kokkos_object_param

const std::string MooseBase::kokkos_object_param = "_kokkos_object"

staticinherited

The name of the parameter that indicates an object is a Kokkos functor.

Definition at line 64 of file MooseBase.h.

Referenced by InputParameters::isKokkosObject().

◆ moose_base_param

const std::string MooseBase::moose_base_param = "_moose_base"

staticinherited

The name of the parameter that contains the moose system base.

Definition at line 61 of file MooseBase.h.

Referenced by InputParameters::getBase(), InputParameters::hasBase(), and InputParameters::registerBase().

◆ name_param

const std::string MooseBase::name_param = "_object_name"

staticinherited

The name of the parameter that contains the object name.

Definition at line 55 of file MooseBase.h.

Referenced by InputParameterWarehouse::addInputParameters(), ActionUnitTest::buildMinimalObjects(), MooseObjectUnitTest::buildObjects(), AppFactory::create(), InputParameters::getObjectName(), AutomaticMortarGeneration::initOutput(), InputParameters::isMooseBaseObject(), MooseMesh::prepare(), CouplingFunctorCheckAction::validParams(), and MooseBase::validParams().

◆ type_param

const std::string MooseBase::type_param = "_type"

staticinherited

The name of the parameter that contains the object type.

Definition at line 53 of file MooseBase.h.

Referenced by ActionFactory::create(), AppFactory::create(), InputParameters::getObjectType(), Factory::initialize(), InputParameters::isMooseBaseObject(), InputParameters::queryObjectType(), MooseBase::validParams(), and MortarNodalGeometryOutput::validParams().

◆ unique_name_param

const std::string MooseBase::unique_name_param = "_unique_name"

staticinherited

The name of the parameter that contains the unique object name.

Definition at line 57 of file MooseBase.h.

Referenced by InputParameterWarehouse::addInputParameters(), AppFactory::create(), InputParameterWarehouse::removeInputParameters(), MooseBase::uniqueName(), and MooseBase::validParams().

◆ usingCombinedWarningSolutionWarnings

MooseObject::usingCombinedWarningSolutionWarnings

inherited

Definition at line 67 of file MooseObject.h.

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

include/mfem/executioners/MFEMTransient.h
src/mfem/executioners/MFEMTransient.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ DataFileParameterType

Constructor & Destructor Documentation

◆ MFEMTransient()

Member Function Documentation

◆ addAttributeReporter()

◆ addPostprocessorDependencyHelper()

◆ addProblemOperator()

◆ addReporterDependencyHelper()

◆ addUserObjectDependencyHelper()

◆ atSyncPoint()

◆ buildOutputHideVariableList()

◆ callMooseError() [1/2]

◆ callMooseError() [2/2]

◆ castUserObject()

◆ checkParam()

◆ computeConstrainedDT()

◆ computeDT()

◆ computeSolutionChangeNorm()

◆ connectControllableParams()

◆ constrainDTFromMultiApp()

◆ convergedToSteadyState()

◆ coupledPostprocessors()

◆ declareLateValues()

◆ declareManagedRestartableDataWithContext()

◆ declareRecoverableData()

◆ declareRestartableData()

◆ declareRestartableDataHelper()

◆ declareRestartableDataWithContext()

◆ declareRestartableDataWithObjectName()

◆ declareRestartableDataWithObjectNameWithContext()

◆ declareUnusedValue()

◆ declareValue() [1/4]

◆ declareValue() [2/4]

◆ declareValue() [3/4]

◆ declareValue() [4/4]

◆ declareValueByName() [1/4]

◆ declareValueByName() [2/4]

◆ declareValueByName() [3/4]

◆ declareValueByName() [4/4]

◆ defaultSteadyStateConvergenceParams()

◆ dtMax()

◆ dtMin()

◆ enabled()

◆ endStep()

◆ endTime()

◆ errorPrefix()

◆ estimateTimeError()

◆ execute()

◆ feProblem()

◆ fixedPointSolve()

◆ flagInvalidSolutionInternal()

◆ forceNumSteps()

◆ getBase()

◆ getCheckedPointerParam()

◆ getDataFileName()

◆ getDataFileNameByName()

◆ getDataFilePath()

◆ getDefaultPostprocessorValueByName()

◆ getDT()

◆ getEndTime()

◆ getHitNode() [1/2]

◆ getHitNode() [2/2]

◆ getMooseApp()

◆ getOutputs()

◆ getParam() [1/2]

◆ getParam() [2/2]

◆ getPostprocessorName()

◆ getPostprocessorNameInternal()