www.mooseframework.org
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
Transient Class Reference

Transient executioners usually loop through a number of timesteps... More...

#include <Transient.h>

Inheritance diagram for Transient:
[legend]

Public Member Functions

 Transient (const InputParameters &parameters)
 Constructor. More...
 
virtual void init () override
 Initialize the executioner. More...
 
virtual void execute () override
 Pure virtual execute function MUST be overridden by children classes. More...
 
virtual void takeStep (Real input_dt=-1.0)
 Do whatever is necessary to advance one step. More...
 
virtual Real computeConstrainedDT ()
 
virtual void estimateTimeError ()
 
virtual Real getDT ()
 
virtual bool keepGoing ()
 Transient loop will continue as long as this keeps returning true. More...
 
virtual bool lastSolveConverged () const override
 Whether or not the last solve converged. More...
 
virtual void preExecute () override
 Override this for actions that should take place before execution. More...
 
virtual void postExecute () override
 Override this for actions that should take place after execution. More...
 
virtual void computeDT ()
 
virtual void preStep ()
 
virtual void postStep ()
 
virtual void incrementStepOrReject ()
 This is where the solve step is actually incremented. More...
 
virtual void endStep (Real input_time=-1.0)
 
virtual void setTargetTime (Real target_time)
 Can be used to set the next "target time" which is a time to nail perfectly. More...
 
virtual Real getTime ()
 Get the current time. More...
 
virtual void setTime (Real t)
 Set the current time. More...
 
virtual void setTimeOld (Real t)
 Set the old time. More...
 
Real getSolutionChangeNorm ()
 Get the Relative L2 norm of the change in the solution. More...
 
TimeSteppergetTimeStepper ()
 Pointer to the TimeStepper. More...
 
void setTimeStepper (std::shared_ptr< TimeStepper > ts)
 Set the timestepper to use. More...
 
virtual std::string getTimeStepperName () override
 Get the timestepper. More...
 
Moose::TimeIntegratorType getTimeScheme ()
 Get the time scheme used. More...
 
std::set< Real > & syncTimes ()
 Get the set of sync times. More...
 
Real & dtMax ()
 Get the maximum dt. More...
 
Real & dtMin ()
 Get the minimal dt. More...
 
Real getStartTime ()
 Return the start time. More...
 
Real & endTime ()
 Get the end time. More...
 
Real & timestepTol ()
 Get the timestep tolerance. More...
 
bool & verbose ()
 Get the verbose output flag. More...
 
bool atSyncPoint ()
 Is the current step at a sync point (sync times, time interval, target time, etc)? More...
 
Real unconstrainedDT ()
 Get the unconstrained dt. More...
 
void parentOutputPositionChanged () override
 Can be used by subsclasses to call parentOutputPositionChanged() on the underlying FEProblemBase. More...
 
virtual Real relativeSolutionDifferenceNorm ()
 The relative L2 norm of the difference between solution and old solution vector. More...
 
virtual void preSolve ()
 Override this for actions that should take place before execution. More...
 
virtual void postSolve ()
 Override this for actions that should take place after execution. More...
 
virtual Problemproblem ()
 Deprecated: Return a reference to this Executioner's Problem instance. More...
 
FEProblemBasefeProblem ()
 Return a reference to this Executioner's FEProblemBase instance. More...
 
PicardSolvepicardSolve ()
 Return underlining PicardSolve object. More...
 
virtual bool augmentedPicardConvergenceCheck () const
 Augmented Picard convergence check that can be overridden by derived executioners. 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
 
template<class T >
const T & getUserObject (const std::string &name)
 Get an user object with a given parameter name. More...
 
template<class T >
const T & getUserObjectByName (const std::string &name)
 Get an user object with a given name. More...
 
const UserObjectgetUserObjectBase (const std::string &name)
 Get an user object with a given parameter name. More...
 
const UserObjectgetUserObjectBaseByName (const std::string &name)
 Get an user object with a given name. More...
 
bool hasPostprocessor (const std::string &name) const
 Determine if the Postprocessor exists. More...
 
bool hasPostprocessorByName (const PostprocessorName &name)
 Determine if the Postprocessor exists. More...
 
const PostprocessorValuegetPostprocessorValue (const std::string &name)
 Retrieve the value of a Postprocessor or one of it's old or older values. More...
 
const PostprocessorValuegetPostprocessorValueOld (const std::string &name)
 
const PostprocessorValuegetPostprocessorValueOlder (const std::string &name)
 
const PostprocessorValuegetPostprocessorValueByName (const PostprocessorName &name)
 Retrieve the value of the Postprocessor. More...
 
const PostprocessorValuegetPostprocessorValueOldByName (const PostprocessorName &name)
 
const PostprocessorValuegetPostprocessorValueOlderByName (const PostprocessorName &name)
 
const PostprocessorValuegetDefaultPostprocessorValue (const std::string &name)
 Return the default postprocessor value. More...
 

Public Attributes

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

Protected Member Functions

void setupTimeIntegrator ()
 
virtual void addAttributeReporter (const std::string &name, Real &attribute, const std::string execute_on="")
 Adds a postprocessor to report a Real class attribute. 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

FEProblemBase_problem
 Here for backward compatibility. More...
 
NonlinearSystemBase_nl
 Reference to nonlinear system base for faster access. More...
 
Moose::TimeIntegratorType _time_scheme
 
std::shared_ptr< TimeStepper_time_stepper
 
int & _t_step
 Current timestep. More...
 
Real & _time
 Current time. More...
 
Real & _time_old
 Previous time. More...
 
Real & _dt
 Current delta t... or timestep size. More...
 
Real & _dt_old
 
Real & _unconstrained_dt
 
bool & _at_sync_point
 
bool & _last_solve_converged
 Whether or not the last solve converged. More...
 
bool _xfem_repeat_step
 Whether step should be repeated due to xfem modifying the mesh. More...
 
Real _end_time
 
Real _dtmin
 
Real _dtmax
 
unsigned int _num_steps
 
int _n_startup_steps
 
bool _steady_state_detection
 Steady state detection variables: More...
 
Real _steady_state_tolerance
 
Real _steady_state_start_time
 
Real & _sln_diff_norm
 
Real & _old_time_solution_norm
 
std::set< Real > & _sync_times
 
bool _abort
 
bool & _time_interval
 if to use time interval output More...
 
Real _next_interval_output_time
 
Real _time_interval_output_interval
 
Real _start_time
 
Real _timestep_tolerance
 
Real & _target_time
 
bool _use_multiapp_dt
 
bool _verbose
 should detailed diagnostic output be printed More...
 
Real _solution_change_norm
 
NumericVector< Number > & _sln_diff
 The difference of current and old solutions. More...
 
PerfID _final_timer
 
FEProblemBase_fe_problem
 
PicardSolve _picard_solve
 
Real _initial_residual_norm
 Initial Residual Variables. More...
 
Real _old_initial_residual_norm
 
std::string _restart_file_base
 
std::vector< std::string > _splitting
 
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...
 
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...
 

Detailed Description

Transient executioners usually loop through a number of timesteps...

calling solve() for each timestep.

Definition at line 31 of file Transient.h.

Constructor & Destructor Documentation

◆ Transient()

Transient::Transient ( const InputParameters parameters)

Constructor.

Parameters
parametersThe parameters object holding data for the class to use.
Returns
Whether or not the solve was successful.

Definition at line 129 of file Transient.C.

