www.mooseframework.org
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
Exodus Class Reference

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

#include <Exodus.h>

Inheritance diagram for Exodus:
[legend]

Public Types

enum  OutputDimension : int {
  OutputDimension::DEFAULT, OutputDimension::ONE, OutputDimension::TWO, OutputDimension::THREE,
  OutputDimension::PROBLEM_DIMENSION
}
 

Public Member Functions

 Exodus (const InputParameters &parameters)
 Class constructor. More...
 
virtual void output (const ExecFlagType &type) override
 Overload the OutputBase::output method, this is required for ExodusII output due to the method utilized for outputing single/global parameters. More...
 
virtual void initialSetup () override
 Performs basic error checking and initial setup of ExodusII_IO output object. More...
 
virtual void meshChanged () override
 Set flag indicating that the mesh has changed. More...
 
void outputSetup ()
 Performs the necessary deletion and re-creating of ExodusII_IO object. More...
 
virtual void sequence (bool state)
 Set the sequence state When the sequence state is set to true then the outputSetup() method is called with every call to output(). More...
 
void setOutputDimension (unsigned int dim)
 Force the output dimension programatically. More...
 
void clear ()
 Reset Exodus output. 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 OutputOnWarehouseadvancedExecuteOn () 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 MultiMooseEnumexecuteOn () 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...
 
const std::string & name () const
 Get the name of the object. More...
 
const InputParametersparameters () const
 Get the parameters of the object. More...
 
template<typename T >
const T & getParam (const std::string &name) const
 Retrieve a parameter for the object. More...
 
template<typename 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...
 
MooseAppgetMooseApp () 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)
 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)
 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)
 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 ExecFlagEnumgetExecuteOnEnum () 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 void setOutputDimensionInExodusWriter (ExodusII_IO &exodus_io, const MooseMesh &mesh, OutputDimension output_dim=OutputDimension::DEFAULT)
 Helper method to change the output dimension in the passed in Exodus writer depending on the dimension and coordinates of the passed in mesh. More...
 
static InputParameters enableOutputTypes (const std::string &names=std::string())
 A method for enabling individual output type control. More...
 
static std::string getOutputFileBase (const MooseApp &app, std::string suffix="_out")
 Returns the default output file base. 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 outputNodalVariables () override
 Outputs nodal, nonlinear variables. More...
 
virtual void outputElementalVariables () override
 Outputs elemental, nonlinear variables. More...
 
virtual void outputPostprocessors () override
 Writes postprocessor values to global output parameters. More...
 
virtual void outputScalarVariables () override
 Writes scalar AuxVariables to global output parameters. More...
 
virtual void outputInput () override
 Writes the input file to the ExodusII output. More...
 
virtual std::string filename () override
 Returns the current filename, this method handles the -s000 suffix common to ExodusII files. 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 outputVectorPostprocessors ()
 Performs output of VectorPostprocessors The child class must define this method to output the VectorPostprocessors as desired. 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 & declareRestartableData (std::string data_name)
 Declare a piece of data as "restartable". More...
 
template<typename T >
T & declareRestartableData (std::string data_name, const T &init_value)
 Declare a piece of data as "restartable" and initialize it. More...
 
template<typename T >
T & declareRestartableDataWithContext (std::string data_name, void *context)
 Declare a piece of data as "restartable". More...
 
