Based class for output objects. More...

#include <Output.h>

Inheritance diagram for Output:

Public Member Functions
	Output (const InputParameters &parameters)
	Class constructor. More...

virtual Real	time ()
	Get the output time. More...

virtual Real	timeOld ()
	Get the old output time. More...

virtual Real	dt ()
	Get the current time step size. More...

virtual Real	dtOld ()
	Get old time step size. More...

virtual int	timeStep ()
	Get the current time step. More...

const unsigned int &	interval () const
	Get the output interval. More...

const MultiMooseEnum &	executeOn () const
	Get the current 'execute_on' selections for display. More...

bool	isAdvanced ()
	Returns true if this object is an AdvancedOutput object. More...

virtual const OutputOnWarehouse &	advancedExecuteOn () const
	Returns the advanced 'execute_on' settings. More...

void	allowOutput (bool state)
	Method for controlling the allow output state. More...

virtual void	outputStep (const ExecFlagType &type)
	A single call to this function should output all the necessary data for a single timestep. More...

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

virtual const std::string &	name () const
	Get the name of the object. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual void	meshChanged ()
	Called on this object when the mesh changes. More...

virtual void	timestepSetup ()
	Gets called at the beginning of the timestep before this object is asked to do its job. More...

virtual void	jacobianSetup ()
	Gets called just before the Jacobian is computed and before this object is asked to do its job. More...

virtual void	residualSetup ()
	Gets called just before the residual is computed and before this object is asked to do its job. More...

