Class for output data to the TecplotII format. More...

#include <Tecplot.h>

Inheritance diagram for Tecplot:

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

virtual void	initialSetup () override
	Initialization method. 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...

const OutputOnWarehouse &	advancedExecuteOn () const
	Get the current advanced 'execute_on' selections for display. 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::string &	type () const
	Get the type of this object. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Static Public Member Functions
static InputParameters	validParams ()

static 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 ExecFlagEnum	getExecuteOptions ()
	(DEPRECATED) Returns the available options for the 'execute_on' input parameters TODO: ExecFlagType More...

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

Protected Member Functions
virtual void	output (const ExecFlagType &type) override
	Overload the Output::output method, this is required for Tecplot output due to the method utilized for outputting single/global parameters. More...

virtual std::string	filename () override
	Returns the current filename, this method handles adding the timestep suffix. More...

virtual void	updateOversample ()
	Performs the update of the solution vector for the oversample/re-positioned mesh. More...

virtual bool	shouldOutput (const ExecFlagType &type)
	Handles logic for determining if a step should be output. 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 ()

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

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

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

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

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

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

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

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

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

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

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

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

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

bool	_oversample
	Flag indicating that oversampling is enabled. More...

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

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

bool	_scalar_as_nodal

std::string	_file_base
	The base filename from the input paramaters. 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...

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

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

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

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

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

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

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

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

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

Real &	_time_old
	The old time. More...

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

Real &	_dt
	Time step delta. More...

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

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

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

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

Real	_start_time
	Start outputting time. More...

Real	_end_time
	End outputting time. More...

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

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

Real	_t_tol
	Time checking tolerance. More...

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

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

bool	_allow_output
	Flag for disabling output. More...

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

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

PerfID	_output_step_timer
	Timers. More...

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

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

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

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

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

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

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

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

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

const InputParameters *	_pg_params
	Params. More...

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

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

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

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

void	initAvailableLists ()
	Initializes the available lists for each of the output types. More...

void	initExecutionTypes (const std::string &name, ExecFlagEnum &input)
	Initialize the possible execution types. More...

void	initShowHideLists (const std::vector< VariableName > &show, const std::vector< VariableName > &hide)
	Parses the user-supplied input for hiding and showing variables and postprocessors into a list for each type of output. More...

template<typename postprocessor_type >
void	initPostprocessorOrVectorPostprocessorLists (const std::string &execute_data_name)
	Helper function for initAvailableLists, templated on warehouse type and postprocessor_type. More...

void	initOutputList (OutputData &data)
	Initializes the list of items to be output using the available, show, and hide lists. More...

bool	wantOutput (const std::string &name, const ExecFlagType &type)
	Handles logic for determining if a step should be output. More...

bool	hasOutputHelper (const std::string &name)
	Helper method for checking if output types exists. More...

void	solveSetup () override
	Internal setup function that executes at the beginning of the time step. More...

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

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

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

Static Private Member Functions
static void	addValidParams (InputParameters &params, const MultiMooseEnum &types)
	Method for defining the available parameters based on the types of outputs. More...

static MultiMooseEnum	getOutputTypes ()
	Get the supported types of output (e.g., postprocessors, etc.) More...

static PetscErrorCode	petscNonlinearOutput (SNES, PetscInt its, PetscReal fnorm, void *void_ptr)
	Performs the output on non-linear iterations. More...

static PetscErrorCode	petscLinearOutput (KSP, PetscInt its, PetscReal fnorm, void *void_ptr)
	Performs the output onlinear iterations. More...

Private Attributes
bool	_binary
	Flag for binary output. More...

bool	_ascii_append
	Flag for turning on appending to ASCII files. More...

bool &	_first_time
	True if this is the first time the file has been written to, gets set to false after the first call to output(). More...

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

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

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

std::unique_ptr< EquationSystems >	_oversample_es

std::unique_ptr< MooseMesh >	_cloned_mesh_ptr

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

OutputDataWarehouse	_execute_data
	Storage structures for the various output types. More...

std::map< std::string, Real >	_last_execute_time
	Storage for the last output time for the various output types, this is used to avoid duplicate output when using OUTPUT_FINAL flag. More...

Real	_nonlinear_time
	The psuedo non-linear time. More...

Real	_nonlinear_dt
	The pseuedo non-linear time step. More...

Real	_linear_time
	Psuedo linear time. More...

Real	_linear_dt
	Psuedo linear time step. 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...

Real	_nonlinear_dt_divisor
	Pseudo non-linear timestep divisor. More...

Real	_linear_dt_divisor
	Pseudo linear timestep divisor. More...

Real	_nonlinear_start_time
	Non-linear residual output start time. More...

Real	_linear_start_time
	Linear residual output start time. More...

Real	_nonlinear_end_time
	Non-linear residual output end time. More...

Real	_linear_end_time
	Linear residual output end time. More...

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

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

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

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

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

Detailed Description

Class for output data to the TecplotII format.

Definition at line 24 of file Tecplot.h.

Constructor & Destructor Documentation

◆ Tecplot()

Tecplot::Tecplot ( const InputParameters & parameters )

Class constructor.

Definition at line 49 of file Tecplot.C.

   : OversampleOutput(parameters),
     _binary(getParam<bool>("binary")),
     _ascii_append(getParam<bool>("ascii_append")),
     _first_time(declareRestartableData<bool>("first_time", true))
 {
 #ifndef LIBMESH_HAVE_TECPLOT_API
   if (_binary)
   {
     mooseWarning(
         "Teclplot binary output requested but not available, outputting ASCII format instead.");
     _binary = false;
   }
 #endif
 }

Member Function Documentation

◆ addDeprecatedInputParameters()

static void Output::addDeprecatedInputParameters ( InputParameters & params )

staticinherited

A static helper for injecting deprecated parameters.

◆ addValidParams()

void AdvancedOutput::addValidParams	(	InputParameters &	params,
		const MultiMooseEnum &	types
	)

staticprivateinherited

Method for defining the available parameters based on the types of outputs.

Parameters

params	The InputParamters object to add parameters to
types	The types of output this object should support (see Output::enableOutputTypes)

Each output object may have a varying set of supported output types (e.g., elemental variables may not be supported). This private, static method populates the InputParameters object with the correct parameters based on the items contained in the ExecFlagEnum.

This method is private, users should utilize the Output::enableOutputTypes method

See also: Output::enableOutputTypes

Definition at line 627 of file AdvancedOutput.C.

 {
   ExecFlagEnum empty_execute_on = MooseUtils::getDefaultExecFlagEnum();
   empty_execute_on.addAvailableFlags(EXEC_FAILED);
  
   // Nodal output
   if (types.contains("nodal"))
   {
     params.addParam<ExecFlagEnum>(
         "execute_nodal_on", empty_execute_on, "Control the output of nodal variables");
     params.addParamNamesToGroup("execute_nodal_on", "Variables");
   }
  
   // Elemental output
   if (types.contains("elemental"))
   {
     params.addParam<ExecFlagEnum>(
         "execute_elemental_on", empty_execute_on, "Control the output of elemental variables");
     params.addParamNamesToGroup("execute_elemental_on", "Variables");
  
     // Add material output control, which are output via elemental variables
     params.addParam<bool>("output_material_properties",
                           false,
                           "Flag indicating if material properties should be output");
     params.addParam<std::vector<std::string>>(
         "show_material_properties",
         "List of materialproperties that should be written to the output");
     params.addParamNamesToGroup("output_material_properties show_material_properties", "Materials");
   }
  
   // Scalar variable output
   if (types.contains("scalar"))
   {
     params.addParam<ExecFlagEnum>(
         "execute_scalars_on", empty_execute_on, "Control the output of scalar variables");
     params.addParamNamesToGroup("execute_scalars_on", "Variables");
   }
  
   // Nodal and scalar output
   if (types.contains("nodal") && types.contains("scalar"))
   {
     params.addParam<bool>("scalar_as_nodal", false, "Output scalar variables as nodal");
     params.addParamNamesToGroup("scalar_as_nodal", "Variables");
   }
  
   // Elemental and nodal
   if (types.contains("elemental") && types.contains("nodal"))
   {
     params.addParam<bool>(
         "elemental_as_nodal", false, "Output elemental nonlinear variables as nodal");
     params.addParamNamesToGroup("elemental_as_nodal", "Variables");
   }
  
   // Postprocessors
   if (types.contains("postprocessor"))
   {
     params.addParam<ExecFlagEnum>(
         "execute_postprocessors_on", empty_execute_on, "Control of when postprocessors are output");
     params.addParamNamesToGroup("execute_postprocessors_on", "Variables");
   }
  
   // Vector Postprocessors
   if (types.contains("vector_postprocessor"))
   {
     params.addParam<ExecFlagEnum>("execute_vector_postprocessors_on",
                                   empty_execute_on,
                                   "Enable/disable the output of VectorPostprocessors");
     params.addParamNamesToGroup("execute_vector_postprocessors_on", "Variables");
   }
  
   // Input file
   if (types.contains("input"))
   {
     params.addParam<ExecFlagEnum>(
         "execute_input_on", empty_execute_on, "Enable/disable the output of the input file");
     params.addParamNamesToGroup("execute_input_on", "Variables");
   }
  
   // System Information
   if (types.contains("system_information"))
   {
     params.addParam<ExecFlagEnum>("execute_system_information_on",
                                   empty_execute_on,
                                   "Control when the output of the simulation information occurs");
     params.addParamNamesToGroup("execute_system_information_on", "Variables");
   }
 }