133  _time_scheme(getParam<MooseEnum>("scheme").getEnum<Moose::TimeIntegratorType>()),
135  _time(_problem.time()),
137  _dt(_problem.dt()),
139  _unconstrained_dt(declareRecoverableData<Real>("unconstrained_dt", -1)),
140  _at_sync_point(declareRecoverableData<bool>("at_sync_point", false)),
141  _last_solve_converged(declareRecoverableData<bool>("last_solve_converged", true)),
142  _xfem_repeat_step(false),
143  _end_time(getParam<Real>("end_time")),
144  _dtmin(getParam<Real>("dtmin")),
145  _dtmax(getParam<Real>("dtmax")),
146  _num_steps(getParam<unsigned int>("num_steps")),
147  _n_startup_steps(getParam<int>("n_startup_steps")),
148  _steady_state_detection(getParam<bool>("steady_state_detection")),
149  _steady_state_tolerance(getParam<Real>("steady_state_tolerance")),
150  _steady_state_start_time(getParam<Real>("steady_state_start_time")),
151  _sln_diff_norm(declareRecoverableData<Real>("sln_diff_norm", 0.0)),
152  _old_time_solution_norm(declareRecoverableData<Real>("old_time_solution_norm", 0.0)),
154  _abort(getParam<bool>("abort_on_solve_fail")),
155  _time_interval(declareRecoverableData<bool>("time_interval", false)),
156  _start_time(getParam<Real>("start_time")),
157  _timestep_tolerance(getParam<Real>("timestep_tolerance")),
158  _target_time(declareRecoverableData<Real>("target_time", -1)),
159  _use_multiapp_dt(getParam<bool>("use_multiapp_dt")),
160  _verbose(getParam<bool>("verbose")),
161  _sln_diff(_nl.addVector("sln_diff", false, PARALLEL)),
163 {
164  // Handle deprecated parameters
165  if (!parameters.isParamSetByAddParam("trans_ss_check"))
166  _steady_state_detection = getParam<bool>("trans_ss_check");
167 
168  if (!parameters.isParamSetByAddParam("ss_check_tol"))
169  _steady_state_tolerance = getParam<Real>("ss_check_tol");
170 
171  if (!parameters.isParamSetByAddParam("ss_tmin"))
172  _steady_state_start_time = getParam<Real>("ss_tmin");
173 
175  _t_step = 0;
176  _dt = 0;
178 
179  // Either a start_time has been forced on us, or we want to tell the App about what our start time
180  // is (in case anyone else is interested.
181  if (_app.hasStartTime())
183  else if (parameters.isParamSetByUser("start_time"))
185 
187  _problem.transient(true);
188 
189  if (!_restart_file_base.empty())
191 
193 
194  if (_app.halfTransient()) // Cut timesteps and end_time in half...
195  {
196  _end_time /= 2.0;
197  _num_steps /= 2.0;
198 
199  if (_num_steps == 0) // Always do one step in the first half
200  _num_steps = 1;
201  }
202 }
PerfID registerTimedSection(const std::string &section_name, const unsigned int level)
Call to register a named section for timing.
Moose::TimeIntegratorType _time_scheme
Definition: Transient.h:207
Real _dtmax
Definition: Transient.h:231
virtual Real & dtOld() const
Real & _unconstrained_dt
Definition: Transient.h:220
virtual Real & time() const
Executioner(const InputParameters &parameters)
Constructor.
Definition: Executioner.C:145
PerfID _final_timer
Definition: Transient.h:268
NonlinearSystemBase & getNonlinearSystemBase()
virtual NumericVector< Number > & addVector(const std::string &vector_name, const bool project, const ParallelType type)
Adds a solution length vector to the system.
Definition: SystemBase.C:526
FEProblemBase & _problem
Here for backward compatibility.
Definition: Transient.h:202
int _n_startup_steps
Definition: Transient.h:233
void setDecomposition(const std::vector< std::string > &decomposition)
If called with a single string, it is used as the name of a the top-level decomposition split...
bool halfTransient()
Whether or not this simulation should only run half its transient (useful for testing recovery) ...
Definition: MooseApp.h:384
Real getStartTime() const
Definition: MooseApp.h:211
bool _xfem_repeat_step
Whether step should be repeated due to xfem modifying the mesh.
Definition: Transient.h:227
bool _steady_state_detection
Steady state detection variables:
Definition: Transient.h:238
std::string _restart_file_base
Definition: Executioner.h:139
Real _dtmin
Definition: Transient.h:230
Real & _time_old
Previous time.
Definition: Transient.h:215
bool & _time_interval
if to use time interval output
Definition: Transient.h:249
bool isParamSetByAddParam(const std::string &name) const
Returns whether or not the parameter was set due to addParam.
std::set< Real > & _sync_times
Definition: Transient.h:244
unsigned int _num_steps
Definition: Transient.h:232
NonlinearSystemBase & _nl
Reference to nonlinear system base for faster access.
Definition: Transient.h:205
void setStartTime(const Real time)
Set the starting time for the simulation.
Definition: MooseApp.C:1036
const InputParameters & parameters() const
Get the parameters of the object.
Definition: MooseObject.h:62
bool _use_multiapp_dt
Definition: Transient.h:256
bool _verbose
should detailed diagnostic output be printed
Definition: Transient.h:259
Real & _target_time
Definition: Transient.h:255
Real _steady_state_tolerance
Definition: Transient.h:239
void setupTimeIntegrator()
Definition: Transient.C:620
Real _start_time
Definition: Transient.h:253
Real & _sln_diff_norm
Definition: Transient.h:241
Real _timestep_tolerance
Definition: Transient.h:254
virtual int & timeStep() const
std::vector< std::string > _splitting
Definition: Executioner.h:142
bool _abort
Definition: Transient.h:246
Real & _dt
Current delta t... or timestep size.
Definition: Transient.h:217
Real & _dt_old
Definition: Transient.h:218
bool isParamSetByUser(const std::string &name) const
Method returns true if the parameter was by the user.
NumericVector< Number > & _sln_diff
The difference of current and old solutions.
Definition: Transient.h:264
bool & _at_sync_point
Definition: Transient.h:221
Real & _time
Current time.
Definition: Transient.h:213
Real _steady_state_start_time
Definition: Transient.h:240
void setRestartFile(const std::string &file_name)
Communicate to the Resurector the name of the restart filer.
bool hasStartTime() const
Definition: MooseApp.h:206
MooseApp & _app
The MooseApp this object is associated with.
Definition: MooseObject.h:174
Real & _old_time_solution_norm
Definition: Transient.h:242
virtual void transient(bool trans)
TimeIntegratorType
Time integrators.
Definition: MooseTypes.h:591
virtual Real & timeOld() const
Real _end_time
Definition: Transient.h:229
virtual Real & dt() const
Real _next_interval_output_time
Definition: Transient.h:250
int & _t_step
Current timestep.
Definition: Transient.h:211
std::set< Real > & getSyncTimes()
Return the sync times for all objects.
OutputWarehouse & getOutputWarehouse()
Get the OutputWarehouse objects.
Definition: MooseApp.C:1049
bool & _last_solve_converged
Whether or not the last solve converged.
Definition: Transient.h:224
FEProblemBase & _fe_problem
Definition: Executioner.h:130

Member Function Documentation

◆ addAttributeReporter()

void Executioner::addAttributeReporter ( const std::string &  name,
Real &  attribute,
const std::string  execute_on = "" 
)
protectedvirtualinherited

Adds a postprocessor to report a Real class attribute.

Parameters
nameThe name of the postprocessor to create
attributeThe Real class attribute to report
execute_onWhen to execute the postprocessor that is created

Definition at line 255 of file Executioner.C.

Referenced by InversePowerMethod::InversePowerMethod(), and NonlinearEigen::NonlinearEigen().

258 {
259  FEProblemBase * problem = getCheckedPointerParam<FEProblemBase *>(
260  "_fe_problem_base",
261  "Failed to retrieve FEProblemBase when adding a attribute reporter in Executioner");
262  InputParameters params = _app.getFactory().getValidParams("ExecutionerAttributeReporter");
263  params.set<Real *>("value") = &attribute;
264  if (!execute_on.empty())
265  params.set<ExecFlagEnum>("execute_on") = execute_on;
266  problem->addPostprocessor("ExecutionerAttributeReporter", name, params);
267 }
A MultiMooseEnum object to hold "execute_on" flags.
Definition: ExecFlagEnum.h:25
InputParameters getValidParams(const std::string &name)
Get valid parameters for the object.
Definition: Factory.C:67
T & set(const std::string &name, bool quiet_mode=false)
Returns a writable reference to the named parameters.
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
Specialization of SubProblem for solving nonlinear equations plus auxiliary equations.
Factory & getFactory()
Retrieve the Factory associated with this App.
Definition: MooseApp.h:280
virtual Problem & problem()
Deprecated: Return a reference to this Executioner&#39;s Problem instance.
Definition: Executioner.C:236
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

◆ atSyncPoint()

bool Transient::atSyncPoint ( )
inline

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

Returns
Bool indicataing whether we are at a sync point

Definition at line 185 of file Transient.h.

Referenced by IterationAdaptiveDT::acceptStep().

185 { return _at_sync_point; }
bool & _at_sync_point
Definition: Transient.h:221

◆ augmentedPicardConvergenceCheck()

virtual bool Executioner::augmentedPicardConvergenceCheck ( ) const
inlinevirtualinherited

Augmented Picard convergence check that can be overridden by derived executioners.

Definition at line 117 of file Executioner.h.

Referenced by PicardSolve::solve().

117 { return false; }

◆ computeConstrainedDT()

Real Transient::computeConstrainedDT ( )
virtual
Returns
The fully constrained dt for this timestep

Definition at line 459 of file Transient.C.

Referenced by takeStep().

