Based class for providing re-positioning and oversampling support to output objects. More...

#include <SampledOutput.h>

Inheritance diagram for SampledOutput:

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

Public Member Functions
	SampledOutput (const InputParameters &parameters)

virtual	~SampledOutput ()

virtual void	initialSetup () override
	Call init() method on setup. More...

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

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

virtual bool	hasOutput ()
	Returns true if any of the other has methods return true. More...

bool	hasOutput (const ExecFlagType &type)
	Tests that any output exist for the given output type. More...

bool	hasNodalVariableOutput ()
	Returns true if there exists nodal nonlinear variables for output. More...

const std::set< std::string > &	getNodalVariableOutput ()
	The list of nodal nonlinear variables names that are set for output. More...

bool	hasElementalVariableOutput ()
	Returns true if there exists elemental nonlinear variables for output. More...

const std::set< std::string > &	getElementalVariableOutput ()
	The list of elemental nonlinear variables names that are set for output. More...

bool	hasScalarOutput ()
	Returns true if there exists scalar variables for output. More...

const std::set< std::string > &	getScalarOutput ()
	The list of scalar variables names that are set for output. More...

bool	hasPostprocessorOutput ()
	Returns true if there exists postprocessors for output. More...

const std::set< std::string > &	getPostprocessorOutput ()
	The list of postprocessor names that are set for output. More...

bool	hasVectorPostprocessorOutput ()
	Returns true if there exists VectorPostprocessors for output. More...

const std::set< std::string > &	getVectorPostprocessorOutput ()
	The list of VectorPostprocessor names that are set for output. More...

bool	hasReporterOutput ()
	Returns true if there exists Reporter for output. More...

const std::set< std::string > &	getReporterOutput ()
	The list of Reporter names that are set for output. More...

const OutputOnWarehouse &	advancedExecuteOn () const
	Get the current advanced 'execute_on' selections for display. More...

virtual std::string	filename ()
	The filename for the output file. More...

void	setFileBase (const std::string &file_base)
	Sets the file base string if the 'file_base' parameter is not set. More...

void	setFileNumber (unsigned int num)
	Sets the file number manually. More...

unsigned int	getFileNumber ()
	Return the current file number for this outputter. More...

virtual Real	time () override
	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...

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

const std::set< Real > &	getSyncTimes ()

virtual bool	supportsMaterialPropertyOutput () const
	A virtual function that stores whether output type supports material output. More...

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

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

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

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

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

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

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

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

MooseObjectName	uniqueName () const

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

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

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

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

template<typename T >
const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const
	Retrieve a renamed 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...

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

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

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

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

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

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

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

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

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

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

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

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

std::string	getDataFilePath (const std::string &relative_path) const
	Returns the path of a data file for a given relative file path. 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...

virtual void	customSetup (const ExecFlagType &)
	Gets called in FEProblemBase::execute() for execute flags other than initial, timestep_begin, nonlinear, linear and subdomain. More...

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

const Function &	getFunction (const std::string &name) const
	Get a function with a given name. More...

const Function &	getFunctionByName (const FunctionName &name) const
	Get a function with a given name. More...

bool	hasFunction (const std::string &param_name) const
	Determine if the function exists. More...

bool	hasFunctionByName (const FunctionName &name) const
	Determine if the function exists. More...

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

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

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

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

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

const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
	DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast. More...

const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
	Retrieve the value of a VectorPostprocessor. More...

const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
	DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast. More...

const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
	Retrieve the value of the VectorPostprocessor. More...

const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
	DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast. More...

const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const
	Retrieve the old value of a VectorPostprocessor. More...

const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
	DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast. More...

const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const
	Retrieve the old value of a VectorPostprocessor. More...

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const
	Return the scatter value for the post processor. More...

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const
	Return the scatter value for the post processor. More...

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const
	Return the old scatter value for the post processor. More...

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const
	Return the old scatter value for the post processor. More...

bool	hasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const
	Determine if the VectorPostprocessor data exists by parameter. More...

bool	hasVectorPostprocessor (const std::string &param_name) const
	Determine if the VectorPostprocessor exists by parameter. More...

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const
	Determine if the VectorPostprocessor data exists by name. More...

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name) const
	Determine if the VectorPostprocessor exists by name. More...

const VectorPostprocessorName &	getVectorPostprocessorName (const std::string &param_name) const
	Get the name of a VectorPostprocessor associated with a parameter. More...

PerfGraph &	perfGraph ()
	Get the PerfGraph. More...


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

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

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const


bool	isVectorPostprocessorDistributed (const std::string &param_name) const
	Return true if the VectorPostprocessor is marked with parallel_type as DISTRIBUTED. More...

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

Static Public Member Functions
static InputParameters	validParams ()

static InputParameters	enableOutputTypes (const std::string &names=std::string())
	A method for enabling individual output type control. More...

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 void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node)
	External method for calling moose error with added object context. More...

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

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

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

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

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

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

Protected Member Functions
virtual void	updateSample ()
	Performs the update of the solution vector for the sample/re-positioned mesh. More...

virtual void	setFileBaseInternal (const std::string &file_base) override
	Appends the base class's file base string. More...

virtual void	init ()
	Populates the various data structures needed to control the output. More...

void	hideAdditionalVariable (const std::string &category, const std::string &var_name)
	Add an additional variable to the hide list. More...

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

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

virtual void	outputNodalVariables ()
	Performs output of nodal nonlinear variables The child class must define this method to output the nonlinear variables as desired. More...

virtual void	outputElementalVariables ()
	Performs output of elemental nonlinear variables The child class must define this method to output the nonlinear variables as desired. More...

virtual void	outputScalarVariables ()
	Performs output of scalar variables The child class must define this method to output the scalar variables as desired. More...

virtual void	outputPostprocessors ()
	Performs output of postprocessors The child class must define this method to output the postprocessors as desired. More...

virtual void	outputVectorPostprocessors ()
	Performs output of VectorPostprocessors The child class must define this method to output the VectorPostprocessors as desired. More...

virtual void	outputInput ()
	Performs the output of the input file By default this method does nothing and is not called, the individual Output objects are responsible for calling it. More...

virtual void	outputSystemInformation ()

virtual void	outputReporters ()
	Output Reporter values. More...

bool	checkFilename ()
	Checks the filename for output Checks the output against the 'output_if_base_contians' list. More...

bool	inNonlinearTimeWindow ()

bool	inLinearTimeWindow ()

virtual Real	getOutputTime ()
	Get the time that will be used for stream/file outputting. More...

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

void	setWallTimeIntervalFromCommandLineParam ()
	Function to set the wall time interval based on value of command line parameter (used for testing only). More...

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

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

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

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

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

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

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

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

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

virtual void	addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &) const
	Helper for deriving classes to override to add dependencies when a VectorPostprocessor is requested. More...

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

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

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

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

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


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

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

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

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

Static Protected Member Functions
static PetscErrorCode	petscNonlinearOutput (SNES, PetscInt its, PetscReal fnorm, void *void_ptr)
	Performs the output on non-linear iterations This is the monitor method that PETSc will call on non-linear iterations. More...

static PetscErrorCode	petscLinearOutput (KSP, PetscInt its, PetscReal fnorm, void *void_ptr)
	Performs the output onlinear iterations This is the monitor method that PETSc will call on linear iterations. More...

Protected Attributes
const unsigned int	_refinements
	The number of oversampling refinements. More...

const bool	_using_external_sampling_file
	Flag indicating another file is being used for the sampling. More...

const bool	_change_position
	Flag for re-positioning. More...

bool	_use_sampled_output
	Flag indicating that the sampled output should be used to re-sample the underlying EquationSystem of the output. More...

bool	_elemental_as_nodal
	Flags to control nodal output. More...

bool	_scalar_as_nodal

const ReporterData &	_reporter_data
	Storage for Reporter values. More...

unsigned int &	_file_num
	A file number counter, initialized to 0 (this must be controlled by the child class, see Exodus) More...

unsigned int	_padding
	Number of digits to pad the extensions. More...

std::vector< std::string >	_output_if_base_contains
	Storage for 'output_if_base_contains'. More...

std::string	_file_base
	The base filename from the input paramaters. More...

Real	_norm
	Current norm returned from PETSc. More...

PetscInt	_nonlinear_iter
	Current non-linear iteration returned from PETSc. More...

PetscInt	_linear_iter
	Current linear iteration returned from PETSc. More...

bool	_on_linear_residual
	True if current output calls is on the linear residual (used by time()) More...

bool	_on_nonlinear_residual
	True if current output call is on the non-linear residual (used by time()) More...

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

libMesh::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...

ExecFlagType	_current_execute_flag
	Current execute on flag. 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 bool	_time_step_interval_set_by_addparam
	Whether time step interval is set by AddParam. More...

unsigned int	_time_step_interval
	The output time step interval. More...

const Real	_min_simulation_time_interval
	Minimum simulation time between outputs. More...

const Real	_simulation_time_interval
	Target simulation time between outputs. More...

Real	_wall_time_interval
	Target wall time between outputs in seconds. More...

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

const Times *const	_sync_times_object
	Sync times object 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	_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...

Real &	_last_output_simulation_time
	last simulation time an output has occured More...

std::chrono::time_point< std::chrono::steady_clock >	_last_output_wall_time
	last wall time an output has occured More...

Real	_wall_time_since_last_output
	time in seconds since last output More...

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

MooseApp &	_app
	The MOOSE application this is associated with. More...

Factory &	_factory
	The Factory associated with the MooseApp. More...

ActionFactory &	_action_factory
	Builds Actions. More...

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

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

const InputParameters &	_pars
	The object's parameters. More...

const Parallel::Communicator &	_communicator

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

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

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

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

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

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

MooseApp &	_pg_moose_app
	The MooseApp that owns the PerfGraph. More...

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

PetscOutput *	_petsc_output

Private Member Functions
void	initSample ()
	Setups the output object to produce re-positioned and/or sampled results. More...

void	cloneMesh ()
	Clone mesh in preperation for re-positioning or oversampling. More...

bool	isSampledAtNodes (const FEType &fe_type) const
	Used to decide which variable is sampled at nodes, then output as a nodal variable for (over)sampling purposes If not sampled at nodes, it is sampled at centroids and output as a constant monomial. More...

Private Attributes
std::vector< std::vector< std::unique_ptr< libMesh::MeshFunction > > >	_mesh_functions
	A vector of pointers to the mesh functions on the sampled mesh This is only populated when the initSample() function is called, it must be cleaned up by the destructor. More...

std::vector< std::vector< unsigned int > >	_variable_numbers_in_system
	A vector of vectors that keeps track of the variable numbers in each system for each mesh function. More...

Point	_position
	When oversampling, the output is shift by this amount. More...

bool	_sampling_mesh_changed
	A flag indicating that the mesh has changed and the sampled mesh needs to be re-initialized. More...

bool	_mesh_subdomains_match
	A flag tracking whether the sampling and source meshes match in terms of subdomains. More...

bool	_serialize
	Flag indicating whether we are outputting in serial or parallel. More...

std::unique_ptr< EquationSystems >	_sampling_es
	Equation system holding the solution vectors for the sampled variables. More...

std::unique_ptr< MooseMesh >	_sampling_mesh_ptr
	Mesh used for sampling. The Output class' _mesh_ptr will refer to this mesh if sampling is being used. More...

std::unique_ptr< NumericVector< Number > >	_serialized_solution
	Sample solution vector. More...

Detailed Description

Based class for providing re-positioning and oversampling support to output objects.

This class performs the actual oversampling calculations and makes the correct changes to the libMesh::EquationsSystems() pointer (_es_ptr), i.e., this pointer is will point to the sampled system, if sampling/oversampling is utilized.

The use of sampling is triggered by specifying one of the sampling parameters:

refinements
sampling block restriction
a mesh file to sample on
a position offset
See also
Exodus

Definition at line 39 of file SampledOutput.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

◆ SampledOutput()

SampledOutput::SampledOutput ( const InputParameters & parameters )

Definition at line 61 of file SampledOutput.C.

   : AdvancedOutput(parameters),
     _refinements(getParam<unsigned int>("refinements")),
     _using_external_sampling_file(isParamValid("file")),
     _change_position(isParamValid("position")),
     _use_sampled_output(_refinements > 0 || _using_external_sampling_file ||
                         isParamValid("sampling_blocks") || _change_position),
     _position(_change_position ? getParam<Point>("position") : Point()),
     _sampling_mesh_changed(true),
     _mesh_subdomains_match(true),
     _serialize(getParam<bool>("serialize_sampling"))
 {
 }

◆ ~SampledOutput()

SampledOutput::~SampledOutput ( )

virtual

Definition at line 116 of file SampledOutput.C.

 {
   // TODO: Remove once libmesh Issue #1184 is fixed
   _sampling_es.reset();
   _sampling_mesh_ptr.reset();
 }

Member Function Documentation

◆ addDeprecatedInputParameters()

static void Output::addDeprecatedInputParameters ( InputParameters & params )

staticinherited

A static helper for injecting deprecated parameters.

◆ 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 AuxKernelTempl< ComputeValueType >, AuxKernelTempl< RT >, AuxKernelTempl< RealVectorValue >, AuxKernelTempl< Real >, UserObject, and InitialConditionBase.

Definition at line 141 of file PostprocessorInterface.h.

Referenced by PostprocessorInterface::getPostprocessorValueByNameInternal().

141 {}

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

Definition at line 105 of file ReporterInterface.h.

Referenced by ReporterInterface::getReporterValueByName().

105 {}

◆ addVectorPostprocessorDependencyHelper()

virtual void VectorPostprocessorInterface::addVectorPostprocessorDependencyHelper ( const VectorPostprocessorName & ) const

inlineprotectedvirtualinherited

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

Reimplemented in AuxKernelTempl< ComputeValueType >, AuxKernelTempl< RT >, AuxKernelTempl< RealVectorValue >, AuxKernelTempl< Real >, and UserObject.

Definition at line 311 of file VectorPostprocessorInterface.h.

Referenced by VectorPostprocessorInterface::getVectorPostprocessorByNameHelper(), and VectorPostprocessorInterface::getVectorPostprocessorContextByNameHelper().

312 {

313 }

◆ advancedExecuteOn()

const OutputOnWarehouse & AdvancedOutput::advancedExecuteOn ( ) const

virtualinherited

Get the current advanced 'execute_on' selections for display.

Reimplemented from Output.

Definition at line 874 of file AdvancedOutput.C.

Referenced by CSV::initialSetup().

 {
   return _advanced_execute_on;
 }

◆ allowOutput()

void Output::allowOutput ( bool state )

inlineinherited

Method for controlling the allow output state.

Parameters

state The state to set the allow flag to

Definition at line 129 of file Output.h.

129 { _allow_output = state; }

Output::_allow_output

bool _allow_output

Flag for disabling output.

Definition: Output.h:271

◆ callMooseError() [1/2]

void MooseBase::callMooseError	(	std::string	msg,
		const bool	with_prefix,
		const hit::Node *	node = `nullptr`
	)		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

Definition at line 102 of file MooseBase.C.

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

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

◆ callMooseError() [2/2]

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

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

Definition at line 110 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);
 }

◆ checkFilename()

bool FileOutput::checkFilename ( )

protectedinherited

Checks the filename for output Checks the output against the 'output_if_base_contians' list.

Returns: Returns true if the filename is valid for output

Definition at line 88 of file FileOutput.C.

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

 {
   // Return true if 'output_if_base_contains' is not utilized
   if (_output_if_base_contains.empty())
     return true;
 
   // Assumed output is false
   bool output = false;
 
   // Loop through each string in the list
   for (const auto & search_string : _output_if_base_contains)
   {
     // Search for the string in the file base, if found set the output to true and break the loop
     if (_file_base.find(search_string) != std::string::npos)
     {
       output = true;
       break;
     }
   }
 
   // Return the value
   return output;
 }

◆ cloneMesh()

void SampledOutput::cloneMesh ( )

private

Clone mesh in preperation for re-positioning or oversampling.

This changes the pointer, _mesh_ptr, with a clone of the current mesh so that it may be modified to perform the necessary sample/positioning/block-restriction actions

Definition at line 443 of file SampledOutput.C.