Referenced by AdvancedOutput::enableOutputTypes().

◆ advancedExecuteOn()

const OutputOnWarehouse & AdvancedOutput::advancedExecuteOn ( ) const

virtualinherited

Get the current advanced 'execute_on' selections for display.

Reimplemented from Output.

Definition at line 788 of file AdvancedOutput.C.

 {
   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 123 of file Output.h.

123 { _allow_output = state; }

◆ 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 113 of file FileOutput.C.

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

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

◆ cloneMesh()

void OversampleOutput::cloneMesh ( )

privateinherited

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 oversample/positioning actions

Definition at line 269 of file OversampleOutput.C.

 {
   // Create the new mesh from a file
   if (isParamValid("file"))
   {
     InputParameters mesh_params = emptyInputParameters();
     mesh_params += _mesh_ptr->parameters();
     mesh_params.set<MeshFileName>("file") = getParam<MeshFileName>("file");
     mesh_params.set<bool>("nemesis") = false;
     mesh_params.set<bool>("skip_partitioning") = false;
     mesh_params.set<std::string>("_object_name") = "output_problem_mesh";
     _cloned_mesh_ptr = libmesh_make_unique<FileMesh>(mesh_params);
     _cloned_mesh_ptr->allowRecovery(false); // We actually want to reread the initial mesh
     _cloned_mesh_ptr->init();
     _cloned_mesh_ptr->prepare();
     _cloned_mesh_ptr->meshChanged();
   }
  
   // Clone the existing mesh
   else
   {
     if (_app.isRecovering())
       mooseWarning("Recovering or Restarting with Oversampling may not work (especially with "
                    "adapted meshes)!!  Refs #2295");
  
     _cloned_mesh_ptr = _mesh_ptr->safeClone();
   }
  
   // Make sure that the mesh pointer points to the newly cloned mesh
   _mesh_ptr = _cloned_mesh_ptr.get();
 }

Referenced by OversampleOutput::initOversample().

◆ declareRecoverableData() [1/2]

template<typename T >

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

protectedinherited

Declare a piece of data as "recoverable".

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

Note - this data will NOT be restored on Restart!

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

Parameters

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

Definition at line 295 of file Restartable.h.

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

◆ declareRecoverableData() [2/2]

template<typename T >

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

protectedinherited

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

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

Note - this data will NOT be restored on Restart!

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

Parameters

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

Definition at line 306 of file Restartable.h.

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

◆ declareRestartableDataTempl() [1/2]

template<typename T >

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

protectedinherited

Declare a piece of data as "restartable".

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

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

Parameters

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

Definition at line 222 of file Restartable.h.

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

◆ declareRestartableDataTempl() [2/2]

template<typename T >

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

protectedinherited

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

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

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

Parameters

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

Definition at line 229 of file Restartable.h.

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

◆ declareRestartableDataWithContext() [1/2]

template<typename T >

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

protectedinherited

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

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

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

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
init_value	The initial value of the data
context	Context pointer that will be passed to the load and store functions

Definition at line 250 of file Restartable.h.

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

◆ declareRestartableDataWithContext() [2/2]

template<typename T >

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

protectedinherited

Declare a piece of data as "restartable".

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

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

Parameters

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

Definition at line 236 of file Restartable.h.

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

◆ declareRestartableDataWithObjectName()

template<typename T >

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

protectedinherited

Declare a piece of data as "restartable".

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

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

Parameters

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

Definition at line 270 of file Restartable.h.

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

◆ declareRestartableDataWithObjectNameWithContext()

template<typename T >

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

protectedinherited

Declare a piece of data as "restartable".

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

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

Parameters

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

Definition at line 278 of file Restartable.h.

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

◆ declareRestartableDataWithPrefixOverrideAndContext()

template<typename T >

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

protectedinherited

Declare a piece of data as "restartable".

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

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

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
prefix	The prefix to prepend to the data_name, to retrieve data from another object.
context	Context pointer that will be passed to the load and store functions

◆ dt()

Real Output::dt ( )

virtualinherited

Get the current time step size.

Definition at line 245 of file Output.C.

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

Referenced by Console::writeTimestepInformation().

◆ dtOld()

Real Output::dtOld ( )

virtualinherited

Get old time step size.

Definition at line 254 of file Output.C.

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

◆ enabled()

virtual bool MooseObject::enabled ( ) const

inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 110 of file MooseObject.h.

110 { return _enabled; }

Referenced by EigenKernel::enabled().

◆ 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 102 of file AdvancedOutput.C.

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

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

◆ execBitFlags()

ExecFlagType SetupInterface::execBitFlags ( ) const

inherited

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

Definition at line 87 of file SetupInterface.C.

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

◆ execFlags()

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

virtualinherited

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

Reimplemented in MultiAppTransfer.

Definition at line 75 of file SetupInterface.C.

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

◆ executeOn()

const MultiMooseEnum & Output::executeOn ( ) const

inherited

Get the current 'execute_on' selections for display.

Definition at line 269 of file Output.C.

 {
   return _execute_on;
 }

◆ filename()

std::string Tecplot::filename ( )

overrideprotectedvirtual

Returns the current filename, this method handles adding the timestep suffix.

Returns: A string containing the current filename to be written

Reimplemented from FileOutput.

Definition at line 89 of file Tecplot.C.

 {
   std::ostringstream output;
   output << _file_base;
  
   // If not appending, put the padded time step in the filename.
   if (_binary || !_ascii_append)
     output << "_" << std::setw(_padding) << std::setprecision(0) << std::setfill('0') << std::right
            << _file_num;
  
   // .plt extension is for binary files
   // .dat extension is for ASCII files
   if (_binary)
     return output.str() + ".plt";
   else
     return output.str() + ".dat";
 }

Referenced by output().

◆ getCheckedPointerParam()

template<typename T >

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

inlineinherited

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

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

Definition at line 91 of file MooseObject.h.

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

◆ getDefaultExecFlagEnum()

ExecFlagEnum Output::getDefaultExecFlagEnum ( )

staticinherited

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

Definition at line 79 of file Output.C.

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

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

◆ 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 746 of file AdvancedOutput.C.

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

Referenced by Nemesis::output(), and Exodus::outputElementalVariables().

◆ getExecuteOnEnum()

const ExecFlagEnum & SetupInterface::getExecuteOnEnum ( ) const

inherited

Return the execute on MultiMooseEnum for this object.

Definition at line 69 of file SetupInterface.C.

 {
   return _execute_enum;
 }

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

◆ getExecuteOptions()

ExecFlagEnum SetupInterface::getExecuteOptions ( )

staticinherited

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

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

Definition at line 103 of file SetupInterface.C.

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

◆ 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 150 of file FileOutput.C.

 {
   return _file_num;
 }

Referenced by OutputWarehouse::getFileNumbers().

◆ getMooseApp()

MooseApp& MooseObject::getMooseApp ( ) const

inlineinherited

Get the MooseApp this object is associated with.

Definition at line 105 of file MooseObject.h.

105 { return _app; }

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

◆ 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 734 of file AdvancedOutput.C.

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

Referenced by Nemesis::output(), and Exodus::outputNodalVariables().

◆ getOutputTypes()

MultiMooseEnum AdvancedOutput::getOutputTypes ( )

staticprivateinherited

Get the supported types of output (e.g., postprocessors, etc.)

Definition at line 94 of file AdvancedOutput.C.

 {
   return MultiMooseEnum("nodal=0 elemental=1 scalar=2 postprocessor=3 vector_postprocessor=4 "
                         "input=5 system_information=6");
 }

Referenced by AdvancedOutput::enableOutputTypes().

◆ getParamTempl()

template<typename T >

const T & MooseObject::getParamTempl ( const std::string & name ) const

inherited

Retrieve a parameter for the object.

Parameters

name	The name of the parameter

Returns: The value of the parameter

Definition at line 208 of file MooseObject.h.

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

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

◆ 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 770 of file AdvancedOutput.C.

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

Referenced by TableOutput::outputPostprocessors(), Nemesis::outputPostprocessors(), and Exodus::outputPostprocessors().

◆ 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 758 of file AdvancedOutput.C.

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

Referenced by TableOutput::outputScalarVariables(), Nemesis::outputScalarVariables(), and Exodus::outputScalarVariables().

◆ 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 782 of file AdvancedOutput.C.

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

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

◆ 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 740 of file AdvancedOutput.C.

 {
   return hasOutputHelper("elemental");
 }

Referenced by Exodus::initialSetup().

◆ 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 728 of file AdvancedOutput.C.

 {
   return hasOutputHelper("nodal");
 }

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

◆ hasOutput() [1/2]

bool AdvancedOutput::hasOutput ( )

virtualinherited

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

Definition at line 351 of file AdvancedOutput.C.

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

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

◆ 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 339 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;
 }

