Implicit Euler's method. More...

#include <ImplicitEuler.h>

Inheritance diagram for ImplicitEuler:

Public Member Functions
	ImplicitEuler (const InputParameters &parameters)

virtual	~ImplicitEuler ()

virtual int	order () override

virtual void	computeTimeDerivatives () override
	Computes the time derivative and the Jacobian of the time derivative. More...

void	computeADTimeDerivatives (DualReal &ad_u_dot, const dof_id_type &dof) const override
	method for computing local automatic differentiation time derivatives More...

virtual void	postResidual (NumericVector< Number > &residual) override
	Callback to the TimeIntegrator called immediately after the residuals are computed in NonlinearSystem::computeResidual(). More...

virtual void	initialSetup ()
	Called to setup datastructures. More...

virtual void	init ()
	Called only before the very first timestep (t_step = 0) Never called again (not even during recover/restart) More...

virtual void	preSolve ()

virtual void	preStep ()

virtual void	solve ()
	Solves the time step and sets the number of nonlinear and linear iterations. More...

virtual void	postSolve ()
	Callback to the TimeIntegrator called immediately after TimeIntegrator::solve() (so the name does make sense!). More...

virtual void	postStep ()
	Callback to the TimeIntegrator called at the very end of time step. More...

virtual unsigned int	getNumNonlinearIterations () const
	Gets the total number of nonlinear iterations over all stages of the time step. More...

virtual unsigned int	getNumLinearIterations () const
	Gets the total number of linear iterations over all stages of the time step. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Static Public Member Functions
static InputParameters	validParams ()

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

Protected Member Functions
template<typename T , typename T2 >
void	computeTimeDerivativeHelper (T &u_dot, const T2 &u_old) const
	Helper function that actually does the math for computing the time derivative. More...

unsigned int	getNumNonlinearIterationsLastSolve () const
	Gets the number of nonlinear iterations in the most recent solve. More...

unsigned int	getNumLinearIterationsLastSolve () const
	Gets the number of linear iterations in the most recent solve. More...

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

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

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

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

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

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

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

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

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

Protected Attributes
FEProblemBase &	_fe_problem

SystemBase &	_sys

NonlinearSystemBase &	_nl

NonlinearImplicitSystem *	_nonlinear_implicit_system
	Nonlinear implicit system, if applicable; otherwise, nullptr. More...

Real &	_du_dot_du
	Derivative of time derivative with respect to current solution: \( {du^dot}\over{du} \). More...

const NumericVector< Number > *const &	_solution
	solution vectors More...

const NumericVector< Number > &	_solution_old

const NumericVector< Number > &	_solution_older

int &	_t_step

Real &	_dt

Real &	_dt_old

NumericVector< Number > &	_Re_time
	residual vector for time contributions More...

NumericVector< Number > &	_Re_non_time
	residual vector for non-time contributions More...

unsigned int	_n_nonlinear_iterations
	Total number of nonlinear iterations over all stages of the time step. More...

unsigned int	_n_linear_iterations
	Total number of linear iterations over all stages of the time step. More...

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

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

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

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

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

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

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

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

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

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

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

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

Detailed Description

Implicit Euler's method.

Definition at line 22 of file ImplicitEuler.h.

Constructor & Destructor Documentation

◆ ImplicitEuler()

ImplicitEuler::ImplicitEuler ( const InputParameters & parameters )

Definition at line 25 of file ImplicitEuler.C.

25 : TimeIntegrator(parameters) {}

◆ ~ImplicitEuler()

ImplicitEuler::~ImplicitEuler ( )

virtual

Definition at line 27 of file ImplicitEuler.C.

27 {}

Member Function Documentation

◆ computeADTimeDerivatives()

void ImplicitEuler::computeADTimeDerivatives	(	DualReal &	ad_u_dot,
		const dof_id_type &	dof
	)		const

overridevirtual

method for computing local automatic differentiation time derivatives

Implements TimeIntegrator.

Definition at line 45 of file ImplicitEuler.C.

 {
   computeTimeDerivativeHelper(ad_u_dot, _solution_old(dof));
 }

◆ computeTimeDerivativeHelper()

template<typename T , typename T2 >

void ImplicitEuler::computeTimeDerivativeHelper	(	T &	u_dot,
		const T2 &	u_old
	)		const

protected

Helper function that actually does the math for computing the time derivative.