Referenced by initSample().

 {
   // Create the new mesh from a file
   if (isParamValid("file"))
   {
     InputParameters mesh_params = _app.getFactory().getValidParams("FileMesh");
     mesh_params.applyParameters(parameters(), {}, true);
     mesh_params.set<bool>("nemesis") = false;
     _sampling_mesh_ptr =
         _app.getFactory().createUnique<MooseMesh>("FileMesh", "output_problem_mesh", mesh_params);
     _sampling_mesh_ptr->allowRecovery(false); // We actually want to reread the initial mesh
     _sampling_mesh_ptr->init();
   }
   // Clone the existing mesh
   else
   {
     if (_app.isRecovering())
       mooseWarning("Recovering or Restarting with oversampling may not work (especially with "
                    "adapted meshes)!!  Refs #2295");
     _sampling_mesh_ptr = _mesh_ptr->safeClone();
   }
 
   // Remove unspecified blocks
   if (isParamValid("sampling_blocks"))
   {
     // Remove all elements not in the blocks
     const auto & blocks_to_keep_names = getParam<std::vector<SubdomainName>>("sampling_blocks");
     const auto & blocks_to_keep = _sampling_mesh_ptr->getSubdomainIDs(blocks_to_keep_names);
     for (const auto & elem_ptr : _sampling_mesh_ptr->getMesh().element_ptr_range())
       if (std::find(blocks_to_keep.begin(), blocks_to_keep.end(), elem_ptr->subdomain_id()) ==
           blocks_to_keep.end())
         _sampling_mesh_ptr->getMesh().delete_elem(elem_ptr);
 
     // Deleting elements and isolated nodes would cause renumbering. Not renumbering might help
     // user examining the sampling mesh and the regular mesh. Also if we end up partitioning the
     // elements, the node partitioning is unlikely to match if the element numbering is different.
     // Still not enough of a guarantee, because of deleted elements the node partitioning could be
     // different. We will rely on ghosting to make it work
     _sampling_mesh_ptr->getMesh().allow_renumbering(false);
   }
 
   // Set a partitioner
   if (!_serialize)
   {
     _sampling_mesh_ptr->setIsCustomPartitionerRequested(true);
     InputParameters partition_params = _app.getFactory().getValidParams("CopyMeshPartitioner");
     partition_params.set<MooseMesh *>("mesh") = _sampling_mesh_ptr.get();
     partition_params.set<MooseMesh *>("source_mesh") = _mesh_ptr;
     std::shared_ptr<MoosePartitioner> mp = _factory.create<MoosePartitioner>(
         "CopyMeshPartitioner", "sampled_output_part", partition_params);
     _sampling_mesh_ptr->setCustomPartitioner(mp.get());
 
     _sampling_mesh_ptr->getMesh().prepare_for_use();
     // this should be called by prepare_for_use, but is not.
     // it also requires a prior call to prepare_for_use()
     mp->partition(_sampling_mesh_ptr->getMesh(), comm().size());
   }
 
   // Prepare mesh, needed for the mesh functions
   if (_using_external_sampling_file)
     _sampling_mesh_ptr->prepare(/*mesh to clone*/ nullptr);
   else if (_serialize && isParamValid("sampling_blocks"))
     // TODO: constraints have not been initialized?
     _sampling_mesh_ptr->getMesh().prepare_for_use();
 
   if (_serialize)
     // we want to avoid re-partitioning, as we will serialize anyway
     _sampling_mesh_ptr->getMesh().skip_partitioning(true);
 
   // Make sure that the mesh pointer points to the newly cloned mesh
   _mesh_ptr = _sampling_mesh_ptr.get();
 
   // Check the source and target mesh in case their subdomains match
   const std::vector<SubdomainID> mesh_subdomain_ids_vec(_mesh_ptr->meshSubdomains().begin(),
                                                         _mesh_ptr->meshSubdomains().end());
   const std::vector<SubdomainID> initial_mesh_subdomain_ids_vec(
       _problem_ptr->mesh().meshSubdomains().begin(), _problem_ptr->mesh().meshSubdomains().end());
   _mesh_subdomains_match =
       (_mesh_ptr->meshSubdomains() == _problem_ptr->mesh().meshSubdomains() &&
        _mesh_ptr->getSubdomainNames(mesh_subdomain_ids_vec) ==
            _problem_ptr->mesh().getSubdomainNames(initial_mesh_subdomain_ids_vec));
   if (_using_external_sampling_file && !_mesh_subdomains_match)
     mooseInfoRepeated("Variable block restriction disabled in sampled output due to non-matching "
                       "subdomain names and ids");
 }

◆ 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 74 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);
     }
   }
 }

◆ 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 129 of file PostprocessorInterface.C.

Referenced by FunctionValuePostprocessor::FunctionValuePostprocessor().

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

◆ customSetup()

virtual void SetupInterface::customSetup ( const ExecFlagType & )

inlinevirtualinherited

Gets called in FEProblemBase::execute() for execute flags other than initial, timestep_begin, nonlinear, linear and subdomain.

Reimplemented in Function.

Definition at line 61 of file SetupInterface.h.

61 {}

◆ 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 276 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 351 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 269 of file Restartable.h.

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

◆ 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 294 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 323 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 333 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;
 }

◆ dt()

Real Output::dt ( )

virtualinherited

Get the current time step size.

Definition at line 371 of file Output.C.

Referenced by Console::writeTimestepInformation().

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

◆ dtOld()

Real Output::dtOld ( )

virtualinherited

Get old time step size.

Definition at line 380 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 39 of file MooseObject.h.

Referenced by EigenKernel::enabled().

39 { return _enabled; }

MooseObject::_enabled

const bool & _enabled

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

Definition: MooseObject.h:50

◆ enableOutputTypes()

InputParameters AdvancedOutput::enableOutputTypes ( const std::string & names = std::string() )

staticinherited

A method for enabling individual output type control.

Parameters

names (optional) Space separated of output type names that are supported by this Output object, if this is omitted all outputs types will be supported. The list of available output types is given below.

Output objects vary widely in what type of outputs they support (e.g., elemental variables, or postprocessor data). This method provides the user a means for controlling the types of outputs that are supported for the object being created. This is a static method that MUST be used to append parameters inside the objects validParams function.

List of Output Types and Method Names The output system is designed around overloading virtual method calls to output the various output types, the following list gives the name of the output type and the associated virtual method that should be overloaded to perform the output in the object being created.

Type virtual Method Name

nodal outputNodalVariables() elemental outputElementalVariables() scalar outputScalarVariables() postprocessor outputPostprocessors() vector_postprocessor outputVectorPostprocessors() input outputInput() system_information outputSystemInformation()

See also: CSV Exodus

Definition at line 117 of file AdvancedOutput.C.

Referenced by JSONOutput::validParams(), XMLOutput::validParams(), Console::validParams(), Exodus::validParams(), and TableOutput::validParams().

 {
   // The parameters object that will be returned
   InputParameters params = emptyInputParameters();
 
   // Get the MultiEnum of output types
   MultiMooseEnum output_types = getOutputTypes();
 
   // Update the enum of output types to append
   if (names.empty())
     output_types = output_types.getRawNames();
   else
     output_types = names;
 
   // Add the parameters and return them
   addValidParams(params, output_types);
   return params;
 }

◆ errorPrefix()

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

inlineinherited

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

Definition at line 260 of file MooseBase.h.

260 { return messagePrefix(); }

MooseBase::messagePrefix

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

Definition: MooseBase.h:252

◆ executeOn()

const MultiMooseEnum & Output::executeOn ( ) const

inherited

Get the current 'execute_on' selections for display.

Definition at line 395 of file Output.C.

 {
   return _execute_on;
 }

◆ filename()

std::string FileOutput::filename ( )

virtualinherited

The filename for the output file.

Returns: A string of output file including the extension, by default this returns _file_base

Reimplemented in Exodus, Checkpoint, Nemesis, Console, CSV, Gnuplot, SolutionHistory, Tecplot, XDA, VTKOutput, GMVOutput, DOFMapOutput, JSONOutput, and XMLOutput.

Definition at line 113 of file FileOutput.C.

 {
   return _file_base;
 }

◆ getBase()

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

inlineinherited

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

Definition at line 143 of file MooseBase.h.

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

143 { return _pars.getBase(); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:362

InputParameters::getBase

const std::string & getBase() const

Definition: InputParameters.C:497

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

Referenced by DataFileInterface::getDataFileNameByName().

 {
   // 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.");
 
   // Throw on error so that if getPath() fails, we can throw an error
   // with the context of _parent.mooseError()
   const auto throw_on_error_before = Moose::_throw_on_error;
   Moose::_throw_on_error = true;
   std::optional<std::string> error;
 
   // This will search the data paths for this relative path
   Moose::DataFileUtils::Path found_path;
   try
   {
     found_path = Moose::DataFileUtils::getPath(relative_path);
   }
   catch (std::exception & e)
   {
     error = e.what();
   }
 
   Moose::_throw_on_error = throw_on_error_before;
   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;
 }

◆ getDefaultExecFlagEnum()

ExecFlagEnum Output::getDefaultExecFlagEnum ( )

staticinherited

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

Definition at line 112 of file Output.C.

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

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

◆ getElementalVariableOutput()

const std::set< std::string > & AdvancedOutput::getElementalVariableOutput ( )

inherited

The list of elemental nonlinear variables names that are set for output.

Returns: A vector of strings containing the names of the nonlinear variables for output

See also: hasElementalVariableOutput

Definition at line 820 of file AdvancedOutput.C.

Referenced by initSample(), and Exodus::outputElementalVariables().

 {
   return _execute_data["elemental"].output;
 }

◆ getExecuteOnEnum()

const ExecFlagEnum & SetupInterface::getExecuteOnEnum ( ) const

inherited

Return the execute on MultiMooseEnum for this object.

Definition at line 66 of file SetupInterface.C.

Referenced by MultiAppTransfer::checkMultiAppExecuteOn(), EigenProblem::checkProblemIntegrity(), Control::Control(), EigenExecutionerBase::init(), MultiAppConservativeTransfer::initialSetup(), IntegralPreservingFunctionIC::initialSetup(), Terminator::initialSetup(), Exodus::outputSetup(), NodalReporter::shouldStore(), ElementReporter::shouldStore(), and GeneralReporter::shouldStore().

 {
   return _execute_enum;
 }

◆ getFileNumber()

unsigned int FileOutput::getFileNumber ( )

inherited

Return the current file number for this outputter.

This method was implemented for the MultiApp system, particularly when reseting an application and a new output file is desired after the reset.

Definition at line 180 of file FileOutput.C.

Referenced by OutputWarehouse::getFileNumbers(), and MFEMDataCollection::output().

 {
   return _file_num;
 }

◆ getFunction()

const Function & FunctionInterface::getFunction ( const std::string & name ) const

inherited

Get a function with a given name.

Parameters

name	The name of the parameter key of the function to retrieve

Returns: The function with name associated with the parameter 'name'

Definition at line 30 of file FunctionInterface.C.

Referenced by FunctionDT::FunctionDT(), and Output::Output().

 {
   return _fni_feproblem.getFunction(_fni_params.get<FunctionName>(name), _fni_tid);
 }

◆ getFunctionByName()

const Function & FunctionInterface::getFunctionByName ( const FunctionName & name ) const

inherited

Get a function with a given name.

Parameters

name	The name of the function to retrieve

Returns: The function with name 'name'

Definition at line 36 of file FunctionInterface.C.

Referenced by ArrayBodyForce::ArrayBodyForce(), ArrayFunctionIC::ArrayFunctionIC(), CompositeFunction::CompositeFunction(), FunctionArrayAux::FunctionArrayAux(), FunctionScalarAux::FunctionScalarAux(), FunctionScalarIC::FunctionScalarIC(), GenericFunctionMaterialTempl< is_ad >::GenericFunctionMaterialTempl(), GenericFunctionRankTwoTensorTempl< is_ad >::GenericFunctionRankTwoTensorTempl(), GenericFunctionVectorMaterialTempl< is_ad >::GenericFunctionVectorMaterialTempl(), LinearCombinationFunction::LinearCombinationFunction(), and LineFunctionSampler::LineFunctionSampler().

 {
   return _fni_feproblem.getFunction(name, _fni_tid);
 }

◆ getHitNode()

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

inlineinherited

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

Definition at line 132 of file MooseBase.h.

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

132 { return getHitNode(_pars); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:362

MooseBase::getHitNode

const hit::Node * getHitNode() const

Definition: MooseBase.h:132

◆ getMooseApp()

MooseApp& MooseBase::getMooseApp ( ) const

inlineinherited

Get the MooseApp this class is associated with.

Definition at line 83 of file MooseBase.h.

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(), MortarData::createMortarInterface(), EigenProblem::doFreeNonlinearPowerIterations(), Terminator::execute(), FEProblemSolve::FEProblemSolve(), SolutionInvalidInterface::flagInvalidSolutionInternal(), ChainControl::getChainControlDataSystem(), DefaultConvergenceBase::getSharedExecutionerParam(), ChainControlDataPostprocessor::initialSetup(), MaterialPropertyInterface::MaterialPropertyInterface(), MooseVariableDataFV< OutputType >::MooseVariableDataFV(), ProgressOutput::output(), PetscOutputInterface::petscLinearOutput(), PetscOutputInterface::petscNonlinearOutput(), PetscOutputInterface::PetscOutputInterface(), PostprocessorInterface::postprocessorsAdded(), MultiApp::preTransfer(), Reporter::Reporter(), ReporterInterface::reportersAdded(), MultiApp::restore(), and VectorPostprocessorInterface::vectorPostprocessorsAdded().

83 { return _app; }

MooseBase::_app

MooseApp & _app

The MOOSE application this is associated with.

Definition: MooseBase.h:353

◆ getNodalVariableOutput()

const std::set< std::string > & AdvancedOutput::getNodalVariableOutput ( )

inherited

The list of nodal nonlinear variables names that are set for output.

Returns: A vector of strings containing the names of the nodal nonlinear variables for output

Note: The list returned by this will contain the names of both elemental and nodal variable names if 'elemental_as_nodal = true' in the input file. The libMesh output system (EquationSystems::build_solution_vector) performs the correct action within the solution vector by setting the nodal values as the average of the values for each of the element that the node shares.

See also: hasNodalVariableOutput

Definition at line 808 of file AdvancedOutput.C.

Referenced by initSample(), and Exodus::outputNodalVariables().

 {
   return _execute_data["nodal"].output;
 }

◆ getOutputTime()

Real PetscOutput::getOutputTime ( )

protectedvirtualinherited

Get the time that will be used for stream/file outputting.

This method is intended to override the output given by time() for cases that do not conform to the linear, nonlinear, time step pattern. For example, this can be used for optimization or fixed point iteration solves. If you override this method for your application, replace time() calls with getOutputTime() calls and ensure output consistency.

Definition at line 273 of file PetscOutput.C.

Referenced by Tecplot::output(), Exodus::outputEmptyTimestep(), Exodus::outputNodalVariables(), TableOutput::outputPostprocessorsRow(), TableOutput::outputReporter(), TableOutput::outputScalarVariables(), TableOutput::shouldOutputPostprocessorsRow(), and Console::writeTimestepInformation().

 {
   return time();
 }

◆ 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 384 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 421 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 185 of file PostprocessorInterface.C.

Referenced by EigenKernel::EigenKernel().

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

◆ getPostprocessorOutput()

const std::set< std::string > & AdvancedOutput::getPostprocessorOutput ( )

inherited

The list of postprocessor names that are set for output.

Returns: A vector of strings containing the names of the postprocessor variables for output

See also: hasPostprocessorOutput

Definition at line 844 of file AdvancedOutput.C.

Referenced by CSV::initialSetup(), Exodus::outputPostprocessors(), TableOutput::outputPostprocessorsRow(), and TableOutput::shouldOutputPostprocessorsRow().

 {
   return _execute_data["postprocessors"].output;
 }

◆ 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 36 of file PostprocessorInterface.C.

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

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

◆ 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 57 of file PostprocessorInterface.C.

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

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

◆ getPostprocessorValueOld()

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

inherited

Definition at line 43 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 63 of file PostprocessorInterface.C.

Referenced by EigenKernel::EigenKernel().

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

◆ getPostprocessorValueOlder()

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

inherited

Definition at line 50 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 69 of file PostprocessorInterface.C.

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

◆ 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 398 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 49 of file ReporterInterface.C.

Referenced by WebServerControl::startServer().

 {
   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 59 of file ReporterInterface.C.

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

 {
   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\".");
 }

◆ getReporterOutput()

const std::set< std::string > & AdvancedOutput::getReporterOutput ( )

inherited

The list of Reporter names that are set for output.

Returns: A vector containing the names of the Reporter names for output

See also: hasReporterOutput

Definition at line 868 of file AdvancedOutput.C.

Referenced by CSV::initialSetup(), JSONOutput::outputReporters(), TableOutput::outputReporters(), and Exodus::outputReporters().

 {
   return _execute_data["reporters"].output;
 }

◆ 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 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 141 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 148 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 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 161 of file ReporterInterface.h.

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

◆ 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 169 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);
 }