virtual void	subdomainSetup ()
	Gets called when the subdomain changes (i.e. More...

const ExecFlagEnum &	getExecuteOnEnum () const
	Return the execute on MultiMooseEnum for this object. More...

virtual const std::vector< ExecFlagType > &	execFlags () const
	(DEPRECATED) Get the execution flag for the object TODO: ExecFlagType More...

ExecFlagType	execBitFlags () const
	(DEPRECATED) Build and return the execution flags as a bitfield TODO: ExecFlagType More...

Static Public Member Functions
static InputParameters	validParams ()

static ExecFlagEnum	getDefaultExecFlagEnum ()
	Return an ExecFlagEnum object with the available execution flags for Output objects. More...

static void	addDeprecatedInputParameters (InputParameters &params)
	A static helper for injecting deprecated parameters. More...

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

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

Protected Member Functions
virtual void	output (const ExecFlagType &type)=0
	Overload this function with the desired output activities. More...

virtual void	solveSetup ()
	A method called just prior to the solve, this is used by PetscOutput to perform the necessary setup actions for each timestep. More...

virtual bool	shouldOutput (const ExecFlagType &type)
	Handles logic for determining if a step should be output. More...

virtual bool	onInterval ()
	Returns true if the output interval is satisfied. More...

virtual void	initialSetup ()
	Initialization method. More...

template<typename T >
T &	declareRestartableDataTempl (const std::string &data_name)
	Declare a piece of data as "restartable". More...

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

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

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

template<typename T >
T &	declareRestartableDataWithPrefixOverrideAndContext (const std::string &data_name, const std::string &prefix, void *context)
	Declare a piece of data as "restartable". More...

template<typename T >
T &	declareRecoverableData (const std::string &data_name)
	Declare a piece of data as "recoverable". More...

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

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

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

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

Protected Attributes
FEProblemBase *	_problem_ptr
	Pointer the the FEProblemBase object for output object (use this) More...

bool	_transient
	Transient flag (true = transient) More...

bool	_use_displaced
	Flag for using displaced mesh. More...

EquationSystems *	_es_ptr
	Reference the the libMesh::EquationSystems object that contains the data. More...

MooseMesh *	_mesh_ptr
	A convenience pointer to the current mesh (reference or displaced depending on "use_displaced") More...

bool	_sequence
	Flag for forcing call to outputSetup() with every call to output() (restartable) More...

ExecFlagEnum	_execute_on
	The common Execution types; this is used as the default execution type for everything except system information and input. More...

Real &	_time
	The current time for output purposes. More...

Real &	_time_old
	The old time. More...

int &	_t_step
	The current time step. More...

Real &	_dt
	Time step delta. More...

Real &	_dt_old
	Old time step delta. More...

unsigned int	_num
	The number of outputs written. More...

const unsigned int	_interval
	The output time step interval. More...

std::set< Real >	_sync_times
	Sync times for this outputter. More...

Real	_start_time
	Start outputting time. More...

Real	_end_time
	End outputting time. More...

int	_start_step
	Start outputting at this time step. More...

int	_end_step
	End outputting at this time step. More...

Real	_t_tol
	Time checking tolerance. More...

bool	_sync_only
	Flag for only executing at sync times. More...

bool	_initialized
	True if init() has been called. More...

bool	_allow_output
	Flag for disabling output. More...

bool	_is_advanced
	Flag for advanced output testing. More...

OutputOnWarehouse	_advanced_execute_on
	Storage for the individual component execute flags. More...

PerfID	_output_step_timer
	Timers. More...

const InputParameters &	_pars
	Parameters of this object, references the InputParameters stored in the InputParametersWarehouse. More...

MooseApp &	_app
	The MooseApp this object is associated with. More...

const std::string &	_type
	The type of this object (the Class name) More...

const std::string &	_name
	The name of this object, reference to value stored in InputParameters. More...

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

FEProblemBase &	_mci_feproblem
	Reference to FEProblemBase instance. More...

const ExecFlagEnum &	_execute_enum
	Execute settings for this oejct. More...

const std::vector< ExecFlagType >	_exec_flags
	(DEPRECATED) execution flag (when is the object executed/evaluated) TODO: ExecFlagType More...

const ExecFlagType &	_current_execute_flag
	Reference to FEProblemBase. More...

const InputParameters *	_pg_params
	Params. More...

PerfGraph &	_perf_graph
	The performance graph to add to. More...

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

Private Member Functions
template<typename... Args>
std::string	paramErrorMsg (const std::string &param, Args... args) const

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

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

Private Attributes
MooseApp &	_restartable_app
	Reference to the application. More...

std::string	_restartable_name
	The name of the object. More...

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

THREAD_ID	_restartable_tid
	The thread ID for this object. More...

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

Friends
class	OutputWarehouse

Detailed Description

Based class for output objects.

Each output class (e.g., Exodus) should inherit from this base class. At a minimum, the pure virtual methods for the various types of output must be defined in the child class.

See also: Exodus Console CSV

Definition at line 41 of file Output.h.

Constructor & Destructor Documentation

◆ Output()

Output::Output ( const InputParameters & parameters )

Class constructor.

The constructor performs all of the necessary initialization of the various output lists required for the various output types.

See also: initAvailable init separate

Definition at line 86 of file Output.C.

   : MooseObject(parameters),
     Restartable(this, "Output"),
     MeshChangedInterface(parameters),
     SetupInterface(this),
     PerfGraphInterface(this),
     _problem_ptr(getParam<FEProblemBase *>("_fe_problem_base")),
     _transient(_problem_ptr->isTransient()),
     _use_displaced(getParam<bool>("use_displaced")),
     _es_ptr(nullptr),
     _mesh_ptr(nullptr),
     _execute_on(getParam<ExecFlagEnum>("execute_on")),
     _time(_problem_ptr->time()),
     _time_old(_problem_ptr->timeOld()),
     _t_step(_problem_ptr->timeStep()),
     _dt(_problem_ptr->dt()),
     _dt_old(_problem_ptr->dtOld()),
     _num(0),
     _interval(getParam<unsigned int>("interval")),
     _sync_times(std::set<Real>(getParam<std::vector<Real>>("sync_times").begin(),
                                getParam<std::vector<Real>>("sync_times").end())),
     _start_time(isParamValid("start_time") ? getParam<Real>("start_time")
                                            : std::numeric_limits<Real>::lowest()),
     _end_time(isParamValid("end_time") ? getParam<Real>("end_time")
                                        : std::numeric_limits<Real>::max()),
     _start_step(isParamValid("start_step") ? getParam<int>("start_step")
                                            : std::numeric_limits<int>::lowest()),
     _end_step(isParamValid("end_step") ? getParam<int>("end_step")
                                        : std::numeric_limits<int>::max()),
     _t_tol(getParam<Real>("time_tolerance")),
     _sync_only(getParam<bool>("sync_only")),
     _initialized(false),
     _allow_output(true),
     _is_advanced(false),
     _advanced_execute_on(_execute_on, parameters),
     _output_step_timer(registerTimedSection("outputStep", 2))
 {
   if (_use_displaced)
   {
     std::shared_ptr<DisplacedProblem> dp = _problem_ptr->getDisplacedProblem();
     if (dp != nullptr)
     {
       _es_ptr = &dp->es();
       _mesh_ptr = &dp->mesh();
     }
     else
     {
       mooseWarning(
           name(),
           ": Parameter 'use_displaced' ignored, there is no displaced problem in your simulation.");
       _es_ptr = &_problem_ptr->es();
       _mesh_ptr = &_problem_ptr->mesh();
     }
   }
   else
   {
     _es_ptr = &_problem_ptr->es();
     _mesh_ptr = &_problem_ptr->mesh();
   }
  
   // Apply the additional output flags
   if (isParamValid("additional_execute_on"))
   {
     const ExecFlagEnum & add = getParam<ExecFlagEnum>("additional_execute_on");
     for (auto & me : add)
       _execute_on.push_back(me);
   }
 }

Member Function Documentation

◆ addDeprecatedInputParameters()

static void Output::addDeprecatedInputParameters ( InputParameters & params )

static

A static helper for injecting deprecated parameters.

◆ advancedExecuteOn()

const OutputOnWarehouse & Output::advancedExecuteOn ( ) const

virtual

Returns the advanced 'execute_on' settings.

Check if this is valid first with isAdvanced()

Reimplemented in AdvancedOutput.

Definition at line 281 of file Output.C.

 {
   mooseError("The output object ", name(), " is not an AdvancedOutput, use isAdvanced() to check.");
   return _advanced_execute_on;
 }

◆ allowOutput()

void Output::allowOutput ( bool state )

inline

Method for controlling the allow output state.

Parameters

state The state to set the allow flag to

Definition at line 123 of file Output.h.

123 { _allow_output = state; }

◆ declareRecoverableData() [1/2]

template<typename T >

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

protectedinherited

Declare a piece of data as "recoverable".

This means that in the event of a recovery 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)

Definition at line 295 of file Restartable.h.

 {
   std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;
  
   registerRestartableNameWithFilterOnApp(full_name, Moose::RESTARTABLE_FILTER::RECOVERABLE);
  
   return declareRestartableDataWithContext<T>(data_name, nullptr);
 }

◆ declareRecoverableData() [2/2]

template<typename T >

T & Restartable::declareRecoverableData	(	const std::string &	data_name,
		const T &	init_value
	)

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 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)
init_value	The initial value of the data