Definition at line 45 of file ImplicitEuler.h.

 {
   u_dot -= u_old;
   u_dot *= 1. / _dt;
 }

Referenced by computeADTimeDerivatives(), and computeTimeDerivatives().

◆ computeTimeDerivatives()

void ImplicitEuler::computeTimeDerivatives ( )

overridevirtual

Computes the time derivative and the Jacobian of the time derivative.

This function is responsible for the following:

computing the time derivative; a reference is retrieved from _sys.solutionUDot().
computing the time derivative Jacobian, stored in _du_dot_du, which is a reference to _sys.duDotDu().

Implements TimeIntegrator.

Definition at line 30 of file ImplicitEuler.C.

 {
   if (!_sys.solutionUDot())
     mooseError("ImplicitEuler: Time derivative of solution (`u_dot`) is not stored. Please set "
                "uDotRequested() to true in FEProblemBase befor requesting `u_dot`.");
  
   NumericVector<Number> & u_dot = *_sys.solutionUDot();
   u_dot = *_solution;
   computeTimeDerivativeHelper(u_dot, _solution_old);
   u_dot.close();
  
   _du_dot_du = 1.0 / _dt;
 }

◆ declareRecoverableData() [1/2]

template<typename T >

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

protectedinherited

Declare a piece of data as "recoverable".

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

Note - this data will NOT be restored on Restart!

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

Parameters

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

Definition at line 295 of file Restartable.h.

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

◆ declareRecoverableData() [2/2]

template<typename T >

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

protectedinherited

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

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

Note - this data will NOT be restored on Restart!

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

Parameters

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

Definition at line 306 of file Restartable.h.

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

◆ declareRestartableDataTempl() [1/2]

template<typename T >

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

protectedinherited

Declare a piece of data as "restartable".

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

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

Parameters

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

Definition at line 222 of file Restartable.h.

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

◆ declareRestartableDataTempl() [2/2]

template<typename T >

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

protectedinherited

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

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

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

Parameters

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

Definition at line 229 of file Restartable.h.

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

◆ declareRestartableDataWithContext() [1/2]

template<typename T >

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

protectedinherited

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

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

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

Parameters

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

Definition at line 250 of file Restartable.h.

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

◆ declareRestartableDataWithContext() [2/2]

template<typename T >

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

protectedinherited

Declare a piece of data as "restartable".

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

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

Parameters

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

Definition at line 236 of file Restartable.h.

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

◆ declareRestartableDataWithObjectName()

template<typename T >

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

protectedinherited

Declare a piece of data as "restartable".

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

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

Parameters

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

Definition at line 270 of file Restartable.h.

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

◆ declareRestartableDataWithObjectNameWithContext()

template<typename T >

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

protectedinherited

Declare a piece of data as "restartable".

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

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

Parameters

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

Definition at line 278 of file Restartable.h.

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

◆ declareRestartableDataWithPrefixOverrideAndContext()

template<typename T >

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

protectedinherited

Declare a piece of data as "restartable".

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

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

Parameters

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

◆ enabled()

virtual bool MooseObject::enabled ( ) const

inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 110 of file MooseObject.h.

110 { return _enabled; }

Referenced by EigenKernel::enabled().

◆ getCheckedPointerParam()

template<typename T >

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

inlineinherited

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

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

Definition at line 91 of file MooseObject.h.

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

◆ getMooseApp()

MooseApp& MooseObject::getMooseApp ( ) const

inlineinherited

Get the MooseApp this object is associated with.

Definition at line 105 of file MooseObject.h.

105 { return _app; }

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

◆ getNumLinearIterations()

virtual unsigned int TimeIntegrator::getNumLinearIterations ( ) const

inlinevirtualinherited

Gets the total number of linear iterations over all stages of the time step.

Definition at line 126 of file TimeIntegrator.h.

126 { return _n_linear_iterations; }

◆ getNumLinearIterationsLastSolve()

unsigned int TimeIntegrator::getNumLinearIterationsLastSolve ( ) const

protectedinherited

Gets the number of linear iterations in the most recent solve.

Definition at line 66 of file TimeIntegrator.C.

 {
   NonlinearSolver<Real> & nonlinear_solver =
       static_cast<NonlinearSolver<Real> &>(*_nonlinear_implicit_system->nonlinear_solver);
  
   return nonlinear_solver.get_total_linear_iterations();
 }