◆ 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 287 of file Restartable.h.

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

◆ getScalarOutput()

const std::set< std::string > & AdvancedOutput::getScalarOutput ( )

inherited

The list of scalar variables names that are set for output.

Returns: A vector of strings containing the names of the scalar variables for output

See also: hasScalarVariableOutput

Definition at line 832 of file AdvancedOutput.C.

Referenced by CSV::initialSetup(), TableOutput::outputScalarVariables(), and Exodus::outputScalarVariables().

 {
   return _execute_data["scalars"].output;
 }

◆ getScatterVectorPostprocessorValue()

const ScatterVectorPostprocessorValue & VectorPostprocessorInterface::getScatterVectorPostprocessorValue	(	const std::string &	param_name,
		const std::string &	vector_name
	)		const

inherited

Return the scatter value for the post processor.

This is only valid when you expec the vector to be of lenghth "num_procs" In that case - this will return a reference to a value that will be this processor's value from that vector

Parameters

param_name	The name of the parameter holding the vpp name
vector_name	The name of the vector

Returns: The reference to the current scatter value

Definition at line 106 of file VectorPostprocessorInterface.C.

 {
   possiblyCheckHasVectorPostprocessor(param_name, vector_name);
   return getScatterVectorPostprocessorValueByName(getVectorPostprocessorName(param_name),
                                                   vector_name);
 }

◆ getScatterVectorPostprocessorValueByName()

const ScatterVectorPostprocessorValue & VectorPostprocessorInterface::getScatterVectorPostprocessorValueByName	(	const VectorPostprocessorName &	name,
		const std::string &	vector_name
	)		const

inherited

Return the scatter value for the post processor.

This is only valid when you expec the vector to be of lenghth "num_procs" In that case - this will return a reference to a value that will be this processor's value from that vector

Parameters

name	The name of the VectorPostprocessor
vector_name	The name of the vector

Returns: The reference to the current scatter value

Definition at line 115 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::getScatterVectorPostprocessorValue().

 {
   return getVectorPostprocessorContextByNameHelper(name, vector_name).getScatterValue();
 }

◆ getScatterVectorPostprocessorValueOld()

const ScatterVectorPostprocessorValue & VectorPostprocessorInterface::getScatterVectorPostprocessorValueOld	(	const std::string &	param_name,
		const std::string &	vector_name
	)		const

inherited

Return the old scatter value for the post processor.

This is only valid when you expec the vector to be of lenghth "num_procs" In that case - this will return a reference to a value that will be this processor's value from that vector

Parameters

param_name	The name of the parameter holding the vpp name
vector_name	The name of the vector

Returns: The reference to the old scatter value

Definition at line 122 of file VectorPostprocessorInterface.C.

 {
   possiblyCheckHasVectorPostprocessor(param_name, vector_name);
   return getScatterVectorPostprocessorValueOldByName(getVectorPostprocessorName(param_name),
                                                      vector_name);
 }

◆ getScatterVectorPostprocessorValueOldByName()

const ScatterVectorPostprocessorValue & VectorPostprocessorInterface::getScatterVectorPostprocessorValueOldByName	(	const VectorPostprocessorName &	name,
		const std::string &	vector_name
	)		const

inherited

Return the old scatter value for the post processor.

This is only valid when you expect the vector to be of length "num_procs" In that case - this will return a reference to a value that will be this processor's value from that vector

Parameters

name	The name of the VectorPostprocessor
vector_name	The name of the vector

Returns: The reference to the old scatter value

Definition at line 131 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::getScatterVectorPostprocessorValueOld().

 {
   return getVectorPostprocessorContextByNameHelper(name, vector_name).getScatterValueOld();
 }

◆ 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 61 of file MooseObject.C.

Referenced by MFEMProblem::addBoundaryCondition(), MFEMProblem::addKernel(), and MFEMProblem::addMFEMSolver().

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

◆ getSharedPtr() [2/2]

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

inherited

Definition at line 74 of file MooseObject.C.

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

◆ getSyncTimes()

const std::set<Real>& Output::getSyncTimes ( )

inlineinherited

Definition at line 144 of file Output.h.

144 { return _sync_times; }

Output::_sync_times

std::set< Real > _sync_times

Sync times for this outputter.

Definition: Output.h:247

◆ getVectorPostprocessorName()

const VectorPostprocessorName & VectorPostprocessorInterface::getVectorPostprocessorName ( const std::string & param_name ) const

inherited

Get the name of a VectorPostprocessor associated with a parameter.

Parameters

param_name The name of the VectorPostprocessor parameter

Returns: The name of the given VectorPostprocessor

Definition at line 203 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::getScatterVectorPostprocessorValue(), VectorPostprocessorInterface::getScatterVectorPostprocessorValueOld(), VectorPostprocessorInterface::getVectorPostprocessorValue(), VectorPostprocessorInterface::getVectorPostprocessorValueOld(), VectorPostprocessorInterface::hasVectorPostprocessor(), VectorPostprocessorInterface::isVectorPostprocessorDistributed(), and VectorPostprocessorInterface::possiblyCheckHasVectorPostprocessor().

 {
   const auto & params = _vpi_moose_object.parameters();
 
   if (!params.isParamValid(param_name))
     _vpi_moose_object.mooseError(
         "When getting a VectorPostprocessor, failed to get a parameter with the name \"",
         param_name,
         "\".",
         "\n\nKnown parameters:\n",
         _vpi_moose_object.parameters());
 
   if (!params.isType<VectorPostprocessorName>(param_name))
     _vpi_moose_object.mooseError(
         "Supplied parameter with name \"",
         param_name,
         "\" of type \"",
         params.type(param_name),
         "\" is not an expected type for getting a VectorPostprocessor.\n\n",
         "The allowed type is \"VectorPostprocessorName\".");
 
   return params.get<VectorPostprocessorName>(param_name);
 }

◆ getVectorPostprocessorOutput()

const std::set< std::string > & AdvancedOutput::getVectorPostprocessorOutput ( )

inherited

The list of VectorPostprocessor names that are set for output.

Returns: A vector of strings containing the names of the VectorPostprocessor variables for output

See also: hasVectorPostprocessorOutput

Definition at line 856 of file AdvancedOutput.C.

Referenced by CSV::initialSetup(), TableOutput::outputReporters(), XMLOutput::outputVectorPostprocessors(), and TableOutput::outputVectorPostprocessors().

 {
   return _execute_data["vector_postprocessors"].output;
 }

◆ getVectorPostprocessorValue() [1/2]

const VectorPostprocessorValue & VectorPostprocessorInterface::getVectorPostprocessorValue	(	const std::string &	param_name,
		const std::string &	vector_name
	)		const

inherited

DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast.

Retrieve the value of a VectorPostprocessor

Parameters

param_name	The name of the VectorPostprocessor parameter (see below)
vector_name	The name of the particular vector you want.

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 VectorPostprocessor you may have an input file with "pp = my_pp", this function requires the "pp" name as input (see .../moose_test/functions/VectorPostprocessorFunction.C)

see getVectorPostprocessorValueOld getVectorPostprocessorValueByName getVectorPostprocessorValueOldByName

Definition at line 36 of file VectorPostprocessorInterface.C.

 {
   possiblyCheckHasVectorPostprocessor(param_name, vector_name);
   return getVectorPostprocessorValueByName(getVectorPostprocessorName(param_name), vector_name);
 }

◆ getVectorPostprocessorValue() [2/2]

const VectorPostprocessorValue & VectorPostprocessorInterface::getVectorPostprocessorValue	(	const std::string &	param_name,
		const std::string &	vector_name,
		bool	needs_broadcast
	)		const

inherited

Retrieve the value of a VectorPostprocessor.

Parameters

param_name	The name of the VectorPostprocessor parameter (see below)
vector_name	The name of the particular vector you want.
need_broadcast	Whether or not this object requires the vector to be replicated in parallel

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 VectorPostprocessor you may have an input file with "pp = my_pp", this function requires the "pp" name as input (see .../moose_test/functions/VectorPostprocessorFunction.C)

see getVectorPostprocessorValueOld getVectorPostprocessorValueByName getVectorPostprocessorValueOldByName

Definition at line 66 of file VectorPostprocessorInterface.C.

 {
   possiblyCheckHasVectorPostprocessor(param_name, vector_name);
   return getVectorPostprocessorValueByName(
       getVectorPostprocessorName(param_name), vector_name, needs_broadcast);
 }

◆ getVectorPostprocessorValueByName() [1/2]

const VectorPostprocessorValue & VectorPostprocessorInterface::getVectorPostprocessorValueByName	(	const VectorPostprocessorName &	name,
		const std::string &	vector_name
	)		const

inherited

DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast.

Retrieve the value of the VectorPostprocessor

Parameters

name	VectorPostprocessor name (see below)
vector_name	The name of the particular vector you want.

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 VectorPostprocessor you may have an input file with "pp = my_pp", this method requires the "my_pp" name as input (see .../moose_test/functions/VectorPostprocessorFunction.C)

see getVectorPostprocessorValue getVectorPostprocessorValueOldByName getVectorPostprocessorValueByName

Definition at line 44 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::getVectorPostprocessorValue().

 {
   return getVectorPostprocessorByNameHelper(name, vector_name, _broadcast_by_default, 0);
 }

◆ getVectorPostprocessorValueByName() [2/2]

const VectorPostprocessorValue & VectorPostprocessorInterface::getVectorPostprocessorValueByName	(	const VectorPostprocessorName &	name,
		const std::string &	vector_name,
		bool	needs_broadcast
	)		const

inherited

Retrieve the value of the VectorPostprocessor.

Parameters

name	VectorPostprocessor name (see below)
vector_name	The name of the particular vector you want.
need_broadcast	Whether or not this object requires the vector to be replicated in parallel

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 VectorPostprocessor you may have an input file with "pp = my_pp", this method requires the "my_pp" name as input (see .../moose_test/functions/VectorPostprocessorFunction.C)

see getVectorPostprocessorValue getVectorPostprocessorValueOldByName getVectorPostprocessorValueByName

Definition at line 76 of file VectorPostprocessorInterface.C.

 {
   return getVectorPostprocessorByNameHelper(
       name, vector_name, needs_broadcast || _broadcast_by_default, 0);
 }

◆ getVectorPostprocessorValueOld() [1/2]

const VectorPostprocessorValue & VectorPostprocessorInterface::getVectorPostprocessorValueOld	(	const std::string &	param_name,
		const std::string &	vector_name
	)		const

inherited

DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast.

Retrieve the old value of a VectorPostprocessor

Parameters

param_name	The name of the VectorPostprocessor parameter
vector_name	The name of the particular vector you want.

Returns: The value of the VectorPostprocessor

see getVectorPostprocessorValue

Definition at line 51 of file VectorPostprocessorInterface.C.

 {
   possiblyCheckHasVectorPostprocessor(param_name, vector_name);
   return getVectorPostprocessorValueOldByName(getVectorPostprocessorName(param_name), vector_name);
 }

◆ getVectorPostprocessorValueOld() [2/2]

const VectorPostprocessorValue & VectorPostprocessorInterface::getVectorPostprocessorValueOld	(	const std::string &	param_name,
		const std::string &	vector_name,
		bool	needs_broadcast
	)		const

inherited

Retrieve the old value of a VectorPostprocessor.

Parameters

param_name	The name of the VectorPostprocessor parameter
vector_name	The name of the particular vector you want.
need_broadcast	Whether or not this object requires the vector to be replicated in parallel

Returns: The value of the VectorPostprocessor

see getVectorPostprocessorValue

Definition at line 86 of file VectorPostprocessorInterface.C.

 {
   possiblyCheckHasVectorPostprocessor(param_name, vector_name);
   return getVectorPostprocessorValueOldByName(
       getVectorPostprocessorName(param_name), vector_name, needs_broadcast);
 }

◆ getVectorPostprocessorValueOldByName() [1/2]

const VectorPostprocessorValue & VectorPostprocessorInterface::getVectorPostprocessorValueOldByName	(	const VectorPostprocessorName &	name,
		const std::string &	vector_name
	)		const

inherited

DEPRECATED: Use the new version where you need to specify whether or not the vector must be broadcast.

Retrieve the old value of a VectorPostprocessor

Parameters

name	The name of the VectorPostprocessor
vector_name	The name of the particular vector you want.

Returns: The value of the VectorPostprocessor

If within the validParams for the object the addVectorPostprocessorParam was called this method will retun a reference to the default value specified in the call to the addVectorPostprocessorParam function if the postVectorPostprocessor does not exist.

see getVectorPostprocessorValueByName

Definition at line 59 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::getVectorPostprocessorValueOld().

 {
   return getVectorPostprocessorByNameHelper(name, vector_name, _broadcast_by_default, 1);
 }

◆ getVectorPostprocessorValueOldByName() [2/2]

const VectorPostprocessorValue & VectorPostprocessorInterface::getVectorPostprocessorValueOldByName	(	const VectorPostprocessorName &	name,
		const std::string &	vector_name,
		bool	needs_broadcast
	)		const

inherited

Retrieve the old value of a VectorPostprocessor.

Parameters

name	The name of the VectorPostprocessor
vector_name	The name of the particular vector you want.
need_broadcast	Whether or not this object requires the vector to be replicated in parallel

Returns: The value of the VectorPostprocessor

If within the validParams for the object the addVectorPostprocessorParam was called this method will retun a reference to the default value specified in the call to the addVectorPostprocessorParam function if the postVectorPostprocessor does not exist.

see getVectorPostprocessorValueByName

Definition at line 96 of file VectorPostprocessorInterface.C.

 {
   return getVectorPostprocessorByNameHelper(
       name, vector_name, needs_broadcast || _broadcast_by_default, 1);
 }

◆ hasBase()

bool MooseBase::hasBase ( ) const

inlineinherited

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

Definition at line 138 of file MooseBase.h.

138 { return _pars.hasBase(); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:362

InputParameters::hasBase

bool hasBase() const

Definition: InputParameters.C:491

◆ hasElementalVariableOutput()

bool AdvancedOutput::hasElementalVariableOutput ( )

inherited

Returns true if there exists elemental nonlinear variables for output.

Returns: True if nonlinear variable output exists

See also: getElementalVariableOutput

Definition at line 814 of file AdvancedOutput.C.

Referenced by Exodus::initialSetup().

 {
   return hasOutputHelper("elemental");
 }

◆ hasFunction()

bool FunctionInterface::hasFunction ( const std::string & param_name ) const

inherited

Determine if the function exists.

Parameters

param_name	The name of the function parameter
index	The index of the function

Returns: True if the function exists

Definition at line 42 of file FunctionInterface.C.

 {
   return hasFunctionByName(_fni_params.get<FunctionName>(param_name));
 }

◆ hasFunctionByName()

bool FunctionInterface::hasFunctionByName ( const FunctionName & name ) const

inherited

Determine if the function exists.

Parameters

name	The name of the function

Returns: True if the function exists

Definition at line 48 of file FunctionInterface.C.

Referenced by FunctionInterface::hasFunction().

 {
   return _fni_feproblem.hasFunction(name, _fni_tid);
 }

◆ hasNodalVariableOutput()

bool AdvancedOutput::hasNodalVariableOutput ( )

inherited

Returns true if there exists nodal nonlinear variables for output.

Returns: True if nonlinear variable output exists

See also: getNodalVariableOutput

Definition at line 802 of file AdvancedOutput.C.

Referenced by Exodus::initialSetup(), and Exodus::outputElementalVariables().

 {
   return hasOutputHelper("nodal");
 }

◆ hasOutput() [1/2]

bool AdvancedOutput::hasOutput ( )

virtualinherited

Returns true if any of the other has methods return true.

Definition at line 388 of file AdvancedOutput.C.

Referenced by Exodus::initialSetup(), and AdvancedOutput::shouldOutput().

 {
   // Test that variables exist for output AND that output execution flags are valid
   for (const auto & it : _execute_data)
     if (!(it.second).output.empty() && _advanced_execute_on.contains(it.first) &&
         _advanced_execute_on[it.first].isValid())
       return true;
 
   // Test execution flags for non-variable output
   if (_advanced_execute_on.contains("system_information") &&
       _advanced_execute_on["system_information"].isValid())
     return true;
   if (_advanced_execute_on.contains("input") && _advanced_execute_on["input"].isValid())
     return true;
 
   return false;
 }

◆ hasOutput() [2/2]

bool AdvancedOutput::hasOutput ( const ExecFlagType & type )

inherited

Tests that any output exist for the given output type.

See also: Exodus

Definition at line 376 of file AdvancedOutput.C.

 {
   // If any of the component outputs are true, then there is some output to perform
   for (const auto & it : _advanced_execute_on)
     if (wantOutput(it.first, type))
       return true;
 
   // There is nothing to output
   return false;
 }

◆ 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 107 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 118 of file PostprocessorInterface.C.

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

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

◆ hasPostprocessorOutput()

bool AdvancedOutput::hasPostprocessorOutput ( )

inherited

Returns true if there exists postprocessors for output.

Returns: True if postprocessor output exists

See also: getPostprocessorOutput

Definition at line 838 of file AdvancedOutput.C.

Referenced by Exodus::initialSetup().

 {
   return hasOutputHelper("postprocessors");
 }

◆ hasReporterOutput()

bool AdvancedOutput::hasReporterOutput ( )

inherited

Returns true if there exists Reporter for output.

Returns: True if Reporter output exists

See also: getReporterOutput

Definition at line 862 of file AdvancedOutput.C.

 {
   return hasOutputHelper("reporters");
 }

◆ 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 29 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 182 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 39 of file ReporterInterface.C.

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

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

◆ hasReporterValueByName() [2/2]

template<typename T >

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

protectedinherited

Definition at line 193 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);
 }