460 {
461  // // If start up steps are needed
462  // if (_t_step == 1 && _n_startup_steps > 1)
463  // _dt = _input_dt/(double)(_n_startup_steps);
464  // else if (_t_step == 1+_n_startup_steps && _n_startup_steps > 1)
465  // _dt = _input_dt;
466 
467  Real dt_cur = _dt;
468  std::ostringstream diag;
469 
470  // After startup steps, compute new dt
472  dt_cur = getDT();
473 
474  else
475  {
476  diag << "Timestep < n_startup_steps, using old dt: " << std::setw(9) << std::setprecision(6)
477  << std::setfill('0') << std::showpoint << std::left << _dt << " tstep: " << _t_step
478  << " n_startup_steps: " << _n_startup_steps << std::endl;
479  }
480  _unconstrained_dt = dt_cur;
481 
482  if (_verbose)
483  _console << diag.str();
484 
485  diag.str("");
486  diag.clear();
487 
488  // Allow the time stepper to limit the time step
489  _at_sync_point = _time_stepper->constrainStep(dt_cur);
490 
491  // Don't let time go beyond next time interval output if specified
493  {
495  _at_sync_point = true;
496 
497  diag << "Limiting dt for time interval output at time: " << std::setw(9) << std::setprecision(6)
498  << std::setfill('0') << std::showpoint << std::left << _next_interval_output_time
499  << " dt: " << std::setw(9) << std::setprecision(6) << std::setfill('0') << std::showpoint
500  << std::left << dt_cur << std::endl;
501  }
502 
503  // Adjust to a target time if set
504  if (_target_time > 0 && _time + dt_cur + _timestep_tolerance >= _target_time)
505  {
506  dt_cur = _target_time - _time;
507  _at_sync_point = true;
508 
509  diag << "Limiting dt for target time: " << std::setw(9) << std::setprecision(6)
510  << std::setfill('0') << std::showpoint << std::left << _next_interval_output_time
511  << " dt: " << std::setw(9) << std::setprecision(6) << std::setfill('0') << std::showpoint
512  << std::left << dt_cur << std::endl;
513  }
514 
515  // Constrain by what the multi apps are doing
516  Real multi_app_dt = _problem.computeMultiAppsDT(EXEC_TIMESTEP_BEGIN);
517  if (_use_multiapp_dt || multi_app_dt < dt_cur)
518  {
519  dt_cur = multi_app_dt;
520  _at_sync_point = false;
521  diag << "Limiting dt for MultiApps: " << std::setw(9) << std::setprecision(6)
522  << std::setfill('0') << std::showpoint << std::left << dt_cur << std::endl;
523  }
525  if (multi_app_dt < dt_cur)
526  {
527  dt_cur = multi_app_dt;
528  _at_sync_point = false;
529  diag << "Limiting dt for MultiApps: " << std::setw(9) << std::setprecision(6)
530  << std::setfill('0') << std::showpoint << std::left << dt_cur << std::endl;
531  }
532 
533  if (_verbose)
534  _console << diag.str();
535 
536  return dt_cur;
537 }
virtual Real getDT()
Definition: Transient.C:540
Real & _unconstrained_dt
Definition: Transient.h:220
FEProblemBase & _problem
Here for backward compatibility.
Definition: Transient.h:202
int _n_startup_steps
Definition: Transient.h:233
const ExecFlagType EXEC_TIMESTEP_END
Real computeMultiAppsDT(ExecFlagType type)
Find the smallest timestep over all MultiApps.
bool & _time_interval
if to use time interval output
Definition: Transient.h:249
std::shared_ptr< TimeStepper > _time_stepper
Definition: Transient.h:208
const ExecFlagType EXEC_TIMESTEP_BEGIN
bool _use_multiapp_dt
Definition: Transient.h:256
bool _verbose
should detailed diagnostic output be printed
Definition: Transient.h:259
Real & _target_time
Definition: Transient.h:255
Real _timestep_tolerance
Definition: Transient.h:254
Real & _dt
Current delta t... or timestep size.
Definition: Transient.h:217
bool & _at_sync_point
Definition: Transient.h:221
Real & _time
Current time.
Definition: Transient.h:213
const ConsoleStream _console
An instance of helper class to write streams to the Console objects.
Real _next_interval_output_time
Definition: Transient.h:250
int & _t_step
Current timestep.
Definition: Transient.h:211

◆ computeDT()

void Transient::computeDT ( )
virtual

Definition at line 331 of file Transient.C.

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

332 {
333  _time_stepper->computeStep(); // This is actually when DT gets computed
334 }
std::shared_ptr< TimeStepper > _time_stepper
Definition: Transient.h:208

◆ 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

◆ dtMax()

Real& Transient::dtMax ( )
inline

Get the maximum dt.

Returns
The maximum dt

Definition at line 149 of file Transient.h.

149 { return _dtmax; }
Real _dtmax
Definition: Transient.h:231

◆ dtMin()

Real& Transient::dtMin ( )
inline

Get the minimal dt.

Returns
The minimal dt

Definition at line 155 of file Transient.h.

155 { return _dtmin; }
Real _dtmin
Definition: Transient.h:230

◆ 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

◆ endStep()

void Transient::endStep ( Real  input_time = -1.0)
virtual

Definition at line 429 of file Transient.C.

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

430 {
431  if (input_time == -1.0)
432  _time = _time_old + _dt;
433  else
434  _time = input_time;
435 
436  if (lastSolveConverged())
437  {
438  if (_xfem_repeat_step)
439  _time = _time_old;
440  else
441  {
443 
444  // Compute the Error Indicators and Markers
447 
448  // Perform the output of the current time step
450 
451  // output
454  }
455  }
456 }
virtual void postStep()
Callback to the TimeIntegrator called at the very end of time step.
FEProblemBase & _problem
Here for backward compatibility.
Definition: Transient.h:202
virtual void computeMarkers()
TimeIntegrator * getTimeIntegrator()
Definition: SystemBase.h:689
const ExecFlagType EXEC_TIMESTEP_END
bool _xfem_repeat_step
Whether step should be repeated due to xfem modifying the mesh.
Definition: Transient.h:227
Real & _time_old
Previous time.
Definition: Transient.h:215
bool & _time_interval
if to use time interval output
Definition: Transient.h:249
virtual bool lastSolveConverged() const override
Whether or not the last solve converged.
Definition: Transient.C:596
NonlinearSystemBase & _nl
Reference to nonlinear system base for faster access.
Definition: Transient.h:205
virtual void computeIndicators()
Real _timestep_tolerance
Definition: Transient.h:254
Real & _dt
Current delta t... or timestep size.
Definition: Transient.h:217
Real _time_interval_output_interval
Definition: Transient.h:251
Real & _time
Current time.
Definition: Transient.h:213
Real _next_interval_output_time
Definition: Transient.h:250
virtual void outputStep(ExecFlagType type)
Output the current step.

◆ endTime()

Real& Transient::endTime ( )
inline

Get the end time.

Returns
The end time

Definition at line 167 of file Transient.h.

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

167 { return _end_time; }
Real _end_time
Definition: Transient.h:229

◆ estimateTimeError()

void Transient::estimateTimeError ( )
virtual

Definition at line 591 of file Transient.C.

592 {
593 }

◆ execute()

void Transient::execute ( )
overridevirtual

Pure virtual execute function MUST be overridden by children classes.

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

Implements Executioner.

Definition at line 289 of file Transient.C.

290 {
291  preExecute();
292 
293  // Start time loop...
294  while (keepGoing())
295  {
297  preStep();
298  computeDT();
299  takeStep();
300  endStep();
301  postStep();
302  }
303 
304  if (lastSolveConverged())
305  {
306  _t_step++;
308  {
311  }
312  }
313 
314  if (!_app.halfTransient())
315  {
316  TIME_SECTION(_final_timer);
321  }
322 
323  // This method is to finalize anything else we want to do on the problem side.
325 
326  // This method can be overridden for user defined activities in the Executioner.
327  postExecute();
328 }
void finalizeMultiApps()
PerfID _final_timer
Definition: Transient.h:268
virtual void postExecute()
Method called at the end of the simulation.
virtual void computeDT()
Definition: Transient.C:331
FEProblemBase & _problem
Here for backward compatibility.
Definition: Transient.h:202
void finishMultiAppStep(ExecFlagType type)
Finish the MultiApp time step (endStep, postStep) associated with the ExecFlagType.
virtual void endStep(Real input_time=-1.0)
Definition: Transient.C:429
bool halfTransient()
Whether or not this simulation should only run half its transient (useful for testing recovery) ...
Definition: MooseApp.h:384
virtual void postExecute() override
Override this for actions that should take place after execution.
Definition: Transient.C:602
const ExecFlagType EXEC_TIMESTEP_END
virtual void execute(const ExecFlagType &exec_type)
Convenience function for performing execution of MOOSE systems.
virtual void takeStep(Real input_dt=-1.0)
Do whatever is necessary to advance one step.
Definition: Transient.C:387
virtual bool lastSolveConverged() const override
Whether or not the last solve converged.
Definition: Transient.C:596
const ExecFlagType EXEC_TIMESTEP_BEGIN
bool hasPicardIteration()
Whether or not this has Picard iterations.
Definition: PicardSolve.h:66
virtual void incrementStepOrReject()
This is where the solve step is actually incremented.
Definition: Transient.C:337
PicardSolve _picard_solve
Definition: Executioner.h:132
virtual void preExecute() override
Override this for actions that should take place before execution.
Definition: Transient.C:250
MooseApp & _app
The MooseApp this object is associated with.
Definition: MooseObject.h:174
virtual void preStep()
Definition: Transient.C:277
virtual bool keepGoing()
Transient loop will continue as long as this keeps returning true.
Definition: Transient.C:546
bool execMultiApps(ExecFlagType type, bool auto_advance=true)
Execute the MultiApps associated with the ExecFlagType.
virtual void postStep()
Definition: Transient.C:283
const ExecFlagType EXEC_FINAL
int & _t_step
Current timestep.
Definition: Transient.h:211
virtual void outputStep(ExecFlagType type)
Output the current step.