Definition at line 306 of file Restartable.h.

 {
   std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;
  
   registerRestartableNameWithFilterOnApp(full_name, Moose::RESTARTABLE_FILTER::RECOVERABLE);
  
   return declareRestartableDataWithContext<T>(data_name, init_value, nullptr);
 }

◆ declareRestartableDataTempl() [1/2]

template<typename T >

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

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)

Definition at line 222 of file Restartable.h.

 {
   return declareRestartableDataWithContext<T>(data_name, nullptr);
 }

◆ declareRestartableDataTempl() [2/2]

template<typename T >

T & Restartable::declareRestartableDataTempl	(	const std::string &	data_name,
		const T &	init_value
	)

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)
init_value	The initial value of the data

Definition at line 229 of file Restartable.h.

 {
   return declareRestartableDataWithContext<T>(data_name, init_value, nullptr);
 }

◆ declareRestartableDataWithContext() [1/2]

template<typename T >

T & Restartable::declareRestartableDataWithContext	(	const std::string &	data_name,
		const T &	init_value,
		void *	context
	)

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)
init_value	The initial value of the data
context	Context pointer that will be passed to the load and store functions

Definition at line 250 of file Restartable.h.

 {
   std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + 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 = libmesh_make_unique<RestartableData<T>>(full_name, context);
   auto & restartable_data_ref = static_cast<RestartableData<T> &>(
       registerRestartableDataOnApp(full_name, std::move(data_ptr), _restartable_tid));
  
   restartable_data_ref.set() = init_value;
   return restartable_data_ref.get();
 }

◆ declareRestartableDataWithContext() [2/2]

template<typename T >

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

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)
context	Context pointer that will be passed to the load and store functions

Definition at line 236 of file Restartable.h.

 {
   std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;
   auto data_ptr = libmesh_make_unique<RestartableData<T>>(full_name, context);
  
   // See comment in overloaded version of this function with "init_value"
   auto & restartable_data_ref = static_cast<RestartableData<T> &>(
       registerRestartableDataOnApp(full_name, std::move(data_ptr), _restartable_tid));
  
   return restartable_data_ref.get();
 }

◆ declareRestartableDataWithObjectName()

template<typename T >

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

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.

Definition at line 270 of file Restartable.h.

 {
   return declareRestartableDataWithObjectNameWithContext<T>(data_name, object_name, nullptr);
 }

◆ declareRestartableDataWithObjectNameWithContext()

template<typename T >

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

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

Definition at line 278 of file Restartable.h.

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

◆ declareRestartableDataWithPrefixOverrideAndContext()

template<typename T >

T& Restartable::declareRestartableDataWithPrefixOverrideAndContext	(	const std::string &	data_name,
		const std::string &	prefix,
		void *	context
	)

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)
prefix	The prefix to prepend to the data_name, to retrieve data from another object.
context	Context pointer that will be passed to the load and store functions

◆ dt()

Real Output::dt ( )

virtual

Get the current time step size.

Definition at line 245 of file Output.C.

 {
   if (_transient)
     return _dt;
   else
     return 1;
 }

Referenced by Console::writeTimestepInformation().

◆ dtOld()

Real Output::dtOld ( )

virtual

Get old time step size.

Definition at line 254 of file Output.C.

 {
   if (_transient)
     return _dt_old;
   else
     return 1;
 }

◆ enabled()

virtual bool MooseObject::enabled ( ) const

inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 110 of file MooseObject.h.

110 { return _enabled; }

Referenced by EigenKernel::enabled().

◆ execBitFlags()

ExecFlagType SetupInterface::execBitFlags ( ) const

inherited

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

Definition at line 87 of file SetupInterface.C.

 {
   // TODO: ExecFlagType
   mooseDeprecated("The execBitFlags method is being removed because MOOSE was updated to use a "
                   "ExecFlagEnum for execute flags. This method maintains the behavior of the "
                   "original method but the use of this method should be removed from your "
                   "application. The ExecFlagEnum should be inspected directly via the "
                   "getExecuteOnEnum() method.");
  
   unsigned int exec_bit_field = EXEC_NONE;
   for (const auto & flag : _exec_flags)
     exec_bit_field |= flag.id();
   return ExecFlagType("deprecated", exec_bit_field);
 }

◆ execFlags()

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

virtualinherited

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

Reimplemented in MultiAppTransfer.

Definition at line 75 of file SetupInterface.C.

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

◆ executeOn()

const MultiMooseEnum & Output::executeOn ( ) const

Get the current 'execute_on' selections for display.

Definition at line 269 of file Output.C.

 {
   return _execute_on;
 }

◆ getCheckedPointerParam()

template<typename T >

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

inlineinherited

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 91 of file MooseObject.h.

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

◆ getDefaultExecFlagEnum()

ExecFlagEnum Output::getDefaultExecFlagEnum ( )

static

Return an ExecFlagEnum object with the available execution flags for Output objects.

Definition at line 79 of file Output.C.

 {
   ExecFlagEnum exec_enum = MooseUtils::getDefaultExecFlagEnum();
   exec_enum.addAvailableFlags(EXEC_FAILED);
   return exec_enum;
 }

Referenced by CommonOutputAction::validParams(), and validParams().

◆ getExecuteOnEnum()

const ExecFlagEnum & SetupInterface::getExecuteOnEnum ( ) const

inherited

Return the execute on MultiMooseEnum for this object.

Definition at line 69 of file SetupInterface.C.

 {
   return _execute_enum;
 }

Referenced by ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), and MultiAppTransfer::checkMultiAppExecuteOn().

◆ getExecuteOptions()

ExecFlagEnum SetupInterface::getExecuteOptions ( )

staticinherited

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

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