◆ hasScalarOutput()

bool AdvancedOutput::hasScalarOutput ( )

inherited

Returns true if there exists scalar variables for output.

Returns: True if scalar variable output exists

See also: getScalarVariableOutput

Definition at line 826 of file AdvancedOutput.C.

Referenced by Exodus::initialSetup().

 {
   return hasOutputHelper("scalars");
 }

◆ hasVectorPostprocessor() [1/2]

bool VectorPostprocessorInterface::hasVectorPostprocessor	(	const std::string &	param_name,
		const std::string &	vector_name
	)		const

inherited

Determine if the VectorPostprocessor data exists by parameter.

Parameters

param_name	The name of the VectorPostprocessor parameter
vector_name	The vector name within the VectorPostprocessor

Returns: True if the VectorPostprocessor data exists

See also: hasVectorPostprocessorByName getVectorPostprocessorValue

Definition at line 138 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::possiblyCheckHasVectorPostprocessor().

 {
   if (!vectorPostprocessorsAdded())
     _vpi_feproblem.mooseError("Cannot call hasVectorPostprocessor() until all VectorPostprocessors "
                               "have been constructed.");
 
   return hasVectorPostprocessorByName(getVectorPostprocessorName(param_name), vector_name);
 }

◆ hasVectorPostprocessor() [2/2]

bool VectorPostprocessorInterface::hasVectorPostprocessor ( const std::string & param_name ) const

inherited

Determine if the VectorPostprocessor exists by parameter.

Parameters

name	The name of the VectorPostprocessor parameter

Returns: True if the VectorPostprocessor exists

Definition at line 168 of file VectorPostprocessorInterface.C.

 {
   if (!vectorPostprocessorsAdded())
     _vpi_feproblem.mooseError("Cannot call hasVectorPostprocessor() until all "
                               "VectorPostprocessors have been constructed.");
 
   return hasVectorPostprocessorByName(getVectorPostprocessorName(param_name));
 }

◆ hasVectorPostprocessorByName() [1/2]

bool VectorPostprocessorInterface::hasVectorPostprocessorByName	(	const VectorPostprocessorName &	name,
		const std::string &	vector_name
	)		const

inherited

Determine if the VectorPostprocessor data exists by name.

Parameters

name	The name of the VectorPostprocessor
vector_name	The vector name within the VectorPostprocessor

Returns: True if the VectorPostprocessor data exists

See also: hasVectorPostprocessor getVectorPostprocessorValueByName

Definition at line 149 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::hasVectorPostprocessor(), AdvancedOutput::initShowHideLists(), CSV::output(), and VectorPostprocessorInterface::possiblyCheckHasVectorPostprocessorByName().

 {
   if (!vectorPostprocessorsAdded())
     _vpi_feproblem.mooseError("Cannot call hasVectorPostprocessorByName() until all "
                               "VectorPostprocessors have been constructed.");
 
   const bool has_vpp = _vpi_feproblem.getReporterData().hasReporterValue<VectorPostprocessorValue>(
       VectorPostprocessorReporterName(name, vector_name));
 
   if (has_vpp)
     mooseAssert(_vpi_feproblem.hasUserObject(name) && dynamic_cast<const VectorPostprocessor *>(
                                                           &_vpi_feproblem.getUserObjectBase(name)),
                 "Has reporter VectorPostprocessor Reporter value but not VectorPostprocessor UO");
 
   return has_vpp;
 }

◆ hasVectorPostprocessorByName() [2/2]

bool VectorPostprocessorInterface::hasVectorPostprocessorByName ( const VectorPostprocessorName & name ) const

inherited

Determine if the VectorPostprocessor exists by name.

Parameters

name	The name of the VectorPostprocessor

Returns: True if the VectorPostprocessor exists

Definition at line 178 of file VectorPostprocessorInterface.C.

 {
   if (!vectorPostprocessorsAdded())
     _vpi_feproblem.mooseError("Cannot call hasVectorPostprocessorByName() until all "
                               "VectorPostprocessors have been constructed.");
 
   return _vpi_feproblem.hasUserObject(name) &&
          dynamic_cast<const VectorPostprocessor *>(&_vpi_feproblem.getUserObjectBase(name));
 }

◆ hasVectorPostprocessorOutput()

bool AdvancedOutput::hasVectorPostprocessorOutput ( )

inherited

Returns true if there exists VectorPostprocessors for output.

Returns: True if VectorPostprocessor output exists

See also: getVectorPostprocessorOutput

Definition at line 850 of file AdvancedOutput.C.

 {
   return hasOutputHelper("vector_postprocessors");
 }

◆ hideAdditionalVariable()

void AdvancedOutput::hideAdditionalVariable	(	const std::string &	category,
		const std::string &	var_name
	)

inlineprotectedinherited

Add an additional variable to the hide list.

Definition at line 204 of file AdvancedOutput.h.

Referenced by initSample().

   {
     _execute_data[category].hide.insert(var_name);
     _execute_data[category].output.erase(var_name);
   }

◆ init()

void AdvancedOutput::init ( )

protectedvirtualinherited

Populates the various data structures needed to control the output.

Definition at line 158 of file AdvancedOutput.C.

Referenced by AdvancedOutput::initialSetup(), and AdvancedOutput::output().

 {
   // Initialize the execution flags
   for (auto & [name, input] : _advanced_execute_on)
     initExecutionTypes(name, input);
 
   // Clear existing execute information lists
   _execute_data.reset();
 
   // Initialize the available output
   initAvailableLists();
 
   // Separate the hide/show list into components
   initShowHideLists(getParam<std::vector<VariableName>>("show"),
                     getParam<std::vector<VariableName>>("hide"));
 
   // If 'elemental_as_nodal = true' the elemental variable names must be appended to the
   // nodal variable names. Thus, when libMesh::EquationSystem::build_solution_vector is called
   // it will create the correct nodal variable from the elemental
   if (_elemental_as_nodal)
   {
     OutputData & nodal = _execute_data["nodal"];
     OutputData & elemental = _execute_data["elemental"];
     nodal.show.insert(elemental.show.begin(), elemental.show.end());
     nodal.hide.insert(elemental.hide.begin(), elemental.hide.end());
     nodal.available.insert(elemental.available.begin(), elemental.available.end());
   }
 
   // Similarly as above, if 'scalar_as_nodal = true' append the elemental variable lists
   if (_scalar_as_nodal)
   {
     OutputData & nodal = _execute_data["nodal"];
     OutputData & scalar = _execute_data["scalars"];
     nodal.show.insert(scalar.show.begin(), scalar.show.end());
     nodal.hide.insert(scalar.hide.begin(), scalar.hide.end());
     nodal.available.insert(scalar.available.begin(), scalar.available.end());
   }
 
   // Initialize the show/hide/output lists for each of the types of output
   for (auto & it : _execute_data)
     initOutputList(it.second);
 }

◆ initialSetup()

void SampledOutput::initialSetup ( )

overridevirtual

Call init() method on setup.

Reimplemented from AdvancedOutput.

Reimplemented in Exodus.

Definition at line 76 of file SampledOutput.C.

Referenced by Exodus::initialSetup().

 {
   AdvancedOutput::initialSetup();
 
   // Creates and initializes the sampling mesh
   initSample();
 }

◆ initSample()

void SampledOutput::initSample ( )

private

Setups the output object to produce re-positioned and/or sampled results.

This is accomplished by creating a new, finer mesh that the existing solution is projected upon. This function is called by the creating action (addOutputAction) and should not be called by the user as it will create a memory leak if called multiple times.

Definition at line 130 of file SampledOutput.C.

Referenced by initialSetup().

 {
   // Perform the mesh cloning, if needed
   if (!_use_sampled_output)
     return;
 
   cloneMesh();
 
   // Re-position the sampling mesh
   if (_change_position)
     for (auto & node : _mesh_ptr->getMesh().node_ptr_range())
       *node += _position;
 
   // Perform the mesh refinement
   if (_refinements > 0)
   {
     MeshRefinement mesh_refinement(_mesh_ptr->getMesh());
 
     // We want original and refined partitioning to match so we can
     // query from one to the other safely on distributed meshes.
     _mesh_ptr->getMesh().skip_partitioning(true);
     mesh_refinement.uniformly_refine(_refinements);
 
     // Note that nodesets are not propagated with mesh refinement, unless you built the nodesets
     // from the sidesets again, which is what happens for the regular mesh with initial refinement
   }
 
   // We can't allow renumbering if we want to output multiple time
   // steps to the same Exodus file
   _mesh_ptr->getMesh().allow_renumbering(false);
 
   // This should be called after changing the mesh (block restriction for example)
   if (_change_position || (_refinements > 0) || isParamValid("sampling_blocks"))
     _sampling_mesh_ptr->meshChanged();
 
   // Create the new EquationSystems
   _sampling_es = std::make_unique<EquationSystems>(_mesh_ptr->getMesh());
   _es_ptr = _sampling_es.get();
 
   // Reference the system from which we are copying
   EquationSystems & source_es = _problem_ptr->es();
 
   // If we're going to be copying from that system later, we need to keep its
   // original elements as ghost elements even if it gets grossly
   // repartitioned, since we can't repartition the sample mesh to
   // match.
   // FIXME: this is not enough. It assumes our initial partition of the sampling mesh
   // and the source mesh match. But that's usually only true in the 'refinement' case,
   // not with an arbitrary sampling mesh file
   DistributedMesh * dist_mesh = dynamic_cast<DistributedMesh *>(&source_es.get_mesh());
   if (dist_mesh)
   {
     for (auto & elem : dist_mesh->active_local_element_ptr_range())
       dist_mesh->add_extra_ghost_elem(elem);
   }
 
   // Initialize the _mesh_functions vector
   const auto num_systems = source_es.n_systems();
   _mesh_functions.resize(num_systems);
 
   // Keep track of the variable numbering in both regular and sampled system
   _variable_numbers_in_system.resize(num_systems);
 
   // Get the list of nodal and elemental output data
   const auto & nodal_data = getNodalVariableOutput();
   const auto & elemental_data = getElementalVariableOutput();
 
   // Loop over the number of systems
   for (const auto sys_num : make_range(num_systems))
   {
     // Reference to the current system
     const auto & source_sys = source_es.get_system(sys_num);
 
     // Add the system to the new EquationsSystems
     ExplicitSystem & dest_sys = _sampling_es->add_system<ExplicitSystem>(source_sys.name());
 
     // Loop through the variables in the System
     const auto num_vars = source_sys.n_vars();
     unsigned int num_actual_vars = 0;
     if (num_vars > 0)
     {
       if (_serialize)
         _serialized_solution = NumericVector<Number>::build(_communicator);
 
       // Add the variables to the system... simultaneously creating MeshFunctions for them.
       for (const auto var_num : make_range(num_vars))
       {
         // Is the variable supposed to be output?
         const auto & var_name = source_sys.variable_name(var_num);
         if (!nodal_data.count(var_name) && !elemental_data.count(var_name))
           continue;
 
         // We do what we can to preserve the block restriction
         const std::set<SubdomainID> * subdomains;
         std::set<SubdomainID> restricted_subdomains;
         if (_using_external_sampling_file && !_mesh_subdomains_match)
           subdomains = nullptr;
         else
         {
           subdomains = &source_sys.variable(var_num).active_subdomains();
           // Reduce the block restriction if the output is block restricted
           if (isParamValid("sampling_blocks") && !subdomains->empty())
           {
             const auto & sampling_blocks = _sampling_mesh_ptr->getSubdomainIDs(
                 getParam<std::vector<SubdomainName>>("sampling_blocks"));
             set_intersection(subdomains->begin(),
                              subdomains->end(),
                              sampling_blocks.begin(),
                              sampling_blocks.end(),
                              std::inserter(restricted_subdomains, restricted_subdomains.begin()));
             subdomains = &restricted_subdomains;
 
             // None of the subdomains are included in the sampling, might as well skip
             if (subdomains->empty())
             {
               hideAdditionalVariable(nodal_data.count(var_name) ? "nodal" : "elemental", var_name);
               continue;
             }
           }
         }
 
         // We are going to add the variable, let's count it
         _variable_numbers_in_system[sys_num].push_back(var_num);
         num_actual_vars++;
 
         // Add the variable. We essentially support nodal variables and constant monomials
         const FEType & fe_type = source_sys.variable_type(var_num);
         if (isSampledAtNodes(fe_type))
         {
           dest_sys.add_variable(source_sys.variable_name(var_num), fe_type, subdomains);
           if (dist_mesh && !_serialize)
             paramError("serialize_sampling",
                        "Variables sampled as nodal currently require serialization with a "
                        "distributed mesh.");
         }
         else
         {
           const auto & var_name = source_sys.variable_name(var_num);
           if (fe_type != FEType(CONSTANT, MONOMIAL))
           {
             mooseInfoRepeated("Sampled output projects variable '" + var_name +
                               "' onto a constant monomial");
             if (!_serialize)
               paramWarning("serialize_sampling",
                            "Projection without serialization may fail with insufficient ghosting. "
                            "Consider setting 'serialize_sampling' to true.");
           }
           dest_sys.add_variable(var_name, FEType(CONSTANT, MONOMIAL), subdomains);
         }
         // Note: we could do more, using the generic projector. But exodus output of higher order
         // or more exotic variables is limited anyway
       }
 
       // Size for the actual number of variables output
       _mesh_functions[sys_num].resize(num_actual_vars);
     }
   }
 
   // Initialize the newly created EquationSystem
   _sampling_es->init();
 }

◆ inLinearTimeWindow()

bool PetscOutput::inLinearTimeWindow ( )

inlineprotectedinherited

Definition at line 67 of file PetscOutput.h.

   {
     return _time >= _linear_start_time - _t_tol && _time <= _linear_end_time + _t_tol;
   }

◆ inNonlinearTimeWindow()

bool PetscOutput::inNonlinearTimeWindow ( )

inlineprotectedinherited

Definition at line 63 of file PetscOutput.h.

   {
     return _time >= _nonlinear_start_time - _t_tol && _time <= _nonlinear_end_time + _t_tol;
   }

◆ interval()

const unsigned int& Output::interval ( ) const

inherited

Get the output interval.

◆ isAdvanced()

bool Output::isAdvanced ( )

inherited

Returns true if this object is an AdvancedOutput object.

Definition at line 401 of file Output.C.

 {
   return _is_advanced;
 }

◆ 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 75 of file PostprocessorInterface.C.

Referenced by EigenKernel::EigenKernel().

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

◆ 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 201 of file MooseBase.h.