◆ feProblem()

FEProblemBase & Executioner::feProblem ( )
inherited

Return a reference to this Executioner's FEProblemBase instance.

Definition at line 243 of file Executioner.C.

Referenced by AlgebraicRelationshipManager::attachAlgebraicFunctorHelper(), and TransientMultiApp::restore().

244 {
245  return _fe_problem;
246 }
FEProblemBase & _fe_problem
Definition: Executioner.h:130

◆ 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

◆ getDefaultPostprocessorValue()

const PostprocessorValue & PostprocessorInterface::getDefaultPostprocessorValue ( const std::string &  name)
inherited

Return the default postprocessor value.

Parameters
nameThe name of the postprocessor parameter
Returns
A const reference to the default value

Definition at line 86 of file PostprocessorInterface.C.

Referenced by EigenKernel::EigenKernel().

87 {
89 }
const InputParameters & _ppi_params
PostprocessorInterface Parameters.
const PostprocessorValue & getDefaultPostprocessorValue(const std::string &name, bool suppress_error=false) const
Get the default value for a postprocessor added with addPostprocessor.

◆ getDT()

Real Transient::getDT ( )
virtual
Returns
The the computed dt to use for this timestep.

Definition at line 540 of file Transient.C.

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

541 {
542  return _time_stepper->getCurrentDT();
543 }
std::shared_ptr< TimeStepper > _time_stepper
Definition: Transient.h:208

◆ 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

◆ 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

◆ getPostprocessorValue()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValue ( const std::string &  name)
inherited

Retrieve the value of a Postprocessor or one of it's old or older values.

Parameters
nameThe name of the Postprocessor parameter (see below)
Returns
A reference to the desired value

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

see getPostprocessorValueByName getPostprocessorValueOldByName getPostprocessorValueOlderByName

Definition at line 23 of file PostprocessorInterface.C.

Referenced by GeneralUserObject::getPostprocessorValue(), and AuxKernel::getPostprocessorValue().

24 {
25  // Return the default if the Postprocessor does not exist and a default does, otherwise
26  // continue as usual
29  else
30  return _pi_feproblem.getPostprocessorValue(_ppi_params.get<PostprocessorName>(name));
31 }
bool hasPostprocessor(const std::string &name) const
Determine if the Postprocessor exists.
bool hasDefaultPostprocessorValue(const std::string &name) const
Returns true if a default PostprocessorValue is defined.
FEProblemBase & _pi_feproblem
Reference the the FEProblemBase class.
PostprocessorValue & getPostprocessorValue(const PostprocessorName &name)
Get a reference to the value associated with the postprocessor.
const InputParameters & _ppi_params
PostprocessorInterface Parameters.
const PostprocessorValue & getDefaultPostprocessorValue(const std::string &name, bool suppress_error=false) const
Get the default value for a postprocessor added with addPostprocessor.

◆ getPostprocessorValueByName()

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

Retrieve the value of the Postprocessor.

Parameters
namePostprocessor name (see below)
Returns
A reference to the desired value

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

see getPostprocessorValue getPostprocessorValueOld getPostprocessorValueOlder

Definition at line 56 of file PostprocessorInterface.C.

Referenced by EigenKernel::EigenKernel(), GeneralUserObject::getPostprocessorValueByName(), AuxKernel::getPostprocessorValueByName(), and EigenExecutionerBase::inversePowerIteration().

57 {
59 }
FEProblemBase & _pi_feproblem
Reference the the FEProblemBase class.
PostprocessorValue & getPostprocessorValue(const PostprocessorName &name)
Get a reference to the value associated with the postprocessor.

◆ getPostprocessorValueOld()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValueOld ( const std::string &  name)
inherited

Definition at line 34 of file PostprocessorInterface.C.

35 {
36  // Return the default if the Postprocessor does not exist and a default does, otherwise
37  // continue as usual
40  else
41  return _pi_feproblem.getPostprocessorValueOld(_ppi_params.get<PostprocessorName>(name));
42 }
bool hasPostprocessor(const std::string &name) const
Determine if the Postprocessor exists.
bool hasDefaultPostprocessorValue(const std::string &name) const
Returns true if a default PostprocessorValue is defined.
PostprocessorValue & getPostprocessorValueOld(const std::string &name)
Get the reference to the old value of a post-processor.
FEProblemBase & _pi_feproblem
Reference the the FEProblemBase class.
const InputParameters & _ppi_params
PostprocessorInterface Parameters.
const PostprocessorValue & getDefaultPostprocessorValue(const std::string &name, bool suppress_error=false) const
Get the default value for a postprocessor added with addPostprocessor.

◆ getPostprocessorValueOldByName()

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

Definition at line 62 of file PostprocessorInterface.C.

Referenced by EigenKernel::EigenKernel().

63 {
65 }
PostprocessorValue & getPostprocessorValueOld(const std::string &name)
Get the reference to the old value of a post-processor.
FEProblemBase & _pi_feproblem
Reference the the FEProblemBase class.

◆ getPostprocessorValueOlder()

const PostprocessorValue & PostprocessorInterface::getPostprocessorValueOlder ( const std::string &  name)
inherited

Definition at line 45 of file PostprocessorInterface.C.

46 {
47  // Return the default if the Postprocessor does not exist and a default does, otherwise
48  // continue as usual
51  else
52  return _pi_feproblem.getPostprocessorValueOlder(_ppi_params.get<PostprocessorName>(name));
53 }
bool hasPostprocessor(const std::string &name) const
Determine if the Postprocessor exists.
bool hasDefaultPostprocessorValue(const std::string &name) const
Returns true if a default PostprocessorValue is defined.
FEProblemBase & _pi_feproblem
Reference the the FEProblemBase class.
PostprocessorValue & getPostprocessorValueOlder(const std::string &name)
Get the reference to the older value of a post-processor.
const InputParameters & _ppi_params
PostprocessorInterface Parameters.
const PostprocessorValue & getDefaultPostprocessorValue(const std::string &name, bool suppress_error=false) const
Get the default value for a postprocessor added with addPostprocessor.

◆ getPostprocessorValueOlderByName()

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

Definition at line 68 of file PostprocessorInterface.C.

69 {
71 }
FEProblemBase & _pi_feproblem
Reference the the FEProblemBase class.
PostprocessorValue & getPostprocessorValueOlder(const std::string &name)
Get the reference to the older value of a post-processor.

◆ getSolutionChangeNorm()

Real Transient::getSolutionChangeNorm ( )

Get the Relative L2 norm of the change in the solution.

Definition at line 614 of file Transient.C.

Referenced by TransientMultiApp::solveStep().

615 {
616  return _solution_change_norm;
617 }
Real _solution_change_norm
Definition: Transient.h:261

◆ getStartTime()

Real Transient::getStartTime ( )
inline

Return the start time.

Returns
The start time

Definition at line 161 of file Transient.h.

Referenced by TimeSequenceStepperBase::setupSequence().

161 { return _start_time; }
Real _start_time
Definition: Transient.h:253

◆ getTime()

virtual Real Transient::getTime ( )
inlinevirtual

Get the current time.

Definition at line 98 of file Transient.h.

Referenced by TransientMultiApp::solveStep().

98 { return _time; };
Real & _time
Current time.
Definition: Transient.h:213

◆ getTimeScheme()

Moose::TimeIntegratorType Transient::getTimeScheme ( )
inline

Get the time scheme used.

Returns
MooseEnum with the time scheme

Definition at line 137 of file Transient.h.

137 { return _time_scheme; }
Moose::TimeIntegratorType _time_scheme
Definition: Transient.h:207

◆ getTimeStepper()

TimeStepper* Transient::getTimeStepper ( )
inline

Pointer to the TimeStepper.

Returns
Pointer to the time stepper for this Executioner

Definition at line 119 of file Transient.h.

119 { return _time_stepper.get(); }
std::shared_ptr< TimeStepper > _time_stepper
Definition: Transient.h:208

◆ getTimeStepperName()

std::string Transient::getTimeStepperName ( )
overridevirtual

Get the timestepper.

Reimplemented from Executioner.

Definition at line 669 of file Transient.C.

670 {
671  if (_time_stepper)
672  {
673  TimeStepper & ts = *_time_stepper;
674  return demangle(typeid(ts).name());
675  }
676  else
677  return std::string();
678 }
Base class for time stepping.
Definition: TimeStepper.h:27
std::shared_ptr< TimeStepper > _time_stepper
Definition: Transient.h:208
const std::string & name() const
Get the name of the object.
Definition: MooseObject.h:56

◆ getUserObject()

template<class T >
const T & UserObjectInterface::getUserObject ( const std::string &  name)
inherited

Get an user object with a given parameter name.

Parameters
nameThe name of the parameter key of the user object to retrieve
Returns
The user object with name associated with the parameter 'name'

Definition at line 81 of file UserObjectInterface.h.