Referenced by LStableDirk2::solve(), LStableDirk3::solve(), ImplicitMidpoint::solve(), ExplicitTVDRK2::solve(), AStableDirk4::solve(), LStableDirk4::solve(), ExplicitRK2::solve(), and TimeIntegrator::solve().

◆ getNumNonlinearIterations()

virtual unsigned int TimeIntegrator::getNumNonlinearIterations ( ) const

inlinevirtualinherited

Gets the total number of nonlinear iterations over all stages of the time step.

Definition at line 121 of file TimeIntegrator.h.

121 { return _n_nonlinear_iterations; }

◆ getNumNonlinearIterationsLastSolve()

unsigned int TimeIntegrator::getNumNonlinearIterationsLastSolve ( ) const

protectedinherited

Gets the number of nonlinear iterations in the most recent solve.

Definition at line 60 of file TimeIntegrator.C.

 {
   return _nonlinear_implicit_system->n_nonlinear_iterations();
 }

Referenced by LStableDirk2::solve(), LStableDirk3::solve(), ImplicitMidpoint::solve(), ExplicitTVDRK2::solve(), AStableDirk4::solve(), LStableDirk4::solve(), ExplicitRK2::solve(), and TimeIntegrator::solve().

◆ getParamTempl()

template<typename T >

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

inherited

Retrieve a parameter for the object.

Parameters

name	The name of the parameter

Returns: The value of the parameter

Definition at line 208 of file MooseObject.h.

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

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

◆ init()

virtual void TimeIntegrator::init ( )

inlinevirtualinherited

Called only before the very first timestep (t_step = 0) Never called again (not even during recover/restart)

Reimplemented in ExplicitTimeIntegrator, and CrankNicolson.

Definition at line 68 of file TimeIntegrator.h.

68 {}

Referenced by Transient::preExecute().

◆ initialSetup()

virtual void TimeIntegrator::initialSetup ( )

inlinevirtualinherited

Called to setup datastructures.

WILL be called during recover/restart

Should NOT do any computation for initial values use init() for that

Note: this doesn't inherit this from SetupInterface because I'm not sure that we need all the other setup functions for TimeIntegrator

Reimplemented in ExplicitTimeIntegrator.

Definition at line 62 of file TimeIntegrator.h.

62 {}

◆ isParamValid()

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

inlineinherited

Test if the supplied parameter is valid.

Parameters

name	The name of the parameter to test

Definition at line 100 of file MooseObject.h.

100 { return _pars.isParamValid(name); }

◆ mooseDeprecated()

template<typename... Args>

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

inlineinherited

Definition at line 156 of file MooseObject.h.

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

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

◆ mooseError()

template<typename... Args>

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

inlineinherited

Definition at line 141 of file MooseObject.h.

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

◆ mooseInfo()

template<typename... Args>

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

inlineinherited

Definition at line 162 of file MooseObject.h.

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

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

◆ mooseWarning()

template<typename... Args>

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

inlineinherited

Definition at line 150 of file MooseObject.h.

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

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

◆ name()

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

inlinevirtualinherited

Get the name of the object.

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

Reimplemented in MooseVariableBase.

Definition at line 70 of file MooseObject.h.

70 { return _name; }

◆ order()

virtual int ImplicitEuler::order ( )

inlineoverridevirtual

Implements TimeIntegrator.

Definition at line 30 of file ImplicitEuler.h.

30 { return 1; }

◆ paramError()

template<typename... Args>

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

inherited

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

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

Definition at line 215 of file MooseObject.h.

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

◆ paramErrorMsg()

template<typename... Args>

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

inlineprivateinherited

Definition at line 185 of file MooseObject.h.

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

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

◆ parameters()

const InputParameters& MooseObject::parameters ( ) const

inlineinherited

Get the parameters of the object.

Returns: The parameters of the object

Definition at line 76 of file MooseObject.h.

76 { return _pars; }

◆ paramInfo()

template<typename... Args>

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

inherited

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

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

Definition at line 231 of file MooseObject.h.

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

Referenced by TransientMultiApp::TransientMultiApp().

◆ paramWarning()

template<typename... Args>

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

inherited

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

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

Definition at line 224 of file MooseObject.h.

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

Referenced by Executioner::Executioner().

◆ postResidual()

void ImplicitEuler::postResidual ( NumericVector< Number > & )

overridevirtual