Referenced by SetupDebugAction::act(), ADConservativeAdvectionBC::ADConservativeAdvectionBC(), DiffusionCG::addFEBCs(), DiffusionPhysicsBase::addInitialConditions(), MFEMMesh::buildMesh(), LibtorchNeuralNetControl::conditionalParameterError(), MooseApp::copyInputs(), DiffusionPhysicsBase::DiffusionPhysicsBase(), ElementSubdomainModifierBase::ElementSubdomainModifierBase(), MooseApp::errorCheck(), MooseBase::getRenamedParam(), DefaultConvergenceBase::getSharedExecutionerParam(), AddVariableAction::init(), PhysicsBase::initializePhysics(), ElementSubdomainModifierBase::initialSetup(), MatrixSymmetryCheck::MatrixSymmetryCheck(), MeshDiagnosticsGenerator::MeshDiagnosticsGenerator(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), SolutionInvalidityOutput::output(), Output::Output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), PetscExternalPartitioner::partition(), PiecewiseTabularBase::PiecewiseTabularBase(), MooseMesh::prepare(), SolutionUserObjectBase::readXda(), PhysicsBase::reportPotentiallyMissedParameters(), MooseApp::runInputFile(), MooseApp::runInputs(), MFEMSolverBase::setPreconditioner(), SetupMeshAction::setupMesh(), MooseApp::setupOptions(), SideSetsFromBoundingBoxGenerator::SideSetsFromBoundingBoxGenerator(), TimedSubdomainModifier::TimedSubdomainModifier(), and XYDelaunayGenerator::XYDelaunayGenerator().

   {
     return _pars.isParamSetByUser(name);
   }

◆ 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 195 of file MooseBase.h.

195 { return _pars.isParamValid(name); }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:362

MooseBase::name

const std::string & name() const

Get the name of the class.

Definition: MooseBase.h:99

InputParameters::isParamValid

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

This method returns parameters that have been initialized in one fashion or another, i.e.

Definition: InputParameters.C:386

◆ isSampledAtNodes()

bool SampledOutput::isSampledAtNodes ( const FEType & fe_type ) const

private

Used to decide which variable is sampled at nodes, then output as a nodal variable for (over)sampling purposes If not sampled at nodes, it is sampled at centroids and output as a constant monomial.

Definition at line 539 of file SampledOutput.C.

Referenced by initSample(), and updateSample().

 {
   // This is the same criterion as in MooseVariableData
   const auto continuity = FEInterface::get_continuity(fe_type);
   return (continuity == C_ZERO || continuity == C_ONE);
 }

◆ isVectorPostprocessorDistributed()

bool VectorPostprocessorInterface::isVectorPostprocessorDistributed ( const std::string & param_name ) const

inherited

Return true if the VectorPostprocessor is marked with parallel_type as DISTRIBUTED.

Definition at line 190 of file VectorPostprocessorInterface.C.

 {
   return isVectorPostprocessorDistributedByName(getVectorPostprocessorName(param_name));
 }

◆ isVectorPostprocessorDistributedByName()

bool VectorPostprocessorInterface::isVectorPostprocessorDistributedByName ( const VectorPostprocessorName & name ) const

inherited

Definition at line 196 of file VectorPostprocessorInterface.C.

Referenced by VectorPostprocessorInterface::isVectorPostprocessorDistributed().

 {
   return _vpi_feproblem.getVectorPostprocessorObjectByName(name).isDistributed();
 }

◆ 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 MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, MooseVariableFE< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableField< OutputType >, MooseVariableField< RT >, MooseVariableField< ComputeValueType >, MooseVariableField< T >, MooseVariableField< RealEigenVector >, MooseVariableField< RealVectorValue >, MooseVariableField< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, Function, Positions, Times, DiffusionLHDGKernel, IPHDGKernel, EqualValueEmbeddedConstraintTempl< is_ad >, ADKernelTempl< T >, IPHDGBC, DiffusionLHDGPrescribedGradientBC, and DiffusionLHDGDirichletBC.

Definition at line 51 of file SetupInterface.C.

Referenced by MooseVariableField< Real >::jacobianSetup(), and ComputeFVFluxJacobianThread< RangeType >::setup().

52 {

53 }

◆ meshChanged()

void SampledOutput::meshChanged ( )

overridevirtual

Called on this object when the mesh changes.

Reimplemented from MeshChangedInterface.

Reimplemented in Exodus.

Definition at line 124 of file SampledOutput.C.

Referenced by Exodus::meshChanged().

 {
   _sampling_mesh_changed = true;
 }

◆ messagePrefix()

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 252 of file MooseBase.h.

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

   {
     return messagePrefix(_pars, hit_prefix);
   }

◆ mooseDeprecated()

template<typename... Args>

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

inlineinherited

Definition at line 310 of file MooseBase.h.

Referenced by FEProblemBase::addAuxArrayVariable(), FEProblemBase::addAuxScalarVariable(), FEProblemBase::addAuxVariable(), FEProblemBase::advanceMultiApps(), MultiApp::appProblem(), MooseMesh::buildSideList(), ChangeOverTimestepPostprocessor::ChangeOverTimestepPostprocessor(), AddVariableAction::determineType(), EigenProblem::EigenProblem(), Eigenvalue::Eigenvalue(), MooseMesh::elem(), UserForcingFunction::f(), FaceFaceConstraint::FaceFaceConstraint(), FunctionDT::FunctionDT(), RandomICBase::generateRandom(), MooseMesh::getBoundariesToElems(), DataFileInterface::getDataFileName(), DataFileInterface::getDataFileNameByName(), Control::getExecuteOptions(), FEProblemBase::getNonlinearSystem(), MooseApp::getRecoverFileBase(), FEProblemBase::getUserObjects(), FEProblemBase::hasPostprocessor(), MooseApp::hasRecoverFileBase(), MatDiffusionBase< Real >::MatDiffusionBase(), MultiAppNearestNodeTransfer::MultiAppNearestNodeTransfer(), MultiAppShapeEvaluationTransfer::MultiAppShapeEvaluationTransfer(), MultiAppUserObjectTransfer::MultiAppUserObjectTransfer(), NodalScalarKernel::NodalScalarKernel(), MooseMesh::node(), FixedPointSolve::numPicardIts(), RelationshipManager::operator>=(), PercentChangePostprocessor::PercentChangePostprocessor(), ReferenceResidualConvergence::ReferenceResidualConvergence(), Residual::Residual(), MooseMesh::setBoundaryToNormalMap(), Exodus::setOutputDimension(), MooseApp::setupOptions(), UserForcingFunction::UserForcingFunction(), and VariableResidual::VariableResidual().

   {
     moose::internal::mooseDeprecatedStream(
         _console, false, true, 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 273 of file MooseBase.h.

Referenced by ArrayDGLowerDKernel::ArrayDGLowerDKernel(), ArrayHFEMDirichletBC::ArrayHFEMDirichletBC(), ArrayLowerDIntegratedBC::ArrayLowerDIntegratedBC(), DGLowerDKernel::DGLowerDKernel(), HFEMDirichletBC::HFEMDirichletBC(), and LowerDIntegratedBC::LowerDIntegratedBC().

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

◆ 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 267 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 286 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 317 of file MooseBase.h.

Referenced by SetupRecoverFileBaseAction::act(), AStableDirk4::AStableDirk4(), MeshDiagnosticsGenerator::checkNonConformalMeshFromAdaptivity(), MultiAppGeneralFieldNearestLocationTransfer::evaluateInterpValuesNearestNode(), PIDTransientControl::execute(), Executioner::Executioner(), ExplicitRK2::ExplicitRK2(), ExplicitTVDRK2::ExplicitTVDRK2(), DataFileInterface::getDataFilePath(), MFEMScalarFESpace::getFECName(), MultiAppTransfer::getPointInTargetAppFrame(), ImplicitMidpoint::ImplicitMidpoint(), ParsedDownSelectionPositions::initialize(), PropertyReadFile::initialize(), MultiAppGeneralFieldTransfer::initialSetup(), InversePowerMethod::InversePowerMethod(), LStableDirk2::LStableDirk2(), LStableDirk3::LStableDirk3(), LStableDirk4::LStableDirk4(), PNGOutput::makeMeshFunc(), NonlinearEigen::NonlinearEigen(), SolutionInvalidityOutput::output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), MooseBase::paramInfo(), ProjectionAux::ProjectionAux(), ReferenceResidualConvergence::ReferenceResidualConvergence(), MFEMDataCollection::registerFields(), FEProblemBase::setRestartFile(), MooseApp::setupOptions(), SolutionUserObjectBase::SolutionUserObjectBase(), SymmetryTransformGenerator::SymmetryTransformGenerator(), TransientBase::takeStep(), and TransientBase::TransientBase().

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

◆ mooseWarning()

template<typename... Args>

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

inlineinherited

Emits a warning prefixed with object name and type.

Definition at line 295 of file MooseBase.h.

Referenced by CopyMeshPartitioner::_do_partition(), AddKernelAction::act(), MeshOnlyAction::act(), AddFunctionAction::act(), MaterialOutputAction::act(), CommonOutputAction::act(), MFEMProblem::addFunction(), MooseMesh::addPeriodicVariable(), DiracKernelBase::addPoint(), BoundaryMarker::BoundaryMarker(), DistributedRectilinearMeshGenerator::buildCube(), MultiAppVariableValueSamplePostprocessorTransfer::cacheElemToPostprocessorData(), CartesianMeshGenerator::CartesianMeshGenerator(), CheckOutputAction::checkConsoleOutput(), MultiAppTransfer::checkMultiAppExecuteOn(), MeshDiagnosticsGenerator::checkNonMatchingEdges(), ActionComponent::checkRequiredTasks(), PhysicsBase::checkRequiredTasks(), cloneMesh(), MultiAppGeneralFieldTransfer::closestToPosition(), VariableValueElementSubdomainModifier::computeSubdomainID(), GapValueAux::computeValue(), MultiApp::createApp(), DebugResidualAux::DebugResidualAux(), MeshDiagnosticsGenerator::diagnosticsLog(), CartesianGridDivision::divisionIndex(), CylindricalGridDivision::divisionIndex(), SphericalGridDivision::divisionIndex(), ElementMaterialSampler::ElementMaterialSampler(), Postprocessor::evaluateDotWarning(), MeshDivisionFunctorReductionVectorPostprocessor::execute(), ElementQualityChecker::finalize(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), FixedPointSolve::FixedPointSolve(), SubdomainPerElementGenerator::generate(), StitchMeshGenerator::generate(), ParsedGenerateSideset::generate(), MultiAppTransfer::getAppInfo(), FunctorBinnedValuesDivision::getBinIndex(), DataFileInterface::getDataFilePath(), PointSamplerBase::getLocalElemContainingPoint(), FEProblemBase::getMaterial(), LineValueSampler::getValue(), Terminator::handleMessage(), IndicatorMarker::IndicatorMarker(), CylindricalGridDivision::initialize(), CartesianGridDivision::initialize(), SphericalGridDivision::initialize(), ElementGroupCentroidPositions::initialize(), MultiAppGeneralFieldNearestLocationTransfer::initialSetup(), BoundsBase::initialSetup(), ReferenceResidualConvergence::initialSetup(), MultiAppGeneralFieldTransfer::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), MaterialBase::initStatefulProperties(), LeastSquaresFit::LeastSquaresFit(), IterationAdaptiveDT::limitDTToPostprocessorValue(), MooseApp::loadLibraryAndDependencies(), FEProblemBase::mesh(), MultiAppGeneralFieldTransfer::MultiAppGeneralFieldTransfer(), NewmarkBeta::NewmarkBeta(), NodalPatchRecovery::NodalPatchRecovery(), NonlocalIntegratedBC::NonlocalIntegratedBC(), NonlocalKernel::NonlocalKernel(), Output::Output(), MultiAppGeneralFieldTransfer::outputValueConflicts(), MooseBase::paramWarning(), PiecewiseConstantFromCSV::PiecewiseConstantFromCSV(), Executioner::problem(), PropertyReadFile::readData(), TestSourceStepper::rejectStep(), PhysicsBase::reportPotentiallyMissedParameters(), MaterialBase::resetQpProperties(), SecondTimeDerivativeAux::SecondTimeDerivativeAux(), MooseMesh::setCoordSystem(), SidesetAroundSubdomainUpdater::SidesetAroundSubdomainUpdater(), FEProblemBase::sizeZeroes(), TransientMultiApp::solveStep(), Tecplot::Tecplot(), TimeDerivativeAux::TimeDerivativeAux(), Checkpoint::updateCheckpointFiles(), updateSample(), PiecewiseConstantFromCSV::value(), and VariableCondensationPreconditioner::VariableCondensationPreconditioner().

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

◆ mooseWarningNonPrefixed()

template<typename... Args>

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

inlineinherited

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

Definition at line 304 of file MooseBase.h.

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

◆ name()

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

inlineinherited

Get the name of the class.

Returns: The name of the class

Definition at line 99 of file MooseBase.h.

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

◆ onInterval()

bool Output::onInterval ( )

protectedvirtualinherited

Returns true if the output interval is satisfied.

Todo:: {Implement additional types of intervals (e.g., simulation time and real time)}

Definition at line 285 of file Output.C.

Referenced by Console::output(), outputStep(), Output::outputStep(), and Checkpoint::shouldOutput().

 {
   // 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 % _time_step_interval) == 0)
     output = true;
 
   // Return false if 'sync_only' is set to true
   if (_sync_only)
     output = false;
 
   if (_sync_times_object)
   {
     const auto & sync_times = _sync_times_object->getUniqueTimes();
     if (sync_times != _sync_times)
       mooseError("The provided sync times object has changing time values. Only static time "
                  "values are supported since time steppers take sync times from the output "
                  "warehouse which determines its sync times at output construction time.");
   }
 
   // If sync times are not skipped, return true if the current time is a sync_time
   for (const auto _sync_time : _sync_times)
   {
     if (std::abs(_sync_time - _time) < _t_tol)
       output = true;
   }
 
   // check if enough simulation time has passed between outputs
   if (_time > _last_output_simulation_time &&
       _last_output_simulation_time + _min_simulation_time_interval > _time + _t_tol)
     output = false;
 
   // check if enough wall time has passed between outputs
   const auto now = std::chrono::steady_clock::now();
   // count below returns an interger type, so lets express on a millisecond
   // scale and convert to seconds for finer resolution
   _wall_time_since_last_output =
       std::chrono::duration_cast<std::chrono::milliseconds>(now - _last_output_wall_time).count() /
       1000.0;
   // Take the maximum wall time since last output accross all processors
   _communicator.max(_wall_time_since_last_output);
   if (_wall_time_since_last_output >= _wall_time_interval)
     output = true;
 
   // Return the output status
   return output;
 }

◆ output()

void AdvancedOutput::output ( )

protectedvirtualinherited

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

By default this function performs calls each of the four virtual output methods: outputScalarVariables(), outputPostprocessors(), outputElementalVariables(), and outputNodalVariables(). But, only if output exists for each type.

See also: outputNodalVariables outputElementalVariables outputScalarVariables outputPostprocessors

Implements Output.

Reimplemented in Nemesis, Console, Exodus, CSV, Gnuplot, Tecplot, VTKOutput, XDA, GMVOutput, JSONOutput, and XMLOutput.

Definition at line 279 of file AdvancedOutput.C.

Referenced by AdvancedOutput::initOutputList(), XMLOutput::output(), JSONOutput::output(), Gnuplot::output(), CSV::output(), Exodus::output(), and outputStep().

 {
   const auto & type = _current_execute_flag;
 
   // (re)initialize the list of available items for output
   init();
 
   // Call the various output types, if data exists
   if (wantOutput("nodal", type))
   {
     outputNodalVariables();
     _last_execute_time["nodal"] = _time;
   }
 
   if (wantOutput("elemental", type))
   {
     outputElementalVariables();
     _last_execute_time["elemental"] = _time;
   }
 
   if (wantOutput("postprocessors", type))
   {
     outputPostprocessors();
     _last_execute_time["postprocessors"] = _time;
   }
 
   if (wantOutput("vector_postprocessors", type))
   {
     outputVectorPostprocessors();
     _last_execute_time["vector_postprocessors"] = _time;
   }
 
   if (wantOutput("scalars", type))
   {
     outputScalarVariables();
     _last_execute_time["scalars"] = _time;
   }
 
   if (wantOutput("system_information", type))
   {
     outputSystemInformation();
     _last_execute_time["system_information"] = _time;
   }
 
   if (wantOutput("input", type))
   {
     outputInput();
     _last_execute_time["input"] = _time;
   }
 
   if (wantOutput("reporters", type))
   {
     outputReporters();
     _last_execute_time["reporters"] = _time;
   }
 }