◆ hasOutputHelper()

bool AdvancedOutput::hasOutputHelper ( const std::string & name )

privateinherited

Helper method for checking if output types exists.

Parameters

name	The name of the output type to test (e.g., postprocessors)

Definition at line 716 of file AdvancedOutput.C.

 {
   if (!_initialized)
     mooseError("The output object must be initialized before it may be determined if ",
                name,
                " output is enabled.");
  
   return !_execute_data[name].output.empty() && _advanced_execute_on.contains(name) &&
          _advanced_execute_on[name].isValid() && !_advanced_execute_on[name].contains("none");
 }

Referenced by AdvancedOutput::hasElementalVariableOutput(), AdvancedOutput::hasNodalVariableOutput(), AdvancedOutput::hasPostprocessorOutput(), AdvancedOutput::hasScalarOutput(), and AdvancedOutput::hasVectorPostprocessorOutput().

◆ 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 764 of file AdvancedOutput.C.

 {
   return hasOutputHelper("postprocessors");
 }

Referenced by Exodus::initialSetup().

◆ 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 752 of file AdvancedOutput.C.

 {
   return hasOutputHelper("scalars");
 }

Referenced by Exodus::initialSetup().

◆ 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 776 of file AdvancedOutput.C.

 {
   return hasOutputHelper("vector_postprocessors");
 }

◆ initAvailableLists()

void AdvancedOutput::initAvailableLists ( )

privateinherited

Initializes the available lists for each of the output types.

Definition at line 370 of file AdvancedOutput.C.

 {
   // Initialize Postprocessor list
   // This flag is set to true if any postprocessor has the 'outputs' parameter set, it is then used
   // to produce an warning if postprocessor output is disabled
   initPostprocessorOrVectorPostprocessorLists<Postprocessor>("postprocessors");
  
   // Initialize vector postprocessor list
   // This flag is set to true if any vector postprocessor has the 'outputs' parameter set, it is
   // then used
   // to produce an warning if vector postprocessor output is disabled
   initPostprocessorOrVectorPostprocessorLists<VectorPostprocessor>("vector_postprocessors");
  
   // Get a list of the available variables
   std::vector<VariableName> variables = _problem_ptr->getVariableNames();
  
   // Loop through the variables and store the names in the correct available lists
   for (const auto & var_name : variables)
   {
     if (_problem_ptr->hasVariable(var_name))
     {
       MooseVariableFEBase & var = _problem_ptr->getVariable(
           0, var_name, Moose::VarKindType::VAR_ANY, Moose::VarFieldType::VAR_FIELD_ANY);
       const FEType type = var.feType();
       for (unsigned int i = 0; i < var.count(); ++i)
       {
         VariableName vname = var_name;
         if (var.count() > 1)
           vname = SubProblem::arrayVariableComponent(var_name, i);
  
         if (type.order == CONSTANT && type.family != MONOMIAL_VEC)
           _execute_data["elemental"].available.insert(vname);
         else if (type.family == NEDELEC_ONE || type.family == LAGRANGE_VEC ||
                  type.family == MONOMIAL_VEC)
         {
           switch (_es_ptr->get_mesh().spatial_dimension())
           {
             case 0:
             case 1:
               _execute_data["nodal"].available.insert(vname);
               break;
             case 2:
               _execute_data["nodal"].available.insert(vname + "_x");
               _execute_data["nodal"].available.insert(vname + "_y");
               break;
             case 3:
               _execute_data["nodal"].available.insert(vname + "_x");
               _execute_data["nodal"].available.insert(vname + "_y");
               _execute_data["nodal"].available.insert(vname + "_z");
               break;
           }
         }
         else
           _execute_data["nodal"].available.insert(vname);
       }
     }
  
     else if (_problem_ptr->hasScalarVariable(var_name))
       _execute_data["scalars"].available.insert(var_name);
   }
 }

Referenced by AdvancedOutput::initialSetup().

◆ initExecutionTypes()

void AdvancedOutput::initExecutionTypes	(	const std::string &	name,
		ExecFlagEnum &	input
	)

privateinherited

Initialize the possible execution types.

Parameters

name	The name of the supplied MultiMoose enum from the _execute_on std::map (e.g., scalars)
input	The ExecFlagEnum for output type flags to initialize

Definition at line 433 of file AdvancedOutput.C.

 {
   // Build the input paramemter name
   std::string param_name = "execute_";
   param_name += name + "_on";
  
   // The parameters exists and has been set by the user
   if (_pars.have_parameter<ExecFlagEnum>(param_name) && isParamValid(param_name))
     input = getParam<ExecFlagEnum>(param_name);
  
   // If the parameter does not exists; set it to a state where no valid entries exists so nothing
   // gets executed
   else if (!_pars.have_parameter<ExecFlagEnum>(param_name))
   {
     input = _execute_on;
     input.clear();
   }
 }

Referenced by AdvancedOutput::initialSetup().

◆ initialSetup()

void OversampleOutput::initialSetup ( )

overridevirtualinherited

Initialization method.

This populates the various data structures needed to control the output

Reimplemented from AdvancedOutput.

Reimplemented in Exodus.

Definition at line 73 of file OversampleOutput.C.

 {
   AdvancedOutput::initialSetup();
  
   // Creates and initializes the oversampled mesh
   initOversample();
 }

Referenced by Exodus::initialSetup().

◆ initOutputList()

void AdvancedOutput::initOutputList ( OutputData & data )

privateinherited

Initializes the list of items to be output using the available, show, and hide lists.

Parameters

data	The OutputData to operate on

Definition at line 577 of file AdvancedOutput.C.

 {
   // References to the vectors of variable names
   std::set<std::string> & hide = data.hide;
   std::set<std::string> & show = data.show;
   std::set<std::string> & avail = data.available;
   std::set<std::string> & output = data.output;
  
   // Append the list from OutputInterface objects
   std::set<std::string> interface_hide;
   _app.getOutputWarehouse().buildInterfaceHideVariables(name(), interface_hide);
   hide.insert(interface_hide.begin(), interface_hide.end());
  
   // Both show and hide are empty and no show/hide settings were provided (show all available)
   if (show.empty() && hide.empty() && !_execute_data.hasShowList())
     output = avail;
  
   // Only hide is empty (show all the variables listed)
   else if (!show.empty() && hide.empty())
     output = show;
  
   // Only show is empty (show all except those hidden)
   else if (show.empty() && !hide.empty())
     std::set_difference(avail.begin(),
                         avail.end(),
                         hide.begin(),
                         hide.end(),
                         std::inserter(output, output.begin()));
  
   // Both hide and show are present (show all those listed)
   else
   {
     // Check if variables are in both, which is invalid
     std::vector<std::string> tmp;
     std::set_intersection(
         hide.begin(), hide.end(), show.begin(), show.end(), std::inserter(tmp, tmp.begin()));
     if (!tmp.empty())
     {
       std::ostringstream oss;
       oss << "Output(s) specified to be both shown and hidden: ";
       std::copy(tmp.begin(), tmp.end(), infix_ostream_iterator<std::string>(oss, " "));
       mooseError(oss.str());
     }
  
     // Define the output variable list
     output = show;
   }
 }

Referenced by AdvancedOutput::initialSetup().

◆ initOversample()

void OversampleOutput::initOversample ( )

privateinherited