82 {
83  unsigned int tid = needThreadedCopy(getUserObjectBase(name)) ? _uoi_tid : 0;
84  return _uoi_feproblem.getUserObject<T>(_uoi_params.get<UserObjectName>(name), tid);
85 }
T & getUserObject(const std::string &name, unsigned int tid=0) const
Get the user object by its name.
const InputParameters & _uoi_params
Parameters of the object with this interface.
FEProblemBase & _uoi_feproblem
Reference to the FEProblemBase instance.
THREAD_ID _uoi_tid
Thread ID.
const UserObject & getUserObjectBase(const std::string &name)
Get an user object with a given parameter name.
bool needThreadedCopy(const UserObject &uo) const
Check if the threaded copy of the user object is needed.

◆ getUserObjectBase()

const UserObject & UserObjectInterface::getUserObjectBase ( const std::string &  name)
inherited

Get an user object with a given parameter name.

Parameters
nameThe name of the parameter key of the user object to retrieve
Returns
The user object with name associated with the parameter 'name'

Definition at line 24 of file UserObjectInterface.C.

Referenced by UserObjectInterface::getUserObject(), InitialConditionBase::getUserObjectBase(), and AuxKernel::getUserObjectBase().

25 {
26  return _uoi_feproblem.getUserObjectBase(_uoi_params.get<UserObjectName>(name));
27 }
const UserObject & getUserObjectBase(const std::string &name) const
Get the user object by its name.
const InputParameters & _uoi_params
Parameters of the object with this interface.
FEProblemBase & _uoi_feproblem
Reference to the FEProblemBase instance.

◆ getUserObjectBaseByName()

const UserObject & UserObjectInterface::getUserObjectBaseByName ( const std::string &  name)
inherited

Get an user object with a given name.

Parameters
nameThe name of the user object to retrieve
Returns
The user object with the name

Definition at line 30 of file UserObjectInterface.C.

Referenced by UserObjectInterface::getUserObjectByName().

31 {
32  return _uoi_feproblem.getUserObjectBase(name);
33 }
const UserObject & getUserObjectBase(const std::string &name) const
Get the user object by its name.
FEProblemBase & _uoi_feproblem
Reference to the FEProblemBase instance.

◆ getUserObjectByName()

template<class T >
const T & UserObjectInterface::getUserObjectByName ( const std::string &  name)
inherited

Get an user object with a given name.

Parameters
nameThe name of the user object to retrieve
Returns
The user object with the name

Definition at line 89 of file UserObjectInterface.h.

90 {
91  unsigned int tid = needThreadedCopy(getUserObjectBaseByName(name)) ? _uoi_tid : 0;
92  return _uoi_feproblem.getUserObject<T>(name, tid);
93 }
T & getUserObject(const std::string &name, unsigned int tid=0) const
Get the user object by its name.
const UserObject & getUserObjectBaseByName(const std::string &name)
Get an user object with a given name.
FEProblemBase & _uoi_feproblem
Reference to the FEProblemBase instance.
THREAD_ID _uoi_tid
Thread ID.
bool needThreadedCopy(const UserObject &uo) const
Check if the threaded copy of the user object is needed.

◆ hasPostprocessor()

bool PostprocessorInterface::hasPostprocessor ( const std::string &  name) const
inherited

Determine if the Postprocessor exists.

Parameters
nameThe name of the Postprocessor parameter
Returns
True if the Postprocessor exists
See also
hasPostprocessorByName getPostprocessorValue

Definition at line 74 of file PostprocessorInterface.C.

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

75 {
76  return _pi_feproblem.hasPostprocessor(_ppi_params.get<PostprocessorName>(name));
77 }
FEProblemBase & _pi_feproblem
Reference the the FEProblemBase class.
bool hasPostprocessor(const std::string &name)
Check existence of the postprocessor.
const InputParameters & _ppi_params
PostprocessorInterface Parameters.

◆ hasPostprocessorByName()

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

Determine if the Postprocessor exists.

Parameters
nameThe name of the Postprocessor
Returns
True if the Postprocessor exists
See also
hasPostprocessor getPostprocessorValueByName

Definition at line 80 of file PostprocessorInterface.C.

Referenced by VectorOfPostprocessors::VectorOfPostprocessors().

81 {
82  return _pi_feproblem.hasPostprocessor(name);
83 }
FEProblemBase & _pi_feproblem
Reference the the FEProblemBase class.
bool hasPostprocessor(const std::string &name)
Check existence of the postprocessor.

◆ incrementStepOrReject()

void Transient::incrementStepOrReject ( )
virtual

This is where the solve step is actually incremented.

Definition at line 337 of file Transient.C.

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

338 {
339  if (lastSolveConverged())
340  {
341  if (!_xfem_repeat_step)
342  {
343 #ifdef LIBMESH_ENABLE_AMR
344  if (_t_step != 0)
346 #endif
347 
348  _time_old = _time;
349  _t_step++;
350 
352 
353  if (_t_step == 1)
354  return;
355 
356  /*
357  * Call the multi-app executioners endStep and
358  * postStep methods when doing Picard. We do not perform these calls for
359  * loose coupling because Transient::endStep and Transient::postStep get
360  * called from TransientMultiApp::solveStep in that case.
361  */
363  {
366  }
367 
368  /*
369  * Ensure that we increment the sub-application time steps so that
370  * when dt selection is made in the master application, we are using
371  * the correct time step information
372  */
375  }
376  }
377  else
378  {
381  _time_stepper->rejectStep();
382  _time = _time_old;
383  }
384 }
FEProblemBase & _problem
Here for backward compatibility.
Definition: Transient.h:202
void finishMultiAppStep(ExecFlagType type)
Finish the MultiApp time step (endStep, postStep) associated with the ExecFlagType.
const ExecFlagType EXEC_TIMESTEP_END
bool _xfem_repeat_step
Whether step should be repeated due to xfem modifying the mesh.
Definition: Transient.h:227
Real & _time_old
Previous time.
Definition: Transient.h:215
virtual void advanceState()
Advance all of the state holding vectors / datastructures so that we can move to the next timestep...
std::shared_ptr< TimeStepper > _time_stepper
Definition: Transient.h:208
virtual bool lastSolveConverged() const override
Whether or not the last solve converged.
Definition: Transient.C:596
const ExecFlagType EXEC_TIMESTEP_BEGIN
bool hasPicardIteration()
Whether or not this has Picard iterations.
Definition: PicardSolve.h:66
PicardSolve _picard_solve
Definition: Executioner.h:132
Real & _time
Current time.
Definition: Transient.h:213
void restoreMultiApps(ExecFlagType type, bool force=false)
Restore the MultiApps associated with the ExecFlagType.
void incrementMultiAppTStep(ExecFlagType type)
Advance the MultiApps t_step (incrementStepOrReject) associated with the ExecFlagType.
int & _t_step
Current timestep.
Definition: Transient.h:211
virtual bool adaptMesh()

◆ init()

void Transient::init ( )
overridevirtual

Initialize the executioner.

We have a default "dt" set in the Transient parameters but it's possible for users to set other parameters explicitly that could provide a better calculated "dt". Rather than provide difficult to understand behavior using the default "dt" in this case, we'll calculate "dt" properly.

Reimplemented from Executioner.

Definition at line 205 of file Transient.C.

Referenced by TransientMultiApp::setupApp().