◆ outputElementalVariables()

void AdvancedOutput::outputElementalVariables ( )

protectedvirtualinherited

Performs output of elemental nonlinear variables The child class must define this method to output the nonlinear variables as desired.

See also: Exodus::outputElementalVariables

Reimplemented in Exodus.

Definition at line 212 of file AdvancedOutput.C.

Referenced by AdvancedOutput::output().

 {
   mooseError(
       "Individual output of elemental variables is not support for this output object named '",
       name(),
       "'");
 }

◆ outputInput()

void AdvancedOutput::outputInput ( )

protectedvirtualinherited

Performs the output of the input file By default this method does nothing and is not called, the individual Output objects are responsible for calling it.

Reimplemented in Exodus, and Console.

Definition at line 252 of file AdvancedOutput.C.

Referenced by AdvancedOutput::output().

 {
   mooseError("Output of the input file information is not support for this output object named '",
              name(),
              "'");
 }

◆ outputNodalVariables()

void AdvancedOutput::outputNodalVariables ( )

protectedvirtualinherited

Performs output of nodal nonlinear variables The child class must define this method to output the nonlinear variables as desired.

See also: Exodus::outputNodalVariables

Reimplemented in Exodus.

Definition at line 204 of file AdvancedOutput.C.

Referenced by AdvancedOutput::output().

 {
   mooseError("Individual output of nodal variables is not support for the output object named '",
              name(),
              "'");
 }

◆ outputPostprocessors()

void AdvancedOutput::outputPostprocessors ( )

protectedvirtualinherited

Performs output of postprocessors The child class must define this method to output the postprocessors as desired.

See also: Exodus::outputPostprocessors

Reimplemented in Console, Exodus, Nemesis, CSV, and TableOutput.

Definition at line 221 of file AdvancedOutput.C.

Referenced by AdvancedOutput::output().

 {
   mooseError("Individual output of postprocessors is not support for this output object named '",
              name(),
              "'");
 }

◆ outputReporters()

void AdvancedOutput::outputReporters ( )

protectedvirtualinherited

Output Reporter values.

The child class must define this method to output the Reporter values as desired

See also: CSV::outputReporters

Reimplemented in Console, Exodus, TableOutput, CSV, and JSONOutput.

Definition at line 260 of file AdvancedOutput.C.

Referenced by AdvancedOutput::output().

 {
   mooseError(
       "Output of the Reporter value(s) is not support for this output object named '", name(), "'");
 }

◆ outputScalarVariables()

void AdvancedOutput::outputScalarVariables ( )

protectedvirtualinherited

Performs output of scalar variables The child class must define this method to output the scalar variables as desired.

See also: Exodus::outputScalarVariables

Reimplemented in Exodus, Console, Nemesis, CSV, and TableOutput.

Definition at line 238 of file AdvancedOutput.C.

Referenced by AdvancedOutput::output().

 {
   mooseError(
       "Individual output of scalars is not support for this output object named '", name(), "'");
 }

◆ outputStep()

void SampledOutput::outputStep ( const ExecFlagType & type )

overridevirtual

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 from Output.

Definition at line 85 of file SampledOutput.C.

 {
   // 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;
 
   // store current simulation time
   _last_output_simulation_time = _time;
 
   // set current type
   _current_execute_flag = type;
 
   // Call the output method
   if (shouldOutput())
   {
     TIME_SECTION("outputStep", 2, "Outputting Step");
     updateSample();
     output();
   }
 
   _current_execute_flag = EXEC_NONE;
 }

◆ outputSystemInformation()

void AdvancedOutput::outputSystemInformation ( )

protectedvirtualinherited

Todo:: {Make this call automatic in similar fashion to outputInput} Performs the output of system information By default this method does nothing and is not called by output()

Reimplemented in Console, and JSONOutput.

Definition at line 245 of file AdvancedOutput.C.

Referenced by AdvancedOutput::output().

 {
   mooseError(
       "Output of system information is not support for this output object named '", name(), "'");
 }

◆ outputVectorPostprocessors()

void AdvancedOutput::outputVectorPostprocessors ( )

protectedvirtualinherited

Performs output of VectorPostprocessors The child class must define this method to output the VectorPostprocessors as desired.

Reimplemented in Console, TableOutput, CSV, and XMLOutput.

Definition at line 229 of file AdvancedOutput.C.

Referenced by AdvancedOutput::output().

 {
   mooseError(
       "Individual output of VectorPostprocessors is not support for this output object named '",
       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 435 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 127 of file MooseBase.h.

127 { return _pars; }

MooseBase::_pars

const InputParameters & _pars

The object's parameters.

Definition: MooseBase.h:362

◆ 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 449 of file MooseBase.h.

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

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

◆ paramWarning()

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 442 of file MooseBase.h.

Referenced by GridPartitioner::_do_partition(), MultiAppTransfer::checkParentAppUserObjectExecuteOn(), EigenProblem::checkProblemIntegrity(), CombinerGenerator::copyIntoMesh(), DefaultMultiAppFixedPointConvergence::DefaultMultiAppFixedPointConvergence(), MultiAppNearestNodeTransfer::execute(), FEProblemSolve::FEProblemSolve(), UniqueExtraIDMeshGenerator::generate(), PlaneIDMeshGenerator::generate(), Terminator::initialSetup(), initSample(), MooseMesh::MooseMesh(), FEProblemBase::setPreserveMatrixSparsityPattern(), and Terminator::Terminator().

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

◆ perfGraph()

PerfGraph & PerfGraphInterface::perfGraph ( )

inherited

Get the PerfGraph.

Definition at line 78 of file PerfGraphInterface.C.

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

 {
   return _pg_moose_app.perfGraph();
 }

◆ petscLinearOutput()

PetscErrorCode PetscOutputInterface::petscLinearOutput	(	KSP	,
		PetscInt	its,
		PetscReal	fnorm,
		void *	void_ptr
	)

staticprotectedinherited

Performs the output onlinear iterations This is the monitor method that PETSc will call on linear iterations.

This is one of three locations where we explicitly flush the output buffers during a simulation: PetscOutput::petscNonlinearOutput() PetscOutput::petscLinearOutput() OutputWarehouse::outputStep()

All other Console output should be using newlines to avoid covering buffer errors and to avoid excessive I/O. This call is necessary. In the PETSc callback the context bypasses the OutputWarehouse.

Definition at line 76 of file PetscOutput.C.

Referenced by PetscOutput::solveSetup().

 {
   // Get the primary outputter object
   PetscOutput * primary_ptr = static_cast<PetscOutput *>(void_ptr);
 
   // loop over all interface objects
   for (const auto poi_ptr : primary_ptr->getMooseApp().getInterfaceObjects<PetscOutputInterface>())
   {
     auto ptr = poi_ptr->_petsc_output;
 
     // check time
     if (!ptr->inLinearTimeWindow())
       continue;
 
     // Update the pseudo time
     ptr->_linear_time += ptr->_linear_dt;
 
     // Set the current norm and iteration number
     ptr->_norm = norm;
     ptr->_linear_iter = its;
 
     // Set the flag indicating that output is occurring on the non-linear residual
     ptr->_on_linear_residual = true;
 
     // Perform the output
     ptr->outputStep(EXEC_LINEAR);
 
     ptr->_app.getOutputWarehouse().flushConsoleBuffer();
 
     // Reset the linear output flag and the simulation time
     ptr->_on_linear_residual = false;
   }
 
   // Done
   return (PetscErrorCode)0;
 }

◆ petscNonlinearOutput()

PetscErrorCode PetscOutputInterface::petscNonlinearOutput	(	SNES	,
		PetscInt	its,
		PetscReal	fnorm,
		void *	void_ptr
	)

staticprotectedinherited

Performs the output on non-linear iterations This is the monitor method that PETSc will call on non-linear iterations.

This is one of three locations where we explicitly flush the output buffers during a simulation: PetscOutput::petscNonlinearOutput() PetscOutput::petscLinearOutput() OutputWarehouse::outputStep()

All other Console output should be using newlines to avoid covering buffer errors and to avoid excessive I/O. This call is necessary. In the PETSc callback the context bypasses the OutputWarehouse.

Definition at line 26 of file PetscOutput.C.

Referenced by PetscOutput::solveSetup().

 {
   // Get the primary outputter object
   PetscOutput * primary_ptr = static_cast<PetscOutput *>(void_ptr);
 
   // loop over all interface objects
   for (const auto poi_ptr : primary_ptr->getMooseApp().getInterfaceObjects<PetscOutputInterface>())
   {
     auto ptr = poi_ptr->_petsc_output;
 
     // check time
     if (!ptr->inNonlinearTimeWindow())
       continue;
 
     // Update the pseudo times
     ptr->_nonlinear_time += ptr->_nonlinear_dt;
     ptr->_linear_time = ptr->_nonlinear_time;
 
     // Set the current norm and iteration number
     ptr->_norm = norm;
     ptr->_nonlinear_iter = its;
 
     // Set the flag indicating that output is occurring on the non-linear residual
     ptr->_on_nonlinear_residual = true;
 
     // Perform the output
     ptr->outputStep(EXEC_NONLINEAR);
 
     ptr->_app.getOutputWarehouse().flushConsoleBuffer();
 
     // Reset the non-linear output flag and the simulation time
     ptr->_on_nonlinear_residual = false;
   }
 
   // Done
   return (PetscErrorCode)0;
 }

◆ queryParam()

template<typename T >

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

inherited

Query a parameter for the object.

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 391 of file MooseBase.h.

 {
   return isParamValid(name) ? &getParam<T>(name) : nullptr;
 }

◆ 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 53 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 64 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);
 }

◆ 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 MooseVariableFE< OutputType >, MooseVariableFE< ComputeValueType >, MooseVariableFE< T >, MooseVariableFE< RealEigenVector >, MooseVariableFE< VectorValue< Real > >, MooseVariableFE< RealVectorValue >, MooseVariableFE< Real >, MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableField< OutputType >, MooseVariableField< RT >, MooseVariableField< ComputeValueType >, MooseVariableField< T >, MooseVariableField< RealEigenVector >, MooseVariableField< RealVectorValue >, MooseVariableField< Real >, MooseLinearVariableFV< OutputType >, MooseLinearVariableFV< ComputeValueType >, MooseLinearVariableFV< T >, MooseLinearVariableFV< RealEigenVector >, MooseLinearVariableFV< RealVectorValue >, MooseLinearVariableFV< Real >, Function, NodeFaceConstraint, Positions, and Times.

Definition at line 56 of file SetupInterface.C.

Referenced by MooseVariableField< Real >::residualSetup(), ComputeFVFluxResidualThread< RangeType >::setup(), and ComputeFVFluxRJThread< RangeType >::setup().

57 {

58 }

◆ 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 66 of file Restartable.C.

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

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

◆ setFileBase()

void FileOutput::setFileBase ( const std::string & file_base )

inherited

Sets the file base string if the 'file_base' parameter is not set.

Parameters

file_base The new file base string

Definition at line 119 of file FileOutput.C.

 {
   if (!isParamValid("file_base"))
     setFileBaseInternal(file_base);
 }

◆ setFileBaseInternal()

void SampledOutput::setFileBaseInternal ( const std::string & file_base )

overrideprotectedvirtual

Appends the base class's file base string.

Reimplemented from FileOutput.

Definition at line 530 of file SampledOutput.C.

 {
   AdvancedOutput::setFileBaseInternal(file_base);
   // ** DEPRECATED SUPPORT **
   if (getParam<bool>("append_oversample"))
     _file_base += "_oversample";
 }

◆ setFileNumber()

void FileOutput::setFileNumber ( unsigned int num )

inherited

Sets the file number manually.

This method was implemented for the MultiApp system, particularly when reseting an application and a new output file is desired after the reset.

Definition at line 174 of file FileOutput.C.

Referenced by OutputWarehouse::setFileNumbers().

 {
   _file_num = num;
 }

◆ setWallTimeIntervalFromCommandLineParam()

void Output::setWallTimeIntervalFromCommandLineParam ( )

protectedinherited

Function to set the wall time interval based on value of command line parameter (used for testing only).

Parameters

cli_param_name The name of the command line parameter to set the wall time interval to

Definition at line 338 of file Output.C.

Referenced by Checkpoint::Checkpoint().

 {
   if (_app.isParamValid("output_wall_time_interval"))
   {
     _wall_time_interval = _app.getParam<Real>("output_wall_time_interval");
 
     // If default value of _wall_time_interval was just overriden and user did not
     // explicitly specify _time_step_interval, override default value of
     // _time_step_interval so output does not occur after every time step
     if (_time_step_interval_set_by_addparam)
       _time_step_interval = std::numeric_limits<unsigned int>::max();
   }
 }

◆ shouldOutput()

bool AdvancedOutput::shouldOutput ( )

protectedvirtualinherited

Handles logic for determining if a step should be output.

Returns: True if a call if output should be performed

Reimplemented from FileOutput.

Definition at line 267 of file AdvancedOutput.C.

Referenced by outputStep().

 {
   if (!checkFilename())
     return false;
 
   if (hasOutput(_current_execute_flag))
     return true;
   else
     return Output::shouldOutput();
 }

◆ 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 MaterialBase, Material, GeneralUserObject, NodalUserObject, Constraint, and ThreadedGeneralUserObject.

Definition at line 61 of file SetupInterface.C.

62 {

63 }

◆ supportsMaterialPropertyOutput()

virtual bool Output::supportsMaterialPropertyOutput ( ) const

inlinevirtualinherited

A virtual function that stores whether output type supports material output.

Defaults to false, if a particular output type supports material output it can be overridden in the child class.

Reimplemented in Checkpoint, Exodus, Nemesis, VTKOutput, Tecplot, and XDA.

Definition at line 150 of file Output.h.

Referenced by OutputWarehouse::hasMaterialPropertyOutput().

150 { return false; }

◆ time()

Real PetscOutput::time ( )

overridevirtualinherited

Get the output time.

This outputter enables the ability to perform output on the nonlinear and linear iterations performed by PETSc. To separate theses outputs within the output a pseudo time is defined, this function provides this time and it should be used in place of _time from Outputter.

Reimplemented from Output.

Definition at line 262 of file PetscOutput.C.

Referenced by PetscOutput::getOutputTime(), MFEMDataCollection::output(), and FileOutput::setFileBaseInternal().

 {
   if (_on_nonlinear_residual)
     return _nonlinear_time;
   else if (_on_linear_residual)
     return _linear_time;
   else
     return Output::time();
 }

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

Referenced by PerfGraphInterface::registerTimedSection().

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

◆ timeOld()

Real Output::timeOld ( )

virtualinherited

Get the old output time.

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

See also: time()

Definition at line 362 of file Output.C.

Referenced by Console::writeTimestepInformation().

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

◆ timeStep()

int Output::timeStep ( )

virtualinherited

Get the current time step.

Definition at line 389 of file Output.C.

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

 {
   return _t_step;
 }

◆ timestepSetup()

void SetupInterface::timestepSetup ( )

virtualinherited

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

Reimplemented in MooseVariableFV< OutputType >, MooseVariableFV< ComputeValueType >, MooseVariableFV< T >, MooseVariableFV< RealEigenVector >, MooseVariableFV< RealVectorValue >, MooseVariableFV< Real >, MooseVariableField< OutputType >, MooseVariableField< RT >, MooseVariableField< ComputeValueType >, MooseVariableField< T >, MooseVariableField< RealEigenVector >, MooseVariableField< RealVectorValue >, MooseVariableField< Real >, Function, Positions, Times, SolutionUserObjectBase, Console, VectorPostprocessorVisualizationAux, EqualValueEmbeddedConstraintTempl< is_ad >, NumNonlinearIterations, VectorMemoryUsage, JSONOutput, and MemoryUsage.

Definition at line 46 of file SetupInterface.C.

Referenced by JSONOutput::timestepSetup(), and MooseVariableField< Real >::timestepSetup().

47 {

48 }

◆ 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 89 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 54 of file MooseBase.C.

Referenced by FEProblemBase::addPostprocessor(), MaterialPropertyStorage::addProperty(), FEProblemBase::addReporter(), FEProblemBase::addVectorPostprocessor(), MeshGeneratorSystem::dataDrivenError(), ReporterContext< std::vector< T > >::finalize(), and ReporterData::getReporterInfo().

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