Setups the output object to produce re-positioned and/or oversampled 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 122 of file OversampleOutput.C.

 {
   // Perform the mesh cloning, if needed
   if (_change_position || _oversample)
     cloneMesh();
   else
     return;
  
   // Re-position the oversampled mesh
   if (_change_position)
     for (auto & node : _mesh_ptr->getMesh().node_ptr_range())
       *node += _position;
  
   // Perform the mesh refinement
   if (_oversample)
   {
     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);
   }
  
   // We can't allow renumbering if we want to output multiple time
   // steps to the same Exodus file
   _mesh_ptr->getMesh().allow_renumbering(false);
  
   // Create the new EquationSystems
   _oversample_es = libmesh_make_unique<EquationSystems>(_mesh_ptr->getMesh());
   _es_ptr = _oversample_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 oversample mesh to
   // match.
   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
   unsigned int num_systems = source_es.n_systems();
   _mesh_functions.resize(num_systems);
  
   // Loop over the number of systems
   for (unsigned int sys_num = 0; sys_num < num_systems; sys_num++)
   {
     // Reference to the current system
     System & source_sys = source_es.get_system(sys_num);
  
     // Add the system to the new EquationsSystems
     ExplicitSystem & dest_sys = _oversample_es->add_system<ExplicitSystem>(source_sys.name());
  
     // Loop through the variables in the System
     unsigned int num_vars = source_sys.n_vars();
     if (num_vars > 0)
     {
       _mesh_functions[sys_num].resize(num_vars);
       _serialized_solution = NumericVector<Number>::build(_communicator);
       _serialized_solution->init(source_sys.n_dofs(), false, SERIAL);
  
       // Need to pull down a full copy of this vector on every processor so we can get values in
       // parallel
       source_sys.solution->localize(*_serialized_solution);
  
       // Add the variables to the system... simultaneously creating MeshFunctions for them.
       for (unsigned int var_num = 0; var_num < num_vars; var_num++)
       {
         // Add the variable, allow for first and second lagrange
         const FEType & fe_type = source_sys.variable_type(var_num);
         FEType second(SECOND, LAGRANGE);
         if (fe_type == second)
           dest_sys.add_variable(source_sys.variable_name(var_num), second);
         else
           dest_sys.add_variable(source_sys.variable_name(var_num), FEType());
       }
     }
   }
  
   // Initialize the newly created EquationSystem
   _oversample_es->init();
 }

Referenced by OversampleOutput::initialSetup().

◆ initPostprocessorOrVectorPostprocessorLists()

template<typename postprocessor_type >

void AdvancedOutput::initPostprocessorOrVectorPostprocessorLists ( const std::string & execute_data_name )

privateinherited

Helper function for initAvailableLists, templated on warehouse type and postprocessor_type.

Parameters

execute_data_name	Name of the OutputData struct to initialize
warehouse	Reference to the postprocessor or vector postprocessor warehouse

Definition at line 347 of file AdvancedOutput.h.

 {
   // Convenience reference to the OutputData being operated on (should used "postprocessors" or
   // "vector_postprocessors")
   OutputData & execute_data = _execute_data[execute_data_name];
  
   // Build the input file parameter name (i.e. "output_postprocessors_on" or
   // "output_vector_postprocessors_on")
   std::ostringstream oss;
   oss << "execute_" << execute_data_name << "_on";
   std::string execute_on_name = oss.str();
  
   // True if the postprocessors has been limited using 'outputs' parameter
   bool has_limited_pps = false;
  
   std::vector<UserObject *> objs;
   _problem_ptr->theWarehouse()
       .query()
       .condition<AttribSystem>("UserObject")
       .condition<AttribThread>(0)
       .queryInto(objs);
  
   for (const auto & obj : objs)
   {
     auto pps = dynamic_cast<postprocessor_type *>(obj);
     if (!pps)
       continue;
  
     execute_data.available.insert(pps->PPName());
  
     // Extract the list of outputs
     const auto & pps_outputs = pps->getOutputs();
  
     // Check that the outputs lists are valid
     _app.getOutputWarehouse().checkOutputs(pps_outputs);
  
     // Check that the output object allows postprocessor output,
     // account for "all" keyword (if it is present assume "all" was desired)
     if (pps_outputs.find(name()) != pps_outputs.end() ||
         pps_outputs.find("all") != pps_outputs.end())
     {
       if (!_advanced_execute_on.contains(execute_data_name) ||
           (_advanced_execute_on[execute_data_name].isValid() &&
            _advanced_execute_on[execute_data_name].contains("none")))
         mooseWarning(
             "Postprocessor '",
             pps->PPName(),
             "' has requested to be output by the '",
             name(),
             "' output, but postprocessor output is not support by this type of output object.");
     }
  
     // Set the flag state for postprocessors that utilize 'outputs' parameter
     if (!pps_outputs.empty() && pps_outputs.find("all") == pps_outputs.end())
       has_limited_pps = true;
   }
  
   // Produce the warning when 'outputs' is used, but postprocessor output is disabled
   if (has_limited_pps && isParamValid(execute_on_name))
   {
     const ExecFlagEnum & pp_on = getParam<ExecFlagEnum>(execute_on_name);
     if (pp_on.contains(EXEC_NONE))
     {
       if (execute_on_name == "execute_postprocessors_on")
         mooseWarning("A Postprocessor utilizes the 'outputs' parameter; however, postprocessor "
                      "output is disabled for the '",
                      name(),
                      "' output object.");
       else if (execute_on_name == "execute_vectorpostprocessors_on")
         mooseWarning("A VectorPostprocessor utilizes the 'outputs' parameter; however, vector "
                      "postprocessor output is disabled for the '",
                      name(),
                      "' output object.");
     }
   }
 }

◆ initShowHideLists()

void AdvancedOutput::initShowHideLists	(	const std::vector< VariableName > &	show,
		const std::vector< VariableName > &	hide
	)

privateinherited

Parses the user-supplied input for hiding and showing variables and postprocessors into a list for each type of output.

Parameters

show	The vector of names that are to be output
hide	The vector of names that are to be suppressed from the output

Definition at line 453 of file AdvancedOutput.C.

 {
  
   // Storage for user-supplied input that is unknown as a variable or postprocessor
   std::set<std::string> unknown;
  
   // If a show hide/list exists, let the data warehouse know about it. This allows for the proper
   // handling of output lists (see initOutputList)
   if (show.size() > 0)
     _execute_data.setHasShowList(true);
  
   // Populate the show lists
   for (const auto & var_name : show)
   {
     if (_problem_ptr->hasVariable(var_name))
     {
       MooseVariableFEBase & var = _problem_ptr->getVariable(
           0, var_name, Moose::VarKindType::VAR_ANY, Moose::VarFieldType::VAR_FIELD_ANY);
       const FEType type = var.feType();
       for (unsigned int i = 0; i < var.count(); ++i)
       {
         VariableName vname = var_name;
         if (var.count() > 1)
           vname = SubProblem::arrayVariableComponent(var_name, i);
  
         if (type.order == CONSTANT)
           _execute_data["elemental"].show.insert(vname);
         else if (type.family == NEDELEC_ONE || type.family == LAGRANGE_VEC ||
                  type.family == MONOMIAL_VEC)
         {
           switch (_es_ptr->get_mesh().spatial_dimension())
           {
             case 0:
             case 1:
               _execute_data["nodal"].show.insert(vname);
               break;
             case 2:
               _execute_data["nodal"].show.insert(vname + "_x");
               _execute_data["nodal"].show.insert(vname + "_y");
               break;
             case 3:
               _execute_data["nodal"].show.insert(vname + "_x");
               _execute_data["nodal"].show.insert(vname + "_y");
               _execute_data["nodal"].show.insert(vname + "_z");
               break;
           }
         }
         else
           _execute_data["nodal"].show.insert(vname);
       }
     }
     else if (_problem_ptr->hasScalarVariable(var_name))
       _execute_data["scalars"].show.insert(var_name);
     else if (_problem_ptr->hasPostprocessor(var_name))
       _execute_data["postprocessors"].show.insert(var_name);
     else if (_problem_ptr->hasVectorPostprocessor(var_name))
       _execute_data["vector_postprocessors"].show.insert(var_name);
     else
       unknown.insert(var_name);
   }
  
   // Populate the hide lists
   for (const auto & var_name : hide)
   {
     if (_problem_ptr->hasVariable(var_name))
     {
       MooseVariableFEBase & var = _problem_ptr->getVariable(
           0, var_name, Moose::VarKindType::VAR_ANY, Moose::VarFieldType::VAR_FIELD_ANY);
       const FEType type = var.feType();
       for (unsigned int i = 0; i < var.count(); ++i)
       {
         VariableName vname = var_name;
         if (var.count() > 1)
           vname = SubProblem::arrayVariableComponent(var_name, i);
  
         if (type.order == CONSTANT)
           _execute_data["elemental"].hide.insert(vname);
         else if (type.family == NEDELEC_ONE || type.family == LAGRANGE_VEC ||
                  type.family == MONOMIAL_VEC)
         {
           switch (_es_ptr->get_mesh().spatial_dimension())
           {
             case 0:
             case 1:
               _execute_data["nodal"].hide.insert(vname);
               break;
             case 2:
               _execute_data["nodal"].hide.insert(vname + "_x");
               _execute_data["nodal"].hide.insert(vname + "_y");
               break;
             case 3:
               _execute_data["nodal"].hide.insert(vname + "_x");
               _execute_data["nodal"].hide.insert(vname + "_y");
               _execute_data["nodal"].hide.insert(vname + "_z");
               break;
           }
         }
         else
           _execute_data["nodal"].hide.insert(vname);
       }
     }
     else if (_problem_ptr->hasScalarVariable(var_name))
       _execute_data["scalars"].hide.insert(var_name);
     else if (_problem_ptr->hasPostprocessor(var_name))
       _execute_data["postprocessors"].hide.insert(var_name);
     else if (_problem_ptr->hasVectorPostprocessor(var_name))
       _execute_data["vector_postprocessors"].hide.insert(var_name);
     else
       unknown.insert(var_name);
   }
  
   // Error if an unknown variable or postprocessor is found
   if (!unknown.empty())
   {
     std::ostringstream oss;
     oss << "Output(s) do not exist (must be variable, scalar, postprocessor, or vector "
            "postprocessor): ";
     std::copy(unknown.begin(), unknown.end(), infix_ostream_iterator<std::string>(oss, " "));
     mooseError(oss.str());
   }
 }