template<typename T >
T & declareRestartableDataWithContext (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 & declareRecoverableData (std::string data_name)
 Declare a piece of data as "recoverable". More...
 
template<typename T >
T & declareRecoverableData (std::string data_name, const T &init_value)
 Declare a piece of data as "restartable" and initialize it. More...
 
template<typename T >
T & declareRestartableDataWithObjectName (std::string data_name, std::string object_name)
 Declare a piece of data as "restartable". More...
 
template<typename T >
T & declareRestartableDataWithObjectNameWithContext (std::string data_name, 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

std::unique_ptr< ExodusII_IO > _exodus_io_ptr
 Pointer to the libMesh::ExodusII_IO object that performs the actual data output. More...
 
std::vector< Real > _global_values
 Storage for scalar values (postprocessors and scalar AuxVariables) More...
 
std::vector< std::string > _global_names
 Storage for names of the above scalar values. More...
 
bool _exodus_initialized
 Flag for indicating the status of the ExodusII file that is being written. More...
 
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...
 
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 outputEmptyTimestep ()
 A helper function for 'initializing' the ExodusII output file, see the comments for the _initialized member variable. More...
 

Private Attributes

unsigned int & _exodus_num
 Count of outputs per exodus file. More...
 
bool _recovering
 Flag indicating MOOSE is recovering via –recover command-line option. More...
 
std::vector< std::string > _input_record
 Storage for input file record; this is written to the file only after it has been initialized. More...
 
bool & _exodus_mesh_changed
 A flag indicating to the Exodus object that the mesh has changed. More...
 
bool _sequence
 Sequence flag, if true each timestep is written to a new file. More...
 
bool _overwrite
 Flag for overwriting timesteps. More...
 
OutputDimension _output_dimension
 Enum for the output dimension. More...
 
bool _discontinuous
 Flag to output discontinuous format in Exodus. More...
 

Detailed Description

Class for output data to the ExodusII format.

Definition at line 31 of file Exodus.h.

Member Enumeration Documentation

◆ OutputDimension

enum Exodus::OutputDimension : int
strong
Enumerator
DEFAULT 
ONE 
TWO 
THREE 
PROBLEM_DIMENSION 

Definition at line 34 of file Exodus.h.

34  : int
35  {
36  DEFAULT,
37  ONE,
38  TWO,
39  THREE,
40  PROBLEM_DIMENSION
41  };

Constructor & Destructor Documentation

◆ Exodus()

Exodus::Exodus ( const InputParameters parameters)

Class constructor.

Definition at line 76 of file Exodus.C.

78  _exodus_initialized(false),
79  _exodus_num(declareRestartableData<unsigned int>("exodus_num", 0)),
81  _exodus_mesh_changed(declareRestartableData<bool>("exodus_mesh_changed", true)),
82  _sequence(isParamValid("sequence") ? getParam<bool>("sequence")
83  : _use_displaced ? true : false),
84  _overwrite(getParam<bool>("overwrite")),
85  _output_dimension(getParam<MooseEnum>("output_dimension").getEnum<OutputDimension>()),
86  _discontinuous(getParam<bool>("discontinuous"))
87 {
88  if (isParamValid("use_problem_dimension"))
89  {
90  auto use_problem_dimension = getParam<bool>("use_problem_dimension");
91 
92  if (use_problem_dimension)
94  else
96  }
97  // If user sets 'discontinuous = true' and 'elemental_as_nodal = false', issue an error that these
98  // are incompatible states
99  if (_discontinuous && parameters.isParamSetByUser("elemental_as_nodal") &&
100  !getParam<bool>("elemental_as_nodal"))
101  mooseError(name(),
102  ": Invalid parameters. 'elemental_as_nodal' set to false while 'discontinuous' set "
103  "to true.");
104  // Discontinuous output implies that elemental values are output as nodal values
105  if (_discontinuous)
106  _elemental_as_nodal = true;
107 }
OversampleOutput(const InputParameters &parameters)
bool _elemental_as_nodal
Flags to control nodal output.
bool _overwrite
Flag for overwriting timesteps.
Definition: Exodus.h:187
void mooseError(Args &&... args) const
Definition: MooseObject.h:144
OutputDimension _output_dimension
Enum for the output dimension.
Definition: Exodus.h:190
bool _discontinuous
Flag to output discontinuous format in Exodus.
Definition: Exodus.h:193
bool _exodus_initialized
Flag for indicating the status of the ExodusII file that is being written.
Definition: Exodus.h:160
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:62
bool _recovering
Flag indicating MOOSE is recovering via –recover command-line option.
Definition: Exodus.h:175
bool & _exodus_mesh_changed
A flag indicating to the Exodus object that the mesh has changed.
Definition: Exodus.h:181
unsigned int & _exodus_num
Count of outputs per exodus file.
Definition: Exodus.h:172
bool _sequence
Sequence flag, if true each timestep is written to a new file.
Definition: Exodus.h:184
bool _use_displaced
Flag for using displaced mesh.
Definition: Output.h:174
bool isParamSetByUser(const std::string &name) const
Method returns true if the parameter was by the user.
MooseApp & _app
The MooseApp this object is associated with.
Definition: MooseObject.h:174
const std::string & name() const
Get the name of the object.
Definition: MooseObject.h:56
bool isParamValid(const std::string &name) const
Test if the supplied parameter is valid.
Definition: MooseObject.h:86
bool isRecovering() const
Whether or not this is a "recover" calculation.
Definition: MooseApp.C:853

Member Function Documentation

◆ addDeprecatedInputParameters()

static void Output::addDeprecatedInputParameters ( InputParameters params)
staticinherited

A static helper for injecting deprecated parameters.

◆ advancedExecuteOn()

const OutputOnWarehouse & AdvancedOutput::advancedExecuteOn ( ) const
virtualinherited

Get the current advanced 'execute_on' selections for display.

Reimplemented from Output.

Definition at line 763 of file AdvancedOutput.C.

764 {
765  return _advanced_execute_on;
766 }
OutputOnWarehouse _advanced_execute_on
Storage for the individual component execute flags.
Definition: Output.h:243

◆ allowOutput()

void Output::allowOutput ( bool  state)
inlineinherited

Method for controlling the allow output state.

Parameters
stateThe state to set the allow flag to

Definition at line 122 of file Output.h.

122 { _allow_output = state; }
bool _allow_output
Flag for disabling output.
Definition: Output.h:234

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

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

148 {
149  // Return true if 'output_if_base_contains' is not utilized
150  if (_output_if_base_contains.empty())
151  return true;
152 
153  // Assumed output is false
154  bool output = false;
155 
156  // Loop through each string in the list
157  for (const auto & search_string : _output_if_base_contains)
158  {
159  // Search for the string in the file base, if found set the output to true and break the loop
160  if (_file_base.find(search_string) != std::string::npos)
161  {
162  output = true;
163  break;
164  }
165  }
166 
167  // Return the value
168  return output;
169 }
virtual void output(const ExecFlagType &type)=0
Overload this function with the desired output activities.
std::string _file_base
The base filename from the input paramaters.
Definition: FileOutput.h:82
std::vector< std::string > _output_if_base_contains
Storage for &#39;output_if_base_contains&#39;.
Definition: FileOutput.h:91

◆ clear()

void Exodus::clear ( )
inline

Reset Exodus output.

Definition at line 104 of file Exodus.h.

Referenced by OutputWarehouse::reset().

104 { _exodus_io_ptr.reset(); }
std::unique_ptr< ExodusII_IO > _exodus_io_ptr
Pointer to the libMesh::ExodusII_IO object that performs the actual data output.
Definition: Exodus.h:140

◆ declareRecoverableData() [1/2]

template<typename T >
T & Restartable::declareRecoverableData ( 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_nameThe name of the data (usually just use the same name as the member variable)

Definition at line 269 of file Restartable.h.

270 {
271  std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;
272 
273  registerRecoverableDataOnApp(full_name);
274 
275  return declareRestartableDataWithContext<T>(data_name, nullptr);
276 }
std::string _restartable_system_name
The system name this object is in.
Definition: Restartable.h:194
std::string _restartable_name
The name of the object.
Definition: Restartable.h:191
void registerRecoverableDataOnApp(std::string name)
Helper function for actually registering the restartable data.
Definition: Restartable.C:54

◆ declareRecoverableData() [2/2]

template<typename T >
T & Restartable::declareRecoverableData ( 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_nameThe name of the data (usually just use the same name as the member variable)
init_valueThe initial value of the data

Definition at line 280 of file Restartable.h.

281 {
282  std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;
283 
284  registerRecoverableDataOnApp(full_name);
285 
286  return declareRestartableDataWithContext<T>(data_name, init_value, nullptr);
287 }
std::string _restartable_system_name
The system name this object is in.
Definition: Restartable.h:194
std::string _restartable_name
The name of the object.
Definition: Restartable.h:191
void registerRecoverableDataOnApp(std::string name)
Helper function for actually registering the restartable data.
Definition: Restartable.C:54

◆ declareRestartableData() [1/2]

template<typename T >
T & Restartable::declareRestartableData ( 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_nameThe name of the data (usually just use the same name as the member variable)

Definition at line 202 of file Restartable.h.

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

◆ declareRestartableData() [2/2]

template<typename T >
T & Restartable::declareRestartableData ( 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_nameThe name of the data (usually just use the same name as the member variable)
init_valueThe initial value of the data

Definition at line 209 of file Restartable.h.

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

◆ declareRestartableDataWithContext() [1/2]

template<typename T >
T & Restartable::declareRestartableDataWithContext ( 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_nameThe name of the data (usually just use the same name as the member variable)
contextContext pointer that will be passed to the load and store functions

Definition at line 216 of file Restartable.h.

217 {
218  std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;
219  auto data_ptr = libmesh_make_unique<RestartableData<T>>(full_name, context);
220  T & restartable_data_ref = data_ptr->get();
221 
222  registerRestartableDataOnApp(full_name, std::move(data_ptr), _restartable_tid);
223 
224  return restartable_data_ref;
225 }
std::string _restartable_system_name
The system name this object is in.
Definition: Restartable.h:194
std::string _restartable_name
The name of the object.
Definition: Restartable.h:191
THREAD_ID _restartable_tid
The thread ID for this object.
Definition: Restartable.h:197
void registerRestartableDataOnApp(std::string name, std::unique_ptr< RestartableDataValue > data, THREAD_ID tid)
Helper function for actually registering the restartable data.
Definition: Restartable.C:46

◆ declareRestartableDataWithContext() [2/2]

template<typename T >
T & Restartable::declareRestartableDataWithContext ( 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_nameThe name of the data (usually just use the same name as the member variable)
init_valueThe initial value of the data
contextContext pointer that will be passed to the load and store functions

Definition at line 229 of file Restartable.h.

232 {
233  std::string full_name = _restartable_system_name + "/" + _restartable_name + "/" + data_name;
234  auto data_ptr = libmesh_make_unique<RestartableData<T>>(full_name, context);
235  data_ptr->set() = init_value;
236 
237  T & restartable_data_ref = data_ptr->get();
238  registerRestartableDataOnApp(full_name, std::move(data_ptr), _restartable_tid);
239 
240  return restartable_data_ref;
241 }
std::string _restartable_system_name
The system name this object is in.
Definition: Restartable.h:194
std::string _restartable_name
The name of the object.
Definition: Restartable.h:191
THREAD_ID _restartable_tid
The thread ID for this object.
Definition: Restartable.h:197
void registerRestartableDataOnApp(std::string name, std::unique_ptr< RestartableDataValue > data, THREAD_ID tid)
Helper function for actually registering the restartable data.
Definition: Restartable.C:46

◆ declareRestartableDataWithObjectName()

template<typename T >
T & Restartable::declareRestartableDataWithObjectName ( std::string  data_name,
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_nameThe name of the data (usually just use the same name as the member variable)
object_nameA supplied name for the object that is declaring this data.

Definition at line 245 of file Restartable.h.

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

◆ declareRestartableDataWithObjectNameWithContext()

template<typename T >
T & Restartable::declareRestartableDataWithObjectNameWithContext ( std::string  data_name,
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_nameThe name of the data (usually just use the same name as the member variable)
object_nameA supplied name for the object that is declaring this data.
contextContext pointer that will be passed to the load and store functions

Definition at line 252 of file Restartable.h.

255 {
256  std::string old_name = _restartable_name;
257 
258  _restartable_name = object_name;
259 
260  T & value = declareRestartableDataWithContext<T>(data_name, context);
261 
262  _restartable_name = old_name;
263 
264  return value;
265 }
std::string _restartable_name
The name of the object.
Definition: Restartable.h:191

◆ dt()

Real Output::dt ( )
virtualinherited

Get the current time step size.

Definition at line 241 of file Output.C.

Referenced by Console::writeTimestepInformation().

242 {
243  if (_transient)
244  return _dt;
245  else
246  return 1;
247 }
bool _transient
Transient flag (true = transient)
Definition: Output.h:171
Real & _dt
Time step delta.
Definition: Output.h:198

◆ dtOld()

Real Output::dtOld ( )
virtualinherited

Get old time step size.

Definition at line 250 of file Output.C.

251 {
252  if (_transient)
253  return _dt_old;
254  else
255  return 1;
256 }
Real & _dt_old
Old time step delta.
Definition: Output.h:201
bool _transient
Transient flag (true = transient)
Definition: Output.h:171

◆ enabled()

virtual bool MooseObject::enabled ( ) const
inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 96 of file MooseObject.h.

Referenced by EigenKernel::enabled().

96 { return _enabled; }
const bool & _enabled
Reference to the "enable" InputParaemters, used by Controls for toggling on/off MooseObjects.
Definition: MooseObject.h:183

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

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

102 {
103  // The parameters object that will be returned
105 
106  // Get the MultiEnum of output types
107  MultiMooseEnum output_types = getOutputTypes();
108 
109  // Update the enum of output types to append
110  if (names.empty())
111  output_types = output_types.getRawNames();
112  else
113  output_types = names;
114 
115  // Add the parameters and return them
116  addValidParams(params, output_types);
117  return params;
118 }
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
std::string getRawNames() const
Method for returning the raw name strings for this instance.
InputParameters emptyInputParameters()
static void addValidParams(InputParameters &params, const MultiMooseEnum &types)
Method for defining the available parameters based on the types of outputs.
static MultiMooseEnum getOutputTypes()
Get the supported types of output (e.g., postprocessors, etc.)
This is a "smart" enum class intended to replace many of the shortcomings in the C++ enum type It sho...

◆ execBitFlags()

ExecFlagType SetupInterface::execBitFlags ( ) const
inherited

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

Definition at line 85 of file SetupInterface.C.

86 {
87  // TODO: ExecFlagType
88  mooseDeprecated("The execBitFlags method is being removed because MOOSE was updated to use a "
89  "ExecFlagEnum for execute flags. This method maintains the behavior of the "
90  "original method but the use of this method should be removed from your "
91  "application. The ExecFlagEnum should be inspected directly via the "
92  "getExecuteOnEnum() method.");
93 
94  unsigned int exec_bit_field = EXEC_NONE;
95  for (const auto & flag : _exec_flags)
96  exec_bit_field |= flag.id();
97  return ExecFlagType("deprecated", exec_bit_field);
98 }
MooseEnumItem ExecFlagType
Definition: Moose.h:85
const ExecFlagType EXEC_NONE
void mooseDeprecated(Args &&... args)
Emit a deprecated code/feature message with the given stringified, concatenated args.
Definition: MooseError.h:237
const int & id() const
Return the numeric, name, or raw name.
Definition: MooseEnumItem.h:37
const std::vector< ExecFlagType > _exec_flags
(DEPRECATED) execution flag (when is the object executed/evaluated) TODO: ExecFlagType ...

◆ 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 73 of file SetupInterface.C.

74 {
75  // TODO: ExecFlagType
76  mooseDeprecated("The execFlags() method is being removed because MOOSE has been updated to use a "
77  "ExecFlagEnum for execute flags. The current flags should be retrieved from "
78  "the \"exeucte_on\" parameters of your object or by using the \"_execute_enum\" "
79  "reference to the parameter or the getExecuteOnEnum() method.");
80 
81  return _exec_flags;
82 }
void mooseDeprecated(Args &&... args)
Emit a deprecated code/feature message with the given stringified, concatenated args.
Definition: MooseError.h:237
const std::vector< ExecFlagType > _exec_flags
(DEPRECATED) execution flag (when is the object executed/evaluated) TODO: ExecFlagType ...

◆ executeOn()

const MultiMooseEnum & Output::executeOn ( ) const
inherited

Get the current 'execute_on' selections for display.

Definition at line 265 of file Output.C.

266 {
267  return _execute_on;
268 }
ExecFlagEnum _execute_on
The common Execution types; this is used as the default execution type for everything except system i...
Definition: Output.h:186

◆ filename()

std::string Exodus::filename ( )
overrideprotectedvirtual

Returns the current filename, this method handles the -s000 suffix common to ExodusII files.

Returns
A string containing the current filename to be written

Reimplemented from FileOutput.

Definition at line 402 of file Exodus.C.

Referenced by output(), outputEmptyTimestep(), and outputNodalVariables().

403 {
404  // Append the .e extension on the base file name
405  std::ostringstream output;
406  output << _file_base + ".e";
407 
408  // Add the -s00x extension to the file
409  if (_file_num > 1)
410  output << "-s" << std::setw(_padding) << std::setprecision(0) << std::setfill('0') << std::right
411  << _file_num;
412 
413  // Return the filename
414  return output.str();
415 }
virtual void output(const ExecFlagType &type) override
Overload the OutputBase::output method, this is required for ExodusII output due to the method utiliz...
Definition: Exodus.C:347
std::string _file_base
The base filename from the input paramaters.
Definition: FileOutput.h:82
unsigned int _padding
Number of digits to pad the extensions.
Definition: FileOutput.h:88
unsigned int & _file_num
A file number counter, initialized to 0 (this must be controlled by the child class, see Exodus)
Definition: FileOutput.h:85

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

78  {
79  return parameters().getCheckedPointerParam<T>(name, error_string);
80  }
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...
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:62
const std::string & name() const
Get the name of the object.
Definition: MooseObject.h:56

◆ getDefaultExecFlagEnum()

ExecFlagEnum Output::getDefaultExecFlagEnum ( )
staticinherited

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

Definition at line 77 of file Output.C.

Referenced by validParams< CommonOutputAction >(), and validParams< Output >().

78 {
80  exec_enum.addAvailableFlags(EXEC_FAILED);
81  return exec_enum;
82 }
const ExecFlagType EXEC_FAILED
A MultiMooseEnum object to hold "execute_on" flags.
Definition: ExecFlagEnum.h:25
void addAvailableFlags(const ExecFlagType &flag, Args... flags)
Add additional execute_on flags to the list of possible flags.
Definition: ExecFlagEnum.h:85
ExecFlagEnum getDefaultExecFlagEnum()
Return the default ExecFlagEnum for MOOSE.
Definition: MooseUtils.C:715

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

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

722 {
723  return _execute_data["elemental"].output;
724 }
OutputDataWarehouse _execute_data
Storage structures for the various output types.

◆ getExecuteOnEnum()

const ExecFlagEnum & SetupInterface::getExecuteOnEnum ( ) const
inherited

Return the execute on MultiMooseEnum for this object.

Definition at line 67 of file SetupInterface.C.

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

68 {
69  return _execute_enum;
70 }
const ExecFlagEnum & _execute_enum
Execute settings for this oejct.

◆ 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 101 of file SetupInterface.C.

102 {
103  // TODO: ExecFlagType
104  ::mooseDeprecated("The 'getExecuteOptions' was replaced by the ExecFlagEnum class because MOOSE "
105  "was updated to use this for the execute flags and the new function provides "
106  "additional arguments for modification of the enum.");
108 }
ExecFlagEnum getDefaultExecFlagEnum()
Return the default ExecFlagEnum for MOOSE.
Definition: MooseUtils.C:715
void mooseDeprecated(Args &&... args)
Emit a deprecated code/feature message with the given stringified, concatenated args.
Definition: MooseError.h:237

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

Referenced by OutputWarehouse::getFileNumbers().

185 {
186  return _file_num;
187 }
unsigned int & _file_num
A file number counter, initialized to 0 (this must be controlled by the child class, see Exodus)
Definition: FileOutput.h:85

◆ getMooseApp()

MooseApp& MooseObject::getMooseApp ( ) const
inlineinherited

Get the MooseApp this object is associated with.

Definition at line 91 of file MooseObject.h.

Referenced by RestartableDataIO::createBackup(), RestartableDataIO::deserializeRestartableData(), ConsoleUtils::outputMeshInformation(), Resurrector::restartRestartableData(), and RestartableDataIO::restoreBackup().

91 { return _app; }
MooseApp & _app
The MooseApp this object is associated with.
Definition: MooseObject.h:174

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

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

710 {
711  return _execute_data["nodal"].output;
712 }
OutputDataWarehouse _execute_data
Storage structures for the various output types.

◆ getOutputFileBase()

std::string FileOutput::getOutputFileBase ( const MooseApp app,
std::string  suffix = "_out" 
)
staticinherited

Returns the default output file base.

Returns
The name of the input file with '_out' append to the end

This method is static to allow for outside objects to call it, namely CommonOutputAction::setRecoverFileBase().

See also
CommonOutputAction::setRecoverFileBase()

Definition at line 111 of file FileOutput.C.

Referenced by FileOutput::FileOutput(), and MooseApp::getCheckpointDirectories().

112 {
113  // If the App has an outputfile, then use it (MultiApp scenario)
114  if (!app.getOutputFileBase().empty())
115  return app.getOutputFileBase();
116 
117  // If the output base is not set it must be determined from the input file
118  /* This will only return a non-empty string if the setInputFileName() was called, which is
119  * generally not the case. One exception is when CoupledExecutioner is used */
120  std::string input_filename = app.getInputFileName();
121  if (input_filename.empty())
122  input_filename = app.getFileName();
123 
124  // Assert that the filename is not empty
125  mooseAssert(!input_filename.empty(), "Input Filename is NULL");
126 
127  // Determine location of "." in extension, assert if it is not found
128  size_t pos = input_filename.find_last_of('.');
129  mooseAssert(pos != std::string::npos, "Unable to determine suffix of input file name");
130 
131  // Append the "_out" to the name and return it
132  size_t start = 0;
133  if (input_filename.find_last_of('/') != std::string::npos)
134  start = input_filename.find_last_of('/') + 1;
135  return input_filename.substr(start, pos - start) + suffix;
136 }
std::string getFileName(bool stripLeadingPath=true) const
Return the filename that was parsed.
Definition: MooseApp.C:1043
std::string getOutputFileBase() const
Override the selection of the output file base name.
Definition: MooseApp.C:784
std::string getInputFileName() const
Returns the input file name that was set with setInputFileName.
Definition: MooseApp.h:154

◆ getParam()

template<typename T >
const T & MooseObject::getParam ( const std::string &  name) const
inherited

Retrieve a parameter for the object.

Parameters
nameThe name of the parameter
Returns
The value of the parameter

Definition at line 188 of file MooseObject.h.

Referenced by FEProblemBase::addMaterialHelper(), ConstraintWarehouse::addObject(), BicubicSplineFunction::BicubicSplineFunction(), Piecewise::buildFromXandY(), MultiApp::createApp(), DerivativeParsedMaterial::DerivativeParsedMaterial(), EigenKernel::EigenKernel(), FEProblemBase::FEProblemBase(), FieldSplitPreconditioner::FieldSplitPreconditioner(), FiniteDifferencePreconditioner::FiniteDifferencePreconditioner(), SideSetsBetweenSubdomainsGenerator::generate(), ExtraNodesetGenerator::generate(), MeshExtruderGenerator::generate(), SideSetsAroundSubdomainGenerator::generate(), GenericConstantRankTwoTensor::GenericConstantRankTwoTensor(), TimeSequenceStepper::init(), AttribThread::initFrom(), BlockRestrictable::initializeBlockRestrictable(), BoundaryRestrictable::initializeBoundaryRestrictable(), Console::initialSetup(), AdvancedOutput::initialSetup(), SideSetsBetweenSubdomains::modify(), AddExtraNodeset::modify(), MeshExtruder::modify(), SideSetsAroundSubdomain::modify(), ParsedAddSideset::ParsedAddSideset(), ParsedAux::ParsedAux(), ParsedGenerateSideset::ParsedGenerateSideset(), ParsedMaterial::ParsedMaterial(), ParsedODEKernel::ParsedODEKernel(), ParsedSubdomainMeshGenerator::ParsedSubdomainMeshGenerator(), ParsedSubdomainMeshModifier::ParsedSubdomainMeshModifier(), PhysicsBasedPreconditioner::PhysicsBasedPreconditioner(), SingleMatrixPreconditioner::SingleMatrixPreconditioner(), TimePeriod::TimePeriod(), and VectorOfPostprocessors::VectorOfPostprocessors().

189 {
190  return InputParameters::getParamHelper(name, _pars, static_cast<T *>(0));
191 }
static const T & getParamHelper(const std::string &name, const InputParameters &pars, const T *the_type)
const InputParameters & _pars
Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.
Definition: MooseObject.h:171
const std::string & name() const
Get the name of the object.
Definition: MooseObject.h:56

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

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

746 {
747  return _execute_data["postprocessors"].output;
748 }
OutputDataWarehouse _execute_data
Storage structures for the various output types.

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

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

734 {
735  return _execute_data["scalars"].output;
736 }
OutputDataWarehouse _execute_data
Storage structures for the various output types.

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

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

758 {
759  return _execute_data["vector_postprocessors"].output;
760 }
OutputDataWarehouse _execute_data
Storage structures for the various output types.

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

Referenced by initialSetup().

716 {
717  return hasOutputHelper("elemental");
718 }
bool hasOutputHelper(const std::string &name)
Helper method for checking if output types exists.

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

Referenced by initialSetup(), and outputElementalVariables().

704 {
705  return hasOutputHelper("nodal");
706 }
bool hasOutputHelper(const std::string &name)
Helper method for checking if output types exists.

◆ hasOutput() [1/2]

bool AdvancedOutput::hasOutput ( )
virtualinherited

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

Definition at line 350 of file AdvancedOutput.C.

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

351 {
352  // Test that variables exist for output AND that output execution flags are valid
353  for (const auto & it : _execute_data)
354  if (!(it.second).output.empty() && _advanced_execute_on.contains(it.first) &&
355  _advanced_execute_on[it.first].isValid())
356  return true;
357 
358  // Test execution flags for non-variable output
359  if (_advanced_execute_on.contains("system_information") &&
360  _advanced_execute_on["system_information"].isValid())
361  return true;
362  if (_advanced_execute_on.contains("input") && _advanced_execute_on["input"].isValid())
363  return true;
364 
365  return false;
366 }
OutputOnWarehouse _advanced_execute_on
Storage for the individual component execute flags.
Definition: Output.h:243
OutputDataWarehouse _execute_data
Storage structures for the various output types.
bool contains(const std::string &name)
A method for testing of a key exists.

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

339 {
340  // If any of the component outputs are true, then there is some output to perform
341  for (const auto & it : _advanced_execute_on)
342  if (wantOutput(it.first, type))
343  return true;
344 
345  // There is nothing to output
346  return false;
347 }
OutputOnWarehouse _advanced_execute_on
Storage for the individual component execute flags.
Definition: Output.h:243
const std::string & type() const
Get the type of this object.
Definition: MooseObject.h:50
bool wantOutput(const std::string &name, const ExecFlagType &type)
Handles logic for determining if a step should be output.

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

Referenced by initialSetup().

740 {
741  return hasOutputHelper("postprocessors");
742 }
bool hasOutputHelper(const std::string &name)
Helper method for checking if output types exists.

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

Referenced by initialSetup().

728 {
729  return hasOutputHelper("scalars");
730 }
bool hasOutputHelper(const std::string &name)
Helper method for checking if output types exists.

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

752 {
753  return hasOutputHelper("vector_postprocessors");
754 }
bool hasOutputHelper(const std::string &name)
Helper method for checking if output types exists.

◆ initialSetup()

void Exodus::initialSetup ( )
overridevirtual

Performs basic error checking and initial setup of ExodusII_IO output object.

Reimplemented from OversampleOutput.

Definition at line 117 of file Exodus.C.

118 {
119  // Call base class setup method
121 
122  // The libMesh::ExodusII_IO will fail when it is closed if the object is created but
123  // nothing is written to the file. This checks that at least something will be written.
124  if (!hasOutput())
125  mooseError("The current settings result in nothing being output to the Exodus file.");
126 
127  // Test that some sort of variable output exists (case when all variables are disabled but input
128  // output is still enabled
130  !hasScalarOutput())
131  mooseError("The current settings results in only the input file and no variables being output "
132  "to the Exodus file, this is not supported.");
133 }
bool hasPostprocessorOutput()
Returns true if there exists postprocessors for output.
virtual bool hasOutput()
Returns true if any of the other has methods return true.
void mooseError(Args &&... args) const
Definition: MooseObject.h:144
bool hasNodalVariableOutput()
Returns true if there exists nodal nonlinear variables for output.
virtual void initialSetup() override
Initialization method.
bool hasScalarOutput()
Returns true if there exists scalar variables for output.
bool hasElementalVariableOutput()
Returns true if there exists elemental nonlinear variables for output.

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

272 {
273  return _is_advanced;
274 }
bool _is_advanced
Flag for advanced output testing.
Definition: Output.h:237

◆ isParamValid()

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

Test if the supplied parameter is valid.

Parameters
nameThe name of the parameter to test

Definition at line 86 of file MooseObject.h.

Referenced by AdvancedOutput::AdvancedOutput(), BicubicSplineFunction::BicubicSplineFunction(), Piecewise::buildFromFile(), Piecewise::buildFromXandY(), DistributedGeneratedMesh::buildMesh(), GeneratedMesh::buildMesh(), CartesianMeshGenerator::CartesianMeshGenerator(), LibmeshPartitioner::clone(), OversampleOutput::cloneMesh(), CSVReader::CSVReader(), MultiAppNearestNodeTransfer::execute(), Exodus(), FEProblemBase::FEProblemBase(), FileOutput::FileOutput(), MultiApp::fillPositions(), FunctionDT::FunctionDT(), RenameBoundaryGenerator::generate(), BreakBoundaryOnSubdomainGenerator::generate(), ElementSubdomainIDGenerator::generate(), ExtraNodesetGenerator::generate(), LowerDBlockFromSidesetGenerator::generate(), MeshSideSetGenerator::generate(), RenameBlockGenerator::generate(), GeneratedMeshGenerator::generate(), ParsedSubdomainMeshGenerator::generate(), MeshExtruderGenerator::generate(), SubdomainBoundingBoxGenerator::generate(), MultiAppNearestNodeTransfer::getLocalEntities(), MeshGenerator::getMesh(), MultiAppNearestNodeTransfer::getNearestNode(), IterationAdaptiveDT::init(), EigenExecutionerBase::init(), MooseMesh::init(), AdvancedOutput::initExecutionTypes(), BlockRestrictable::initializeBlockRestrictable(), BoundaryRestrictable::initializeBoundaryRestrictable(), SolutionAux::initialSetup(), MooseParsedVectorFunction::initialSetup(), Console::initialSetup(), Receiver::initialSetup(), SolutionFunction::initialSetup(), MooseParsedGradFunction::initialSetup(), MooseParsedFunction::initialSetup(), AdvancedOutput::initialSetup(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), IterationAdaptiveDT::IterationAdaptiveDT(), LeastSquaresFit::LeastSquaresFit(), LibmeshPartitioner::LibmeshPartitioner(), BreakBoundaryOnSubdomain::modify(), MeshExtruder::modify(), MeshSideSet::modify(), LowerDBlockFromSideset::modify(), AssignElementSubdomainID::modify(), ParsedSubdomainMeshModifier::modify(), RenameBlock::modify(), SubdomainBoundingBox::modify(), MooseMesh::MooseMesh(), EigenExecutionerBase::normalizeSolution(), Output::Output(), PetscOutput::PetscOutput(), Piecewise::Piecewise(), SolutionUserObject::readExodusII(), RenameBlock::RenameBlock(), RenameBlockGenerator::RenameBlockGenerator(), RenameBoundaryGenerator::RenameBoundaryGenerator(), SolutionUserObject::SolutionUserObject(), and TimePeriod::TimePeriod().

86 { return _pars.isParamValid(name); }
const InputParameters & _pars
Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.
Definition: MooseObject.h:171
const std::string & name() const
Get the name of the object.
Definition: MooseObject.h:56
bool isParamValid(const std::string &name) const
This method returns parameters that have been initialized in one fashion or another, i.e.

◆ 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 52 of file SetupInterface.C.

53 {
54 }

◆ meshChanged()

void Exodus::meshChanged ( )
overridevirtual

Set flag indicating that the mesh has changed.

Reimplemented from OversampleOutput.

Definition at line 136 of file Exodus.C.

137 {
138  // Maintain Oversample::meshChanged() functionality
140 
141  // Indicate to the Exodus object that the mesh has changed
142  _exodus_mesh_changed = true;
143 }
virtual void meshChanged() override
Called on this object when the mesh changes.
bool & _exodus_mesh_changed
A flag indicating to the Exodus object that the mesh has changed.
Definition: Exodus.h:181

◆ mooseDeprecated()

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

◆ mooseError()

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

Definition at line 144 of file MooseObject.h.

Referenced by PetscExternalPartitioner::_do_partition(), GridPartitioner::_do_partition(), FEProblemBase::addConstraint(), FEProblemBase::addInitialCondition(), FEProblem::addLineSearch(), FEProblemBase::addLineSearch(), FEProblemBase::addOutput(), DiracKernel::addPointWithValidId(), FEProblemBase::addPostprocessor(), MooseMesh::addQuadratureNode(), FEProblemBase::addVectorPostprocessor(), Output::advancedExecuteOn(), AnnularMesh::AnnularMesh(), AnnularMeshGenerator::AnnularMeshGenerator(), MultiApp::appPostprocessorValue(), MultiApp::appProblem(), MultiApp::appProblemBase(), MultiApp::appUserObjectBase(), DerivativeParsedMaterialHelper::assembleDerivatives(), Function::average(), Axisymmetric2D3DSolutionFunction::Axisymmetric2D3DSolutionFunction(), BicubicSplineFunction::BicubicSplineFunction(), BoundingValueElementDamper::BoundingValueElementDamper(), BoundingValueNodalDamper::BoundingValueNodalDamper(), BoundsAux::BoundsAux(), BreakMeshByBlockGenerator::BreakMeshByBlockGenerator(), BreakMeshByBlockGeneratorBase::BreakMeshByBlockGeneratorBase(), MooseMesh::buildCoarseningMap(), Piecewise::buildFromFile(), Piecewise::buildFromXandY(), Piecewise::buildFromXY(), TiledMesh::buildMesh(), FileMesh::buildMesh(), SpiralAnnularMesh::buildMesh(), DistributedGeneratedMesh::buildMesh(), GeneratedMesh::buildMesh(), ImageMeshGenerator::buildMesh3D(), ImageMesh::buildMesh3D(), MooseMesh::buildMeshBaseObject(), MooseMesh::buildRefinementMap(), MooseMesh::buildSideList(), CartesianMeshGenerator::CartesianMeshGenerator(), ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), EigenExecutionerBase::chebyshev(), SubProblem::checkBlockMatProps(), SubProblem::checkBoundaryMatProps(), FEProblemBase::checkCoordinateSystems(), FEProblemBase::checkDependMaterialsHelper(), FEProblemBase::checkDisplacementOrders(), Material::checkExecutionStage(), BreakMeshByBlockBase::checkInputParameter(), Steady::checkIntegrity(), EigenExecutionerBase::checkIntegrity(), ActuallyExplicitEuler::checkLinearConvergence(), FEProblemBase::checkProblemIntegrity(), Material::checkStatefulSanity(), FEProblemBase::checkUserObjects(), LibmeshPartitioner::clone(), MooseMesh::clone(), ComparisonPostprocessor::comparisonIsTrue(), CompositeFunction::CompositeFunction(), ElementLpNormAux::compute(), ElementH1ErrorFunctionAux::compute(), NodalPatchRecovery::compute(), KernelBase::computeADOffDiagJacobian(), InterfaceKernel::computeElemNeighJacobian(), TimeSequenceStepperBase::computeFailedDT(), IterationAdaptiveDT::computeFailedDT(), TimeStepper::computeFailedDT(), HistogramVectorPostprocessor::computeHistogram(), EqualValueEmbeddedConstraint::computeQpJacobian(), EqualValueEmbeddedConstraint::computeQpOffDiagJacobian(), KernelValue::computeQpResidual(), FEProblemBase::computeResidualInternal(), FEProblemBase::computeResidualTag(), FEProblemBase::computeResidualType(), StatisticsVectorPostprocessor::computeStatValue(), Material::computeSubdomainProperties(), ExplicitEuler::computeTimeDerivatives(), ImplicitEuler::computeTimeDerivatives(), BDF2::computeTimeDerivatives(), NewmarkBeta::computeTimeDerivatives(), CrankNicolson::computeTimeDerivatives(), ActuallyExplicitEuler::computeTimeDerivatives(), LStableDirk2::computeTimeDerivatives(), LStableDirk3::computeTimeDerivatives(), ImplicitMidpoint::computeTimeDerivatives(), ExplicitTVDRK2::computeTimeDerivatives(), AStableDirk4::computeTimeDerivatives(), LStableDirk4::computeTimeDerivatives(), ExplicitRK2::computeTimeDerivatives(), PenetrationAux::computeValue(), ConcentricCircleMesh::ConcentricCircleMesh(), ConcentricCircleMeshGenerator::ConcentricCircleMeshGenerator(), TimeStepper::constrainStep(), AuxKernel::coupledDot(), AuxKernel::coupledDotDu(), CoupledForce::CoupledForce(), DebugResidualAux::DebugResidualAux(), BicubicSplineFunction::derivative(), DerivativeSumMaterial::DerivativeSumMaterial(), DGKernel::DGKernel(), FEProblemBase::duplicateVariableCheck(), EigenProblem::EigenProblem(), Eigenvalues::Eigenvalues(), ElementalVariableValue::ElementalVariableValue(), ElementQualityAux::ElementQualityAux(), MooseMesh::errorIfDistributedMesh(), SolutionUserObject::evalMeshFunction(), SolutionUserObject::evalMeshFunctionGradient(), SolutionUserObject::evalMultiValuedMeshFunction(), SolutionUserObject::evalMultiValuedMeshFunctionGradient(), MultiAppPostprocessorTransfer::execute(), DiscreteElementUserObject::execute(), MultiAppPostprocessorInterpolationTransfer::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), ElementQualityChecker::execute(), NodalValueSampler::execute(), PointValue::execute(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppScalarToAuxScalarTransfer::execute(), MultiAppVariableValueSampleTransfer::execute(), MultiAppInterpolationTransfer::execute(), MultiAppUserObjectTransfer::execute(), FindValueOnLine::execute(), MultiAppNearestNodeTransfer::execute(), TimeExtremeValue::execute(), VectorPostprocessorComparison::execute(), LeastSquaresFit::execute(), LeastSquaresFitHistory::execute(), FEProblemBase::executeControls(), MultiAppVectorPostprocessorTransfer::executeFromMultiapp(), MultiAppVectorPostprocessorTransfer::executeToMultiapp(), Exodus(), FileOutput::FileOutput(), CentroidMultiApp::fillPositions(), MultiApp::fillPositions(), VerifyNodalUniqueID::finalize(), VerifyElementUniqueID::finalize(), DiscreteElementUserObject::finalize(), ElementQualityChecker::finalize(), MemoryUsage::finalize(), PointSamplerBase::finalize(), Transfer::find_sys(), BreakMeshByBlockBase::findFreeBoundaryId(), BreakMeshByBlockGeneratorBase::findFreeBoundaryId(), FunctionDT::FunctionDT(), FunctionMaterialBase::FunctionMaterialBase(), ParsedMaterialHelper::functionParse(), FunctionScalarAux::FunctionScalarAux(), FunctionScalarIC::FunctionScalarIC(), GapValueAux::GapValueAux(), ElementSubdomainIDGenerator::generate(), ExtraNodesetGenerator::generate(), RenameBlockGenerator::generate(), RenameBoundaryGenerator::generate(), GeneratedMeshGenerator::generate(), MeshExtruderGenerator::generate(), SideSetsFromBoundingBoxGenerator::generate(), StackGenerator::generate(), SpiralAnnularMeshGenerator::generate(), PatternedMeshGenerator::generate(), BoundingBoxNodeSetGenerator::generate(), GeneratedMesh::GeneratedMesh(), GeneratedMeshGenerator::GeneratedMeshGenerator(), RandomICBase::generateRandom(), GenericConstantMaterial::GenericConstantMaterial(), GenericFunctionMaterial::GenericFunctionMaterial(), MooseMesh::getBoundaryID(), MultiApp::getBoundingBox(), MooseMesh::getCoarseningMap(), Control::getControllableParameterByName(), FEProblemBase::getCoordSystem(), PiecewiseConstant::getDirection(), FEProblemBase::getDistribution(), ElementGenerator::getElemType(), MultiApp::getExecutioner(), FEProblemBase::getFunction(), SolutionUserObject::getLocalVarIndex(), AuxKernel::getMaterialProperty(), AuxKernel::getMaterialPropertyOld(), AuxKernel::getMaterialPropertyOlder(), SubProblem::getMatrixTagID(), AnnularMesh::getMaxInDimension(), DistributedGeneratedMesh::getMaxInDimension(), GeneratedMesh::getMaxInDimension(), FEProblemBase::getMaxQps(), FEProblemBase::getMaxShapeFunctions(), AnnularMesh::getMinInDimension(), DistributedGeneratedMesh::getMinInDimension(), GeneratedMesh::getMinInDimension(), MooseMesh::getMortarInterface(), MooseMesh::getMortarInterfaceByName(), MooseMesh::getNodeBlockIds(), MooseMesh::getNodeList(), FEProblemBase::getNonlinearSystem(), MooseMesh::getPairedBoundaryMapping(), ImageMeshGenerator::GetPixelInfo(), ImageMesh::GetPixelInfo(), MaterialStdVectorAux::getRealValue(), MooseMesh::getRefinementMap(), FEProblemBase::getSampler(), DisplacedProblem::getScalarVariable(), FEProblemBase::getScalarVariable(), DisplacedProblem::getStandardVariable(), FEProblemBase::getStandardVariable(), MooseMesh::getSubdomainBoundaryIds(), MooseMesh::getSubdomainID(), DisplacedProblem::getSystem(), FEProblemBase::getSystem(), FEProblemBase::getUserObject(), FEProblemBase::getUserObjectBase(), PerformanceData::getValue(), Residual::getValue(), PerfGraphData::getValue(), LineValueSampler::getValue(), FindValueOnLine::getValueAtPoint(), SubProblem::getVariableHelper(), SubProblem::getVectorTagID(), DisplacedProblem::getVectorVariable(), FEProblemBase::getVectorVariable(), MultiApp::globalAppToLocal(), MooseParsedVectorFunction::gradient(), AdvancedOutput::hasOutputHelper(), CrankNicolson::init(), CSVTimeSequenceStepper::init(), IterationAdaptiveDT::init(), EigenExecutionerBase::init(), Transient::init(), MooseMesh::init(), FEProblemBase::init(), NumPicardIterations::initialize(), FullSolveMultiApp::initialSetup(), PiecewiseBase::initialSetup(), SolutionAux::initialSetup(), Axisymmetric2D3DSolutionFunction::initialSetup(), SolutionFunction::initialSetup(), initialSetup(), SolutionUserObject::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initOutputList(), AdvancedOutput::initShowHideLists(), Material::initStatefulProperties(), Function::integral(), InterfaceKernel::InterfaceKernel(), InterfaceTimeKernel::InterfaceTimeKernel(), EigenExecutionerBase::inversePowerIteration(), InversePowerMethod::InversePowerMethod(), IterationAdaptiveDT::IterationAdaptiveDT(), LayeredSideIntegral::LayeredSideIntegral(), LeastSquaresFit::LeastSquaresFit(), LibmeshPartitioner::LibmeshPartitioner(), LinearCombinationFunction::LinearCombinationFunction(), LinearCombinationPostprocessor::LinearCombinationPostprocessor(), LinearNodalConstraint::LinearNodalConstraint(), LineMaterialSamplerBase< Real >::LineMaterialSamplerBase(), LineSearch::lineSearch(), LineValueSampler::LineValueSampler(), MaterialRealTensorValueAux::MaterialRealTensorValueAux(), MaterialRealVectorValueAux::MaterialRealVectorValueAux(), MaterialStdVectorRealGradientAux::MaterialStdVectorRealGradientAux(), MaterialVectorPostprocessor::MaterialVectorPostprocessor(), Distribution::median(), SubProblem::meshChanged(), MeshExtruder::MeshExtruder(), MeshExtruderGenerator::MeshExtruderGenerator(), MeshSideSetGenerator::MeshSideSetGenerator(), SideSetsFromNormals::modify(), SideSetsFromPoints::modify(), MeshExtruder::modify(), BreakMeshByBlockBase::modify(), AddExtraNodeset::modify(), AssignElementSubdomainID::modify(), SmoothMesh::modify(), ElementDeleterBase::modify(), AddAllSideSetsByNormals::modify(), ParsedSubdomainMeshModifier::modify(), RenameBlock::modify(), ImageSubdomain::modify(), OrientedSubdomainBoundingBox::modify(), BoundingBoxNodeSet::modify(), SubdomainBoundingBox::modify(), AddSideSetsFromBoundingBox::modify(), MooseMesh::MooseMesh(), MultiAppMeshFunctionTransfer::MultiAppMeshFunctionTransfer(), MultiAppPostprocessorTransfer::MultiAppPostprocessorTransfer(), NearestNodeDistanceAux::NearestNodeDistanceAux(), NearestNodeValueAux::NearestNodeValueAux(), RenameBlockGenerator::newBlockID(), RenameBlock::newBlockID(), RenameBlockGenerator::newBlockName(), RenameBlock::newBlockName(), NewmarkBeta::NewmarkBeta(), NodalConstraint::NodalConstraint(), NodalScalarKernel::NodalScalarKernel(), NodalVariableValue::NodalVariableValue(), NumDOFs::NumDOFs(), NumNonlinearIterations::NumNonlinearIterations(), NumVars::NumVars(), ElementSideNeighborLayers::operator()(), ElementPointNeighbors::operator()(), RelationshipManager::operator==(), XDA::output(), SolutionHistory::output(), output(), AdvancedOutput::outputElementalVariables(), AdvancedOutput::outputInput(), AdvancedOutput::outputNodalVariables(), AdvancedOutput::outputPostprocessors(), AdvancedOutput::outputScalarVariables(), AdvancedOutput::outputSystemInformation(), Console::outputVectorPostprocessors(), AdvancedOutput::outputVectorPostprocessors(), MooseObject::paramError(), PiecewiseBilinear::parse(), ParsedAddSideset::ParsedAddSideset(), ParsedAux::ParsedAux(), ParsedGenerateSideset::ParsedGenerateSideset(), ParsedODEKernel::ParsedODEKernel(), ParsedSubdomainMeshGenerator::ParsedSubdomainMeshGenerator(), ParsedSubdomainMeshModifier::ParsedSubdomainMeshModifier(), PetscExternalPartitioner::PetscExternalPartitioner(), PhysicsBasedPreconditioner::PhysicsBasedPreconditioner(), Piecewise::Piecewise(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), PiecewiseMulticonstant::PiecewiseMulticonstant(), PiecewiseMultiInterpolation::PiecewiseMultiInterpolation(), SolutionUserObject::pointValueGradientWrapper(), SolutionUserObject::pointValueWrapper(), LStableDirk2::postResidual(), LStableDirk3::postResidual(), ImplicitMidpoint::postResidual(), ExplicitTVDRK2::postResidual(), LStableDirk4::postResidual(), AStableDirk4::postResidual(), ExplicitRK2::postResidual(), Predictor::Predictor(), Transient::preExecute(), SolutionUserObject::readExodusII(), SolutionUserObject::readXda(), EqualValueEmbeddedConstraint::reinitConstraint(), RelativeSolutionDifferenceNorm::RelativeSolutionDifferenceNorm(), RenameBlock::RenameBlock(), RenameBlockGenerator::RenameBlockGenerator(), RenameBoundaryGenerator::RenameBoundaryGenerator(), RinglebMesh::RinglebMesh(), RinglebMeshGenerator::RinglebMeshGenerator(), ScalarComponentIC::ScalarComponentIC(), BicubicSplineFunction::secondDerivative(), FEProblemBase::setCoordSystem(), PiecewiseBase::setData(), EigenProblem::setEigenproblemType(), Sampler::setNumberOfRequiedRandomSeeds(), setOutputDimensionInExodusWriter(), Split::setup(), TransientMultiApp::setupApp(), TimeSequenceStepperBase::setupSequence(), Transient::setupTimeIntegrator(), SideSetsFromBoundingBoxGenerator::SideSetsFromBoundingBoxGenerator(), SideSetsFromNormals::SideSetsFromNormals(), SideSetsFromNormalsGenerator::SideSetsFromNormalsGenerator(), SideSetsFromPoints::SideSetsFromPoints(), SideSetsFromPointsGenerator::SideSetsFromPointsGenerator(), SolutionTimeAdaptiveDT::SolutionTimeAdaptiveDT(), SolutionUserObject::SolutionUserObject(), PicardSolve::solve(), ActuallyExplicitEuler::solve(), FullSolveMultiApp::solveStep(), UserObject::spatialValue(), SphericalAverage::SphericalAverage(), SpiralAnnularMesh::SpiralAnnularMesh(), SpiralAnnularMeshGenerator::SpiralAnnularMeshGenerator(), StitchedMesh::StitchedMesh(), NodalUserObject::subdomainSetup(), GeneralUserObject::subdomainSetup(), Constraint::subdomainSetup(), Console::systemInfoFlags(), Terminator::Terminator(), TestSetupPostprocessorDataActionFunction::TestSetupPostprocessorDataActionFunction(), ThreadedGeneralUserObject::ThreadedGeneralUserObject(), ThreadedGeneralUserObject::threadJoin(), DiscreteElementUserObject::threadJoin(), GeneralUserObject::threadJoin(), TiledMeshGenerator::TiledMeshGenerator(), Function::timeDerivative(), TimeExtremeValue::TimeExtremeValue(), TimePeriod::TimePeriod(), VectorPostprocessorVisualizationAux::timestepSetup(), MultiAppCopyTransfer::transfer(), MultiAppMeshFunctionTransfer::transferVariable(), FEProblemBase::uDotDotOldRequested(), FEProblemBase::uDotOldRequested(), EqualValueBoundaryConstraint::updateConstrainedNodes(), SolutionUserObject::updateExodusBracketingTimeIndices(), Axisymmetric2D3DSolutionFunction::value(), ValueRangeMarker::ValueRangeMarker(), ValueThresholdMarker::ValueThresholdMarker(), MultiAppTransfer::variableIntegrityCheck(), VariableTimeIntegrationAux::VariableTimeIntegrationAux(), VectorNodalBC::VectorNodalBC(), VectorOfPostprocessors::VectorOfPostprocessors(), VectorPostprocessorFunction::VectorPostprocessorFunction(), MooseParsedGradFunction::vectorValue(), MooseParsedFunction::vectorValue(), VolumeHistogram::VolumeHistogram(), VTKOutput::VTKOutput(), DOFMapOutput::writeStreamToFile(), and Console::writeStreamToFile().

144  {
145  std::ostringstream oss;
146  moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
147  std::string msg = oss.str();
148  callMooseErrorRaw(msg, &_app);
149  }
void mooseStreamAll(std::ostringstream &ss)
All of the following are not meant to be called directly - they are called by the normal macros (moos...
Definition: MooseError.C:87
void callMooseErrorRaw(std::string &msg, MooseApp *app)
Definition: MooseObject.C:57
MooseApp & _app
The MooseApp this object is associated with.
Definition: MooseObject.h:174

◆ mooseInfo()

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

◆ mooseWarning()

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

◆ name()

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

Get the name of the object.

Returns
The name of the object

Definition at line 56 of file MooseObject.h.

Referenced by GridPartitioner::_do_partition(), FEProblemBase::addADJacobianMaterial(), FEProblemBase::addADResidualMaterial(), Executioner::addAttributeReporter(), DumpObjectsProblem::addAuxKernel(), FEProblemBase::addAuxKernel(), DumpObjectsProblem::addAuxScalarKernel(), FEProblemBase::addAuxScalarKernel(), DumpObjectsProblem::addBoundaryCondition(), FEProblemBase::addBoundaryCondition(), DumpObjectsProblem::addConstraint(), FEProblemBase::addConstraint(), FEProblemBase::addDamper(), DumpObjectsProblem::addDGKernel(), FEProblemBase::addDGKernel(), DumpObjectsProblem::addDiracKernel(), FEProblemBase::addDiracKernel(), FEProblemBase::addDistribution(), DumpObjectsProblem::addFunction(), FEProblemBase::addFunction(), FEProblemBase::addIndicator(), DumpObjectsProblem::addInitialCondition(), FEProblemBase::addInitialCondition(), DumpObjectsProblem::addInterfaceKernel(), FEProblemBase::addInterfaceKernel(), DumpObjectsProblem::addKernel(), FEProblemBase::addKernel(), FEProblemBase::addMarker(), DumpObjectsProblem::addMaterial(), FEProblemBase::addMaterial(), FEProblemBase::addMaterialHelper(), MooseMesh::addMortarInterface(), FEProblemBase::addMultiApp(), DumpObjectsProblem::addNodalKernel(), FEProblemBase::addNodalKernel(), FEProblemBase::addPostprocessor(), FEProblemBase::addPredictor(), FEProblemBase::addSampler(), DumpObjectsProblem::addScalarKernel(), FEProblemBase::addScalarKernel(), FEProblemBase::addTimeIntegrator(), FEProblemBase::addTransfer(), FEProblemBase::addUserObject(), FEProblemBase::addVectorPostprocessor(), Output::advancedExecuteOn(), MultiApp::appPostprocessorValue(), MultiApp::appProblem(), MultiApp::appProblemBase(), MultiApp::appUserObjectBase(), DerivativeParsedMaterialHelper::assembleDerivatives(), AStableDirk4::AStableDirk4(), Function::average(), MultiApp::backup(), BreakMeshByBlockGenerator::BreakMeshByBlockGenerator(), ChangeOverTimePostprocessor::ChangeOverTimePostprocessor(), FEProblemBase::checkDependMaterialsHelper(), Damper::checkMinDamping(), Material::checkStatefulSanity(), CompositeFunction::CompositeFunction(), Material::computeSubdomainProperties(), VectorPostprocessorVisualizationAux::computeValue(), AuxKernel::coupledCallback(), AuxKernel::coupledDot(), AuxKernel::coupledDotDu(), MultiApp::createApp(), FEProblemBase::declareVectorPostprocessorVector(), DOFMapOutput::demangle(), DerivativeSumMaterial::DerivativeSumMaterial(), DGKernel::DGKernel(), DumpObjectsProblem::dumpObjectHelper(), ElementValueSampler::ElementValueSampler(), MooseMesh::errorIfDistributedMesh(), AB2PredictorCorrector::estimateTimeError(), SolutionUserObject::evalMeshFunction(), SolutionUserObject::evalMeshFunctionGradient(), SolutionUserObject::evalMultiValuedMeshFunction(), SolutionUserObject::evalMultiValuedMeshFunctionGradient(), MultiAppPostprocessorTransfer::execute(), MultiAppPostprocessorInterpolationTransfer::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), StatisticsVectorPostprocessor::execute(), PointValue::execute(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppScalarToAuxScalarTransfer::execute(), MultiAppVariableValueSampleTransfer::execute(), MultiAppUserObjectTransfer::execute(), MultiAppInterpolationTransfer::execute(), MultiAppMeshFunctionTransfer::execute(), MultiAppNearestNodeTransfer::execute(), MultiAppProjectionTransfer::execute(), MultiAppVectorPostprocessorTransfer::execute(), HistogramVectorPostprocessor::execute(), MultiAppCopyTransfer::execute(), Exodus(), FileOutput::FileOutput(), MultiApp::fillPositions(), PointSamplerBase::finalize(), DerivativeParsedMaterialHelper::findMatPropDerivative(), FunctionDT::FunctionDT(), GeneralUserObject::GeneralUserObject(), LowerDBlockFromSidesetGenerator::generate(), StitchedMeshGenerator::generate(), Material::getADMaterialProperty(), MultiApp::getBoundingBox(), MooseObject::getCheckedPointerParam(), Control::getControllableParameterByName(), Control::getControllableValue(), Control::getControllableValueByName(), DistributionInterface::getDistribution(), FEProblemBase::getDistribution(), DistributionInterface::getDistributionByName(), MultiApp::getExecutioner(), OutputWarehouse::getFileNumbers(), FEProblemBase::getFunction(), SolutionUserObject::getLocalVarIndex(), Marker::getMarkerValue(), FEProblemBase::getMaterial(), NodalPatchRecovery::getMaterialProperty(), AuxKernel::getMaterialProperty(), Material::getMaterialProperty(), SubProblem::getMaterialPropertyBlockNames(), SubProblem::getMaterialPropertyBoundaryNames(), NodalPatchRecovery::getMaterialPropertyOld(), AuxKernel::getMaterialPropertyOld(), Material::getMaterialPropertyOld(), NodalPatchRecovery::getMaterialPropertyOlder(), AuxKernel::getMaterialPropertyOlder(), Material::getMaterialPropertyOlder(), MeshGenerator::getMesh(), MooseMesh::getMortarInterfaceByName(), OutputWarehouse::getOutput(), MooseObject::getParam(), GeneralUserObject::getPostprocessorValue(), AuxKernel::getPostprocessorValue(), FEProblemBase::getPostprocessorValue(), GeneralUserObject::getPostprocessorValueByName(), AuxKernel::getPostprocessorValueByName(), FEProblemBase::getPostprocessorValueOld(), FEProblemBase::getPostprocessorValueOlder(), FEProblemBase::getSampler(), AuxKernel::getScatterVectorPostprocessorValue(), FEProblemBase::getScatterVectorPostprocessorValue(), AuxKernel::getScatterVectorPostprocessorValueByName(), FEProblemBase::getScatterVectorPostprocessorValueOld(), Transient::getTimeStepperName(), AuxKernel::getUserObject(), InitialConditionBase::getUserObject(), FEProblemBase::getUserObject(), InitialConditionBase::getUserObjectBase(), AuxKernel::getUserObjectBase(), FEProblemBase::getUserObjectBase(), AuxKernel::getUserObjectByName(), InitialConditionBase::getUserObjectByName(), GeneralUserObject::getVectorPostprocessorValue(), AuxKernel::getVectorPostprocessorValue(), FEProblemBase::getVectorPostprocessorValue(), GeneralUserObject::getVectorPostprocessorValueByName(), AuxKernel::getVectorPostprocessorValueByName(), FEProblemBase::getVectorPostprocessorValueOld(), FEProblemBase::hasFunction(), AdvancedOutput::hasOutputHelper(), FEProblemBase::hasPostprocessor(), FEProblemBase::hasUserObject(), FEProblemBase::hasVectorPostprocessor(), FEProblemBase::init(), AdvancedOutput::initExecutionTypes(), AttribName::initFrom(), CSVReader::initialize(), StatisticsVectorPostprocessor::initialize(), HistogramVectorPostprocessor::initialize(), MultiAppProjectionTransfer::initialSetup(), DerivativeFunctionMaterialBase::initialSetup(), SolutionUserObject::initialSetup(), AdvancedOutput::initOutputList(), FEProblemBase::initPostprocessorData(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), Material::initStatefulProperties(), FEProblemBase::initVectorPostprocessorData(), Function::integral(), InterfaceKernel::InterfaceKernel(), MooseObject::isParamValid(), LinearCombinationFunction::LinearCombinationFunction(), Marker::Marker(), MatDiffusionBase< Real >::MatDiffusionBase(), MaterialDerivativeTestKernelBase< Real >::MaterialDerivativeTestKernelBase(), MaterialVectorPostprocessor::MaterialVectorPostprocessor(), Distribution::median(), MemoryUsageReporter::MemoryUsageReporter(), MeshSideSetGenerator::MeshSideSetGenerator(), ElementDeleterBase::modify(), MooseVariableInterface< Real >::MooseVariableInterface(), NearestPointBase< LayeredAverage >::NearestPointBase(), NodalValueSampler::NodalValueSampler(), NodalVariableValue::NodalVariableValue(), DOFMapOutput::output(), Output::Output(), AdvancedOutput::outputElementalVariables(), AdvancedOutput::outputInput(), AdvancedOutput::outputNodalVariables(), ConsoleUtils::outputOutputInformation(), Nemesis::outputPostprocessors(), outputPostprocessors(), AdvancedOutput::outputPostprocessors(), AdvancedOutput::outputScalarVariables(), AdvancedOutput::outputSystemInformation(), AdvancedOutput::outputVectorPostprocessors(), ParsedAddSideset::ParsedAddSideset(), ParsedAux::ParsedAux(), ParsedGenerateSideset::ParsedGenerateSideset(), ParsedODEKernel::ParsedODEKernel(), ParsedSubdomainMeshGenerator::ParsedSubdomainMeshGenerator(), ParsedSubdomainMeshModifier::ParsedSubdomainMeshModifier(), PointSamplerBase::PointSamplerBase(), Registry::registerObjectsTo(), FEProblemBase::registerRandomInterface(), Material::resetQpProperties(), MultiApp::restore(), Sampler::Sampler(), ScalarComponentIC::ScalarComponentIC(), MooseMesh::setBoundaryName(), Control::setControllableValue(), Control::setControllableValueByName(), OutputWarehouse::setFileNumbers(), MooseMesh::setSubdomainName(), Split::setup(), TransientMultiApp::setupApp(), SideSetsFromNormalsGenerator::SideSetsFromNormalsGenerator(), SideSetsFromPointsGenerator::SideSetsFromPointsGenerator(), SideValueSampler::SideValueSampler(), TransientMultiApp::solveStep(), UserObject::spatialValue(), SphericalAverage::SphericalAverage(), StitchedMesh::StitchedMesh(), SubProblem::storeBoundaryDelayedCheckMatProp(), SubProblem::storeBoundaryMatPropName(), SubProblem::storeBoundaryZeroMatProp(), SubProblem::storeSubdomainDelayedCheckMatProp(), SubProblem::storeSubdomainMatPropName(), SubProblem::storeSubdomainZeroMatProp(), TaggingInterface::TaggingInterface(), ThreadedGeneralUserObject::ThreadedGeneralUserObject(), Function::timeDerivative(), VectorPostprocessorVisualizationAux::timestepSetup(), TransientMultiApp::TransientMultiApp(), MultiAppTransfer::variableIntegrityCheck(), and AdvancedOutput::wantOutput().

56 { return _name; }
const std::string & _name
The name of this object, reference to value stored in InputParameters.
Definition: MooseObject.h:180

◆ onInterval()

bool Output::onInterval ( )
protectedvirtualinherited

Returns true if the output interval is satisfied.

Definition at line 199 of file Output.C.

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

200 {
201  // The output flag to return
202  bool output = false;
203 
204  // Return true if the current step on the current output interval and within the output time range
205  // and within the output step range
206  if (_time >= _start_time && _time <= _end_time && _t_step >= _start_step &&
207  _t_step <= _end_step && (_t_step % _interval) == 0)
208  output = true;
209 
210  // Return false if 'sync_only' is set to true
211  if (_sync_only)
212  output = false;
213 
214  // If sync times are not skipped, return true if the current time is a sync_time
215  if (_sync_times.find(_time) != _sync_times.end())
216  output = true;
217 
218  // Return the output status
219  return output;
220 }
virtual void output(const ExecFlagType &type)=0
Overload this function with the desired output activities.
Real _start_time
Start outputting time.
Definition: Output.h:213
int & _t_step
The current time step.
Definition: Output.h:195
int _start_step
Start outputting at this time step.
Definition: Output.h:219
const unsigned int _interval
The output time step interval.
Definition: Output.h:207
int _end_step
End outputting at this time step.
Definition: Output.h:222
bool _sync_only
Flag for only executing at sync times.
Definition: Output.h:228
std::set< Real > _sync_times
Sync times for this outputter.
Definition: Output.h:210
Real & _time
The current time for output purposes.
Definition: Output.h:189

◆ output()

void Exodus::output ( const ExecFlagType type)
overridevirtual

Overload the OutputBase::output method, this is required for ExodusII output due to the method utilized for outputing single/global parameters.

Reimplemented from AdvancedOutput.

Definition at line 347 of file Exodus.C.

Referenced by filename().

348 {
349  // Prepare the ExodusII_IO object
350  outputSetup();
351  LockFile lf(filename(), processor_id() == 0);
352 
353  // Adjust the position of the output
354  if (_app.hasOutputPosition())
355  _exodus_io_ptr->set_coordinate_offset(_app.getOutputPosition());
356 
357  // Clear the global variables (postprocessors and scalars)
358  _global_names.clear();
359  _global_values.clear();
360 
361  // Call the individual output methods
363 
364  // Write the global variables (populated by the output methods)
365  if (!_global_values.empty())
366  {
367  if (!_exodus_initialized)
369  _exodus_io_ptr->write_global_data(_global_values, _global_names);
370  }
371 
372  // Write the input file record if it exists and the output file is initialized
373  if (!_input_record.empty() && _exodus_initialized)
374  {
375  _exodus_io_ptr->write_information_records(_input_record);
376  _input_record.clear();
377  }
378 
379  // Reset the mesh changed flag
380  _exodus_mesh_changed = false;
381 
382  // It is possible to have an empty file created with the following scenario. By default the
383  // 'execute_on_input' flag is setup to run on INITIAL. If the 'execute_on' is set to FINAL
384  // but the simulation stops early (e.g., --half-transient) the Exodus file is created but there
385  // is no data in it, because of the initial call to write the input data seems to create the file
386  // but doesn't actually write the data into the solution/mesh is also supplied to the IO object.
387  // Then if --recover is used this empty file fails to open for appending.
388  //
389  // The code below will delete any empty files that exist. Another solution is to set the
390  // 'execute_on_input' flag to NONE.
391  std::string current = filename();
392  if (processor_id() == 0 && MooseUtils::checkFileReadable(current, false, false) &&
393  (MooseUtils::fileSize(current) == 0))
394  {
395  int err = std::remove(current.c_str());
396  if (err != 0)
397  mooseError("MOOSE failed to remove the empty file ", current);
398  }
399 }
std::vector< std::string > _input_record
Storage for input file record; this is written to the file only after it has been initialized...
Definition: Exodus.h:178
bool hasOutputPosition() const
Whether or not an output position has been set.
Definition: MooseApp.h:187
virtual std::string filename() override
Returns the current filename, this method handles the -s000 suffix common to ExodusII files...
Definition: Exodus.C:402
void mooseError(Args &&... args) const
Definition: MooseObject.h:144
bool _exodus_initialized
Flag for indicating the status of the ExodusII file that is being written.
Definition: Exodus.h:160
const std::string & type() const
Get the type of this object.
Definition: MooseObject.h:50
bool checkFileReadable(const std::string &filename, bool check_line_endings=false, bool throw_on_unreadable=true)
Checks to see if a file is readable (exists and permissions)
Definition: MooseUtils.C:146
virtual void output(const ExecFlagType &type)
A single call to this function should output all the necessary data for a single timestep.
bool & _exodus_mesh_changed
A flag indicating to the Exodus object that the mesh has changed.
Definition: Exodus.h:181
std::vector< std::string > _global_names
Storage for names of the above scalar values.
Definition: Exodus.h:146
std::size_t fileSize(const std::string &filename)
Check the file size.
Definition: MooseUtils.C:837
std::vector< Real > _global_values
Storage for scalar values (postprocessors and scalar AuxVariables)
Definition: Exodus.h:143
Point getOutputPosition() const
Get the output position.
Definition: MooseApp.h:193
void outputEmptyTimestep()
A helper function for &#39;initializing&#39; the ExodusII output file, see the comments for the _initialized ...
Definition: Exodus.C:418
void outputSetup()
Performs the necessary deletion and re-creating of ExodusII_IO object.
Definition: Exodus.C:152
MooseApp & _app
The MooseApp this object is associated with.
Definition: MooseObject.h:174
Gets an exclusive lock on a file.
Definition: LockFile.h:23
std::unique_ptr< ExodusII_IO > _exodus_io_ptr
Pointer to the libMesh::ExodusII_IO object that performs the actual data output.
Definition: Exodus.h:140

◆ outputElementalVariables()

void Exodus::outputElementalVariables ( )
overrideprotectedvirtual

Outputs elemental, nonlinear variables.

Reimplemented from AdvancedOutput.

Definition at line 257 of file Exodus.C.

258 {
259  // Make sure the the file is ready for writing of elemental data
262 
263  // Write the elemental data
264  std::vector<std::string> elemental(getElementalVariableOutput().begin(),
266  _exodus_io_ptr->set_output_variables(elemental);
267  _exodus_io_ptr->write_element_data(*_es_ptr);
268 }
bool _exodus_initialized
Flag for indicating the status of the ExodusII file that is being written.
Definition: Exodus.h:160
bool hasNodalVariableOutput()
Returns true if there exists nodal nonlinear variables for output.
EquationSystems * _es_ptr
Reference the the libMesh::EquationSystems object that contains the data.
Definition: Output.h:177
void outputEmptyTimestep()
A helper function for &#39;initializing&#39; the ExodusII output file, see the comments for the _initialized ...
Definition: Exodus.C:418
const std::set< std::string > & getElementalVariableOutput()
The list of elemental nonlinear variables names that are set for output.
std::unique_ptr< ExodusII_IO > _exodus_io_ptr
Pointer to the libMesh::ExodusII_IO object that performs the actual data output.
Definition: Exodus.h:140

◆ outputEmptyTimestep()

void Exodus::outputEmptyTimestep ( )
private

A helper function for 'initializing' the ExodusII output file, see the comments for the _initialized member variable.

See also
_initialized

Definition at line 418 of file Exodus.C.

Referenced by output(), and outputElementalVariables().

419 {
420  // Write a timestep with no variables
421  _exodus_io_ptr->set_output_variables(std::vector<std::string>());
422  _exodus_io_ptr->write_timestep(
424 
425  if (!_overwrite)
426  _exodus_num++;
427 
428  _exodus_initialized = true;
429 }
virtual Real time() override
Get the output time.
Definition: PetscOutput.C:253
virtual std::string filename() override
Returns the current filename, this method handles the -s000 suffix common to ExodusII files...
Definition: Exodus.C:402
bool _overwrite
Flag for overwriting timesteps.
Definition: Exodus.h:187
bool _exodus_initialized
Flag for indicating the status of the ExodusII file that is being written.
Definition: Exodus.h:160
EquationSystems * _es_ptr
Reference the the libMesh::EquationSystems object that contains the data.
Definition: Output.h:177
unsigned int & _exodus_num
Count of outputs per exodus file.
Definition: Exodus.h:172
MooseApp & _app
The MooseApp this object is associated with.
Definition: MooseObject.h:174
std::unique_ptr< ExodusII_IO > _exodus_io_ptr
Pointer to the libMesh::ExodusII_IO object that performs the actual data output.
Definition: Exodus.h:140
Real getGlobalTimeOffset() const
Each App has it&#39;s own local time.
Definition: MooseApp.h:223

◆ outputInput()

void Exodus::outputInput ( )
overrideprotectedvirtual

Writes the input file to the ExodusII output.

Reimplemented from AdvancedOutput.

Definition at line 335 of file Exodus.C.

336 {
337  // Format the input file
338  ExodusFormatter syntax_formatter;
339  syntax_formatter.printInputFile(_app.actionWarehouse());
340  syntax_formatter.format();
341 
342  // Store the information
343  _input_record = syntax_formatter.getInputFileRecord();
344 }
std::vector< std::string > _input_record
Storage for input file record; this is written to the file only after it has been initialized...
Definition: Exodus.h:178
std::vector< std::string > & getInputFileRecord()
ActionWarehouse & actionWarehouse()
Definition: MooseApp.h:140
MooseApp & _app
The MooseApp this object is associated with.
Definition: MooseObject.h:174
void printInputFile(ActionWarehouse &wh)

◆ outputNodalVariables()

void Exodus::outputNodalVariables ( )
overrideprotectedvirtual

Outputs nodal, nonlinear variables.

Reimplemented from AdvancedOutput.

Definition at line 235 of file Exodus.C.

236 {
237  // Set the output variable to the nodal variables
238  std::vector<std::string> nodal(getNodalVariableOutput().begin(), getNodalVariableOutput().end());
239  _exodus_io_ptr->set_output_variables(nodal);
240 
241  // Write the data via libMesh::ExodusII_IO
242  if (_discontinuous)
243  _exodus_io_ptr->write_timestep_discontinuous(
245  else
246  _exodus_io_ptr->write_timestep(
248 
249  if (!_overwrite)
250  _exodus_num++;
251 
252  // This satisfies the initialization of the ExodusII_IO object
253  _exodus_initialized = true;
254 }
virtual Real time() override
Get the output time.
Definition: PetscOutput.C:253
virtual std::string filename() override
Returns the current filename, this method handles the -s000 suffix common to ExodusII files...
Definition: Exodus.C:402
bool _overwrite
Flag for overwriting timesteps.
Definition: Exodus.h:187
bool _discontinuous
Flag to output discontinuous format in Exodus.
Definition: Exodus.h:193
bool _exodus_initialized
Flag for indicating the status of the ExodusII file that is being written.
Definition: Exodus.h:160
EquationSystems * _es_ptr
Reference the the libMesh::EquationSystems object that contains the data.
Definition: Output.h:177
unsigned int & _exodus_num
Count of outputs per exodus file.
Definition: Exodus.h:172
MooseApp & _app
The MooseApp this object is associated with.
Definition: MooseObject.h:174
const std::set< std::string > & getNodalVariableOutput()
The list of nodal nonlinear variables names that are set for output.
std::unique_ptr< ExodusII_IO > _exodus_io_ptr
Pointer to the libMesh::ExodusII_IO object that performs the actual data output.
Definition: Exodus.h:140
Real getGlobalTimeOffset() const
Each App has it&#39;s own local time.
Definition: MooseApp.h:223

◆ outputPostprocessors()

void Exodus::outputPostprocessors ( )
overrideprotectedvirtual

Writes postprocessor values to global output parameters.

Reimplemented from AdvancedOutput.

Definition at line 271 of file Exodus.C.

272 {
273  // List of desired postprocessor outputs
274  const std::set<std::string> & pps = getPostprocessorOutput();
275 
276  // Append the postprocessor data to the global name value parameters; scalar outputs
277  // also append these member variables
278  for (const auto & name : pps)
279  {
280  _global_names.push_back(name);
282  }
283 }
const std::set< std::string > & getPostprocessorOutput()
The list of postprocessor names that are set for output.
FEProblemBase * _problem_ptr
Pointer the the FEProblemBase object for output object (use this)
Definition: Output.h:168
std::vector< std::string > _global_names
Storage for names of the above scalar values.
Definition: Exodus.h:146
std::vector< Real > _global_values
Storage for scalar values (postprocessors and scalar AuxVariables)
Definition: Exodus.h:143
const std::string & name() const
Get the name of the object.
Definition: MooseObject.h:56
PostprocessorValue & getPostprocessorValue(const PostprocessorName &name)
Get a reference to the value associated with the postprocessor.

◆ outputScalarVariables()

void Exodus::outputScalarVariables ( )
overrideprotectedvirtual

Writes scalar AuxVariables to global output parameters.

Reimplemented from AdvancedOutput.

Definition at line 286 of file Exodus.C.

287 {
288  // List of desired scalar outputs
289  const std::set<std::string> & out = getScalarOutput();
290 
291  // Append the scalar to the global output lists
292  for (const auto & out_name : out)
293  {
294  // Make sure scalar values are in sync with the solution vector
295  // and are visible on this processor. See TableOutput.C for
296  // TableOutput::outputScalarVariables() explanatory comments
297 
298  MooseVariableScalar & scalar_var = _problem_ptr->getScalarVariable(0, out_name);
299  scalar_var.reinit();
300  VariableValue value = scalar_var.sln();
301 
302  const std::vector<dof_id_type> & dof_indices = scalar_var.dofIndices();
303  const unsigned int n = dof_indices.size();
304  value.resize(n);
305 
306  const DofMap & dof_map = scalar_var.sys().dofMap();
307  for (unsigned int i = 0; i != n; ++i)
308  {
309  const processor_id_type pid = dof_map.dof_owner(dof_indices[i]);
310  this->comm().broadcast(value[i], pid);
311  }
312 
313  // If the scalar has a single component, output the name directly
314  if (n == 1)
315  {
316  _global_names.push_back(out_name);
317  _global_values.push_back(value[0]);
318  }
319 
320  // If the scalar as many components add indices to the end of the name
321  else
322  {
323  for (unsigned int i = 0; i < n; ++i)
324  {
325  std::ostringstream os;
326  os << out_name << "_" << i;
327  _global_names.push_back(os.str());
328  _global_values.push_back(value[i]);
329  }
330  }
331  }
332 }
VariableValue & sln()
void resize(const unsigned int size)
Change the number of elements the array can store.
Definition: MooseArray.h:205
virtual DofMap & dofMap()
Gets the dof map.
Definition: SystemBase.C:900
const std::set< std::string > & getScalarOutput()
The list of scalar variables names that are set for output.
DofMap & dof_map
virtual MooseVariableScalar & getScalarVariable(THREAD_ID tid, const std::string &var_name) override
Returns the scalar variable reference from whichever system contains it.
FEProblemBase * _problem_ptr
Pointer the the FEProblemBase object for output object (use this)
Definition: Output.h:168
std::vector< std::string > _global_names
Storage for names of the above scalar values.
Definition: Exodus.h:146
std::vector< Real > _global_values
Storage for scalar values (postprocessors and scalar AuxVariables)
Definition: Exodus.h:143
std::vector< dof_id_type > & dofIndices()
PetscInt n
Class for scalar variables (they are different).
MPI_Comm comm
SystemBase & sys()
Get the system this variable is part of.

◆ outputSetup()

void Exodus::outputSetup ( )

Performs the necessary deletion and re-creating of ExodusII_IO object.

This function is stand-alone and called directly from the output() method because the ExodusII_IO object is extremely fragile with respect to closing a file that has not had data written. Thus, it is important to only create a new ExodusII_IO object if it is certain that it will be used.

Definition at line 152 of file Exodus.C.

Referenced by output().

153 {
154  if (_exodus_io_ptr)
155  {
156  // Do nothing if the ExodusII_IO objects exists, but has not been initialized
157  if (!_exodus_initialized)
158  return;
159 
160  // Do nothing if the output is using oversampling. In this case the mesh that is being output
161  // has not been changed, so there is no need to create a new ExodusII_IO object
163  return;
164 
165  // Do nothing if the mesh has not changed and sequential output is not desired
167  return;
168  }
169 
170  // Create the ExodusII_IO object
171  _exodus_io_ptr = libmesh_make_unique<ExodusII_IO>(_es_ptr->get_mesh());
172  _exodus_initialized = false;
173 
174  // Increment file number and set appending status, append if all the following conditions are met:
175  // (1) If the application is recovering (not restarting)
176  // (2) The mesh has NOT changed
177  // (3) An existing Exodus file exists for appending (_exodus_num > 0)
178  // (4) Sequential output is NOT desired
180  {
181  // Set the recovering flag to false so that this special case is not triggered again
182  _recovering = false;
183 
184  // Set the append flag to true b/c on recover the file is being appended
185  _exodus_io_ptr->append(true);
186  }
187  else
188  {
189  // Increment file counter
191  _file_num++;
192 
193  // Disable file appending and reset exodus file number count
194  _exodus_io_ptr->append(false);
195  _exodus_num = 1;
196  }
197 
199 }
OutputDimension _output_dimension
Enum for the output dimension.
Definition: Exodus.h:190
bool _exodus_initialized
Flag for indicating the status of the ExodusII file that is being written.
Definition: Exodus.h:160
EquationSystems * _es_ptr
Reference the the libMesh::EquationSystems object that contains the data.
Definition: Output.h:177
bool _oversample
Flag indicating that oversampling is enabled.
bool _recovering
Flag indicating MOOSE is recovering via –recover command-line option.
Definition: Exodus.h:175
bool & _exodus_mesh_changed
A flag indicating to the Exodus object that the mesh has changed.
Definition: Exodus.h:181
unsigned int & _exodus_num
Count of outputs per exodus file.
Definition: Exodus.h:172
bool _sequence
Sequence flag, if true each timestep is written to a new file.
Definition: Exodus.h:184
static void setOutputDimensionInExodusWriter(ExodusII_IO &exodus_io, const MooseMesh &mesh, OutputDimension output_dim=OutputDimension::DEFAULT)
Helper method to change the output dimension in the passed in Exodus writer depending on the dimensio...
Definition: Exodus.C:202
MooseMesh * _mesh_ptr
A convenience pointer to the current mesh (reference or displaced depending on "use_displaced") ...
Definition: Output.h:180
unsigned int & _file_num
A file number counter, initialized to 0 (this must be controlled by the child class, see Exodus)
Definition: FileOutput.h:85
std::unique_ptr< ExodusII_IO > _exodus_io_ptr
Pointer to the libMesh::ExodusII_IO object that performs the actual data output.
Definition: Exodus.h:140
bool _change_position
Flag for re-positioning.

◆ 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
typeThe type execution flag (see Moose.h)
See also
outputNodalVariables outputElementalVariables outputScalarVariables outputPostprocessors

Reimplemented from Output.

Definition at line 80 of file OversampleOutput.C.

81 {
82  // Output is not allowed
83  if (!_allow_output && type != EXEC_FORCED)
84  return;
85 
86  // If recovering disable output of initial condition, it was already output
87  if (type == EXEC_INITIAL && _app.isRecovering())
88  return;
89 
90  // Return if the current output is not on the desired interval
91  if (type != EXEC_FINAL && !onInterval())
92  return;
93 
94  // Call the output method (this has the file checking built in b/c OversampleOutput is a
95  // FileOutput)
96  if (shouldOutput(type))
97  {
98  TIME_SECTION(_output_step_timer);
100  output(type);
101  }
102 }
virtual void updateOversample()
Performs the update of the solution vector for the oversample/re-positioned mesh. ...
const ExecFlagType EXEC_FORCED
virtual bool onInterval()
Returns true if the output interval is satisfied.
Definition: Output.C:199
const std::string & type() const
Get the type of this object.
Definition: MooseObject.h:50
virtual void output(const ExecFlagType &type)
A single call to this function should output all the necessary data for a single timestep.
virtual bool shouldOutput(const ExecFlagType &type)
Handles logic for determining if a step should be output.
bool _allow_output
Flag for disabling output.
Definition: Output.h:234
PerfID _output_step_timer
Timers.
Definition: Output.h:246
MooseApp & _app
The MooseApp this object is associated with.
Definition: MooseObject.h:174
bool isRecovering() const
Whether or not this is a "recover" calculation.
Definition: MooseApp.C:853
const ExecFlagType EXEC_FINAL
const ExecFlagType EXEC_INITIAL

◆ outputSystemInformation()

void AdvancedOutput::outputSystemInformation ( )
protectedvirtualinherited

Reimplemented in Console.

Definition at line 225 of file AdvancedOutput.C.

Referenced by AdvancedOutput::output().

226 {
227  mooseError(
228  "Output of system information is not support for this output object named '", name(), "'");
229 }
void mooseError(Args &&... args) const
Definition: MooseObject.h:144
const std::string & name() const
Get the name of the object.
Definition: MooseObject.h:56

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

Referenced by AdvancedOutput::output().

210 {
211  mooseError(
212  "Individual output of VectorPostprocessors is not support for this output object named '",
213  name(),
214  "'");
215 }
void mooseError(Args &&... args) const
Definition: MooseObject.h:144
const std::string & name() const
Get the name of the object.
Definition: MooseObject.h:56

◆ paramError()

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

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

Referenced by ADIntegratedBCTempl< T, compute_stage >::ADIntegratedBCTempl(), ADKernelTempl< T, compute_stage >::ADKernelTempl(), DGKernel::DGKernel(), ElementValueSampler::ElementValueSampler(), StackGenerator::generate(), StitchedMeshGenerator::generate(), MultiApp::init(), IntegratedBC::IntegratedBC(), Kernel::Kernel(), NodalBC::NodalBC(), NodalEqualValueConstraint::NodalEqualValueConstraint(), NodalKernel::NodalKernel(), NodalValueSampler::NodalValueSampler(), RandomIC::RandomIC(), MultiAppCopyTransfer::transfer(), and TransientMultiApp::TransientMultiApp().

105  {
106  auto prefix = param + ": ";
107  if (!_pars.inputLocation(param).empty())
108  prefix = _pars.inputLocation(param) + ": (" + _pars.paramFullpath(param) + "):\n";
109  mooseError(prefix, args...);
110  }
void mooseError(Args &&... args) const
Definition: MooseObject.h:144
const std::string & inputLocation(const std::string &param) const
Get/set a string representing the location in the input text the parameter originated from (i...
const InputParameters & _pars
Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.
Definition: MooseObject.h:171
const std::string & paramFullpath(const std::string &param) const
Get/set a string representing the full HIT parameter path from the input file (e.g.

◆ parameters()

const InputParameters& MooseObject::parameters ( ) const
inlineinherited

Get the parameters of the object.

Returns
The parameters of the object

Definition at line 62 of file MooseObject.h.

Referenced by FEProblemBase::addADJacobianMaterial(), FEProblemBase::addADResidualMaterial(), DumpObjectsProblem::addAuxKernel(), FEProblemBase::addAuxKernel(), DumpObjectsProblem::addAuxScalarKernel(), FEProblemBase::addAuxScalarKernel(), DumpObjectsProblem::addBoundaryCondition(), FEProblemBase::addBoundaryCondition(), DumpObjectsProblem::addConstraint(), FEProblemBase::addConstraint(), FEProblemBase::addDamper(), DumpObjectsProblem::addDGKernel(), FEProblemBase::addDGKernel(), DumpObjectsProblem::addDiracKernel(), FEProblemBase::addDiracKernel(), FEProblemBase::addDistribution(), DumpObjectsProblem::addFunction(), FEProblemBase::addFunction(), FEProblemBase::addIndicator(), DumpObjectsProblem::addInitialCondition(), FEProblemBase::addInitialCondition(), DumpObjectsProblem::addInterfaceKernel(), FEProblemBase::addInterfaceKernel(), DumpObjectsProblem::addKernel(), FEProblemBase::addKernel(), FEProblem::addLineSearch(), FEProblemBase::addMarker(), DumpObjectsProblem::addMaterial(), FEProblemBase::addMaterial(), FEProblemBase::addMaterialHelper(), FEProblemBase::addMultiApp(), DumpObjectsProblem::addNodalKernel(), FEProblemBase::addNodalKernel(), FEProblemBase::addOutput(), FEProblemBase::addPostprocessor(), FEProblemBase::addPredictor(), FEProblemBase::addSampler(), DumpObjectsProblem::addScalarKernel(), FEProblemBase::addScalarKernel(), FEProblemBase::addTimeIntegrator(), FEProblemBase::addTransfer(), FEProblemBase::addUserObject(), FEProblemBase::addVectorPostprocessor(), AdvancedOutput::AdvancedOutput(), assemble_l2(), Moose::assemble_matrix(), AuxKernel::AuxKernel(), AuxScalarKernel::AuxScalarKernel(), BoundsAux::BoundsAux(), LibmeshPartitioner::clone(), OversampleOutput::cloneMesh(), Moose::compute_bounds(), Moose::compute_jacobian(), Moose::compute_nearnullspace(), Moose::compute_nullspace(), Moose::compute_postcheck(), Moose::compute_transpose_nullspace(), Console::Console(), DumpObjectsProblem::deduceNecessaryParameters(), DumpObjectsProblem::dumpObjectHelper(), EigenProblem::EigenProblem(), Eigenvalue::Eigenvalue(), Executioner::Executioner(), Exodus(), FEProblem::FEProblem(), GapValueAux::GapValueAux(), MooseObject::getCheckedPointerParam(), MooseMesh::init(), BlockRestrictable::initializeBlockRestrictable(), FEProblemBase::initNullSpaceVectors(), InterfaceKernel::InterfaceKernel(), isValid(), LayeredSideIntegral::LayeredSideIntegral(), MooseVariableInterface< Real >::MooseVariableInterface(), NearestPointBase< LayeredAverage >::NearestPointBase(), NodeFaceConstraint::NodeFaceConstraint(), PenetrationAux::PenetrationAux(), PiecewiseBilinear::PiecewiseBilinear(), PiecewiseLinearInterpolationMaterial::PiecewiseLinearInterpolationMaterial(), MultiAppProjectionTransfer::projectSolution(), RandomIC::RandomIC(), InputParameterWarehouse::removeInputParameters(), FEProblem::setInputParametersFEProblem(), FEProblemBase::setInputParametersFEProblem(), DumpObjectsProblem::stringifyParameters(), and Transient::Transient().

62 { return _pars; }
const InputParameters & _pars
Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.
Definition: MooseObject.h:171

◆ paramInfo()

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

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

Referenced by TransientMultiApp::TransientMultiApp().

136  {
137  auto prefix = param + ": ";
138  if (!_pars.inputLocation(param).empty())
139  prefix = _pars.inputLocation(param) + ": (" + _pars.paramFullpath(param) + "):\n";
140  mooseInfo(prefix, args...);
141  }
const std::string & inputLocation(const std::string &param) const
Get/set a string representing the location in the input text the parameter originated from (i...
const InputParameters & _pars
Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.
Definition: MooseObject.h:171
void mooseInfo(Args &&... args) const
Definition: MooseObject.h:164
const std::string & paramFullpath(const std::string &param) const
Get/set a string representing the full HIT parameter path from the input file (e.g.

◆ paramWarning()

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

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

120  {
121  auto prefix = param + ": ";
122  if (!_pars.inputLocation(param).empty())
123  prefix = _pars.inputLocation(param) + ": (" + _pars.paramFullpath(param) + "):\n";
124  mooseWarning(prefix, args...);
125  }
void mooseWarning(Args &&... args) const
Definition: MooseObject.h:152
const std::string & inputLocation(const std::string &param) const
Get/set a string representing the location in the input text the parameter originated from (i...
const InputParameters & _pars
Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.
Definition: MooseObject.h:171
const std::string & paramFullpath(const std::string &param) const
Get/set a string representing the full HIT parameter path from the input file (e.g.

◆ registerTimedSection()

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

Call to register a named section for timing.

Parameters
section_nameThe name of the code section to be timed
levelThe 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 50 of file PerfGraphInterface.C.

51 {
52  if (_prefix != "")
53  return _perf_graph.registerSection(_prefix + "::" + section_name, level);
54  else
55  return _perf_graph.registerSection(section_name, level);
56 }
PerfGraph & _perf_graph
The performance graph to add to.
std::string _prefix
A prefix to use for all sections.
PerfID registerSection(const std::string &section_name, unsigned int level)
Registers a named section of code.
Definition: PerfGraph.C:42

◆ residualSetup()

void SetupInterface::residualSetup ( )
virtualinherited

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

Definition at line 57 of file SetupInterface.C.

58 {
59 }

◆ sequence()

void Exodus::sequence ( bool  state)
virtual

Set the sequence state When the sequence state is set to true then the outputSetup() method is called with every call to output().

In the case of Exodus output, this creates a new file with each output.

The sequence state is automatically set to true when 'use_displaced = true', otherwise it is set to false initially

Definition at line 146 of file Exodus.C.

147 {
148  _sequence = state;
149 }
bool _sequence
Sequence flag, if true each timestep is written to a new file.
Definition: Exodus.h:184

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

Referenced by OutputWarehouse::setFileNumbers().

179 {
180  _file_num = num;
181 }
unsigned int & _file_num
A file number counter, initialized to 0 (this must be controlled by the child class, see Exodus)
Definition: FileOutput.h:85

◆ setOutputDimension()

void Exodus::setOutputDimension ( unsigned int  dim)

Force the output dimension programatically.

Parameters
dimThe dimension written in the output file

Definition at line 110 of file Exodus.C.

111 {
113  "This method is no longer needed. We can determine output dimension programmatically");
114 }
void mooseDeprecated(Args &&... args) const
Definition: MooseObject.h:158

◆ setOutputDimensionInExodusWriter()

void Exodus::setOutputDimensionInExodusWriter ( ExodusII_IO &  exodus_io,
const MooseMesh mesh,
OutputDimension  output_dim = OutputDimension::DEFAULT 
)
static

Helper method to change the output dimension in the passed in Exodus writer depending on the dimension and coordinates of the passed in mesh.

Parameters
exodus_ioThe ExodusII_IO object to modify
meshThe MooseMesh object that is queried to determine the appropriate output dimension.

Definition at line 202 of file Exodus.C.

Referenced by MeshOnlyAction::act(), and outputSetup().

205 {
206  switch (output_dimension)
207  {
209  // If the mesh_dimension is 1, we need to write out as 3D.
210  //
211  // This works around an issue in Paraview where 1D meshes cannot
212  // not be visualized correctly. Otherwise, write out based on the effectiveSpatialDimension.
213  if (mesh.getMesh().mesh_dimension() == 1)
214  exodus_io.write_as_dimension(3);
215  else
216  exodus_io.write_as_dimension(static_cast<int>(mesh.effectiveSpatialDimension()));
217  break;
218 
222  exodus_io.write_as_dimension(static_cast<int>(output_dimension));
223  break;
224 
226  exodus_io.use_mesh_dimension_instead_of_spatial_dimension(true);
227  break;
228 
229  default:
230  ::mooseError("Unknown output_dimension in Exodus writer");
231  }
232 }
void mooseError(Args &&... args) const
Definition: MooseObject.h:144
MeshBase & getMesh()
Accessor for the underlying libMesh Mesh object.
Definition: MooseMesh.C:2562
virtual unsigned int effectiveSpatialDimension() const
Returns the effective spatial dimension determined by the coordinates actually used by the mesh...
Definition: MooseMesh.C:2134

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

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

241 {
242  if (!checkFilename())
243  return false;
244 
245  if (hasOutput(type))
246  return true;
247  else
248  return Output::shouldOutput(type);
249 }
virtual bool hasOutput()
Returns true if any of the other has methods return true.
virtual bool shouldOutput(const ExecFlagType &type)
Handles logic for determining if a step should be output.
Definition: Output.C:188
const std::string & type() const
Get the type of this object.
Definition: MooseObject.h:50
bool checkFilename()
Checks the filename for output Checks the output against the &#39;output_if_base_contians&#39; list...
Definition: FileOutput.C:147

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

Definition at line 62 of file SetupInterface.C.

63 {
64 }

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

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

254 {
256  return _nonlinear_time;
257  else if (_on_linear_residual)
258  return _linear_time;
259  else
260  return Output::time();
261 }
bool _on_linear_residual
True if current output calls is on the linear residual (used by time())
Definition: PetscOutput.h:89
Real _linear_time
Psuedo linear time.
Definition: PetscOutput.h:83
bool _on_nonlinear_residual
True if current output call is on the non-linear residual (used by time())
Definition: PetscOutput.h:92
Real _nonlinear_time
The psuedo non-linear time.
Definition: PetscOutput.h:77
virtual Real time()
Get the output time.
Definition: Output.C:223

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

Referenced by Console::writeTimestepInformation().

233 {
234  if (_transient)
235  return _time_old;
236  else
237  return _t_step - 1;
238 }
Real & _time_old
The old time.
Definition: Output.h:192
int & _t_step
The current time step.
Definition: Output.h:195
bool _transient
Transient flag (true = transient)
Definition: Output.h:171

◆ timeStep()

int Output::timeStep ( )
virtualinherited

Get the current time step.

Definition at line 259 of file Output.C.

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

260 {
261  return _t_step;
262 }
int & _t_step
The current time step.
Definition: Output.h:195

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

48 {
49 }

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

Referenced by DumpObjectsProblem::addAuxKernel(), DumpObjectsProblem::addAuxScalarKernel(), FEProblemBase::addAuxScalarVariable(), DumpObjectsProblem::addAuxVariable(), DisplacedProblem::addAuxVariable(), FEProblemBase::addAuxVariable(), DumpObjectsProblem::addBoundaryCondition(), DumpObjectsProblem::addConstraint(), DumpObjectsProblem::addDGKernel(), DumpObjectsProblem::addDiracKernel(), FEProblemBase::addDistribution(), DumpObjectsProblem::addFunction(), FEProblemBase::addFunction(), DumpObjectsProblem::addInitialCondition(), DumpObjectsProblem::addInterfaceKernel(), DumpObjectsProblem::addKernel(), DumpObjectsProblem::addMaterial(), DumpObjectsProblem::addNodalKernel(), FEProblemBase::addPredictor(), FEProblemBase::addSampler(), DumpObjectsProblem::addScalarKernel(), FEProblemBase::addScalarVariable(), PhysicsBasedPreconditioner::addSystem(), FEProblemBase::addTimeIntegrator(), DumpObjectsProblem::addVariable(), DisplacedProblem::addVariable(), FEProblemBase::addVariable(), FEProblemBase::advanceMultiApps(), FEProblemBase::backupMultiApps(), MooseMesh::buildRefinementAndCoarseningMaps(), FEProblemBase::computeAuxiliaryKernels(), ElemElemConstraint::computeElemNeighJacobian(), InterfaceKernel::computeElemNeighJacobian(), DGKernel::computeElemNeighJacobian(), ElemElemConstraint::computeElemNeighResidual(), InterfaceKernel::computeElemNeighResidual(), DGKernel::computeElemNeighResidual(), FEProblemBase::computeMultiAppsDT(), InterfaceKernel::computeOffDiagElemNeighJacobian(), DGKernel::computeOffDiagElemNeighJacobian(), DGConvection::computeQpJacobian(), CoupledTiedValueConstraint::computeQpJacobian(), TiedValueConstraint::computeQpJacobian(), DGDiffusion::computeQpJacobian(), LinearNodalConstraint::computeQpJacobian(), EqualValueBoundaryConstraint::computeQpJacobian(), EqualValueEmbeddedConstraint::computeQpJacobian(), CoupledTiedValueConstraint::computeQpOffDiagJacobian(), EqualValueEmbeddedConstraint::computeQpOffDiagJacobian(), DGConvection::computeQpResidual(), CoupledTiedValueConstraint::computeQpResidual(), TiedValueConstraint::computeQpResidual(), LinearNodalConstraint::computeQpResidual(), DGDiffusion::computeQpResidual(), EqualValueBoundaryConstraint::computeQpResidual(), EqualValueEmbeddedConstraint::computeQpResidual(), FEProblemBase::computeUserObjects(), DisplacedProblem::createQRules(), FEProblemBase::createQRules(), DumpObjectsProblem::deduceNecessaryParameters(), DumpObjectsProblem::dumpObjectHelper(), FEProblemBase::duplicateVariableCheck(), FEProblemBase::execMultiApps(), FEProblemBase::execMultiAppTransfers(), FEProblemBase::execTransfers(), FEProblemBase::finishMultiAppStep(), ElementSubdomainIDGenerator::generate(), ElementGenerator::getElemType(), FEProblemBase::getMaterial(), FEProblemBase::getMaterialData(), FEProblemBase::getTransfers(), FEProblemBase::hasMultiApps(), AdvancedOutput::hasOutput(), FEProblemBase::incrementMultiAppTStep(), AdvancedOutput::initAvailableLists(), SolutionUserObject::initialSetup(), AdvancedOutput::initShowHideLists(), AssignElementSubdomainID::modify(), ControlOutput::output(), Gnuplot::output(), CSV::output(), output(), Console::output(), Nemesis::output(), AdvancedOutput::output(), OversampleOutput::outputStep(), Output::outputStep(), FEProblemBase::outputStep(), FEProblemBase::restoreMultiApps(), FEProblemBase::setCoupling(), PerfGraphOutput::shouldOutput(), FileOutput::shouldOutput(), Output::shouldOutput(), AdvancedOutput::shouldOutput(), DisplacedProblem::updateGeomSearch(), FEProblemBase::updateGeomSearch(), and AdvancedOutput::wantOutput().

50 { return _type; }
const std::string & _type
The type of this object (the Class name)
Definition: MooseObject.h:177

◆ updateOversample()

void OversampleOutput::updateOversample ( )
protectedvirtualinherited

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

Definition at line 208 of file OversampleOutput.C.

Referenced by OversampleOutput::outputStep().

209 {
210  // Do nothing if oversampling and changing position are not enabled
211  if (!_oversample && !_change_position)
212  return;
213 
214  // Get a reference to actual equation system
215  EquationSystems & source_es = _problem_ptr->es();
216 
217  // Loop throuch each system
218  for (unsigned int sys_num = 0; sys_num < source_es.n_systems(); ++sys_num)
219  {
220  if (!_mesh_functions[sys_num].empty())
221  {
222  // Get references to the source and destination systems
223  System & source_sys = source_es.get_system(sys_num);
224  System & dest_sys = _oversample_es->get_system(sys_num);
225 
226  // Update the solution for the oversampled mesh
227  _serialized_solution->clear();
228  _serialized_solution->init(source_sys.n_dofs(), false, SERIAL);
229  source_sys.solution->localize(*_serialized_solution);
230 
231  // Update the mesh functions
232  for (unsigned int var_num = 0; var_num < _mesh_functions[sys_num].size(); ++var_num)
233  {
234 
235  // If the mesh has change the MeshFunctions need to be re-built, otherwise simply clear it
236  // for re-initialization
237  if (!_mesh_functions[sys_num][var_num] || _oversample_mesh_changed)
238  _mesh_functions[sys_num][var_num] = libmesh_make_unique<MeshFunction>(
239  source_es, *_serialized_solution, source_sys.get_dof_map(), var_num);
240  else
241  _mesh_functions[sys_num][var_num]->clear();
242 
243  // Initialize the MeshFunctions for application to the oversampled solution
244  _mesh_functions[sys_num][var_num]->init();
245  }
246 
247  // Now loop over the nodes of the oversampled mesh setting values for each variable.
248  for (const auto & node : as_range(_mesh_ptr->localNodesBegin(), _mesh_ptr->localNodesEnd()))
249  for (unsigned int var_num = 0; var_num < _mesh_functions[sys_num].size(); ++var_num)
250  if (node->n_dofs(sys_num, var_num))
251  dest_sys.solution->set(node->dof_number(sys_num, var_num, 0),
252  (*_mesh_functions[sys_num][var_num])(
253  *node - _position)); // 0 value is for component
254 
255  dest_sys.solution->close();
256  }
257  }
258 
259  // Set this to false so that new output files are not created, since the oversampled mesh doesn't
260  // actually change
261  _oversample_mesh_changed = false;
262 }
bool _oversample_mesh_changed
A flag indicating that the mesh has changed and the oversampled mesh needs to be re-initialized.
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 c...
Point _position
When oversampling, the output is shift by this amount.
MeshBase::const_node_iterator localNodesBegin()
Calls local_nodes_begin/end() on the underlying libMesh mesh object.
Definition: MooseMesh.C:2200
std::unique_ptr< EquationSystems > _oversample_es
std::unique_ptr< NumericVector< Number > > _serialized_solution
Oversample solution vector.
MeshBase::const_node_iterator localNodesEnd()
Definition: MooseMesh.C:2206
virtual EquationSystems & es() override
bool _oversample
Flag indicating that oversampling is enabled.
FEProblemBase * _problem_ptr
Pointer the the FEProblemBase object for output object (use this)
Definition: Output.h:168
MooseMesh * _mesh_ptr
A convenience pointer to the current mesh (reference or displaced depending on "use_displaced") ...
Definition: Output.h:180
bool _change_position
Flag for re-positioning.

Member Data Documentation

◆ _advanced_execute_on

OutputOnWarehouse Output::_advanced_execute_on
protectedinherited

◆ _allow_output

bool Output::_allow_output
protectedinherited

Flag for disabling output.

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

Referenced by GridPartitioner::_do_partition(), AB2PredictorCorrector::AB2PredictorCorrector(), Executioner::addAttributeReporter(), FEProblemBase::addMaterialHelper(), FEProblemBase::addMultiApp(), FEProblemBase::addOutput(), FEProblemBase::allowOutput(), AStableDirk4::AStableDirk4(), AlgebraicRelationshipManager::attachAlgebraicFunctorHelper(), RelationshipManager::attachRelationshipManagers(), ElementSideNeighborLayers::attachRelationshipManagersInternal(), ElementPointNeighbors::attachRelationshipManagersInternal(), FileMesh::buildMesh(), MeshGeneratorMesh::buildMesh(), MooseMesh::buildMeshBaseObject(), FEProblemBase::checkNonlinearConvergence(), OversampleOutput::cloneMesh(), FEProblemBase::computeJacobianTags(), FEProblemBase::computeResidualTags(), Console::Console(), TimeStepper::constrainStep(), MultiApp::createApp(), 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(), InversePowerMethod::init(), NonlinearEigen::init(), Transient::init(), Steady::init(), MooseMesh::init(), NumPicardIterations::initialize(), TimePeriod::initialSetup(), Console::initialSetup(), MultiApp::initialSetup(), FEProblemBase::initialSetup(), AdvancedOutput::initOutputList(), FEProblemBase::initPetscOutput(), AdvancedOutput::initPostprocessorOrVectorPostprocessorLists(), InversePowerMethod::InversePowerMethod(), MooseObject::mooseError(), NonlinearEigen::NonlinearEigen(), EigenExecutionerBase::normalizeSolution(), PerfGraphOutput::output(), Tecplot::output(), output(), Nemesis::output(), ControlOutput::outputActiveObjects(), ControlOutput::outputChangedControls(), ControlOutput::outputControls(), outputEmptyTimestep(), Console::outputInput(), outputInput(), outputNodalVariables(), OversampleOutput::outputStep(), Output::outputStep(), FEProblemBase::outputStep(), Console::outputSystemInformation(), MultiApp::parentOutputPositionChanged(), PerformanceData::PerformanceData(), PetscOutput::petscLinearOutput(), PetscOutput::petscNonlinearOutput(), 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().

◆ _change_position

bool OversampleOutput::_change_position
protectedinherited

Flag for re-positioning.

Definition at line 67 of file OversampleOutput.h.

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

◆ _console

const ConsoleStream ConsoleStreamInterface::_console
inherited

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

Definition at line 32 of file ConsoleStreamInterface.h.

Referenced by IterationAdaptiveDT::acceptStep(), SetupRecoverFileBaseAction::act(), Adaptivity::adaptMesh(), FEProblemBase::adaptMesh(), SimplePredictor::apply(), MultiApp::backup(), FEProblemBase::backupMultiApps(), FEProblemBase::checkProblemIntegrity(), IterationAdaptiveDT::computeAdaptiveDT(), Transient::computeConstrainedDT(), NonlinearSystemBase::computeDamping(), IterationAdaptiveDT::computeDT(), IterationAdaptiveDT::computeFailedDT(), IterationAdaptiveDT::computeInterpolationDT(), FEProblemBase::computeResidualTags(), IterationAdaptiveDT::constrainStep(), TimeStepper::constrainStep(), MultiApp::createApp(), FEProblemBase::execMultiApps(), FEProblemBase::execMultiAppTransfers(), MultiAppPostprocessorTransfer::execute(), MultiAppPostprocessorInterpolationTransfer::execute(), MultiAppVariableValueSamplePostprocessorTransfer::execute(), MultiAppPostprocessorToAuxScalarTransfer::execute(), MultiAppScalarToAuxScalarTransfer::execute(), MultiAppVariableValueSampleTransfer::execute(), MultiAppInterpolationTransfer::execute(), MultiAppMeshFunctionTransfer::execute(), MultiAppUserObjectTransfer::execute(), MultiAppNearestNodeTransfer::execute(), MultiAppProjectionTransfer::execute(), MultiAppVectorPostprocessorTransfer::execute(), MultiAppCopyTransfer::execute(), Steady::execute(), MultiAppDTKUserObjectTransfer::execute(), ActionWarehouse::executeActionsWithAction(), ActionWarehouse::executeAllActions(), FEProblemBase::FEProblemBase(), ElementQualityChecker::finalize(), FEProblemBase::finishMultiAppStep(), MultiApp::globalAppToLocal(), InversePowerMethod::init(), NonlinearEigen::init(), Steady::init(), FEProblemBase::initialAdaptMesh(), FEProblemBase::initialSetup(), EigenExecutionerBase::inversePowerIteration(), Transient::keepGoing(), IterationAdaptiveDT::limitDTByFunction(), IterationAdaptiveDT::limitDTToPostprocessorValue(), EigenExecutionerBase::makeBXConsistent(), Console::meshChanged(), MooseObject::mooseDeprecated(), MooseObject::mooseInfo(), MooseObject::mooseWarning(), PerfGraphOutput::output(), DOFMapOutput::output(), VariableResidualNormsDebugOutput::output(), Console::output(), ControlOutput::outputActiveObjects(), ControlOutput::outputChangedControls(), ControlOutput::outputControls(), Console::outputInput(), Console::outputPostprocessors(), Console::outputScalarVariables(), Console::outputSystemInformation(), FEProblemBase::possiblyRebuildGeomSearchPatches(), EigenExecutionerBase::postExecute(), AB2PredictorCorrector::postSolve(), ActionWarehouse::printActionDependencySets(), EigenExecutionerBase::printEigenvalue(), MaterialPropertyDebugOutput::printMaterialMap(), SolutionTimeAdaptiveDT::rejectStep(), DT2::rejectStep(), MultiApp::restore(), FEProblemBase::restoreMultiApps(), SimplePredictor::shouldApply(), NonlinearSystem::solve(), PicardSolve::solve(), LStableDirk2::solve(), LStableDirk3::solve(), ImplicitMidpoint::solve(), ExplicitTVDRK2::solve(), LStableDirk4::solve(), AStableDirk4::solve(), ExplicitRK2::solve(), TransientMultiApp::solveStep(), PicardSolve::solveStep(), DT2::step(), AB2PredictorCorrector::step(), NonlinearEigen::takeStep(), Console::writeTimestepInformation(), Console::writeVariableNorms(), and FEProblemBase::~FEProblemBase().

◆ _current_execute_flag

const ExecFlagType& SetupInterface::_current_execute_flag
protectedinherited

Reference to FEProblemBase.

Definition at line 98 of file SetupInterface.h.

◆ _discontinuous

bool Exodus::_discontinuous
private

Flag to output discontinuous format in Exodus.

Definition at line 193 of file Exodus.h.

Referenced by Exodus(), and outputNodalVariables().

◆ _dt

Real& Output::_dt
protectedinherited

Time step delta.

Definition at line 198 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 201 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 260 of file AdvancedOutput.h.

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

◆ _enabled

const bool& MooseObject::_enabled
protectedinherited

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

Definition at line 183 of file MooseObject.h.

Referenced by MooseObject::enabled().

◆ _end_step

int Output::_end_step
protectedinherited

End outputting at this time step.

Definition at line 222 of file Output.h.

Referenced by Output::onInterval().

◆ _end_time

Real Output::_end_time
protectedinherited

End outputting time.

Definition at line 216 of file Output.h.

◆ _es_ptr

EquationSystems* Output::_es_ptr
protectedinherited

◆ _exec_flags

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

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

Definition at line 95 of file SetupInterface.h.

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

◆ _execute_enum

const ExecFlagEnum& SetupInterface::_execute_enum
protectedinherited

Execute settings for this oejct.

Definition at line 92 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 186 of file Output.h.

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

◆ _exodus_initialized

bool Exodus::_exodus_initialized
protected

Flag for indicating the status of the ExodusII file that is being written.

The ExodusII_IO interface requires that the file be 'initialized' prior to writing any type of data. This initialization occurs when write_timestep() is called. However, write_timestep also writes nodal data, so in the case where no nodal data is output, it is necessary to call write_timestep() after calling set_output_variables with an empty input string. This flag allows for the various output methods to check that the ExodusII file is in the proper state prior to writing data.

See also
outputEmptyTimestep()

Definition at line 160 of file Exodus.h.

Referenced by output(), outputElementalVariables(), outputEmptyTimestep(), outputNodalVariables(), and outputSetup().

◆ _exodus_io_ptr

std::unique_ptr<ExodusII_IO> Exodus::_exodus_io_ptr
protected

Pointer to the libMesh::ExodusII_IO object that performs the actual data output.

Definition at line 140 of file Exodus.h.

Referenced by clear(), output(), outputElementalVariables(), outputEmptyTimestep(), outputNodalVariables(), and outputSetup().

◆ _exodus_mesh_changed

bool& Exodus::_exodus_mesh_changed
private

A flag indicating to the Exodus object that the mesh has changed.

Definition at line 181 of file Exodus.h.

Referenced by meshChanged(), output(), and outputSetup().

◆ _exodus_num

unsigned int& Exodus::_exodus_num
private

Count of outputs per exodus file.

Definition at line 172 of file Exodus.h.

Referenced by outputEmptyTimestep(), outputNodalVariables(), and outputSetup().

◆ _file_base

std::string FileOutput::_file_base
protectedinherited

◆ _file_num

unsigned int& FileOutput::_file_num
protectedinherited

◆ _global_names

std::vector<std::string> Exodus::_global_names
protected

Storage for names of the above scalar values.

Definition at line 146 of file Exodus.h.

Referenced by output(), outputPostprocessors(), and outputScalarVariables().

◆ _global_values

std::vector<Real> Exodus::_global_values
protected

Storage for scalar values (postprocessors and scalar AuxVariables)

Definition at line 143 of file Exodus.h.

Referenced by output(), outputPostprocessors(), and outputScalarVariables().

◆ _initialized

bool Output::_initialized
protectedinherited

True if init() has been called.

Definition at line 231 of file Output.h.

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

◆ _input_record

std::vector<std::string> Exodus::_input_record
private

Storage for input file record; this is written to the file only after it has been initialized.

Definition at line 178 of file Exodus.h.

Referenced by output(), and outputInput().

◆ _interval

const unsigned int Output::_interval
protectedinherited

The output time step interval.

Definition at line 207 of file Output.h.

Referenced by Output::onInterval().

◆ _is_advanced

bool Output::_is_advanced
protectedinherited

Flag for advanced output testing.

Definition at line 237 of file Output.h.

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

◆ _linear_iter

PetscInt PetscOutput::_linear_iter
protectedinherited

Current linear iteration returned from PETSc.

Definition at line 52 of file PetscOutput.h.

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

◆ _mci_feproblem

FEProblemBase& MeshChangedInterface::_mci_feproblem
protectedinherited

Reference to FEProblemBase instance.

Definition at line 42 of file MeshChangedInterface.h.

Referenced by MeshChangedInterface::MeshChangedInterface().

◆ _mesh_ptr

MooseMesh* Output::_mesh_ptr
protectedinherited

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

Definition at line 180 of file Output.h.

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

◆ _name

const std::string& MooseObject::_name
protectedinherited

◆ _nonlinear_iter

PetscInt PetscOutput::_nonlinear_iter
protectedinherited

Current non-linear iteration returned from PETSc.

Definition at line 49 of file PetscOutput.h.

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

◆ _norm

Real PetscOutput::_norm
protectedinherited

Current norm returned from PETSc.

Definition at line 46 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 204 of file Output.h.

◆ _output_dimension

OutputDimension Exodus::_output_dimension
private

Enum for the output dimension.

Definition at line 190 of file Exodus.h.

Referenced by Exodus(), and outputSetup().

◆ _output_if_base_contains

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

Storage for 'output_if_base_contains'.

Definition at line 91 of file FileOutput.h.

Referenced by FileOutput::checkFilename().

◆ _output_step_timer

PerfID Output::_output_step_timer
protectedinherited

Timers.

Definition at line 246 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 64 of file OversampleOutput.h.

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

◆ _overwrite

bool Exodus::_overwrite
private

Flag for overwriting timesteps.

Definition at line 187 of file Exodus.h.

Referenced by outputEmptyTimestep(), and outputNodalVariables().

◆ _padding

unsigned int FileOutput::_padding
protectedinherited

◆ _pars

const InputParameters& MooseObject::_pars
protectedinherited

◆ _perf_graph

PerfGraph& PerfGraphInterface::_perf_graph
protectedinherited

The performance graph to add to.

Definition at line 66 of file PerfGraphInterface.h.

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

◆ _pg_params

const InputParameters* PerfGraphInterface::_pg_params
protectedinherited

Params.

Definition at line 63 of file PerfGraphInterface.h.

◆ _prefix

std::string PerfGraphInterface::_prefix
protectedinherited

A prefix to use for all sections.

Definition at line 69 of file PerfGraphInterface.h.

Referenced by PerfGraphInterface::registerTimedSection().

◆ _problem_ptr

FEProblemBase* Output::_problem_ptr
protectedinherited

◆ _recovering

bool Exodus::_recovering
private

Flag indicating MOOSE is recovering via –recover command-line option.

Definition at line 175 of file Exodus.h.

Referenced by outputSetup().

◆ _refinements

const unsigned int OversampleOutput::_refinements
protectedinherited

The number of oversampling refinements.

Definition at line 61 of file OversampleOutput.h.

Referenced by OversampleOutput::initOversample().

◆ _scalar_as_nodal

bool AdvancedOutput::_scalar_as_nodal
protectedinherited

◆ _sequence

bool Exodus::_sequence
private

Sequence flag, if true each timestep is written to a new file.

Definition at line 184 of file Exodus.h.

Referenced by outputSetup(), and sequence().

◆ _start_step

int Output::_start_step
protectedinherited

Start outputting at this time step.

Definition at line 219 of file Output.h.

Referenced by Output::onInterval().

◆ _start_time

Real Output::_start_time
protectedinherited

Start outputting time.

Definition at line 213 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 228 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 210 of file Output.h.

Referenced by Output::onInterval().

◆ _t_step

int& Output::_t_step
protectedinherited

◆ _t_tol

Real Output::_t_tol
protectedinherited

Time checking tolerance.

Definition at line 225 of file Output.h.

Referenced by PetscOutput::solveSetup().

◆ _time

Real& Output::_time
protectedinherited

◆ _time_old

Real& Output::_time_old
protectedinherited

The old time.

Definition at line 192 of file Output.h.

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

◆ _transient

bool Output::_transient
protectedinherited

Transient flag (true = transient)

Definition at line 171 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 177 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 174 of file Output.h.

Referenced by Output::Output().


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