◆ uniqueName()

MooseObjectName MooseBase::uniqueName ( ) const

inherited

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

Definition at line 66 of file MooseBase.C.

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

 {
   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));
 }

◆ 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 60 of file MooseBase.C.

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

◆ updateSample()

void SampledOutput::updateSample ( )

protectedvirtual

Performs the update of the solution vector for the sample/re-positioned mesh.

Definition at line 293 of file SampledOutput.C.

Referenced by outputStep().

 {
   // Do nothing if oversampling and changing position are not enabled
   if (!_use_sampled_output)
     return;
 
   // We need the mesh functions to extend the whole domain so we serialize both the mesh and the
   // solution. We need this because the partitioning of the sampling mesh may not match the
   // partitioning of the source mesh
   if (_serialize)
   {
     _problem_ptr->mesh().getMesh().gather_to_zero();
     _mesh_ptr->getMesh().gather_to_zero();
   }
 
   // Get a reference to actual equation system
   EquationSystems & source_es = _problem_ptr->es();
   const auto num_systems = source_es.n_systems();
 
   // Loop through each system
   for (const auto sys_num : make_range(num_systems))
   {
     if (!_mesh_functions[sys_num].empty())
     {
       // Get references to the source and destination systems
       System & source_sys = source_es.get_system(sys_num);
       System & dest_sys = _sampling_es->get_system(sys_num);
 
       // Update the solution for the sampling mesh
       if (_serialize)
       {
         _serialized_solution->clear();
         _serialized_solution->init(source_sys.n_dofs(), false, SERIAL);
         // Pull down a full copy of this vector on every processor so we can get values in
         // parallel
         source_sys.solution->localize(*_serialized_solution);
       }
 
       // Update the mesh functions
       for (const auto var_num : index_range(_mesh_functions[sys_num]))
       {
         const auto original_var_num = _variable_numbers_in_system[sys_num][var_num];
 
         // If the mesh has changed, the MeshFunctions need to be re-built, otherwise simply clear
         // it for re-initialization
         // TODO: inherit from MeshChangedInterface and rebuild mesh functions on meshChanged()
         if (!_mesh_functions[sys_num][var_num] || _sampling_mesh_changed)
           _mesh_functions[sys_num][var_num] = std::make_unique<MeshFunction>(
               source_es,
               _serialize ? *_serialized_solution : *source_sys.solution,
               source_sys.get_dof_map(),
               original_var_num);
         else
           _mesh_functions[sys_num][var_num]->clear();
 
         // Initialize the MeshFunctions for application to the sampled solution
         _mesh_functions[sys_num][var_num]->init();
 
         // Mesh functions are still defined on the original mesh, which might not fully overlap
         // with the sampling mesh. We don't want to error with a libMesh assert on the out of mesh
         // mode
         _mesh_functions[sys_num][var_num]->enable_out_of_mesh_mode(-1e6);
       }
 
       // Fill solution vectors by evaluating mesh functions on sampling mesh
       for (const auto var_num : index_range(_mesh_functions[sys_num]))
       {
         // we serialized the mesh and the solution vector, we might as well just do this only on
         // processor 0.
         if (_serialize && processor_id() > 0)
           break;
 
         const auto original_var_num = _variable_numbers_in_system[sys_num][var_num];
         const FEType & fe_type = source_sys.variable_type(original_var_num);
         // we use the original variable block restriction for sampling
         const auto * var_blocks = &source_sys.variable(original_var_num).active_subdomains();
         // NOTE: if we have overlapping domains between the sampling mesh and the source mesh
         // we would get a value from the source mesh domain. We could further restrict this
         // block restriction with the sampling mesh block restriction to prevent this.
 
         // Loop over the mesh, nodes for nodal data, elements for element data
         if (isSampledAtNodes(fe_type))
         {
           for (const auto & node : (_serialize ? _mesh_ptr->getMesh().node_ptr_range()
                                                : _mesh_ptr->getMesh().local_node_ptr_range()))
           {
             // Avoid working on ghosted dofs
             if (node->n_dofs(sys_num, var_num) &&
                 (_serialize || processor_id() == node->processor_id()))
             {
               // the node has to be within the domain of the mesh function
               DenseVector<Real> value(1);
               if (var_blocks->size())
                 (*_mesh_functions[sys_num][var_num])(
                     *node - _position, /*time*/ 0., value, var_blocks);
               else
                 value[0] = (*_mesh_functions[sys_num][var_num])(*node - _position);
 
               if (value[0] != -1e6)
                 dest_sys.solution->set(node->dof_number(sys_num, var_num, /*comp=*/0), value[0]);
               else
                 mooseDoOnce(mooseWarning(
                     "Sampling at location ",
                     *node - _position,
                     " by process ",
                     std::to_string(processor_id()),
                     " was outside the problem mesh.\nThis message will not be repeated"));
             }
           }
         }
         else
         {
           const auto elem_range = _serialize
                                       ? _mesh_ptr->getMesh().active_element_ptr_range()
                                       : _mesh_ptr->getMesh().active_local_element_ptr_range();
           for (const auto & elem : elem_range)
           {
             if (elem->n_dofs(sys_num, var_num) &&
                 (_serialize || processor_id() == elem->processor_id()))
             {
               DenseVector<Real> value(1);
               if (var_blocks->size())
                 (*_mesh_functions[sys_num][var_num])(
                     elem->true_centroid() - _position, /*time*/ 0., value, var_blocks);
               else
                 value[0] = (*_mesh_functions[sys_num][var_num])(elem->true_centroid() - _position);
 
               if (value[0] != -1e6)
                 dest_sys.solution->set(elem->dof_number(sys_num, var_num, /*comp=*/0), value[0]);
               else
                 mooseDoOnce(mooseWarning(
                     "Sampling at location ",
                     elem->true_centroid() - _position,
                     " was outside the problem mesh.\nThis message will not be repeated."));
             }
           }
         }
       }
 
       // We modified the solution vector directly, we have to close it
       dest_sys.solution->close();
     }
   }
 
   // Set this to false so that new output files are not created, since the sampling mesh
   // doesn't actually change
   _sampling_mesh_changed = false;
 }

◆ validParams()

InputParameters SampledOutput::validParams ( )

static

Definition at line 25 of file SampledOutput.C.

Referenced by GMVOutput::validParams(), XDA::validParams(), VTKOutput::validParams(), Tecplot::validParams(), and Exodus::validParams().

 {
 
   // Get the parameters from the parent object
   InputParameters params = AdvancedOutput::validParams();
   params.addParam<unsigned int>("refinements",
                                 0,
                                 "Number of uniform refinements for oversampling "
                                 "(refinement levels beyond any level of "
                                 "refinements already applied on the regular mesh)");
   params.addParam<Point>("position",
                          "Set a positional offset, this vector will get added to the "
                          "nodal coordinates to move the domain.");
   params.addParam<MeshFileName>("file", "The name of the mesh file to read, for oversampling");
   params.addParam<std::vector<SubdomainName>>(
       "sampling_blocks", "The list of blocks to restrict the mesh sampling to");
   params.addParam<bool>(
       "serialize_sampling",
       true,
       "If set to true, all sampled output (see sampling parameters) will be done "
       "on rank 0. This option is useful to debug suspected parallel output issues");
 
   // **** DEPRECATED PARAMETERS ****
   params.addDeprecatedParam<bool>("append_oversample",
                                   false,
                                   "Append '_oversample' to the output file base",
                                   "This parameter is deprecated. To append '_oversample' utilize "
                                   "the output block name or the 'file_base'");
 
   // 'Oversampling' Group
   params.addParamNamesToGroup("refinements position file sampling_blocks serialize_sampling",
                               "Modified Mesh Sampling");
 
   return params;
 }

Member Data Documentation

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

◆ _advanced_execute_on

OutputOnWarehouse Output::_advanced_execute_on

protectedinherited

Storage for the individual component execute flags.

Definition at line 280 of file Output.h.

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

◆ _allow_output

bool Output::_allow_output

protectedinherited

Flag for disabling output.

Definition at line 271 of file Output.h.

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

◆ _app

MooseApp& MooseBase::_app

protectedinherited

The MOOSE application this is associated with.

Definition at line 353 of file MooseBase.h.

◆ _change_position

const bool SampledOutput::_change_position

protected

Flag for re-positioning.

Definition at line 68 of file SampledOutput.h.

Referenced by initSample().

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

ExecFlagType Output::_current_execute_flag

protectedinherited

Current execute on flag.

This is different from the flag provided by FEProblemBase::getCurrentExecuteOnFlag() const, as outputs are triggered in PETSc callbacks which cannot update FEProblemBase::_current_execute_on_flag so we shadow it with a new member of the same name.

Definition at line 211 of file Output.h.

Referenced by CSV::getVectorPostprocessorFileName(), ProgressOutput::output(), ControlOutput::output(), CSV::output(), Console::output(), AdvancedOutput::output(), outputStep(), Output::outputStep(), PerfGraphOutput::shouldOutput(), Checkpoint::shouldOutput(), Output::shouldOutput(), and AdvancedOutput::shouldOutput().

◆ _dt

Real& Output::_dt

protectedinherited

Time step delta.

Definition at line 223 of file Output.h.

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

◆ _dt_old

Real& Output::_dt_old

protectedinherited

Old time step delta.

Definition at line 226 of file Output.h.

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

◆ _elemental_as_nodal

bool AdvancedOutput::_elemental_as_nodal

protectedinherited

Flags to control nodal output.

Definition at line 286 of file AdvancedOutput.h.

Referenced by Exodus::Exodus(), and AdvancedOutput::init().

◆ _enabled

const bool& MooseObject::_enabled

protectedinherited

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

Definition at line 50 of file MooseObject.h.

Referenced by MooseObject::enabled().

◆ _end_step

int Output::_end_step

protectedinherited

End outputting at this time step.

Definition at line 262 of file Output.h.

Referenced by Output::onInterval().

◆ _end_time

Real Output::_end_time

protectedinherited

End outputting time.

Definition at line 256 of file Output.h.

◆ _es_ptr

libMesh::EquationSystems* Output::_es_ptr

protectedinherited

Reference the the libMesh::EquationSystems object that contains the data.

Definition at line 194 of file Output.h.

Referenced by Exodus::handleExodusIOMeshRenumbering(), AdvancedOutput::initAvailableLists(), initSample(), AdvancedOutput::initShowHideLists(), PNGOutput::makeMeshFunc(), GMVOutput::output(), Tecplot::output(), VTKOutput::output(), XDA::output(), Output::Output(), Checkpoint::output(), Exodus::outputElementalVariables(), Exodus::outputEmptyTimestep(), Exodus::outputNodalVariables(), and Exodus::outputSetup().

◆ _execute_enum

const ExecFlagEnum& SetupInterface::_execute_enum

protectedinherited

Execute settings for this object.

Definition at line 75 of file SetupInterface.h.

◆ _execute_on

ExecFlagEnum Output::_execute_on

protectedinherited

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

Definition at line 203 of file Output.h.

Referenced by AdvancedOutput::AdvancedOutput(), Checkpoint::checkpointInfo(), Console::Console(), Output::executeOn(), AdvancedOutput::initExecutionTypes(), Console::initialSetup(), Console::output(), Output::Output(), PetscOutput::PetscOutput(), PerfGraphOutput::shouldOutput(), and Output::shouldOutput().

◆ _factory

Factory& ParallelParamObject::_factory

protectedinherited

The Factory associated with the MooseApp.

Definition at line 37 of file ParallelParamObject.h.

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

◆ _file_base

std::string FileOutput::_file_base

protectedinherited

The base filename from the input paramaters.

Definition at line 89 of file FileOutput.h.

Referenced by FileOutput::checkFilename(), Checkpoint::directory(), XMLOutput::filename(), JSONOutput::filename(), DOFMapOutput::filename(), FileOutput::filename(), GMVOutput::filename(), VTKOutput::filename(), Tecplot::filename(), XDA::filename(), Gnuplot::filename(), SolutionHistory::filename(), CSV::filename(), Console::filename(), Exodus::filename(), CSV::getVectorPostprocessorFileName(), CSV::getVectorPostprocessorFilePrefix(), CSV::initialSetup(), PNGOutput::makePNG(), setFileBaseInternal(), and FileOutput::setFileBaseInternal().

◆ _file_num

unsigned int& FileOutput::_file_num

protectedinherited

A file number counter, initialized to 0 (this must be controlled by the child class, see Exodus)

Definition at line 80 of file FileOutput.h.

Referenced by Exodus::customizeFileOutput(), DOFMapOutput::filename(), GMVOutput::filename(), VTKOutput::filename(), XDA::filename(), Tecplot::filename(), Exodus::filename(), FileOutput::FileOutput(), FileOutput::getFileNumber(), MFEMDataCollection::output(), GMVOutput::output(), VTKOutput::output(), XDA::output(), Tecplot::output(), Gnuplot::output(), FileOutput::setFileNumber(), and DOFMapOutput::writeStreamToFile().

◆ _is_advanced

bool Output::_is_advanced

protectedinherited

Flag for advanced output testing.

Definition at line 274 of file Output.h.

Referenced by AdvancedOutput::AdvancedOutput(), and Output::isAdvanced().

◆ _last_output_simulation_time

Real& Output::_last_output_simulation_time

protectedinherited

last simulation time an output has occured

Definition at line 283 of file Output.h.

Referenced by Output::onInterval(), outputStep(), and Output::outputStep().

◆ _last_output_wall_time

std::chrono::time_point<std::chrono::steady_clock> Output::_last_output_wall_time

protectedinherited

last wall time an output has occured

Definition at line 286 of file Output.h.

Referenced by Output::onInterval(), and Output::outputStep().

◆ _linear_iter

PetscInt PetscOutput::_linear_iter

protectedinherited

Current linear iteration returned from PETSc.

Definition at line 87 of file PetscOutput.h.

Referenced by CSV::getVectorPostprocessorFileName(), Console::output(), JSONOutput::outputReporters(), and XMLOutput::outputVectorPostprocessors().

◆ _mci_feproblem

FEProblemBase& MeshChangedInterface::_mci_feproblem

protectedinherited

Reference to FEProblemBase instance.

Definition at line 34 of file MeshChangedInterface.h.

Referenced by MeshChangedInterface::MeshChangedInterface().

◆ _mesh_functions

std::vector<std::vector<std::unique_ptr<libMesh::MeshFunction> > > SampledOutput::_mesh_functions

private

A vector of pointers to the mesh functions on the sampled mesh This is only populated when the initSample() function is called, it must be cleaned up by the destructor.

Outer-indexing by system Inner-indexing for each variable in a system

Definition at line 101 of file SampledOutput.h.

Referenced by initSample(), and updateSample().

◆ _mesh_ptr

MooseMesh* Output::_mesh_ptr

protectedinherited

A convenience pointer to the current mesh (reference or displaced depending on "use_displaced")

Definition at line 197 of file Output.h.

Referenced by cloneMesh(), initSample(), Tecplot::output(), XDA::output(), PNGOutput::output(), Output::Output(), Exodus::outputSetup(), and updateSample().

◆ _mesh_subdomains_match

bool SampledOutput::_mesh_subdomains_match

private

A flag tracking whether the sampling and source meshes match in terms of subdomains.

Definition at line 113 of file SampledOutput.h.

Referenced by cloneMesh(), and initSample().

◆ _min_simulation_time_interval

const Real Output::_min_simulation_time_interval

protectedinherited

Minimum simulation time between outputs.

Definition at line 238 of file Output.h.

Referenced by Output::onInterval().

◆ _name

const std::string& MooseBase::_name

protectedinherited

The name of this class.

Definition at line 359 of file MooseBase.h.

◆ _nonlinear_iter

PetscInt PetscOutput::_nonlinear_iter

protectedinherited

Current non-linear iteration returned from PETSc.

Definition at line 84 of file PetscOutput.h.

Referenced by CSV::getVectorPostprocessorFileName(), Console::output(), JSONOutput::outputReporters(), and XMLOutput::outputVectorPostprocessors().

◆ _norm

Real PetscOutput::_norm

protectedinherited

Current norm returned from PETSc.

Definition at line 81 of file PetscOutput.h.

Referenced by Console::output().

◆ _num

unsigned int Output::_num

protectedinherited

The number of outputs written.

Definition at line 229 of file Output.h.

◆ _on_linear_residual

bool PetscOutput::_on_linear_residual

protectedinherited

True if current output calls is on the linear residual (used by time())