Referenced by AdvancedOutput::initialSetup().

◆ 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 275 of file Output.C.

 {
   return _is_advanced;
 }

◆ isParamValid()

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

inlineinherited

Test if the supplied parameter is valid.

Parameters

name	The name of the parameter to test

Definition at line 100 of file MooseObject.h.

100 { return _pars.isParamValid(name); }

◆ jacobianSetup()

void SetupInterface::jacobianSetup ( )

virtualinherited

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

Reimplemented in EqualValueEmbeddedConstraint.

Definition at line 54 of file SetupInterface.C.

55 {

56 }

◆ meshChanged()

void OversampleOutput::meshChanged ( )

overridevirtualinherited

Called on this object when the mesh changes.

Reimplemented from MeshChangedInterface.

Reimplemented in Exodus.

Definition at line 116 of file OversampleOutput.C.

 {
   _oversample_mesh_changed = true;
 }

Referenced by Exodus::meshChanged().

◆ mooseDeprecated()

template<typename... Args>

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

inlineinherited

Definition at line 156 of file MooseObject.h.

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

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

◆ mooseError()

template<typename... Args>

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

inlineinherited

Definition at line 141 of file MooseObject.h.

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

◆ mooseInfo()

template<typename... Args>

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

inlineinherited

Definition at line 162 of file MooseObject.h.

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

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

◆ mooseWarning()

template<typename... Args>

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

inlineinherited

Definition at line 150 of file MooseObject.h.

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

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

◆ name()

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

inlinevirtualinherited

Get the name of the object.

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

Reimplemented in MooseVariableBase.

Definition at line 70 of file MooseObject.h.

70 { return _name; }

◆ onInterval()

bool Output::onInterval ( )

protectedvirtualinherited

Returns true if the output interval is satisfied.

Definition at line 203 of file Output.C.

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

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

◆ output()

void Tecplot::output ( const ExecFlagType & type )

overrideprotectedvirtual

Overload the Output::output method, this is required for Tecplot output due to the method utilized for outputting single/global parameters.

Reimplemented from AdvancedOutput.

Definition at line 66 of file Tecplot.C.

 {
   TecplotIO out(*_mesh_ptr, _binary, time() + _app.getGlobalTimeOffset());
  
   // Only set the append flag on the TecplotIO object if the user has
   // asked for it, and this is not the first time we called output().
   if (_ascii_append && !_first_time)
     out.ascii_append() = true;
  
   out.write_equation_systems(filename(), *_es_ptr);
  
   // If we're not appending, increment the file number.  If we are appending,
   // we'll use the same filename each time.
   if (_binary || !_ascii_append)
     _file_num++;
  
   // If this was the first time we called output(), the next time will not be
   // the first time.
   if (_first_time)
     _first_time = false;
 }

Referenced by filename().

◆ 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 193 of file AdvancedOutput.C.

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

Referenced by AdvancedOutput::output().

◆ 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 233 of file AdvancedOutput.C.

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

Referenced by AdvancedOutput::output().

◆ 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 185 of file AdvancedOutput.C.

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

Referenced by AdvancedOutput::output().

◆ 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 Exodus, Console, CSV, Nemesis, and TableOutput.

Definition at line 202 of file AdvancedOutput.C.

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

Referenced by AdvancedOutput::output().

◆ 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 219 of file AdvancedOutput.C.

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

Referenced by AdvancedOutput::output().

◆ outputStep()

void OversampleOutput::outputStep ( const ExecFlagType & type )

overridevirtualinherited

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 82 of file OversampleOutput.C.

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

◆ outputSystemInformation()

void AdvancedOutput::outputSystemInformation ( )

protectedvirtualinherited

Reimplemented in Console.

Definition at line 226 of file AdvancedOutput.C.

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

Referenced by AdvancedOutput::output().

◆ 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, CSV, and TableOutput.

Definition at line 210 of file AdvancedOutput.C.

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

Referenced by AdvancedOutput::output().

◆ paramError()

template<typename... Args>

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

inherited

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

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

Definition at line 215 of file MooseObject.h.

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

◆ paramErrorMsg()

template<typename... Args>

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

inlineprivateinherited

Definition at line 185 of file MooseObject.h.

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

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

◆ parameters()

const InputParameters& MooseObject::parameters ( ) const

inlineinherited

Get the parameters of the object.

Returns: The parameters of the object

Definition at line 76 of file MooseObject.h.

76 { return _pars; }

◆ paramInfo()

template<typename... Args>

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

inherited

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

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

Definition at line 231 of file MooseObject.h.

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

Referenced by TransientMultiApp::TransientMultiApp().

◆ paramWarning()

template<typename... Args>

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

inherited

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

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

Definition at line 224 of file MooseObject.h.

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

Referenced by Executioner::Executioner().

◆ petscLinearOutput()

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

staticprivateinherited

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 214 of file PetscOutput.C.

 {
   // Get the Outputter object
   PetscOutput * ptr = static_cast<PetscOutput *>(void_ptr);
  
   // 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 0;
 }

Referenced by PetscOutput::solveSetup().

◆ petscNonlinearOutput()

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

staticprivateinherited

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 174 of file PetscOutput.C.

 {
   // Get the outputter object
   PetscOutput * ptr = static_cast<PetscOutput *>(void_ptr);
  
   // 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 0;
 }

Referenced by PetscOutput::solveSetup().

◆ registerRestartableDataOnApp()

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

privateinherited

Helper function for actually registering the restartable data.

Definition at line 48 of file Restartable.C.

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

Referenced by Restartable::declareRestartableDataWithContext().

◆ registerRestartableNameWithFilterOnApp()

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

privateinherited

Helper function for actually registering the restartable data.

Definition at line 56 of file Restartable.C.

 {
   _restartable_app.registerRestartableNameWithFilter(name, filter);
 }

Referenced by Restartable::declareRecoverableData().

◆ registerTimedSection()

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

protectedinherited

Call to register a named section for timing.

Parameters

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

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

Definition at line 51 of file PerfGraphInterface.C.

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

◆ residualSetup()

void SetupInterface::residualSetup ( )

virtualinherited

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

Reimplemented in NodeFaceConstraint.

Definition at line 59 of file SetupInterface.C.

60 {

61 }

◆ 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 144 of file FileOutput.C.

 {
   _file_num = num;
 }

Referenced by OutputWarehouse::setFileNumbers().

◆ shouldOutput()

bool AdvancedOutput::shouldOutput ( const ExecFlagType & type )

protectedvirtualinherited

Handles logic for determining if a step should be output.

Returns: True if a call if output should be preformed

Reimplemented from FileOutput.

Definition at line 241 of file AdvancedOutput.C.

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

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

◆ solveSetup()

void PetscOutput::solveSetup ( )

overrideprivatevirtualinherited

Internal setup function that executes at the beginning of the time step.