Definition at line 103 of file SetupInterface.C.

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

◆ getMooseApp()

MooseApp& MooseObject::getMooseApp ( ) const

inlineinherited

Get the MooseApp this object is associated with.

Definition at line 105 of file MooseObject.h.

105 { return _app; }

Referenced by MortarData::createMortarInterface(), Executioner::Executioner(), and ConsoleUtils::outputMeshInformation().

◆ getParamTempl()

template<typename T >

const T & MooseObject::getParamTempl ( 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 208 of file MooseObject.h.

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

Referenced by FEProblemBase::addMaterialHelper(), ConstraintWarehouse::addObject(), EigenKernel::EigenKernel(), AttribThread::initFrom(), BlockRestrictable::initializeBlockRestrictable(), BoundaryRestrictable::initializeBoundaryRestrictable(), Console::initialSetup(), ConsoleUtils::outputExecutionInformation(), and TimePeriod::TimePeriod().

◆ initialSetup()

void Output::initialSetup ( )

protectedvirtual

Initialization method.

This populates the various data structures needed to control the output

Reimplemented from SetupInterface.

Reimplemented in Exodus, CSV, OversampleOutput, Nemesis, Console, and AdvancedOutput.

Definition at line 156 of file Output.C.

 {
   _initialized = true;
 }

◆ interval()

const unsigned int& Output::interval ( ) const

Get the output interval.

◆ isAdvanced()

bool Output::isAdvanced ( )

Returns true if this object is an AdvancedOutput object.

Definition at line 275 of file Output.C.

 {
   return _is_advanced;
 }

◆ isParamValid()

bool MooseObject::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 100 of file MooseObject.h.

100 { return _pars.isParamValid(name); }

◆ jacobianSetup()

void SetupInterface::jacobianSetup ( )

virtualinherited

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

Reimplemented in EqualValueEmbeddedConstraint.

Definition at line 54 of file SetupInterface.C.

55 {

56 }

◆ meshChanged()

virtual void MeshChangedInterface::meshChanged ( )

inlinevirtualinherited

Called on this object when the mesh changes.

Reimplemented in DiracKernel, Console, Exodus, Nemesis, OversampleOutput, GhostingUserObject, ExplicitTimeIntegrator, EqualValueBoundaryConstraint, and GeometryBase.

Definition at line 39 of file MeshChangedInterface.h.

39 {}

◆ mooseDeprecated()

template<typename... Args>

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

inlineinherited

Definition at line 156 of file MooseObject.h.

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

Referenced by FEProblemBase::addArrayVariable(), FEProblemBase::addAuxArrayVariable(), FEProblemBase::addAuxScalarVariable(), FEProblemBase::addAuxVariable(), FEProblemBase::addScalarVariable(), FEProblemBase::addVariable(), ADFunctionPresetBC< compute_stage >::ADFunctionPresetBC(), ADPresetBC< compute_stage >::ADPresetBC(), ADPresetNodalBC< compute_stage >::ADPresetNodalBC(), FEProblemBase::advanceMultiApps(), MultiApp::appProblem(), MooseMesh::buildSideList(), ChangeOverTimestepPostprocessor::ChangeOverTimestepPostprocessor(), FEProblemBase::computeResidual(), MaterialBase::declarePropertyOlderTempl(), MaterialBase::declarePropertyOldTempl(), MooseMesh::elem(), MultiAppTransfer::execFlags(), UserForcingFunction::f(), FaceFaceConstraint< compute_stage >::FaceFaceConstraint(), FunctionDT::FunctionDT(), FunctionPresetBC::FunctionPresetBC(), RandomICBase::generateRandom(), Control::getExecuteOptions(), FEProblemBase::getNonlinearSystem(), Sampler::getSamples(), FEProblemBase::getUserObjects(), FEProblemBase::getVectorPostprocessorValue(), FEProblemBase::getVectorPostprocessorValueOld(), MatDiffusionBase< Real >::MatDiffusionBase(), NodalScalarKernel::NodalScalarKernel(), MooseMesh::node(), PercentChangePostprocessor::PercentChangePostprocessor(), PresetBC::PresetBC(), PresetNodalBC::PresetNodalBC(), Sampler::rand(), ReferenceResidualProblem::ReferenceResidualProblem(), MooseMesh::setBoundaryToNormalMap(), Exodus::setOutputDimension(), and UserForcingFunction::UserForcingFunction().

◆ mooseError()

template<typename... Args>

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

inlineinherited

Definition at line 141 of file MooseObject.h.

   {
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     std::string msg = oss.str();
     callMooseErrorRaw(msg, &_app);
   }

◆ mooseInfo()

template<typename... Args>

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

inlineinherited

Definition at line 162 of file MooseObject.h.

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

Referenced by AStableDirk4::AStableDirk4(), ExplicitRK2::ExplicitRK2(), ExplicitTVDRK2::ExplicitTVDRK2(), ParsedMaterialHelper::functionsOptimize(), ImplicitMidpoint::ImplicitMidpoint(), LStableDirk2::LStableDirk2(), LStableDirk3::LStableDirk3(), LStableDirk4::LStableDirk4(), PNGOutput::makeMeshFunc(), MooseObject::paramInfo(), DerivativeParsedMaterialHelper::recurseDerivative(), ReferenceResidualProblem::ReferenceResidualProblem(), and FEProblemBase::setRestartFile().

◆ mooseWarning()

template<typename... Args>

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

inlineinherited

Definition at line 150 of file MooseObject.h.

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

Referenced by CartesianMeshGenerator::CartesianMeshGenerator(), MultiAppTransfer::checkMultiAppExecuteOn(), OversampleOutput::cloneMesh(), GapValueAux::computeValue(), ElementQualityChecker::finalize(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), ElementSubdomainIDGenerator::generate(), MooseMesh::getBoundaryIDs(), FEProblemBase::getInterfaceMaterial(), FEProblemBase::getMaterial(), MooseMesh::getSubdomainIDs(), ReferenceResidualProblem::initialSetup(), DerivativeFunctionMaterialBase::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), LeastSquaresFit::LeastSquaresFit(), MaterialVectorPostprocessor::MaterialVectorPostprocessor(), AssignElementSubdomainID::modify(), NewmarkBeta::NewmarkBeta(), NodalPatchRecovery::NodalPatchRecovery(), NonlocalIntegratedBC::NonlocalIntegratedBC(), NonlocalKernel::NonlocalKernel(), Output(), MooseObject::paramWarning(), Executioner::problem(), MaterialBase::resetQpProperties(), FEProblemBase::sizeZeroes(), TransientMultiApp::solveStep(), Tecplot::Tecplot(), and Checkpoint::updateCheckpointFiles().