Callback to the TimeIntegrator called immediately after the residuals are computed in NonlinearSystem::computeResidual().

The residual vector which is passed in to this function should be filled in by the user with the _Re_time and _Re_non_time vectors in a way that makes sense for the particular TimeIntegration method.

Reimplemented from TimeIntegrator.

Definition at line 51 of file ImplicitEuler.C.

 {
   residual += _Re_time;
   residual += _Re_non_time;
   residual.close();
 }

◆ postSolve()

virtual void TimeIntegrator::postSolve ( )

inlinevirtualinherited

Callback to the TimeIntegrator called immediately after TimeIntegrator::solve() (so the name does make sense!).

See e.g. CrankNicolson for an example of what can be done in the postSolve() callback – there it is used to move the residual from the "old" timestep forward in time to avoid recomputing it.

Definition at line 94 of file TimeIntegrator.h.

94 {}

◆ postStep()

virtual void TimeIntegrator::postStep ( )

inlinevirtualinherited

Callback to the TimeIntegrator called at the very end of time step.

Reimplemented in CrankNicolson.

Definition at line 99 of file TimeIntegrator.h.

99 {}

Referenced by Transient::endStep().

◆ preSolve()

virtual void TimeIntegrator::preSolve ( )

inlinevirtualinherited

Reimplemented in ExplicitRK2, ExplicitTVDRK2, ExplicitTimeIntegrator, and ExplicitEuler.

Definition at line 69 of file TimeIntegrator.h.

69 {}

◆ preStep()

virtual void TimeIntegrator::preStep ( )

inlinevirtualinherited

Reimplemented in BDF2.

Definition at line 70 of file TimeIntegrator.h.

70 {}

◆ registerRestartableDataOnApp()

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

privateinherited

Helper function for actually registering the restartable data.

Definition at line 48 of file Restartable.C.

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

Referenced by Restartable::declareRestartableDataWithContext().

◆ registerRestartableNameWithFilterOnApp()

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

privateinherited

Helper function for actually registering the restartable data.

Definition at line 56 of file Restartable.C.

 {
   _restartable_app.registerRestartableNameWithFilter(name, filter);
 }

Referenced by Restartable::declareRecoverableData().

◆ solve()

void TimeIntegrator::solve ( )

virtualinherited

Solves the time step and sets the number of nonlinear and linear iterations.

Reimplemented in ExplicitRK2, LStableDirk4, AStableDirk4, ExplicitTVDRK2, ImplicitMidpoint, LStableDirk3, LStableDirk2, ActuallyExplicitEuler, and ExplicitSSPRungeKutta.

Definition at line 51 of file TimeIntegrator.C.

 {
   _nl.system().solve();
  
   _n_nonlinear_iterations = getNumNonlinearIterationsLastSolve();
   _n_linear_iterations = getNumLinearIterationsLastSolve();
 }

◆ type()

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

inlineinherited

Get the type of this object.

Returns: the name of the type of this object

Definition at line 63 of file MooseObject.h.

63 { return _type; }

◆ validParams()

InputParameters ImplicitEuler::validParams ( )

static

Definition at line 18 of file ImplicitEuler.C.

 {
   InputParameters params = TimeIntegrator::validParams();
  
   return params;
 }

Member Data Documentation

◆ _app

MooseApp& MooseObject::_app

protectedinherited

The MooseApp this object is associated with.

Definition at line 172 of file MooseObject.h.

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

◆ _console

const ConsoleStream ConsoleStreamInterface::_console

inherited

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

Definition at line 31 of file ConsoleStreamInterface.h.

◆ _dt

Real& TimeIntegrator::_dt

protectedinherited

Definition at line 156 of file TimeIntegrator.h.

◆ _dt_old

Real& TimeIntegrator::_dt_old

protectedinherited

Definition at line 157 of file TimeIntegrator.h.

Referenced by ExplicitEuler::preSolve(), ExplicitTVDRK2::preSolve(), ExplicitRK2::preSolve(), and BDF2::preStep().

◆ _du_dot_du

Real& TimeIntegrator::_du_dot_du

protectedinherited

Derivative of time derivative with respect to current solution: \( {du^dot}\over{du} \).

Definition at line 148 of file TimeIntegrator.h.

◆ _enabled

const bool& MooseObject::_enabled

protectedinherited

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

Definition at line 181 of file MooseObject.h.

Referenced by MooseObject::enabled().