Reimplemented from Output.

Definition at line 130 of file PetscOutput.C.

 {
 // Only execute if PETSc exists
 #ifdef LIBMESH_HAVE_PETSC
  
   // Extract the non-linear and linear solvers from PETSc
   NonlinearSystemBase & nl = _problem_ptr->getNonlinearSystemBase();
   PetscNonlinearSolver<Number> * petsc_solver =
       dynamic_cast<PetscNonlinearSolver<Number> *>(nl.nonlinearSolver());
   SNES snes = petsc_solver->snes();
   KSP ksp;
   SNESGetKSP(snes, &ksp);
  
   // Update the pseudo times
   _nonlinear_time = _time_old; // non-linear time starts with the previous time step
   if (_dt != 0)
     _nonlinear_dt = _dt / _nonlinear_dt_divisor; // set the pseudo non-linear timestep as fraction
                                                  // of real timestep for transient executioners
   else
     _nonlinear_dt = 1. / _nonlinear_dt_divisor; // set the pseudo non-linear timestep for steady
                                                 // executioners (here _dt==0)
  
   _linear_dt = _nonlinear_dt / _linear_dt_divisor; // set the pseudo linear timestep
  
   // Set the PETSc monitor functions
   if (_execute_on.contains(EXEC_NONLINEAR) &&
       (_time >= _nonlinear_start_time - _t_tol && _time <= _nonlinear_end_time + _t_tol))
   {
     PetscErrorCode ierr = SNESMonitorSet(snes, petscNonlinearOutput, this, PETSC_NULL);
     CHKERRABORT(_communicator.get(), ierr);
   }
  
   if (_execute_on.contains(EXEC_LINEAR) &&
       (_time >= _linear_start_time - _t_tol && _time <= _linear_end_time + _t_tol))
   {
     PetscErrorCode ierr = KSPMonitorSet(ksp, petscLinearOutput, this, PETSC_NULL);
     CHKERRABORT(_communicator.get(), ierr);
   }
 #endif
 }

◆ subdomainSetup()

void SetupInterface::subdomainSetup ( )

virtualinherited

Gets called when the subdomain changes (i.e.

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

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

Definition at line 64 of file SetupInterface.C.

65 {

66 }

◆ time()

Real 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 254 of file PetscOutput.C.

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

Referenced by FileOutput::FileOutput(), output(), Nemesis::output(), Exodus::outputEmptyTimestep(), Exodus::outputNodalVariables(), TableOutput::outputPostprocessors(), TableOutput::outputScalarVariables(), and Console::writeTimestepInformation().

◆ 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 236 of file Output.C.

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

Referenced by Console::writeTimestepInformation().

◆ timeStep()

int Output::timeStep ( )

virtualinherited

Get the current time step.

Definition at line 263 of file Output.C.

 {
   return _t_step;
 }

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

◆ timestepSetup()

void SetupInterface::timestepSetup ( )

virtualinherited

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

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

Definition at line 49 of file SetupInterface.C.

50 {

51 }

◆ type()

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

inlineinherited

Get the type of this object.

Returns: the name of the type of this object

Definition at line 63 of file MooseObject.h.

63 { return _type; }

◆ updateOversample()

void OversampleOutput::updateOversample ( )

protectedvirtualinherited

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

Definition at line 212 of file OversampleOutput.C.

 {
   // Do nothing if oversampling and changing position are not enabled
   if (!_oversample && !_change_position)
     return;
  
   // Get a reference to actual equation system
   EquationSystems & source_es = _problem_ptr->es();
  
   // Loop throuch each system
   for (unsigned int sys_num = 0; sys_num < source_es.n_systems(); ++sys_num)
   {
     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 = _oversample_es->get_system(sys_num);
  
       // Update the solution for the oversampled mesh
       _serialized_solution->clear();
       _serialized_solution->init(source_sys.n_dofs(), false, SERIAL);
       source_sys.solution->localize(*_serialized_solution);
  
       // Update the mesh functions
       for (unsigned int var_num = 0; var_num < _mesh_functions[sys_num].size(); ++var_num)
       {
  
         // If the mesh has change the MeshFunctions need to be re-built, otherwise simply clear it
         // for re-initialization
         if (!_mesh_functions[sys_num][var_num] || _oversample_mesh_changed)
           _mesh_functions[sys_num][var_num] = libmesh_make_unique<MeshFunction>(
               source_es, *_serialized_solution, source_sys.get_dof_map(), var_num);
         else
           _mesh_functions[sys_num][var_num]->clear();
  
         // Initialize the MeshFunctions for application to the oversampled solution
         _mesh_functions[sys_num][var_num]->init();
       }
  
       // Now loop over the nodes of the oversampled mesh setting values for each variable.
       for (const auto & node : as_range(_mesh_ptr->localNodesBegin(), _mesh_ptr->localNodesEnd()))
         for (unsigned int var_num = 0; var_num < _mesh_functions[sys_num].size(); ++var_num)
           if (node->n_dofs(sys_num, var_num))
             dest_sys.solution->set(node->dof_number(sys_num, var_num, 0),
                                    (*_mesh_functions[sys_num][var_num])(
                                        *node - _position)); // 0 value is for component
  
       dest_sys.solution->close();
     }
   }
  
   // Set this to false so that new output files are not created, since the oversampled mesh doesn't
   // actually change
   _oversample_mesh_changed = false;
 }

Referenced by OversampleOutput::outputStep().

◆ validParams()

InputParameters Tecplot::validParams ( )

static

Definition at line 23 of file Tecplot.C.

 {
   // Get the base class parameters
   InputParameters params = OversampleOutput::validParams();
  
   // Add binary toggle
   params.addParam<bool>("binary", false, "Set Tecplot files to output in binary format");
   params.addParamNamesToGroup("binary", "Advanced");
  
   // Add optional parameter to turn on appending to ASCII files
   params.addParam<bool>(
       "ascii_append",
       false,
       "If true, append to an existing ASCII file rather than creating a new file each time");
  
   // Need a layer of geometric ghosting for mesh serialization
   params.addRelationshipManager("MooseGhostPointNeighbors",
                                 Moose::RelationshipManagerType::GEOMETRIC);
  
   // Add description for the Tecplot class
   params.addClassDescription("Object for outputting data in the Tecplot format");
  
   // Return the InputParameters
   return params;
 }

◆ wantOutput()

bool AdvancedOutput::wantOutput	(	const std::string &	name,
		const ExecFlagType &	type
	)

privateinherited

Handles logic for determining if a step should be output.

Returns: True if a call if output should be preformed

Definition at line 300 of file AdvancedOutput.C.

 {
   // Ignore EXEC_FORCED for system information and input, there is no reason to force this
   if (type == EXEC_FORCED && (name == "system_information" || name == "input"))
     return false;
  
   // Do not output if the 'none' is contained by the execute_on
   if (_advanced_execute_on.contains(name) && _advanced_execute_on[name].contains("none"))
     return false;
  
   // Data output flag, true if data exists to be output
   bool execute_data_flag = true;
  
   // Set flag to false, if the OutputData exists and the output variable list is empty
   std::map<std::string, OutputData>::const_iterator iter = _execute_data.find(name);
   if (iter != _execute_data.end() && iter->second.output.empty())
     execute_data_flag = false;
  
   // Set flag to false, if the OutputOnWarehouse DOES NOT contain an entry
   if (!_advanced_execute_on.contains(name))
     execute_data_flag = false;
  
   // Force the output, if there is something to output and the time has not been output
   if (type == EXEC_FORCED && execute_data_flag && _last_execute_time[name] != _time)
     return true;
  
   // Return true (output should occur) if three criteria are satisfied, else do not output:
   //   (1) The execute_data_flag = true (i.e, there is data to output)
   //   (2) The current output type is contained in the list of output execution types
   //   (3) The current execution time is "final" or "forced" and the data has not already been
   //   output
   if (execute_data_flag && _advanced_execute_on[name].contains(type) &&
       !(type == EXEC_FINAL && _last_execute_time[name] == _time))
     return true;
   else
     return false;
 }

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

Member Data Documentation

◆ _advanced_execute_on

OutputOnWarehouse Output::_advanced_execute_on

protectedinherited

Storage for the individual component execute flags.

Definition at line 244 of file Output.h.

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

◆ _allow_output

bool Output::_allow_output

protectedinherited

Flag for disabling output.

Definition at line 235 of file Output.h.

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

◆ _app

MooseApp& MooseObject::_app

protectedinherited

The MooseApp this object is associated with.

Definition at line 172 of file MooseObject.h.

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

◆ _ascii_append