206 {
207  if (!_time_stepper.get())
208  {
209  InputParameters pars = _app.getFactory().getValidParams("ConstantDT");
210  pars.set<SubProblem *>("_subproblem") = &_problem;
211  pars.set<Transient *>("_executioner") = this;
212 
220  if (!_pars.isParamSetByAddParam("end_time") && !_pars.isParamSetByAddParam("num_steps") &&
222  pars.set<Real>("dt") = (getParam<Real>("end_time") - getParam<Real>("start_time")) /
223  static_cast<Real>(getParam<unsigned int>("num_steps"));
224  else
225  pars.set<Real>("dt") = getParam<Real>("dt");
226 
227  pars.set<bool>("reset_dt") = getParam<bool>("reset_dt");
228  _time_stepper = _app.getFactory().create<TimeStepper>("ConstantDT", "TimeStepper", pars);
229  }
230 
233 
234  _time_stepper->init();
235 
236  if (_app.isRestarting())
237  _time_old = _time;
238 
239  if (_app.isRecovering()) // Recover case
240  {
241  if (_t_step == 0)
242  mooseError("Internal error in Transient executioner: _t_step is equal to 0 while recovering "
243  "in init().");
244 
245  _dt_old = _dt;
246  }
247 }
std::shared_ptr< MooseObject > create(const std::string &obj_name, const std::string &name, InputParameters parameters, THREAD_ID tid=0, bool print_deprecated=true)
Build an object (must be registered) - THIS METHOD IS DEPRECATED (Use create<T>()) ...
Definition: Factory.C:87
Transient executioners usually loop through a number of timesteps...
Definition: Transient.h:31
InputParameters getValidParams(const std::string &name)
Get valid parameters for the object.
Definition: Factory.C:67
FEProblemBase & _problem
Here for backward compatibility.
Definition: Transient.h:202
T & set(const std::string &name, bool quiet_mode=false)
Returns a writable reference to the named parameters.
Base class for time stepping.
Definition: TimeStepper.h:27
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
void mooseError(Args &&... args) const
Definition: MooseObject.h:144
bool isRestarting() const
Whether or not this is a "restart" calculation.
Definition: MooseApp.C:859
Factory & getFactory()
Retrieve the Factory associated with this App.
Definition: MooseApp.h:280
Real & _time_old
Previous time.
Definition: Transient.h:215
std::shared_ptr< TimeStepper > _time_stepper
Definition: Transient.h:208
virtual void execute(const ExecFlagType &exec_type)
Convenience function for performing execution of MOOSE systems.
bool isParamSetByAddParam(const std::string &name) const
Returns whether or not the parameter was set due to addParam.
const ExecFlagType EXEC_PRE_MULTIAPP_SETUP
const InputParameters & _pars
Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.
Definition: MooseObject.h:171
Real & _dt
Current delta t... or timestep size.
Definition: Transient.h:217
Real & _dt_old
Definition: Transient.h:218
Real & _time
Current time.
Definition: Transient.h:213
Generic class for solving transient nonlinear problems.
Definition: SubProblem.h:60
MooseApp & _app
The MooseApp this object is associated with.
Definition: MooseObject.h:174
virtual void initialSetup()
bool isRecovering() const
Whether or not this is a "recover" calculation.
Definition: MooseApp.C:853
int & _t_step
Current timestep.
Definition: Transient.h:211

◆ 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::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(), EigenExecutionerBase::init(), IterationAdaptiveDT::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.

◆ keepGoing()

bool Transient::keepGoing ( )
virtual

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

Definition at line 546 of file Transient.C.

Referenced by execute().

547 {
548  bool keep_going = !_problem.isSolveTerminationRequested();
549 
550  // Check for stop condition based upon steady-state check flag:
551  if (lastSolveConverged())
552  {
553  if (!_xfem_repeat_step)
554  {
556  {
557  // Check solution difference relative norm against steady-state tolerance
559  {
560  _console << "Steady-State Solution Achieved at time: " << _time << std::endl;
561  // Output last solve if not output previously by forcing it
562  keep_going = false;
563  }
564  else // Keep going
565  {
566  // Update solution norm for next time step
568  // Print steady-state relative error norm
569  _console << "Steady-State Relative Differential Norm: " << _sln_diff_norm << std::endl;
570  }
571  }
572 
573  // Check for stop condition based upon number of simulation steps and/or solution end time:
574  if (static_cast<unsigned int>(_t_step) >= _num_steps)
575  keep_going = false;
576 
577  if ((_time >= _end_time) || (fabs(_time - _end_time) <= _timestep_tolerance))
578  keep_going = false;
579  }
580  }
581  else if (_abort)
582  {
583  _console << "Aborting as solve did not converge and input selected to abort" << std::endl;
584  keep_going = false;
585  }
586 
587  return keep_going;
588 }
virtual const NumericVector< Number > *& currentSolution() override
The solution vector that is currently being operated on.
virtual bool isSolveTerminationRequested()
Check of termination has been requested.
Definition: Problem.h:47
FEProblemBase & _problem
Here for backward compatibility.
Definition: Transient.h:202
bool _xfem_repeat_step
Whether step should be repeated due to xfem modifying the mesh.
Definition: Transient.h:227
bool _steady_state_detection
Steady state detection variables:
Definition: Transient.h:238
unsigned int _num_steps
Definition: Transient.h:232
virtual bool lastSolveConverged() const override
Whether or not the last solve converged.
Definition: Transient.C:596
NonlinearSystemBase & _nl
Reference to nonlinear system base for faster access.
Definition: Transient.h:205
Real _steady_state_tolerance
Definition: Transient.h:239
Real & _sln_diff_norm
Definition: Transient.h:241
Real _timestep_tolerance
Definition: Transient.h:254
bool _abort
Definition: Transient.h:246
Real & _time
Current time.
Definition: Transient.h:213
Real _steady_state_start_time
Definition: Transient.h:240
Real & _old_time_solution_norm
Definition: Transient.h:242
const ConsoleStream _console
An instance of helper class to write streams to the Console objects.
Real _end_time
Definition: Transient.h:229
int & _t_step
Current timestep.
Definition: Transient.h:211

◆ lastSolveConverged()

bool Transient::lastSolveConverged ( ) const
overridevirtual

Whether or not the last solve converged.

Implements Executioner.

Definition at line 596 of file Transient.C.

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

597 {
598  return _last_solve_converged;
599 }
bool & _last_solve_converged
Whether or not the last solve converged.
Definition: Transient.h:224

◆ 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::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(), init(), MooseMesh::init(), FEProblemBase::init(), NumPicardIterations::initialize(), FullSolveMultiApp::initialSetup(), PiecewiseBase::initialSetup(), SolutionAux::initialSetup(), Axisymmetric2D3DSolutionFunction::initialSetup(), SolutionFunction::initialSetup(), Exodus::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(), AddAllSideSetsByNormals::modify(), ElementDeleterBase::modify(), ParsedSubdomainMeshModifier::modify(), RenameBlock::modify(), ImageSubdomain::modify(), OrientedSubdomainBoundingBox::modify(), BoundingBoxNodeSet::modify(), AddSideSetsFromBoundingBox::modify(), SubdomainBoundingBox::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(), Exodus::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(), AStableDirk4::postResidual(), LStableDirk4::postResidual(), ExplicitRK2::postResidual(), Predictor::Predictor(), 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(), Exodus::setOutputDimensionInExodusWriter(), Split::setup(), TransientMultiApp::setupApp(), TimeSequenceStepperBase::setupSequence(), 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::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(), 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(), Exodus::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

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

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.

◆ parentOutputPositionChanged()

void Transient::parentOutputPositionChanged ( )
inlineoverridevirtual

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

Reimplemented from Executioner.

Definition at line 193 of file Transient.h.

void parentOutputPositionChanged()
Calls parentOutputPositionChanged() on all sub apps.
FEProblemBase & _fe_problem
Definition: Executioner.h:130

◆ picardSolve()

PicardSolve& Executioner::picardSolve ( )
inlineinherited

Return underlining PicardSolve object.

Definition at line 114 of file Executioner.h.

Referenced by NumPicardIterations::getValue(), and TimeStepper::step().

114 { return _picard_solve; }
PicardSolve _picard_solve
Definition: Executioner.h:132

◆ postExecute()

void Transient::postExecute ( )
overridevirtual

Override this for actions that should take place after execution.

Reimplemented from Executioner.

Definition at line 602 of file Transient.C.

Referenced by execute().

603 {
604  _time_stepper->postExecute();
605 }
std::shared_ptr< TimeStepper > _time_stepper
Definition: Transient.h:208

◆ postSolve()

void Executioner::postSolve ( )
virtualinherited

Override this for actions that should take place after execution.

Definition at line 231 of file Executioner.C.

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

232 {
233 }

◆ postStep()

void Transient::postStep ( )
virtual

Definition at line 283 of file Transient.C.

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

284 {
285  _time_stepper->postStep();
286 }
std::shared_ptr< TimeStepper > _time_stepper
Definition: Transient.h:208

◆ preExecute()

void Transient::preExecute ( )
overridevirtual

Override this for actions that should take place before execution.

Reimplemented from Executioner.

Definition at line 250 of file Transient.C.

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

251 {
252  _time_stepper->preExecute();
253 
254  if (!_app.isRecovering())
255  {
256  _t_step = 0;
257  _dt = 0;
259  if (!_app.isRestarting())
261 
263 
264  computeDT();
265  _dt = getDT();
266  if (_dt == 0)
267  mooseError("Time stepper computed zero time step size on initial which is not allowed.\n"
268  "1. If you are using an existing time stepper, double check the values in your "
269  "input file or report an error.\n"
270  "2. If you are developing a new time stepper, make sure that initial time step "
271  "size in your code is computed correctly.");
273  }
274 }
virtual Real getDT()
Definition: Transient.C:540
virtual void computeDT()
Definition: Transient.C:331
FEProblemBase & _problem
Here for backward compatibility.
Definition: Transient.h:202
TimeIntegrator * getTimeIntegrator()
Definition: SystemBase.h:689
void mooseError(Args &&... args) const
Definition: MooseObject.h:144
bool isRestarting() const
Whether or not this is a "restart" calculation.
Definition: MooseApp.C:859
virtual void init()
Called only before the very first timestep (t_step = 0) Never called again (not even during recover/r...
Real & _time_old
Previous time.
Definition: Transient.h:215
std::shared_ptr< TimeStepper > _time_stepper
Definition: Transient.h:208
NonlinearSystemBase & _nl
Reference to nonlinear system base for faster access.
Definition: Transient.h:205
Real _start_time
Definition: Transient.h:253
Real & _dt
Current delta t... or timestep size.
Definition: Transient.h:217
Real & _time
Current time.
Definition: Transient.h:213
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
Real _next_interval_output_time
Definition: Transient.h:250
int & _t_step
Current timestep.
Definition: Transient.h:211
virtual void outputStep(ExecFlagType type)
Output the current step.
const ExecFlagType EXEC_INITIAL

◆ preSolve()

void Executioner::preSolve ( )
virtualinherited

Override this for actions that should take place before execution.

Definition at line 226 of file Executioner.C.

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

227 {
228 }

◆ preStep()

void Transient::preStep ( )
virtual

Definition at line 277 of file Transient.C.

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

278 {
279  _time_stepper->preStep();
280 }
std::shared_ptr< TimeStepper > _time_stepper
Definition: Transient.h:208

◆ problem()

Problem & Executioner::problem ( )
virtualinherited

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

Definition at line 236 of file Executioner.C.

Referenced by Executioner::addAttributeReporter().

237 {
238  mooseDoOnce(mooseWarning("This method is deprecated, use feProblem() instead"));
239  return _fe_problem;
240 }
void mooseWarning(Args &&... args) const
Definition: MooseObject.h:152
FEProblemBase & _fe_problem
Definition: Executioner.h:130

◆ 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

◆ relativeSolutionDifferenceNorm()

Real Transient::relativeSolutionDifferenceNorm ( )
virtual

The relative L2 norm of the difference between solution and old solution vector.

Definition at line 681 of file Transient.C.

Referenced by RelativeSolutionDifferenceNorm::getValue(), and takeStep().

682 {
683  const NumericVector<Number> & current_solution = *_nl.currentSolution();
684  const NumericVector<Number> & old_solution = _nl.solutionOld();
685 
686  _sln_diff = current_solution;
687  _sln_diff -= old_solution;
688 
689  return (_sln_diff.l2_norm() / current_solution.l2_norm());
690 }
virtual const NumericVector< Number > *& currentSolution() override
The solution vector that is currently being operated on.
virtual NumericVector< Number > & solutionOld()=0
NonlinearSystemBase & _nl
Reference to nonlinear system base for faster access.
Definition: Transient.h:205
NumericVector< Number > & _sln_diff
The difference of current and old solutions.
Definition: Transient.h:264

◆ setTargetTime()

void Transient::setTargetTime ( Real  target_time)
virtual

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

Useful for driving MultiApps.

Definition at line 608 of file Transient.C.

Referenced by TransientMultiApp::solveStep().

609 {
610  _target_time = target_time;
611 }
Real & _target_time
Definition: Transient.h:255

◆ setTime()

virtual void Transient::setTime ( Real  t)
inlinevirtual

Set the current time.

Definition at line 103 of file Transient.h.

103 { _time = t; };
Real & _time
Current time.
Definition: Transient.h:213

◆ setTimeOld()

virtual void Transient::setTimeOld ( Real  t)
inlinevirtual

Set the old time.

Definition at line 108 of file Transient.h.

108 { _time_old = t; };
Real & _time_old
Previous time.
Definition: Transient.h:215

◆ setTimeStepper()

void Transient::setTimeStepper ( std::shared_ptr< TimeStepper ts)
inline

Set the timestepper to use.

Parameters
tsThe TimeStepper to use

Definition at line 126 of file Transient.h.

126 { _time_stepper = ts; }
std::shared_ptr< TimeStepper > _time_stepper
Definition: Transient.h:208

◆ setupTimeIntegrator()

void Transient::setupTimeIntegrator ( )
protected

Definition at line 620 of file Transient.C.

Referenced by Transient().

621 {
623  mooseError("You cannot specify time_scheme in the Executioner and independently add a "
624  "TimeIntegrator to the system at the same time");
625 
627  {
628  // backwards compatibility
629  std::string ti_str;
630  using namespace Moose;
631 
632  switch (_time_scheme)
633  {
634  case TI_IMPLICIT_EULER:
635  ti_str = "ImplicitEuler";
636  break;
637  case TI_EXPLICIT_EULER:
638  ti_str = "ExplicitEuler";
639  break;
640  case TI_CRANK_NICOLSON:
641  ti_str = "CrankNicolson";
642  break;
643  case TI_BDF2:
644  ti_str = "BDF2";
645  break;
647  ti_str = "ExplicitMidpoint";
648  break;
649  case TI_LSTABLE_DIRK2:
650  ti_str = "LStableDirk2";
651  break;
653  ti_str = "ExplicitTVDRK2";
654  break;
655  case TI_NEWMARK_BETA:
656  ti_str = "NewmarkBeta";
657  break;
658  default:
659  mooseError("Unknown scheme: ", _time_scheme);
660  break;
661  }
662 
663  InputParameters params = _app.getFactory().getValidParams(ti_str);
664  _problem.addTimeIntegrator(ti_str, ti_str, params);
665  }
666 }
Moose::TimeIntegratorType _time_scheme
Definition: Transient.h:207
InputParameters getValidParams(const std::string &name)
Get valid parameters for the object.
Definition: Factory.C:67
FEProblemBase & _problem
Here for backward compatibility.
Definition: Transient.h:202
The main MOOSE class responsible for handling user-defined parameters in almost every MOOSE system...
void mooseError(Args &&... args) const
Definition: MooseObject.h:144
Factory & getFactory()
Retrieve the Factory associated with this App.
Definition: MooseApp.h:280
bool hasTimeIntegrator() const
Returns whether or not this Problem has a TimeIntegrator.
virtual void addTimeIntegrator(const std::string &type, const std::string &name, InputParameters parameters)
const InputParameters & _pars
Parameters of this object, references the InputParameters stored in the InputParametersWarehouse.
Definition: MooseObject.h:171
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
Definition: Moose.h:101

◆ syncTimes()

std::set<Real>& Transient::syncTimes ( )
inline

Get the set of sync times.

Returns
The reference to the set of sync times

Definition at line 143 of file Transient.h.

143 { return _sync_times; }
std::set< Real > & _sync_times
Definition: Transient.h:244

◆ takeStep()

void Transient::takeStep ( Real  input_dt = -1.0)
virtual

Do whatever is necessary to advance one step.

Definition at line 387 of file Transient.C.

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

388 {
389  _dt_old = _dt;
390 
391  if (input_dt == -1.0)
393  else
394  _dt = input_dt;
395 
396  _time_stepper->preSolve();
397 
398  // Increment time
399  _time = _time_old + _dt;
400 
402 
404 
405  _time_stepper->step();
407 
408  _last_solve_converged = _time_stepper->converged();
409 
411  {
412  if (lastSolveConverged())
413  _time_stepper->acceptStep();
414  else
415  _time_stepper->rejectStep();
416  }
417 
418  _time = _time_old;
419 
420  _time_stepper->postSolve();
421 
424 
425  return;
426 }
FEProblemBase & _problem
Here for backward compatibility.
Definition: Transient.h:202
bool haveXFEM()
Find out whether the current analysis is using XFEM.
bool _xfem_repeat_step
Whether step should be repeated due to xfem modifying the mesh.
Definition: Transient.h:227
virtual void timestepSetup()
Real & _time_old
Previous time.
Definition: Transient.h:215
std::shared_ptr< TimeStepper > _time_stepper
Definition: Transient.h:208
virtual Real computeConstrainedDT()
Definition: Transient.C:459
virtual bool lastSolveConverged() const override
Whether or not the last solve converged.
Definition: Transient.C:596
bool XFEMRepeatStep() const
This function checks the _xfem_repeat_step flag set by solve.
Definition: PicardSolve.h:60
PicardSolve _picard_solve
Definition: Executioner.h:132
Real & _sln_diff_norm
Definition: Transient.h:241
Real & _dt
Current delta t... or timestep size.
Definition: Transient.h:217
Real & _dt_old
Definition: Transient.h:218
Real & _time
Current time.
Definition: Transient.h:213
Real _solution_change_norm
Definition: Transient.h:261
virtual void onTimestepBegin() override
virtual Real relativeSolutionDifferenceNorm()
The relative L2 norm of the difference between solution and old solution vector.
Definition: Transient.C:681
bool & _last_solve_converged
Whether or not the last solve converged.
Definition: Transient.h:224

◆ timestepTol()

Real& Transient::timestepTol ( )
inline

Get the timestep tolerance.

Returns
The timestep tolerance

Definition at line 173 of file Transient.h.

Referenced by TransientMultiApp::solveStep().

173 { return _timestep_tolerance; }
Real _timestep_tolerance
Definition: Transient.h:254

◆ 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(), Exodus::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

◆ unconstrainedDT()

Real Transient::unconstrainedDT ( )
inline

Get the unconstrained dt.

Returns
Value of dt before constraints were applied

Definition at line 191 of file Transient.h.

Referenced by IterationAdaptiveDT::acceptStep().

191 { return _unconstrained_dt; }
Real & _unconstrained_dt
Definition: Transient.h:220

◆ verbose()

bool& Transient::verbose ( )
inline

Get the verbose output flag.

Returns
The verbose output flag

Definition at line 179 of file Transient.h.

179 { return _verbose; }
bool _verbose
should detailed diagnostic output be printed
Definition: Transient.h:259

Member Data Documentation

◆ _abort

bool Transient::_abort
protected

Definition at line 246 of file Transient.h.

Referenced by keepGoing().

◆ _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(), execute(), Steady::execute(), FileOutput::FileOutput(), FEProblemBase::forceOutput(), MeshGenerator::getMesh(), MeshGenerator::getMeshByName(), MooseObject::getMooseApp(), InversePowerMethod::init(), NonlinearEigen::init(), 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(), Exodus::output(), Nemesis::output(), ControlOutput::outputActiveObjects(), ControlOutput::outputChangedControls(), ControlOutput::outputControls(), Exodus::outputEmptyTimestep(), Console::outputInput(), Exodus::outputInput(), Exodus::outputNodalVariables(), OversampleOutput::outputStep(), Output::outputStep(), FEProblemBase::outputStep(), Console::outputSystemInformation(), MultiApp::parentOutputPositionChanged(), PerformanceData::PerformanceData(), PetscOutput::petscLinearOutput(), PetscOutput::petscNonlinearOutput(), preExecute(), FEProblemBase::projectSolution(), FEProblemBase::setRestartFile(), TransientMultiApp::setupApp(), TimeSequenceStepperBase::setupSequence(), setupTimeIntegrator(), TransientMultiApp::solveStep(), FEProblemBase::subdomainSetup(), FEProblemBase::theWarehouse(), TimeExtremeValue::TimeExtremeValue(), TimePeriod::TimePeriod(), FEProblemBase::timestepSetup(), Transient(), and Console::write().

◆ _at_sync_point

bool& Transient::_at_sync_point
protected

Definition at line 221 of file Transient.h.

Referenced by atSyncPoint(), and computeConstrainedDT().

◆ _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(), 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(), MultiAppProjectionTransfer::execute(), MultiAppVectorPostprocessorTransfer::execute(), MultiAppNearestNodeTransfer::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(), 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(), AStableDirk4::solve(), LStableDirk4::solve(), ExplicitRK2::solve(), TransientMultiApp::solveStep(), PicardSolve::solveStep(), DT2::step(), AB2PredictorCorrector::step(), NonlinearEigen::takeStep(), Console::writeTimestepInformation(), Console::writeVariableNorms(), and FEProblemBase::~FEProblemBase().

◆ _dt

Real& Transient::_dt
protected

Current delta t... or timestep size.

Definition at line 217 of file Transient.h.

Referenced by computeConstrainedDT(), endStep(), init(), preExecute(), takeStep(), and Transient().

◆ _dt_old

Real& Transient::_dt_old
protected

Definition at line 218 of file Transient.h.

Referenced by init(), and takeStep().

◆ _dtmax

Real Transient::_dtmax
protected

Definition at line 231 of file Transient.h.

Referenced by dtMax().

◆ _dtmin

Real Transient::_dtmin
protected

Definition at line 230 of file Transient.h.

Referenced by dtMin().

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

Real Transient::_end_time
protected

Definition at line 229 of file Transient.h.

Referenced by endTime(), keepGoing(), and Transient().

◆ _fe_problem

FEProblemBase& Executioner::_fe_problem
protectedinherited

◆ _final_timer

PerfID Transient::_final_timer
protected

Definition at line 268 of file Transient.h.

Referenced by execute().

◆ _initial_residual_norm

Real Executioner::_initial_residual_norm
protectedinherited

Initial Residual Variables.

Definition at line 135 of file Executioner.h.

◆ _last_solve_converged

bool& Transient::_last_solve_converged
protected

Whether or not the last solve converged.

Definition at line 224 of file Transient.h.

Referenced by lastSolveConverged(), and takeStep().

◆ _n_startup_steps

int Transient::_n_startup_steps
protected

Definition at line 233 of file Transient.h.

Referenced by computeConstrainedDT().

◆ _name

const std::string& MooseObject::_name
protectedinherited

◆ _next_interval_output_time

Real Transient::_next_interval_output_time
protected

Definition at line 250 of file Transient.h.

Referenced by computeConstrainedDT(), endStep(), preExecute(), and Transient().

◆ _nl

NonlinearSystemBase& Transient::_nl
protected

Reference to nonlinear system base for faster access.

Definition at line 205 of file Transient.h.

Referenced by endStep(), keepGoing(), preExecute(), relativeSolutionDifferenceNorm(), and Transient().

◆ _num_steps

unsigned int Transient::_num_steps
protected

Definition at line 232 of file Transient.h.

Referenced by keepGoing(), and Transient().

◆ _old_initial_residual_norm

Real Executioner::_old_initial_residual_norm
protectedinherited

Definition at line 136 of file Executioner.h.

◆ _old_time_solution_norm

Real& Transient::_old_time_solution_norm
protected

Definition at line 242 of file Transient.h.

Referenced by keepGoing().

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

◆ _picard_solve

PicardSolve Executioner::_picard_solve
protectedinherited

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

FEProblemBase& Transient::_problem
protected

Here for backward compatibility.

Definition at line 202 of file Transient.h.

Referenced by computeConstrainedDT(), endStep(), execute(), incrementStepOrReject(), init(), keepGoing(), preExecute(), setupTimeIntegrator(), takeStep(), and Transient().

◆ _restart_file_base

std::string Executioner::_restart_file_base
protectedinherited

Definition at line 139 of file Executioner.h.

Referenced by Steady::Steady(), and Transient().

◆ _sln_diff

NumericVector<Number>& Transient::_sln_diff
protected

The difference of current and old solutions.

Definition at line 264 of file Transient.h.

Referenced by relativeSolutionDifferenceNorm().

◆ _sln_diff_norm

Real& Transient::_sln_diff_norm
protected

Definition at line 241 of file Transient.h.

Referenced by keepGoing(), and takeStep().

◆ _solution_change_norm

Real Transient::_solution_change_norm
protected

Definition at line 261 of file Transient.h.

Referenced by getSolutionChangeNorm(), and takeStep().

◆ _splitting

std::vector<std::string> Executioner::_splitting
protectedinherited

Definition at line 142 of file Executioner.h.

Referenced by Steady::Steady(), and Transient().

◆ _start_time

Real Transient::_start_time
protected

Definition at line 253 of file Transient.h.

Referenced by getStartTime(), preExecute(), and Transient().

◆ _steady_state_detection

bool Transient::_steady_state_detection
protected

Steady state detection variables:

Definition at line 238 of file Transient.h.

Referenced by keepGoing(), and Transient().

◆ _steady_state_start_time

Real Transient::_steady_state_start_time
protected

Definition at line 240 of file Transient.h.

Referenced by keepGoing(), and Transient().

◆ _steady_state_tolerance

Real Transient::_steady_state_tolerance
protected

Definition at line 239 of file Transient.h.

Referenced by keepGoing(), and Transient().

◆ _sync_times

std::set<Real>& Transient::_sync_times
protected

Definition at line 244 of file Transient.h.

Referenced by syncTimes().

◆ _t_step

int& Transient::_t_step
protected

Current timestep.

Definition at line 211 of file Transient.h.

Referenced by computeConstrainedDT(), execute(), incrementStepOrReject(), init(), keepGoing(), preExecute(), and Transient().

◆ _target_time

Real& Transient::_target_time
protected

Definition at line 255 of file Transient.h.

Referenced by computeConstrainedDT(), and setTargetTime().

◆ _time

Real& Transient::_time
protected

◆ _time_interval

bool& Transient::_time_interval
protected

if to use time interval output

Definition at line 249 of file Transient.h.

Referenced by computeConstrainedDT(), and endStep().

◆ _time_interval_output_interval

Real Transient::_time_interval_output_interval
protected

Definition at line 251 of file Transient.h.

Referenced by endStep().

◆ _time_old

Real& Transient::_time_old
protected

Previous time.

Definition at line 215 of file Transient.h.

Referenced by endStep(), incrementStepOrReject(), init(), preExecute(), setTimeOld(), takeStep(), and Transient().

◆ _time_scheme

Moose::TimeIntegratorType Transient::_time_scheme
protected

Definition at line 207 of file Transient.h.

Referenced by getTimeScheme(), and setupTimeIntegrator().

◆ _time_stepper

std::shared_ptr<TimeStepper> Transient::_time_stepper
protected

◆ _timestep_tolerance

Real Transient::_timestep_tolerance
protected

Definition at line 254 of file Transient.h.

Referenced by computeConstrainedDT(), endStep(), keepGoing(), and timestepTol().

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

◆ _unconstrained_dt

Real& Transient::_unconstrained_dt
protected

Definition at line 220 of file Transient.h.

Referenced by computeConstrainedDT(), and unconstrainedDT().

◆ _use_multiapp_dt

bool Transient::_use_multiapp_dt
protected

Definition at line 256 of file Transient.h.

Referenced by computeConstrainedDT().

◆ _verbose

bool Transient::_verbose
protected

should detailed diagnostic output be printed

Definition at line 259 of file Transient.h.

Referenced by computeConstrainedDT(), and verbose().

◆ _xfem_repeat_step

bool Transient::_xfem_repeat_step
protected

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

Definition at line 227 of file Transient.h.

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


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