◆ _fe_problem

◆ _n_linear_iterations

unsigned int TimeIntegrator::_n_linear_iterations

protectedinherited

Total number of linear iterations over all stages of the time step.

Definition at line 167 of file TimeIntegrator.h.

Referenced by TimeIntegrator::getNumLinearIterations(), ExplicitTimeIntegrator::performExplicitSolve(), ExplicitSSPRungeKutta::solve(), ActuallyExplicitEuler::solve(), LStableDirk2::solve(), LStableDirk3::solve(), ImplicitMidpoint::solve(), ExplicitTVDRK2::solve(), AStableDirk4::solve(), LStableDirk4::solve(), ExplicitRK2::solve(), TimeIntegrator::solve(), and ExplicitTimeIntegrator::solveLinearSystem().

◆ _n_nonlinear_iterations

unsigned int TimeIntegrator::_n_nonlinear_iterations

protectedinherited

Total number of nonlinear iterations over all stages of the time step.

Definition at line 165 of file TimeIntegrator.h.

Referenced by TimeIntegrator::getNumNonlinearIterations(), ExplicitSSPRungeKutta::solve(), ActuallyExplicitEuler::solve(), LStableDirk2::solve(), LStableDirk3::solve(), ImplicitMidpoint::solve(), ExplicitTVDRK2::solve(), AStableDirk4::solve(), LStableDirk4::solve(), ExplicitRK2::solve(), and TimeIntegrator::solve().

◆ _name

const std::string& MooseObject::_name

protectedinherited

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

Definition at line 178 of file MooseObject.h.

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

◆ _nl

NonlinearSystemBase& TimeIntegrator::_nl

protectedinherited

Definition at line 141 of file TimeIntegrator.h.

Referenced by AStableDirk4::AStableDirk4(), ExplicitTimeIntegrator::ExplicitTimeIntegrator(), CrankNicolson::init(), LStableDirk3::LStableDirk3(), LStableDirk4::LStableDirk4(), ActuallyExplicitEuler::solve(), TimeIntegrator::solve(), and ExplicitSSPRungeKutta::solveStage().

◆ _nonlinear_implicit_system

NonlinearImplicitSystem* TimeIntegrator::_nonlinear_implicit_system

protectedinherited

Nonlinear implicit system, if applicable; otherwise, nullptr.

Definition at line 145 of file TimeIntegrator.h.

Referenced by TimeIntegrator::getNumLinearIterationsLastSolve(), TimeIntegrator::getNumNonlinearIterationsLastSolve(), ExplicitSSPRungeKutta::postResidual(), ExplicitSSPRungeKutta::solve(), ActuallyExplicitEuler::solve(), and ExplicitSSPRungeKutta::solveStage().

◆ _pars

const InputParameters& MooseObject::_pars

protectedinherited

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

Definition at line 169 of file MooseObject.h.

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

◆ _Re_non_time

NumericVector<Number>& TimeIntegrator::_Re_non_time

protectedinherited

residual vector for non-time contributions

Definition at line 162 of file TimeIntegrator.h.

Referenced by ExplicitEuler::postResidual(), ExplicitSSPRungeKutta::postResidual(), postResidual(), ActuallyExplicitEuler::postResidual(), BDF2::postResidual(), NewmarkBeta::postResidual(), CrankNicolson::postResidual(), LStableDirk2::postResidual(), LStableDirk3::postResidual(), ImplicitMidpoint::postResidual(), ExplicitTVDRK2::postResidual(), AStableDirk4::postResidual(), LStableDirk4::postResidual(), ExplicitRK2::postResidual(), and CrankNicolson::postStep().

◆ _Re_time

NumericVector<Number>& TimeIntegrator::_Re_time

protectedinherited

residual vector for time contributions

Definition at line 160 of file TimeIntegrator.h.

Referenced by ExplicitEuler::postResidual(), postResidual(), BDF2::postResidual(), ActuallyExplicitEuler::postResidual(), NewmarkBeta::postResidual(), CrankNicolson::postResidual(), LStableDirk2::postResidual(), LStableDirk3::postResidual(), ImplicitMidpoint::postResidual(), ExplicitTVDRK2::postResidual(), AStableDirk4::postResidual(), LStableDirk4::postResidual(), and ExplicitRK2::postResidual().

◆ _restartable_app

MooseApp& Restartable::_restartable_app