Definition at line 90 of file PetscOutput.h.

Referenced by PetscOutput::time().

◆ _on_nonlinear_residual

bool PetscOutput::_on_nonlinear_residual

protectedinherited

True if current output call is on the non-linear residual (used by time())

Definition at line 93 of file PetscOutput.h.

Referenced by JSONOutput::outputReporters(), XMLOutput::outputVectorPostprocessors(), and PetscOutput::time().

◆ _output_if_base_contains

std::vector<std::string> FileOutput::_output_if_base_contains

protectedinherited

Storage for 'output_if_base_contains'.

Definition at line 86 of file FileOutput.h.

Referenced by FileOutput::checkFilename().

◆ _padding

unsigned int FileOutput::_padding

protectedinherited

Number of digits to pad the extensions.

Definition at line 83 of file FileOutput.h.

Referenced by JSONOutput::filename(), GMVOutput::filename(), VTKOutput::filename(), XDA::filename(), Tecplot::filename(), Checkpoint::filename(), Exodus::filename(), and CSV::getVectorPostprocessorFileName().

◆ _pars

const InputParameters& MooseBase::_pars

protectedinherited

The object's parameters.

Definition at line 362 of file MooseBase.h.

Referenced by AddFVICAction::act(), AddICAction::act(), CreateProblemDefaultAction::act(), CreateProblemAction::act(), SetupMeshAction::act(), ComposeTimeStepperAction::act(), SetupDebugAction::act(), AddAuxKernelAction::act(), AddPeriodicBCAction::act(), CommonOutputAction::act(), FunctorMaterial::addFunctorPropertyByBlocks(), BreakMeshByBlockGeneratorBase::BreakMeshByBlockGeneratorBase(), PiecewiseTabularBase::buildFromFile(), PNGOutput::calculateRescalingValues(), MooseBase::callMooseError(), MooseBase::connectControllableParams(), Console::Console(), MooseApp::copyInputs(), MaterialBase::declareADProperty(), MaterialBase::declareProperty(), FEProblemSolve::FEProblemSolve(), FunctionMaterialBase< is_ad >::FunctionMaterialBase(), FileMeshGenerator::generate(), MooseBase::getBase(), MooseBase::getCheckedPointerParam(), MaterialBase::getGenericZeroMaterialProperty(), MooseBase::getHitNode(), MeshGenerator::getMeshGeneratorNameFromParam(), MeshGenerator::getMeshGeneratorNamesFromParam(), MooseBase::getParam(), MooseBase::hasBase(), MeshGenerator::hasGenerateData(), AddVariableAction::init(), AdvancedOutput::initExecutionTypes(), Console::initialSetup(), MooseBase::isParamSetByUser(), MooseBase::isParamValid(), MultiApp::keepSolutionDuringRestore(), MooseBase::messagePrefix(), MooseBase::MooseBase(), MooseApp::outputMachineReadableData(), MooseBase::paramError(), GlobalParamsAction::parameters(), MooseBase::parameters(), MooseBase::paramInfo(), MooseBase::paramWarning(), MooseMesh::prepare(), Eigenvalue::prepareSolverOptions(), MooseMesh::setCoordSystem(), MooseMesh::setPartitionerHelper(), SetupMeshAction::setupMesh(), TransientBase::setupTimeIntegrator(), MooseApp::showInputs(), and MooseBase::uniqueName().

◆ _petsc_output

PetscOutput* PetscOutputInterface::_petsc_output

protectedinherited

Definition at line 23 of file PetscOutput.h.

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

◆ _pg_moose_app

MooseApp& PerfGraphInterface::_pg_moose_app

protectedinherited

The MooseApp that owns the PerfGraph.

Definition at line 124 of file PerfGraphInterface.h.

Referenced by PerfGraphInterface::perfGraph().

◆ _position

Point SampledOutput::_position

private

When oversampling, the output is shift by this amount.

Definition at line 107 of file SampledOutput.h.

Referenced by initSample(), and updateSample().

◆ _prefix

const std::string PerfGraphInterface::_prefix

protectedinherited

A prefix to use for all sections.

Definition at line 127 of file PerfGraphInterface.h.

Referenced by PerfGraphInterface::timedSectionName().

◆ _problem_ptr

FEProblemBase* Output::_problem_ptr

protectedinherited

Pointer the the FEProblemBase object for output object (use this)

Definition at line 185 of file Output.h.

Referenced by PNGOutput::calculateRescalingValues(), cloneMesh(), Exodus::handleExodusIOMeshRenumbering(), AdvancedOutput::initAvailableLists(), JSONOutput::initialSetup(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), initSample(), AdvancedOutput::initShowHideLists(), PNGOutput::makeMeshFunc(), Console::meshChanged(), ReporterDebugOutput::output(), MaterialPropertyDebugOutput::output(), DOFMapOutput::output(), SolutionHistory::output(), VariableResidualNormsDebugOutput::output(), CSV::output(), Output::Output(), Exodus::outputEmptyTimestep(), Exodus::outputNodalVariables(), Exodus::outputPostprocessors(), TableOutput::outputPostprocessorsRow(), JSONOutput::outputReporters(), TableOutput::outputScalarVariables(), Exodus::outputScalarVariables(), Exodus::outputSetup(), Console::outputSystemInformation(), XMLOutput::outputVectorPostprocessors(), BlockRestrictionDebugOutput::printBlockRestrictionMap(), MaterialPropertyDebugOutput::printMaterialMap(), TopResidualDebugOutput::printTopResiduals(), SolutionInvalidityOutput::shouldOutput(), TableOutput::shouldOutputPostprocessorsRow(), PetscOutput::solveSetup(), Checkpoint::updateCheckpointFiles(), updateSample(), and Console::writeVariableNorms().

◆ _refinements

const unsigned int SampledOutput::_refinements

protected

The number of oversampling refinements.

Definition at line 62 of file SampledOutput.h.

Referenced by initSample().

◆ _reporter_data

const ReporterData& AdvancedOutput::_reporter_data

protectedinherited

Storage for Reporter values.

Definition at line 289 of file AdvancedOutput.h.

Referenced by AdvancedOutput::initAvailableLists(), CSV::output(), TableOutput::outputReporter(), Exodus::outputReporters(), XMLOutput::outputVectorPostprocessors(), and TableOutput::outputVectorPostprocessors().

◆ _restartable_app

MooseApp& Restartable::_restartable_app

protectedinherited

Reference to the application.

Definition at line 227 of file Restartable.h.

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

◆ _restartable_read_only

const bool Restartable::_restartable_read_only

protectedinherited

Flag for toggling read only status (see ReporterData)

Definition at line 236 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 230 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 233 of file Restartable.h.

Referenced by Restartable::declareRestartableDataHelper().

◆ _sampling_es

std::unique_ptr<EquationSystems> SampledOutput::_sampling_es

private

Equation system holding the solution vectors for the sampled variables.

Definition at line 119 of file SampledOutput.h.

Referenced by initSample(), updateSample(), and ~SampledOutput().

◆ _sampling_mesh_changed

bool SampledOutput::_sampling_mesh_changed

private

A flag indicating that the mesh has changed and the sampled mesh needs to be re-initialized.

Definition at line 110 of file SampledOutput.h.

Referenced by meshChanged(), and updateSample().

◆ _sampling_mesh_ptr

std::unique_ptr<MooseMesh> SampledOutput::_sampling_mesh_ptr

private

Mesh used for sampling. The Output class' _mesh_ptr will refer to this mesh if sampling is being used.

Definition at line 122 of file SampledOutput.h.

Referenced by cloneMesh(), initSample(), and ~SampledOutput().

◆ _scalar_as_nodal

bool AdvancedOutput::_scalar_as_nodal

protectedinherited

Definition at line 286 of file AdvancedOutput.h.

Referenced by AdvancedOutput::init().

◆ _sequence

bool Output::_sequence

protectedinherited

Flag for forcing call to outputSetup() with every call to output() (restartable)

Definition at line 200 of file Output.h.

◆ _serialize

bool SampledOutput::_serialize

private

Flag indicating whether we are outputting in serial or parallel.

Definition at line 116 of file SampledOutput.h.

Referenced by cloneMesh(), initSample(), and updateSample().

◆ _serialized_solution

std::unique_ptr<NumericVector<Number> > SampledOutput::_serialized_solution

private

Sample solution vector.

Definition at line 130 of file SampledOutput.h.

Referenced by initSample(), and updateSample().

◆ _simulation_time_interval

const Real Output::_simulation_time_interval

protectedinherited

Target simulation time between outputs.

Definition at line 241 of file Output.h.

◆ _start_step

int Output::_start_step

protectedinherited

Start outputting at this time step.

Definition at line 259 of file Output.h.

Referenced by Output::onInterval().

◆ _start_time

Real Output::_start_time

protectedinherited

Start outputting time.

Definition at line 253 of file Output.h.

Referenced by Output::onInterval().

◆ _sync_only

bool Output::_sync_only

protectedinherited

Flag for only executing at sync times.

Definition at line 268 of file Output.h.

Referenced by Output::onInterval().

◆ _sync_times

std::set<Real> Output::_sync_times

protectedinherited

Sync times for this outputter.

Definition at line 247 of file Output.h.

Referenced by Output::getSyncTimes(), Output::onInterval(), and Output::Output().

◆ _sync_times_object

const Times* const Output::_sync_times_object

protectedinherited

Sync times object for this outputter.

Definition at line 250 of file Output.h.

Referenced by Output::onInterval(), and Output::Output().

◆ _t_step

int& Output::_t_step

protectedinherited

The current time step.

Definition at line 220 of file Output.h.

Referenced by PNGOutput::makePNG(), Output::onInterval(), TableOutput::outputReporter(), TableOutput::outputVectorPostprocessors(), Output::time(), Output::timeOld(), and Output::timeStep().

◆ _t_tol

Real Output::_t_tol

protectedinherited

Time checking tolerance.

Definition at line 265 of file Output.h.

Referenced by PetscOutput::inLinearTimeWindow(), PetscOutput::inNonlinearTimeWindow(), and Output::onInterval().

◆ _time

Real& Output::_time

protectedinherited

The current time for output purposes.

Definition at line 214 of file Output.h.

Referenced by PetscOutput::inLinearTimeWindow(), PetscOutput::inNonlinearTimeWindow(), PNGOutput::makePNG(), Output::onInterval(), AdvancedOutput::output(), TableOutput::outputReporter(), outputStep(), Output::outputStep(), TableOutput::outputVectorPostprocessors(), Output::time(), and AdvancedOutput::wantOutput().

◆ _time_old

Real& Output::_time_old

protectedinherited

The old time.

Definition at line 217 of file Output.h.

Referenced by PetscOutput::solveSetup(), and Output::timeOld().

◆ _time_step_interval

unsigned int Output::_time_step_interval

protectedinherited

The output time step interval.

Definition at line 235 of file Output.h.

Referenced by Output::onInterval(), and Output::setWallTimeIntervalFromCommandLineParam().

◆ _time_step_interval_set_by_addparam

const bool Output::_time_step_interval_set_by_addparam

protectedinherited

Whether time step interval is set by AddParam.

Definition at line 232 of file Output.h.

Referenced by Output::setWallTimeIntervalFromCommandLineParam().

◆ _transient

bool Output::_transient

protectedinherited

Transient flag (true = transient)

Definition at line 188 of file Output.h.

Referenced by Output::dt(), Output::dtOld(), Output::time(), Output::timeOld(), and Console::writeTimestepInformation().

◆ _type

const std::string& MooseBase::_type

protectedinherited

The type of this class.

Definition at line 356 of file MooseBase.h.

Referenced by ExplicitTimeIntegrator::ExplicitTimeIntegrator(), FEProblemSolve::FEProblemSolve(), FillBetweenCurvesGenerator::generate(), FillBetweenPointVectorsGenerator::generate(), FillBetweenSidesetsGenerator::generate(), ExplicitTimeIntegrator::init(), FEProblemBase::init(), MooseBase::MooseBase(), MooseStaticCondensationPreconditioner::MooseStaticCondensationPreconditioner(), PhysicsBasedPreconditioner::PhysicsBasedPreconditioner(), FEProblemBase::solverTypeString(), and MooseBase::type().

◆ _use_displaced

bool Output::_use_displaced

protectedinherited

Flag for using displaced mesh.

Definition at line 191 of file Output.h.

Referenced by Output::Output().

◆ _use_sampled_output

bool SampledOutput::_use_sampled_output

protected

Flag indicating that the sampled output should be used to re-sample the underlying EquationSystem of the output.

Definition at line 71 of file SampledOutput.h.

Referenced by initSample(), Exodus::outputSetup(), and updateSample().

◆ _using_external_sampling_file

const bool SampledOutput::_using_external_sampling_file

protected

Flag indicating another file is being used for the sampling.

Definition at line 65 of file SampledOutput.h.

Referenced by cloneMesh(), and initSample().

◆ _variable_numbers_in_system

std::vector<std::vector<unsigned int> > SampledOutput::_variable_numbers_in_system

private

A vector of vectors that keeps track of the variable numbers in each system for each mesh function.

Definition at line 104 of file SampledOutput.h.

Referenced by initSample(), and updateSample().

◆ _wall_time_interval

Real Output::_wall_time_interval

protectedinherited

Target wall time between outputs in seconds.

Definition at line 244 of file Output.h.

Referenced by Checkpoint::Checkpoint(), Checkpoint::checkpointInfo(), Output::onInterval(), Output::setWallTimeIntervalFromCommandLineParam(), and Checkpoint::shouldOutput().

◆ _wall_time_since_last_output

Real Output::_wall_time_since_last_output

protectedinherited

time in seconds since last output

Definition at line 289 of file Output.h.

Referenced by Output::onInterval(), and Checkpoint::shouldOutput().

◆ 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(), Factory::getValidParams(), ActionFactory::getValidParams(), AutomaticMortarGeneration::initOutput(), SetupMeshAction::modifyParamsForUseSplit(), and MortarNodalGeometryOutput::validParams().

◆ 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(), MooseObjectUnitTest::buildObjects(), ActionFactory::create(), 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(), 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().

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

include/outputs/SampledOutput.h
src/outputs/SampledOutput.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ DataFileParameterType

Constructor & Destructor Documentation

◆ SampledOutput()

◆ ~SampledOutput()

Member Function Documentation

◆ addDeprecatedInputParameters()

◆ addPostprocessorDependencyHelper()

◆ addReporterDependencyHelper()

◆ addVectorPostprocessorDependencyHelper()

◆ advancedExecuteOn()

◆ allowOutput()

◆ callMooseError() [1/2]

◆ callMooseError() [2/2]

◆ checkFilename()

◆ cloneMesh()

◆ connectControllableParams()

◆ coupledPostprocessors()

◆ customSetup()

◆ declareManagedRestartableDataWithContext()

◆ declareRecoverableData()

◆ declareRestartableData()

◆ declareRestartableDataWithContext()

◆ declareRestartableDataWithObjectName()

◆ declareRestartableDataWithObjectNameWithContext()

◆ dt()

◆ dtOld()

◆ enabled()

◆ enableOutputTypes()

◆ errorPrefix()

◆ executeOn()

◆ filename()

◆ getBase()

◆ getCheckedPointerParam()

◆ getDataFileName()

◆ getDataFileNameByName()

◆ getDataFilePath()

◆ getDefaultExecFlagEnum()

◆ getElementalVariableOutput()

◆ getExecuteOnEnum()

◆ getFileNumber()

◆ getFunction()

◆ getFunctionByName()

◆ getHitNode()

◆ getMooseApp()

◆ getNodalVariableOutput()

◆ getOutputTime()

◆ getParam() [1/2]

◆ getParam() [2/2]

◆ getPostprocessorName()

◆ getPostprocessorOutput()

◆ getPostprocessorValue()

◆ getPostprocessorValueByName()

◆ getPostprocessorValueOld()

◆ getPostprocessorValueOldByName()

◆ getPostprocessorValueOlder()

◆ getPostprocessorValueOlderByName()

◆ getRenamedParam()

◆ getReporterContextBaseByName()

◆ getReporterName()

◆ getReporterOutput()

◆ getReporterValue() [1/2]

◆ getReporterValue() [2/2]

◆ getReporterValueByName() [1/2]

◆ getReporterValueByName() [2/2]

◆ getRestartableData()

◆ getScalarOutput()

◆ getScatterVectorPostprocessorValue()

◆ getScatterVectorPostprocessorValueByName()