bool Tecplot::_ascii_append

private

Flag for turning on appending to ASCII files.

Definition at line 52 of file Tecplot.h.

Referenced by filename(), and output().

◆ _binary

bool Tecplot::_binary

private

Flag for binary output.

Definition at line 49 of file Tecplot.h.

Referenced by filename(), output(), and Tecplot().

◆ _change_position

bool OversampleOutput::_change_position

protectedinherited

Flag for re-positioning.

Definition at line 68 of file OversampleOutput.h.

Referenced by OversampleOutput::initOversample(), Exodus::outputSetup(), and OversampleOutput::updateOversample().

◆ _cloned_mesh_ptr

std::unique_ptr<MooseMesh> OversampleOutput::_cloned_mesh_ptr

privateinherited

Definition at line 100 of file OversampleOutput.h.

Referenced by OversampleOutput::cloneMesh(), and OversampleOutput::~OversampleOutput().

◆ _console

const ConsoleStream ConsoleStreamInterface::_console

inherited

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

Definition at line 31 of file ConsoleStreamInterface.h.

◆ _current_execute_flag

const ExecFlagType& SetupInterface::_current_execute_flag

protectedinherited

Reference to FEProblemBase.

Definition at line 99 of file SetupInterface.h.

◆ _dt

Real& Output::_dt

protectedinherited

Time step delta.

Definition at line 199 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 202 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 261 of file AdvancedOutput.h.

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

◆ _empty_execute_enum

ExecFlagEnum SetupInterface::_empty_execute_enum

privateinherited

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

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

Definition at line 89 of file SetupInterface.h.

Referenced by SetupInterface::SetupInterface().

◆ _enabled

const bool& MooseObject::_enabled

protectedinherited

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

Definition at line 181 of file MooseObject.h.

Referenced by MooseObject::enabled().

◆ _end_step

int Output::_end_step

protectedinherited

End outputting at this time step.

Definition at line 223 of file Output.h.

Referenced by Output::onInterval().

◆ _end_time

Real Output::_end_time

protectedinherited

End outputting time.

Definition at line 217 of file Output.h.

◆ _es_ptr

EquationSystems* Output::_es_ptr

protectedinherited

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

Definition at line 178 of file Output.h.

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

◆ _exec_flags

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

protectedinherited

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

Definition at line 96 of file SetupInterface.h.

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

◆ _execute_data

OutputDataWarehouse AdvancedOutput::_execute_data

privateinherited

Storage structures for the various output types.

Definition at line 333 of file AdvancedOutput.h.

◆ _execute_enum

const ExecFlagEnum& SetupInterface::_execute_enum

protectedinherited

Execute settings for this oejct.

Definition at line 93 of file SetupInterface.h.

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

◆ _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 187 of file Output.h.

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

◆ _file_base

std::string FileOutput::_file_base

protectedinherited

The base filename from the input paramaters.

Definition at line 72 of file FileOutput.h.

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

◆ _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 75 of file FileOutput.h.

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

◆ _first_time

bool& Tecplot::_first_time

private

True if this is the first time the file has been written to, gets set to false after the first call to output().

If the user has set _ascii_append but _first_time==true, we won't actually append. This prevents old data files in a directory from being appended to. Declared as a reference so it can be restartable data, that way if we restart, we don't think it's the first time again.

Definition at line 61 of file Tecplot.h.

Referenced by output().

◆ _initialized

bool Output::_initialized

protectedinherited

True if init() has been called.

Definition at line 232 of file Output.h.

Referenced by AdvancedOutput::hasOutputHelper(), Output::initialSetup(), AdvancedOutput::initialSetup(), and Console::output().

◆ _interval

const unsigned int Output::_interval

protectedinherited

The output time step interval.

Definition at line 208 of file Output.h.

Referenced by Output::onInterval().

◆ _is_advanced

bool Output::_is_advanced

protectedinherited

Flag for advanced output testing.

Definition at line 238 of file Output.h.

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

◆ _last_execute_time

std::map<std::string, Real> AdvancedOutput::_last_execute_time

privateinherited

Storage for the last output time for the various output types, this is used to avoid duplicate output when using OUTPUT_FINAL flag.

Definition at line 336 of file AdvancedOutput.h.

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

◆ _linear_dt

Real PetscOutput::_linear_dt

privateinherited

Psuedo linear time step.

Definition at line 87 of file PetscOutput.h.

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

◆ _linear_dt_divisor

Real PetscOutput::_linear_dt_divisor

privateinherited

Pseudo linear timestep divisor.

Definition at line 99 of file PetscOutput.h.

Referenced by PetscOutput::solveSetup().

◆ _linear_end_time

Real PetscOutput::_linear_end_time

privateinherited

Linear residual output end time.

Definition at line 111 of file PetscOutput.h.

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

◆ _linear_iter

PetscInt PetscOutput::_linear_iter

protectedinherited

Current linear iteration returned from PETSc.

Definition at line 53 of file PetscOutput.h.

Referenced by Console::output(), and PetscOutput::petscLinearOutput().

◆ _linear_start_time

Real PetscOutput::_linear_start_time

privateinherited

Linear residual output start time.

Definition at line 105 of file PetscOutput.h.

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

◆ _linear_time

Real PetscOutput::_linear_time

privateinherited

Psuedo linear time.

Definition at line 84 of file PetscOutput.h.

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

◆ _mci_feproblem

FEProblemBase& MeshChangedInterface::_mci_feproblem

protectedinherited

Reference to FEProblemBase instance.

Definition at line 43 of file MeshChangedInterface.h.

Referenced by MeshChangedInterface::MeshChangedInterface().

◆ _mesh_functions

std::vector<std::vector<std::unique_ptr<MeshFunction> > > OversampleOutput::_mesh_functions

privateinherited

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

Definition at line 91 of file OversampleOutput.h.

Referenced by OversampleOutput::initOversample(), and OversampleOutput::updateOversample().

◆ _mesh_ptr

MooseMesh* Output::_mesh_ptr

protectedinherited

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

Definition at line 181 of file Output.h.

Referenced by OversampleOutput::cloneMesh(), OversampleOutput::initOversample(), output(), XDA::output(), PNGOutput::output(), Output::Output(), Exodus::outputSetup(), and OversampleOutput::updateOversample().

◆ _name

const std::string& MooseObject::_name

protectedinherited

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

Definition at line 178 of file MooseObject.h.

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

◆ _nonlinear_dt

Real PetscOutput::_nonlinear_dt

privateinherited

The pseuedo non-linear time step.

Definition at line 81 of file PetscOutput.h.

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

◆ _nonlinear_dt_divisor

Real PetscOutput::_nonlinear_dt_divisor

privateinherited

Pseudo non-linear timestep divisor.

Definition at line 96 of file PetscOutput.h.

Referenced by PetscOutput::solveSetup().

◆ _nonlinear_end_time

Real PetscOutput::_nonlinear_end_time

privateinherited

Non-linear residual output end time.

Definition at line 108 of file PetscOutput.h.

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

◆ _nonlinear_iter

PetscInt PetscOutput::_nonlinear_iter

protectedinherited

Current non-linear iteration returned from PETSc.

Definition at line 50 of file PetscOutput.h.

Referenced by Console::output(), and PetscOutput::petscNonlinearOutput().

◆ _nonlinear_start_time

Real PetscOutput::_nonlinear_start_time

privateinherited

Non-linear residual output start time.

Definition at line 102 of file PetscOutput.h.

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

◆ _nonlinear_time

Real PetscOutput::_nonlinear_time

privateinherited

The psuedo non-linear time.

Definition at line 78 of file PetscOutput.h.

Referenced by PetscOutput::petscNonlinearOutput(), PetscOutput::solveSetup(), and PetscOutput::time().

◆ _norm

Real PetscOutput::_norm

protectedinherited

Current norm returned from PETSc.

Definition at line 47 of file PetscOutput.h.

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

◆ _num

unsigned int Output::_num

protectedinherited

The number of outputs written.

Definition at line 205 of file Output.h.

◆ _on_linear_residual

bool PetscOutput::_on_linear_residual

privateinherited

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

Definition at line 90 of file PetscOutput.h.

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

◆ _on_nonlinear_residual

bool PetscOutput::_on_nonlinear_residual

privateinherited

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

Definition at line 93 of file PetscOutput.h.

Referenced by PetscOutput::petscNonlinearOutput(), 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 81 of file FileOutput.h.

Referenced by FileOutput::checkFilename().

◆ _output_step_timer

PerfID Output::_output_step_timer

protectedinherited

Timers.

Definition at line 247 of file Output.h.

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