privateinherited

Reference to the application.

Definition at line 208 of file Restartable.h.

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

◆ _restartable_name

std::string Restartable::_restartable_name

privateinherited

The name of the object.

Definition at line 211 of file Restartable.h.

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

◆ _restartable_system_name

std::string Restartable::_restartable_system_name

privateinherited

The system name this object is in.

Definition at line 214 of file Restartable.h.

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

◆ _restartable_tid

THREAD_ID Restartable::_restartable_tid

privateinherited

The thread ID for this object.

Definition at line 217 of file Restartable.h.

Referenced by Restartable::declareRestartableDataWithContext().

◆ _solution

const NumericVector<Number>* const & TimeIntegrator::_solution

protectedinherited

solution vectors

Definition at line 150 of file TimeIntegrator.h.

◆ _solution_old

const NumericVector<Number>& TimeIntegrator::_solution_old

protectedinherited

Definition at line 151 of file TimeIntegrator.h.

◆ _solution_older

const NumericVector<Number>& TimeIntegrator::_solution_older

protectedinherited

Definition at line 152 of file TimeIntegrator.h.

Referenced by BDF2::computeADTimeDerivatives(), ExplicitTVDRK2::computeADTimeDerivatives(), ExplicitRK2::computeADTimeDerivatives(), BDF2::computeTimeDerivatives(), ExplicitTVDRK2::computeTimeDerivatives(), and ExplicitRK2::computeTimeDerivatives().

◆ _sys

SystemBase& TimeIntegrator::_sys

protectedinherited

Definition at line 140 of file TimeIntegrator.h.

◆ _t_step

int& TimeIntegrator::_t_step

protectedinherited

Definition at line 154 of file TimeIntegrator.h.

Referenced by BDF2::computeADTimeDerivatives(), BDF2::computeTimeDerivativeHelper(), BDF2::computeTimeDerivatives(), AStableDirk4::postResidual(), BDF2::preStep(), and AStableDirk4::solve().

◆ _type

const std::string& MooseObject::_type

protectedinherited

The type of this object (the Class name)

Definition at line 175 of file MooseObject.h.

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

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

include/timeintegrators/ImplicitEuler.h
src/timeintegrators/ImplicitEuler.C

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ImplicitEuler()

◆ ~ImplicitEuler()

Member Function Documentation

◆ computeADTimeDerivatives()

◆ computeTimeDerivativeHelper()

◆ computeTimeDerivatives()

◆ declareRecoverableData() [1/2]

◆ declareRecoverableData() [2/2]

◆ declareRestartableDataTempl() [1/2]

◆ declareRestartableDataTempl() [2/2]

◆ declareRestartableDataWithContext() [1/2]

◆ declareRestartableDataWithContext() [2/2]

◆ declareRestartableDataWithObjectName()

◆ declareRestartableDataWithObjectNameWithContext()

◆ declareRestartableDataWithPrefixOverrideAndContext()

◆ enabled()

◆ getCheckedPointerParam()

◆ getMooseApp()

◆ getNumLinearIterations()

◆ getNumLinearIterationsLastSolve()

◆ getNumNonlinearIterations()

◆ getNumNonlinearIterationsLastSolve()

◆ getParamTempl()

◆ init()

◆ initialSetup()

◆ isParamValid()

◆ mooseDeprecated()

◆ mooseError()

◆ mooseInfo()

◆ mooseWarning()

◆ name()

◆ order()

◆ paramError()

◆ paramErrorMsg()

◆ parameters()

◆ paramInfo()

◆ paramWarning()

◆ postResidual()

◆ postSolve()

◆ postStep()

◆ preSolve()

◆ preStep()

◆ registerRestartableDataOnApp()

◆ registerRestartableNameWithFilterOnApp()

◆ solve()

◆ type()

◆ validParams()

Member Data Documentation

◆ _app

◆ _console

◆ _dt

◆ _dt_old

◆ _du_dot_du

◆ _enabled

◆ _fe_problem

◆ _n_linear_iterations

◆ _n_nonlinear_iterations

◆ _name

◆ _nl

◆ _nonlinear_implicit_system

◆ _pars

◆ _Re_non_time

◆ _Re_time

◆ _restartable_app

◆ _restartable_name

◆ _restartable_system_name

◆ _restartable_tid

◆ _solution

◆ _solution_old

◆ _solution_older

◆ _sys