◆ name()

virtual const std::string& MooseObject::name ( ) const

inlinevirtualinherited

Get the name of the object.

Returns: The name of the object TODO:MooseVariableToMooseObject (see #10601)

Reimplemented in MooseVariableBase.

Definition at line 70 of file MooseObject.h.

70 { return _name; }

◆ onInterval()

bool Output::onInterval ( )

protectedvirtual

Returns true if the output interval is satisfied.

Definition at line 203 of file Output.C.

 {
   // The output flag to return
   bool output = false;
  
   // Return true if the current step on the current output interval and within the output time range
   // and within the output step range
   if (_time >= _start_time && _time <= _end_time && _t_step >= _start_step &&
       _t_step <= _end_step && (_t_step % _interval) == 0)
     output = true;
  
   // Return false if 'sync_only' is set to true
   if (_sync_only)
     output = false;
  
   // If sync times are not skipped, return true if the current time is a sync_time
   if (_sync_times.find(_time) != _sync_times.end())
     output = true;
  
   // Return the output status
   return output;
 }

Referenced by Console::output(), OversampleOutput::outputStep(), and outputStep().

◆ output()

virtual void Output::output ( const ExecFlagType & type )

protectedpure virtual

Overload this function with the desired output activities.

Implemented in TopResidualDebugOutput, Checkpoint, Nemesis, Console, Exodus, CSV, Gnuplot, SolutionHistory, MaterialPropertyDebugOutput, VariableResidualNormsDebugOutput, DOFMapOutput, GMVOutput, Tecplot, VTKOutput, XDA, ControlOutput, PerfGraphOutput, AdvancedOutput, and PNGOutput.

Referenced by FileOutput::checkFilename(), OutputWarehouse::getOutput(), OutputWarehouse::getOutputNames(), OutputWarehouse::getOutputs(), onInterval(), and outputStep().

◆ outputStep()

void Output::outputStep ( const ExecFlagType & type )

virtual

A single call to this function should output all the necessary data for a single timestep.

Parameters

type	The type execution flag (see Moose.h)

See also: outputNodalVariables outputElementalVariables outputScalarVariables outputPostprocessors

Reimplemented in OversampleOutput.

Definition at line 167 of file Output.C.

 {
   CONSOLE_TIMED_PRINT("Outputting ", name());
  
   // Output is not allowed
   if (!_allow_output && type != EXEC_FORCED)
     return;
  
   // If recovering disable output of initial condition, it was already output
   if (type == EXEC_INITIAL && _app.isRecovering())
     return;
  
   // Return if the current output is not on the desired interval
   if (type != EXEC_FINAL && !onInterval())
     return;
  
   // Call the output method
   if (shouldOutput(type))
   {
     TIME_SECTION(_output_step_timer);
     output(type);
   }
 }

Referenced by PetscOutput::petscLinearOutput(), and PetscOutput::petscNonlinearOutput().

◆ paramError()

template<typename... Args>

void MooseObject::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 215 of file MooseObject.h.

 {
   Moose::show_trace = false;
   mooseError(paramErrorMsg(param, std::forward<Args>(args)...));
   Moose::show_trace = true;
 }

◆ paramErrorMsg()

template<typename... Args>

std::string MooseObject::paramErrorMsg	(	const std::string &	param,
		Args...	args
	)		const

inlineprivateinherited

Definition at line 185 of file MooseObject.h.

   {
     auto prefix = paramErrorPrefix(_pars, param);
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     std::string msg = oss.str();
  
     // Wrap error message to a separate line from prefix if it is about to
     // blow past 100 chars.  But only wrap if the prefix is long enough (12
     // chars) for the wrap to buy us much extra length.
     if ((prefix.size() > 12 && msg.size() + prefix.size() > 99) ||
         msg.find("\n") != std::string::npos)
     {
       if (prefix.size() > 0 && prefix[prefix.size() - 1] != ':')
         prefix += ":";
       return prefix + "\n    " + MooseUtils::replaceAll(msg, "\n", "\n    ");
     }
     return prefix + " " + msg;
   }

Referenced by MooseObject::paramError(), MooseObject::paramInfo(), and MooseObject::paramWarning().

◆ parameters()

const InputParameters& MooseObject::parameters ( ) const

inlineinherited

Get the parameters of the object.

Returns: The parameters of the object

Definition at line 76 of file MooseObject.h.

76 { return _pars; }

◆ paramInfo()

template<typename... Args>

void MooseObject::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 231 of file MooseObject.h.

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

Referenced by TransientMultiApp::TransientMultiApp().

◆ paramWarning()

template<typename... Args>

void MooseObject::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 224 of file MooseObject.h.

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

Referenced by Executioner::Executioner().

◆ registerRestartableDataOnApp()

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

privateinherited

Helper function for actually registering the restartable data.

Definition at line 48 of file Restartable.C.

 {
   return _restartable_app.registerRestartableData(name, std::move(data), tid, false, false);
 }

Referenced by Restartable::declareRestartableDataWithContext().

◆ registerRestartableNameWithFilterOnApp()

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

privateinherited

Helper function for actually registering the restartable data.

Definition at line 56 of file Restartable.C.

 {
   _restartable_app.registerRestartableNameWithFilter(name, filter);
 }

Referenced by Restartable::declareRecoverableData().

◆ registerTimedSection()

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

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 51 of file PerfGraphInterface.C.

 {
   if (_prefix != "")
     return _perf_graph.registerSection(_prefix + "::" + section_name, level);
   else
     return _perf_graph.registerSection(section_name, level);
 }

◆ residualSetup()

void SetupInterface::residualSetup ( )

virtualinherited

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

Reimplemented in NodeFaceConstraint.

Definition at line 59 of file SetupInterface.C.

60 {

61 }

◆ shouldOutput()

bool Output::shouldOutput ( const ExecFlagType & type )

protectedvirtual

Handles logic for determining if a step should be output.

Returns: True if a call if output should be preformed

Reimplemented in FileOutput, PerfGraphOutput, and AdvancedOutput.

Definition at line 192 of file Output.C.

 {
   // Note that in older versions of MOOSE, this was overloaded (unintentionally) to always return
   // true for the Console output subclass - basically ignoring execute_on options specified for
   // the console (e.g. via the input file).
   if (_execute_on.contains(type) || type == EXEC_FORCED)
     return true;
   return false;
 }

Referenced by outputStep(), FileOutput::shouldOutput(), and AdvancedOutput::shouldOutput().

◆ solveSetup()

void Output::solveSetup ( )

protectedvirtual

A method called just prior to the solve, this is used by PetscOutput to perform the necessary setup actions for each timestep.

Reimplemented in PetscOutput.

Definition at line 162 of file Output.C.

163 {

164 }

◆ subdomainSetup()

void SetupInterface::subdomainSetup ( )

virtualinherited

Gets called when the subdomain changes (i.e.

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

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

Definition at line 64 of file SetupInterface.C.

65 {

66 }

◆ time()

Real Output::time ( )

virtual

Get the output time.

Returns: The output time, which may be different than the simulation time

When the Executioner is steady this utilizes the time_step and when Transient the actual time is used.

Reimplemented in PetscOutput.

Definition at line 227 of file Output.C.

 {
   if (_transient)
     return _time;
   else
     return _t_step;
 }

Referenced by PetscOutput::time().

◆ timeOld()

Real Output::timeOld ( )

virtual

Get the old output time.

Returns: The old output time, which may be different than the simulation time

See also: time()

Definition at line 236 of file Output.C.

 {
   if (_transient)
     return _time_old;
   else
     return _t_step - 1;
 }

Referenced by Console::writeTimestepInformation().

◆ timeStep()

int Output::timeStep ( )

virtual

Get the current time step.

Definition at line 263 of file Output.C.

 {
   return _t_step;
 }

Referenced by Checkpoint::filename(), CSV::getVectorPostprocessorFileName(), and Console::writeTimestepInformation().

◆ timestepSetup()

void SetupInterface::timestepSetup ( )

virtualinherited

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

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

Definition at line 49 of file SetupInterface.C.

50 {

51 }

◆ type()

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

inlineinherited

Get the type of this object.

Returns: the name of the type of this object

Definition at line 63 of file MooseObject.h.

63 { return _type; }

◆ validParams()

InputParameters Output::validParams ( )

static

Definition at line 31 of file Output.C.

 {
   // Get the parameters from the parent object
   InputParameters params = MooseObject::validParams();
   params += SetupInterface::validParams();
  
   // Displaced Mesh options
   params.addParam<bool>(
       "use_displaced", false, "Enable/disable the use of the displaced mesh for outputting");
  
   // Output intervals and timing
   params.addParam<unsigned int>(
       "interval", 1, "The interval at which time steps are output to the solution file");
   params.addParam<std::vector<Real>>("sync_times",
                                      "Times at which the output and solution is forced to occur");
   params.addParam<bool>("sync_only", false, "Only export results at sync times");
   params.addParam<Real>("start_time", "Time at which this output object begins to operate");
   params.addParam<Real>("end_time", "Time at which this output object stop operating");
   params.addParam<int>("start_step", "Time step at which this output object begins to operate");
   params.addParam<int>("end_step", "Time step at which this output object stop operating");
   params.addParam<Real>(
       "time_tolerance", 1e-14, "Time tolerance utilized checking start and end times");
  
   // Update the 'execute_on' input parameter for output
   ExecFlagEnum & exec_enum = params.set<ExecFlagEnum>("execute_on", true);
   exec_enum = Output::getDefaultExecFlagEnum();
   exec_enum = {EXEC_INITIAL, EXEC_TIMESTEP_END};
   params.setDocString("execute_on", exec_enum.getDocString());
  
   // Add ability to append to the 'execute_on' list
   params.addParam<ExecFlagEnum>("additional_execute_on", exec_enum, exec_enum.getDocString());
   params.set<ExecFlagEnum>("additional_execute_on").clear();
  
   // 'Timing' group
   params.addParamNamesToGroup("time_tolerance interval sync_times sync_only start_time end_time ",
                               "Timing");
  
   // Add a private parameter for indicating if it was created with short-cut syntax
   params.addPrivateParam<bool>("_built_by_moose", false);
  
   // Register this class as base class
   params.declareControllable("enable");
   params.registerBase("Output");
  
   return params;
 }

Referenced by ControlOutput::validParams(), PetscOutput::validParams(), PerfGraphOutput::validParams(), and MaterialPropertyDebugOutput::validParams().

Friends And Related Function Documentation

◆ OutputWarehouse

friend class OutputWarehouse

friend

Definition at line 249 of file Output.h.

Member Data Documentation

◆ _advanced_execute_on

OutputOnWarehouse Output::_advanced_execute_on

protected

Storage for the individual component execute flags.

Definition at line 244 of file Output.h.

Referenced by advancedExecuteOn(), AdvancedOutput::advancedExecuteOn(), AdvancedOutput::AdvancedOutput(), AdvancedOutput::hasOutput(), AdvancedOutput::hasOutputHelper(), Console::initialSetup(), AdvancedOutput::initialSetup(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), and AdvancedOutput::wantOutput().

◆ _allow_output

bool Output::_allow_output

protected

Flag for disabling output.

Definition at line 235 of file Output.h.

Referenced by allowOutput(), OversampleOutput::outputStep(), and outputStep().

◆ _app

MooseApp& MooseObject::_app

protectedinherited

The MooseApp this object is associated with.

Definition at line 172 of file MooseObject.h.

Referenced by GridPartitioner::_do_partition(), AB2PredictorCorrector::AB2PredictorCorrector(), Executioner::addAttributeReporter(), FEProblemBase::addMaterialHelper(), FEProblemBase::addMultiApp(), FEProblemBase::addOutput(), FEProblemBase::allowOutput(), AStableDirk4::AStableDirk4(), FileMesh::buildMesh(), MeshGeneratorMesh::buildMesh(), MooseMesh::buildMeshBaseObject(), FEProblemBase::checkNonlinearConvergence(), OversampleOutput::cloneMesh(), FEProblemBase::computeJacobianTags(), FEProblemBase::computeResidualTags(), Console::Console(), TimeStepper::constrainStep(), MultiApp::createApp(), MeshGenerator::declareMeshProperty(), DumpObjectsProblem::dumpObjectHelper(), DumpObjectsProblem::dumpVariableHelper(), EigenExecutionerBase::EigenExecutionerBase(), EigenKernel::EigenKernel(), NonlinearEigen::execute(), InversePowerMethod::execute(), Transient::execute(), Steady::execute(), FileOutput::FileOutput(), FEProblemBase::forceOutput(), MeshGenerator::getMesh(), MeshGenerator::getMeshByName(), MooseObject::getMooseApp(), NumRelationshipManagers::getValue(), GhostingUserObject::GhostingUserObject(), NonlinearEigen::init(), InversePowerMethod::init(), Transient::init(), Steady::init(), MooseMesh::init(), NumPicardIterations::initialize(), TimePeriod::initialSetup(), Console::initialSetup(), MultiApp::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initOutputList(), FEProblemBase::initPetscOutput(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), ElementSideNeighborLayers::internalInit(), MeshGeneratorMesh::MeshGeneratorMesh(), MooseObject::mooseError(), EigenExecutionerBase::normalizeSolution(), AugmentSparsityOnInterface::operator()(), PerfGraphOutput::output(), Tecplot::output(), Exodus::output(), Nemesis::output(), ControlOutput::outputActiveObjects(), ControlOutput::outputChangedControls(), ControlOutput::outputControls(), Exodus::outputEmptyTimestep(), Console::outputInput(), Exodus::outputInput(), Exodus::outputNodalVariables(), OversampleOutput::outputStep(), outputStep(), FEProblemBase::outputStep(), Console::outputSystemInformation(), MultiApp::parentOutputPositionChanged(), PerformanceData::PerformanceData(), PetscOutput::petscLinearOutput(), PetscOutput::petscNonlinearOutput(), Eigenvalue::postSolve(), Transient::preExecute(), FEProblemBase::projectSolution(), FEProblemBase::setRestartFile(), TransientMultiApp::setupApp(), TimeSequenceStepperBase::setupSequence(), Transient::setupTimeIntegrator(), TransientMultiApp::solveStep(), FEProblemBase::subdomainSetup(), FEProblemBase::theWarehouse(), TimeExtremeValue::TimeExtremeValue(), TimePeriod::TimePeriod(), FEProblemBase::timestepSetup(), Transient::Transient(), and Console::write().

◆ _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.

◆ _current_execute_flag

const ExecFlagType& SetupInterface::_current_execute_flag

protectedinherited

Reference to FEProblemBase.

Definition at line 99 of file SetupInterface.h.

◆ _dt

Real& Output::_dt

protected

Time step delta.

Definition at line 199 of file Output.h.

Referenced by dt(), and PetscOutput::solveSetup().

◆ _dt_old

Real& Output::_dt_old

protected

Old time step delta.

Definition at line 202 of file Output.h.

Referenced by dtOld(), and Console::writeTimestepInformation().

◆ _empty_execute_enum

ExecFlagEnum SetupInterface::_empty_execute_enum

privateinherited

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

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

Definition at line 89 of file SetupInterface.h.

Referenced by SetupInterface::SetupInterface().

◆ _enabled

const bool& MooseObject::_enabled

protectedinherited

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

Definition at line 181 of file MooseObject.h.

Referenced by MooseObject::enabled().

◆ _end_step

int Output::_end_step

protected

End outputting at this time step.

Definition at line 223 of file Output.h.

Referenced by onInterval().

const std::string& MooseObject::_name

protectedinherited

The name of this object, reference to value stored in InputParameters.

Definition at line 178 of file MooseObject.h.

Referenced by ADPiecewiseLinearInterpolationMaterial< compute_stage >::ADPiecewiseLinearInterpolationMaterial(), PiecewiseBase::buildFromFile(), PiecewiseBase::buildFromXY(), PiecewiseLinearBase::buildInterpolation(), CentroidMultiApp::fillPositions(), MultiApp::fillPositions(), FunctionDT::FunctionDT(), MooseObject::name(), PiecewiseBilinear::parse(), PiecewiseBase::PiecewiseBase(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), DerivativeParsedMaterialHelper::recurseDerivative(), PiecewiseBase::setData(), Split::setup(), and VectorPostprocessorFunction::VectorPostprocessorFunction().

◆ _num

unsigned int Output::_num

protected

The number of outputs written.

Definition at line 205 of file Output.h.

◆ _output_step_timer

PerfID Output::_output_step_timer

protected

Timers.

Definition at line 247 of file Output.h.

Referenced by OversampleOutput::outputStep(), and outputStep().

◆ _pars

const InputParameters& MooseObject::_pars

protectedinherited

Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.

Definition at line 169 of file MooseObject.h.

Referenced by GridPartitioner::_do_partition(), BreakMeshByBlockGeneratorBase::BreakMeshByBlockGeneratorBase(), PNGOutput::calculateRescalingValues(), BreakMeshByBlockBase::checkInputParameter(), RandomPartitioner::clone(), PetscExternalPartitioner::clone(), BlockWeightedPartitioner::clone(), GridPartitioner::clone(), Console::Console(), Eigenvalue::execute(), Executioner::Executioner(), FEProblemSolve::FEProblemSolve(), FunctionMaterialBase::FunctionMaterialBase(), ParsedMaterialHelper::functionParse(), ExtraNodesetGenerator::generate(), MooseObject::getParamTempl(), GeneralUserObject::getPostprocessorValue(), InitialConditionBase::getUserObjectBase(), InitialConditionBase::getUserObjectTempl(), GeneralUserObject::getVectorPostprocessorValue(), Transient::init(), AdvancedOutput::initExecutionTypes(), Console::initialSetup(), MooseObject::isParamValid(), AddExtraNodeset::modify(), MooseObject::paramErrorMsg(), MooseObject::parameters(), MooseMesh::setPartitionerHelper(), and Transient::setupTimeIntegrator().

◆ _perf_graph

PerfGraph& PerfGraphInterface::_perf_graph

protectedinherited

The performance graph to add to.

Definition at line 67 of file PerfGraphInterface.h.

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

THREAD_ID Restartable::_restartable_tid

privateinherited

The thread ID for this object.

Definition at line 217 of file Restartable.h.

Referenced by Restartable::declareRestartableDataWithContext().

const std::string& MooseObject::_type

protectedinherited

The type of this object (the Class name)

Definition at line 175 of file MooseObject.h.

Referenced by FEProblemBase::init(), and MooseObject::type().

◆ _use_displaced

bool Output::_use_displaced

protected

Flag for using displaced mesh.

Definition at line 175 of file Output.h.

Referenced by Output().

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

include/outputs/Output.h
src/outputs/Output.C

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Output()

Member Function Documentation

◆ addDeprecatedInputParameters()

◆ advancedExecuteOn()

◆ allowOutput()

◆ declareRecoverableData() [1/2]

◆ declareRecoverableData() [2/2]

◆ declareRestartableDataTempl() [1/2]

◆ declareRestartableDataTempl() [2/2]

◆ declareRestartableDataWithContext() [1/2]

◆ declareRestartableDataWithContext() [2/2]

◆ declareRestartableDataWithObjectName()

◆ declareRestartableDataWithObjectNameWithContext()

◆ declareRestartableDataWithPrefixOverrideAndContext()

◆ dt()

◆ dtOld()

◆ enabled()

◆ execBitFlags()

◆ execFlags()

◆ executeOn()

◆ getCheckedPointerParam()

◆ getDefaultExecFlagEnum()

◆ getExecuteOnEnum()

◆ getExecuteOptions()

◆ getMooseApp()

◆ getParamTempl()

◆ initialSetup()

◆ interval()

◆ isAdvanced()

◆ isParamValid()

◆ jacobianSetup()

◆ meshChanged()

◆ mooseDeprecated()

◆ mooseError()

◆ mooseInfo()

◆ mooseWarning()

◆ name()

◆ onInterval()

◆ output()

◆ outputStep()

◆ paramError()

◆ paramErrorMsg()

◆ parameters()

◆ paramInfo()

◆ paramWarning()

◆ registerRestartableDataOnApp()

◆ registerRestartableNameWithFilterOnApp()

◆ registerTimedSection()

◆ residualSetup()

◆ shouldOutput()

◆ solveSetup()

◆ subdomainSetup()

◆ time()

◆ timeOld()

◆ timeStep()

◆ timestepSetup()

◆ type()

◆ validParams()

Friends And Related Function Documentation

◆ OutputWarehouse

Member Data Documentation

◆ _advanced_execute_on

◆ _allow_output

◆ _app

◆ _console

◆ _current_execute_flag

◆ _dt

◆ _dt_old

◆ _empty_execute_enum

◆ _enabled