◆ _oversample

bool OversampleOutput::_oversample

protectedinherited

Flag indicating that oversampling is enabled.

Definition at line 65 of file OversampleOutput.h.

Referenced by OversampleOutput::initOversample(), Exodus::outputSetup(), and OversampleOutput::updateOversample().

◆ _oversample_es

std::unique_ptr<EquationSystems> OversampleOutput::_oversample_es

privateinherited

Definition at line 99 of file OversampleOutput.h.

Referenced by OversampleOutput::initOversample(), OversampleOutput::updateOversample(), and OversampleOutput::~OversampleOutput().

◆ _oversample_mesh_changed

bool OversampleOutput::_oversample_mesh_changed

privateinherited

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

Definition at line 97 of file OversampleOutput.h.

Referenced by OversampleOutput::meshChanged(), and OversampleOutput::updateOversample().

◆ _padding

unsigned int FileOutput::_padding

protectedinherited

Number of digits to pad the extensions.

Definition at line 78 of file FileOutput.h.

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

◆ _pars

const InputParameters& MooseObject::_pars

protectedinherited

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

Definition at line 169 of file MooseObject.h.

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

◆ _perf_graph

PerfGraph& PerfGraphInterface::_perf_graph

protectedinherited

The performance graph to add to.

Definition at line 67 of file PerfGraphInterface.h.

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

◆ _pg_params

const InputParameters* PerfGraphInterface::_pg_params

protectedinherited

Params.

Definition at line 64 of file PerfGraphInterface.h.

◆ _position

Point OversampleOutput::_position

privateinherited

When oversampling, the output is shift by this amount.

Definition at line 94 of file OversampleOutput.h.

Referenced by OversampleOutput::initOversample(), and OversampleOutput::updateOversample().

◆ _prefix

std::string PerfGraphInterface::_prefix

protectedinherited

A prefix to use for all sections.

Definition at line 70 of file PerfGraphInterface.h.

Referenced by PerfGraphInterface::registerTimedSection().

◆ _problem_ptr

FEProblemBase* Output::_problem_ptr

protectedinherited

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

Definition at line 169 of file Output.h.

Referenced by PNGOutput::calculateRescalingValues(), AdvancedOutput::initAvailableLists(), Console::initialSetup(), OversampleOutput::initOversample(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), AdvancedOutput::initShowHideLists(), PNGOutput::makeMeshFunc(), Nemesis::meshChanged(), Console::meshChanged(), DOFMapOutput::output(), VariableResidualNormsDebugOutput::output(), SolutionHistory::output(), CSV::output(), Output::Output(), TopResidualDebugOutput::output(), TableOutput::outputPostprocessors(), Nemesis::outputPostprocessors(), Exodus::outputPostprocessors(), TableOutput::outputScalarVariables(), Nemesis::outputScalarVariables(), Exodus::outputScalarVariables(), Console::outputSystemInformation(), TableOutput::outputVectorPostprocessors(), MaterialPropertyDebugOutput::printMaterialMap(), TopResidualDebugOutput::printTopResiduals(), PetscOutput::solveSetup(), OversampleOutput::updateOversample(), and Console::writeVariableNorms().

◆ _refinements

const unsigned int OversampleOutput::_refinements

protectedinherited

The number of oversampling refinements.

Definition at line 62 of file OversampleOutput.h.

Referenced by OversampleOutput::initOversample().

◆ _restartable_app

MooseApp& Restartable::_restartable_app

privateinherited

Reference to the application.

Definition at line 208 of file Restartable.h.

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

◆ _restartable_name

std::string Restartable::_restartable_name

privateinherited

The name of the object.

Definition at line 211 of file Restartable.h.

Referenced by Restartable::declareRecoverableData(), Restartable::declareRestartableDataWithContext(), and Restartable::declareRestartableDataWithObjectNameWithContext().

◆ _restartable_system_name

std::string Restartable::_restartable_system_name

privateinherited

The system name this object is in.

Definition at line 214 of file Restartable.h.

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

◆ _restartable_tid

THREAD_ID Restartable::_restartable_tid

privateinherited

The thread ID for this object.

Definition at line 217 of file Restartable.h.

Referenced by Restartable::declareRestartableDataWithContext().

◆ _scalar_as_nodal

bool AdvancedOutput::_scalar_as_nodal

protectedinherited

Definition at line 261 of file AdvancedOutput.h.

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

◆ _sequence

bool Output::_sequence

protectedinherited

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

Definition at line 184 of file Output.h.

◆ _serialized_solution

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

privateinherited

Oversample solution vector.

Definition at line 108 of file OversampleOutput.h.

Referenced by OversampleOutput::initOversample(), and OversampleOutput::updateOversample().

◆ _start_step

int Output::_start_step

protectedinherited

Start outputting at this time step.

Definition at line 220 of file Output.h.

Referenced by Output::onInterval().

◆ _start_time

Real Output::_start_time

protectedinherited

Start outputting time.

Definition at line 214 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 229 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 211 of file Output.h.

Referenced by Output::onInterval().

◆ _t_step

int& Output::_t_step

protectedinherited

The current time step.

Definition at line 196 of file Output.h.

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

◆ _t_tol

Real Output::_t_tol

protectedinherited

Time checking tolerance.

Definition at line 226 of file Output.h.

Referenced by PetscOutput::solveSetup().

◆ _time

Real& Output::_time

protectedinherited

The current time for output purposes.

Definition at line 190 of file Output.h.

Referenced by PNGOutput::makePNG(), Output::onInterval(), AdvancedOutput::output(), TableOutput::outputVectorPostprocessors(), PetscOutput::solveSetup(), Output::time(), and AdvancedOutput::wantOutput().

◆ _time_old

Real& Output::_time_old

protectedinherited

The old time.

Definition at line 193 of file Output.h.

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

◆ _transient

bool Output::_transient

protectedinherited

Transient flag (true = transient)

Definition at line 172 of file Output.h.

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

◆ _type

const std::string& MooseObject::_type

protectedinherited

The type of this object (the Class name)

Definition at line 175 of file MooseObject.h.

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

◆ _use_displaced

bool Output::_use_displaced

protectedinherited

Flag for using displaced mesh.

Definition at line 175 of file Output.h.

Referenced by Output::Output().

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

include/outputs/Tecplot.h
src/outputs/Tecplot.C

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Tecplot()

Member Function Documentation

◆ addDeprecatedInputParameters()

◆ addValidParams()

◆ advancedExecuteOn()

◆ allowOutput()

◆ checkFilename()

◆ cloneMesh()

◆ declareRecoverableData() [1/2]

◆ declareRecoverableData() [2/2]

◆ declareRestartableDataTempl() [1/2]

◆ declareRestartableDataTempl() [2/2]

◆ declareRestartableDataWithContext() [1/2]

◆ declareRestartableDataWithContext() [2/2]

◆ declareRestartableDataWithObjectName()

◆ declareRestartableDataWithObjectNameWithContext()

◆ declareRestartableDataWithPrefixOverrideAndContext()

◆ dt()

◆ dtOld()

◆ enabled()

◆ enableOutputTypes()

◆ execBitFlags()

◆ execFlags()

◆ executeOn()

◆ filename()

◆ getCheckedPointerParam()

◆ getDefaultExecFlagEnum()

◆ getElementalVariableOutput()

◆ getExecuteOnEnum()

◆ getExecuteOptions()

◆ getFileNumber()

◆ getMooseApp()

◆ getNodalVariableOutput()

◆ getOutputTypes()

◆ getParamTempl()

◆ getPostprocessorOutput()

◆ getScalarOutput()

◆ getVectorPostprocessorOutput()

◆ hasElementalVariableOutput()

◆ hasNodalVariableOutput()

◆ hasOutput() [1/2]

◆ hasOutput() [2/2]

◆ hasOutputHelper()

◆ hasPostprocessorOutput()

◆ hasScalarOutput()

◆ hasVectorPostprocessorOutput()

◆ initAvailableLists()

◆ initExecutionTypes()

◆ initialSetup()

◆ initOutputList()

◆ initOversample()

◆ initPostprocessorOrVectorPostprocessorLists()

◆ initShowHideLists()

◆ interval()

◆ isAdvanced()

◆ isParamValid()

◆ jacobianSetup()

◆ meshChanged()

◆ mooseDeprecated()

◆ mooseError()

◆ mooseInfo()

◆ mooseWarning()

◆ name()

◆ onInterval()

◆ output()

◆ outputElementalVariables()

◆ outputInput()

◆ outputNodalVariables()

◆ outputPostprocessors()

◆ outputScalarVariables()