Third order diagonally implicit Runge Kutta method (Dirk) with three stages. More...

#include <LStableDirk3.h>

Inheritance diagram for LStableDirk3:

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

Public Member Functions
	LStableDirk3 (const InputParameters &parameters)

virtual int	order () override

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

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

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

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

virtual bool	overridesSolve () const override

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	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 Real &	dt () const
	Returns the time step size. More...

virtual bool	isExplicit () const
	Returns whether the explicit solvers are used. More...

virtual bool	advancesProblemState () const

virtual unsigned int	numStatesRequired () const
	Return the number of states this requires in a linear system setting. More...

virtual const bool &	isLumped () const
	Returns whether mass matrix is lumped. More...

bool	integratesVar (const unsigned int var_num) const

void	setNumIterationsLastSolve ()
	Record the linear and nonlinear iterations from a just finished solve. More...

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

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

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

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

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

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

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

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

void	callMooseError (std::string msg, const bool with_prefix) const
	Calls moose error with the message `msg`. More...

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const
	The unique parameter name of a valid parameter of this object for accessing parameter controls. More...

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

MooseObjectName	uniqueName () const
	The unique name for accessing input parameters of this object in the InputParameterWarehouse. More...

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

template<typename T1 , typename T2 >
std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const
	Retrieve two parameters and provide pair of parameters for the object. More...

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

template<typename T >
const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const
	Retrieve a renamed parameter for the object. More...

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

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

bool	isParamSetByUser (const std::string &nm) const
	Test if the supplied parameter is set by a user, as opposed to not set or set to default. 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...

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
	Connect controllable parameter of this action with the controllable parameters of the objects added by this action. More...

template<typename... Args>
void	mooseError (Args &&... args) const
	Emits an error prefixed with object name and type. More...

template<typename... Args>
void	mooseErrorNonPrefixed (Args &&... args) const
	Emits an error without the prefixing included in mooseError(). More...

template<typename... Args>
void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
	Emits a documented error with object name and type. More...

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

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

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

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

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

std::string	getDataFileName (const std::string &param) const
	Deprecated method. More...

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

std::string	getDataFilePath (const std::string &relative_path) const
	Returns the path of a data file for a given relative file path. More...

TagID	uDotFactorTag () const
	Returns the tag for the nodal multiplication factor for the residual calculation of the udot term. More...

TagID	uDotDotFactorTag () const
	Returns the tag for the nodal multiplication factor for the residual calculation of the udotdot term. More...

virtual Real	timeDerivativeRHSContribution (dof_id_type dof_id, const std::vector< Real > &factors={}) const
	The time derivative's contribution to the right hand side of a linear system. More...

virtual Real	timeDerivativeMatrixContribution (const Real factor) const
	The time derivative's contribution to the right hand side of a linear system. More...

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

void	copyVector (const NumericVector< Number > &from, NumericVector< Number > &to)
	Copy from one vector into another. More...

virtual Real	duDotDuCoeff () const

void	computeDuDotDu ()
	Compute `_du_dot_du`. More...

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

template<typename T , typename... Args>
ManagedValue< T >	declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)
	Declares a piece of "managed" restartable data and initialize it. More...

template<typename T , typename... Args>
const T &	getRestartableData (const std::string &data_name) const
	Declare a piece of data as "restartable" and initialize it Similar to `declareRestartableData` but returns a const reference to the object. More...

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

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

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

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

std::string	restartableName (const std::string &data_name) const
	Gets the name of a piece of restartable data given a data name, adding the system name and object name prefix. More...

NumericVector< Number > *	addVector (const std::string &name, const bool project, const libMesh::ParallelType type)
	Wrapper around vector addition for nonlinear time integrators. More...

Protected Attributes
unsigned int	_stage

NumericVector< Number > *	_stage_residuals [3]

const Real	_gamma

Real	_c [3]

Real	_a [3][3]

FEProblemBase &	_fe_problem
	Reference to the problem. More...

SystemBase &	_sys
	Reference to the system this time integrator operates on. More...

std::vector< Real > &	_du_dot_du
	Derivative of time derivative with respect to current solution: \( {du^dot}\over{du} \) for the different variables. More...

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

Real &	_dt
	The current time step size. More...

Real &	_dt_old
	The previous time step size. 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...

bool	_is_lumped
	Boolean flag that is set to true if lumped mass matrix is used. More...

bool &	_var_restriction
	Whether the user has requested that the time integrator be applied to a subset of variables. More...

std::vector< dof_id_type > &	_local_indices
	The local degree of freedom indices this time integrator is being applied to. More...

std::unordered_set< unsigned int > &	_vars
	The variables that this time integrator integrates. More...

std::unique_ptr< NumericVector< Number > >	_from_subvector
	A vector that is used for creating 'from' subvectors in the `copyVector()` method. More...

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

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

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

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

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

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

ActionFactory &	_action_factory
	Builds Actions. More...

const Parallel::Communicator &	_communicator

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

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

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

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

NonlinearSystemBase *	_nl
	Pointer to the nonlinear system, can happen that we dont have any. More...

libMesh::NonlinearImplicitSystem *	_nonlinear_implicit_system
	libMesh nonlinear implicit system, if applicable; otherwise, nullptr More...

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

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

const TagID	_u_dot_factor_tag
	The vector tag for the nodal multiplication factor for the residual calculation of the udot term. More...

const TagID	_u_dotdot_factor_tag
	The vector tag for the nodal multiplication factor for the residual calculation of the udotdot term. More...

LinearSystem *	_linear_system
	Pointer to the linear system, can happen that we dont have any. More...

libMesh::LinearImplicitSystem *	_linear_implicit_system
	Nonlinear implicit system, if applicable; otherwise, nullptr. More...


const NumericVector< Number > *const &	_solution

const NumericVector< Number > &	_solution_old

std::unique_ptr< NumericVector< Number > > &	_solution_sub

std::unique_ptr< NumericVector< Number > > &	_solution_old_sub

Detailed Description

Third order diagonally implicit Runge Kutta method (Dirk) with three stages.

The Butcher tableau for this method is: gamma | gamma (1+gamma)/2 | (1-gamma)/2 gamma

1 | (1/4)(-6gamma**2 + 16gamma - 1) (1/4)(6*gamma**2 - 20*gamma + 5) gamma

| (1/4)*(-6*gamma**2 + 16*gamma - 1) (1/4)*(6*gamma**2 - 20*gamma + 5) gamma

where gamma = -sqrt(2)*cos(atan(sqrt(2)/4)/3)/2 + sqrt(6)*sin(atan(sqrt(2)/4)/3)/2 + 1 ~ .435866521508459

The stability function for this method is: R(z) = (1.90128552647780115*z**2 + 2.46079651620301599*z - 8) / (0.662446064957040178*z**3 - 4.55951098972521484*z**2 + 10.460796516203016*z - 8)

The method is L-stable: lim R(z), z->oo = 0

Notes: This method is derived in detail in: R. Alexander, "Diagonally implicit Runge-Kutta Methods for Stiff ODEs", SIAM J. Numer. Anal., 14(6), Dec. 1977, pg. 1006-1021. Unlike BDF3, this method is L-stable and so may be more suitable for "stiff" problems.

Definition at line 40 of file LStableDirk3.h.

Member Typedef Documentation

◆ DataFileParameterType

using DataFileInterface::DataFileParameterType = DataFileName

inherited

The parameter type this interface expects for a data file name.

Definition at line 27 of file DataFileInterface.h.

Constructor & Destructor Documentation

◆ LStableDirk3()

LStableDirk3::LStableDirk3 ( const InputParameters & parameters )

Definition at line 27 of file LStableDirk3.C.

   : TimeIntegrator(parameters),
     _stage(1),
     _gamma(-std::sqrt(2.) * std::cos(std::atan(std::sqrt(2.) / 4.) / 3.) / 2. +
            std::sqrt(6.) * std::sin(std::atan(std::sqrt(2.) / 4.) / 3.) / 2. + 1.)
 {
   mooseInfo("LStableDirk3 and other multistage TimeIntegrators are known not to work with "
             "Materials/AuxKernels that accumulate 'state' and should be used with caution.");
 
   // Name the stage residuals "residual_stage1", "residual_stage2", etc.
   for (unsigned int stage = 0; stage < 3; ++stage)
   {
     std::ostringstream oss;
     oss << "residual_stage" << stage + 1;
     _stage_residuals[stage] = addVector(oss.str(), false, GHOSTED);
   }
 
   // Initialize parameters
   _c[0] = _gamma;
   _c[1] = .5 * (1 + _gamma);
   _c[2] = 1.0;
 
   _a[0][0] = _gamma;
   _a[1][0] = .5 * (1 - _gamma); 
   _a[1][1] = _gamma;
   _a[2][0] = .25 * (-6 * _gamma * _gamma + 16 * _gamma - 1); 
   _a[2][1] = .25 * (6 * _gamma * _gamma - 20 * _gamma + 5);  
   _a[2][2] = _gamma;
 }

Member Function Documentation

◆ addVector()

NumericVector< Number > * NonlinearTimeIntegratorInterface::addVector	(	const std::string &	name,
		const bool	project,
		const libMesh::ParallelType	type
	)

protectedinherited

Wrapper around vector addition for nonlinear time integrators.

If we don't operate on a nonlinear system we don't need to add the vector.

Parameters

name	The name of the vector
project	If the vector should be projected
type	The parallel distribution of the vetor

Definition at line 31 of file NonlinearTimeIntegratorInterface.C.

Referenced by AStableDirk4::AStableDirk4(), ExplicitTimeIntegrator::ExplicitTimeIntegrator(), LStableDirk3(), and LStableDirk4::LStableDirk4().

 {
   if (_nl)
     return &_nl->addVector(name, project, type);
   else
     return nullptr;
 }

◆ advancesProblemState()

virtual bool TimeIntegrator::advancesProblemState ( ) const

inlinevirtualinherited

Definition at line 135 of file TimeIntegrator.h.

135 { return false; }

◆ callMooseError()

void MooseBase::callMooseError	(	std::string	msg,
		const bool	with_prefix
	)		const

inherited

Calls moose error with the message msg.

Will prefix the message with the subapp name if one exists.

If with_prefix, then add the prefix from errorPrefix() to the error.

Definition at line 33 of file MooseBase.C.

Referenced by InputParameters::callMooseErrorHelper(), MooseBaseErrorInterface::mooseDocumentedError(), MooseBaseErrorInterface::mooseError(), MooseBaseErrorInterface::mooseErrorNonPrefixed(), and MooseBaseParameterInterface::paramError().

 {
   _app.getOutputWarehouse().mooseConsole();
   const std::string prefix = _app.isUltimateMaster() ? "" : _app.name();
   if (with_prefix)
     msg = errorPrefix("error") + msg;
   moose::internal::mooseErrorRaw(msg, prefix);
 }

◆ computeADTimeDerivatives()

void LStableDirk3::computeADTimeDerivatives	(	ADReal &	ad_u_dot,
		const dof_id_type &	dof,
		ADReal &	ad_u_dot_dot
	)		const

overridevirtual

method for computing local automatic differentiation time derivatives

Implements TimeIntegrator.

Definition at line 75 of file LStableDirk3.C.

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

◆ computeDuDotDu()

void TimeIntegrator::computeDuDotDu ( )

protectedinherited

Compute _du_dot_du.

Definition at line 155 of file TimeIntegrator.C.

 {
   const auto coeff = duDotDuCoeff();
   for (const auto i : index_range(_du_dot_du))
     if (integratesVar(i))
       _du_dot_du[i] = coeff / _dt;
 }

◆ computeTimeDerivativeHelper()

template<typename T , typename T2 >

void LStableDirk3::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 86 of file LStableDirk3.h.

Referenced by computeADTimeDerivatives(), and computeTimeDerivatives().

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

◆ computeTimeDerivatives()

void LStableDirk3::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.duDotDus().

Implements TimeIntegrator.

Definition at line 58 of file LStableDirk3.C.

 {
   // We are multiplying by the method coefficients in postResidual(), so
   // the time derivatives are of the same form at every stage although
   // the current solution varies depending on the stage.
   if (!_sys.solutionUDot())
     mooseError("LStableDirk3: 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();
   computeDuDotDu();
 }

◆ connectControllableParams()

void MooseBaseParameterInterface::connectControllableParams	(	const std::string &	parameter,
		const std::string &	object_type,
		const std::string &	object_name,
		const std::string &	object_parameter
	)		const

inherited

Connect controllable parameter of this action with the controllable parameters of the objects added by this action.

Parameters

parameter	Name of the controllable parameter of this action
object_type	Type of the object added by this action.
object_name	Name of the object added by this action.
object_parameter	Name of the parameter of the object.

Definition at line 33 of file MooseBaseParameterInterface.C.

 {
   MooseObjectParameterName primary_name(uniqueName(), parameter);
   const auto base_type = _factory.getValidParams(object_type).get<std::string>("_moose_base");
   MooseObjectParameterName secondary_name(base_type, object_name, object_parameter);
   _moose_base.getMooseApp().getInputParameterWarehouse().addControllableParameterConnection(
       primary_name, secondary_name);
 
   const auto & tags = _pars.get<std::vector<std::string>>("control_tags");
   for (const auto & tag : tags)
   {
     if (!tag.empty())
     {
       // Only adds the parameter with the different control tags if the derived class
       // properly registers the parameter to its own syntax
       MooseObjectParameterName tagged_name(tag, _moose_base.name(), parameter);
       _moose_base.getMooseApp().getInputParameterWarehouse().addControllableParameterConnection(
           tagged_name, secondary_name, /*error_on_empty=*/false);
     }
   }
 }

◆ copyVector()

void TimeIntegrator::copyVector	(	const NumericVector< Number > &	from,
		NumericVector< Number > &	to
	)

protectedinherited

Copy from one vector into another.

If the time integrator has been restricted to a subset of variables, then this will selectively copy their dofs

Definition at line 132 of file TimeIntegrator.C.

Referenced by CrankNicolson::init(), and CrankNicolson::postStep().

 {
   if (!_var_restriction)
     to = from;
   else
   {
     auto to_sub = to.get_subvector(_local_indices);
     from.create_subvector(*_from_subvector, _local_indices, false);
     *to_sub = *_from_subvector;
     to.restore_subvector(std::move(to_sub), _local_indices);
   }
 }

◆ declareManagedRestartableDataWithContext()

template<typename T , typename... Args>

Restartable::ManagedValue< T > Restartable::declareManagedRestartableDataWithContext	(	const std::string &	data_name,
		void *	context,
		Args &&...	args
	)

protectedinherited

Declares a piece of "managed" restartable data and initialize it.

Here, "managed" restartable data means that the caller can destruct this data upon destruction of the return value of this method. Therefore, this ManagedValue<T> wrapper should survive after the final calls to dataStore() for it. That is... at the very end.

This is needed for objects whose destruction ordering is important, and enables natural c++ destruction in reverse construction order of the object that declares it.

See delcareRestartableData and declareRestartableDataWithContext for more information.

Definition at line 276 of file Restartable.h.

 {
   auto & data_ptr =
       declareRestartableDataHelper<T>(data_name, context, std::forward<Args>(args)...);
   return Restartable::ManagedValue<T>(data_ptr);
 }

◆ declareRecoverableData()

template<typename T , typename... Args>

T & Restartable::declareRecoverableData	(	const std::string &	data_name,
		Args &&...	args
	)

protectedinherited

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

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

Note - this data will NOT be restored on Restart!

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

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
args	Arguments to forward to the constructor of the data

Definition at line 351 of file Restartable.h.

 {
   const auto full_name = restartableName(data_name);
 
   registerRestartableNameWithFilterOnApp(full_name, Moose::RESTARTABLE_FILTER::RECOVERABLE);
 
   return declareRestartableDataWithContext<T>(data_name, nullptr, std::forward<Args>(args)...);
 }

◆ declareRestartableData()

template<typename T , typename... Args>

T & Restartable::declareRestartableData	(	const std::string &	data_name,
		Args &&...	args
	)

protectedinherited

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

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

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

Parameters

data_name	The name of the data (usually just use the same name as the member variable)
args	Arguments to forward to the constructor of the data

Definition at line 269 of file Restartable.h.

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

◆ declareRestartableDataWithContext()

template<typename T , typename... Args>

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

protectedinherited

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

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

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

Parameters

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

Definition at line 294 of file Restartable.h.

 {
   return declareRestartableDataHelper<T>(data_name, context, std::forward<Args>(args)...).set();
 }

◆ declareRestartableDataWithObjectName()

template<typename T , typename... Args>

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

protectedinherited

Declare a piece of data as "restartable".

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

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

Parameters

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

Definition at line 323 of file Restartable.h.

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

◆ declareRestartableDataWithObjectNameWithContext()

template<typename T , typename... Args>

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

protectedinherited

Declare a piece of data as "restartable".

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

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

Parameters

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

Definition at line 333 of file Restartable.h.

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

◆ dt()

const Real& TimeIntegrator::dt ( ) const

inlineinherited

Returns the time step size.

Returns: The time step size

Definition at line 123 of file TimeIntegrator.h.

Referenced by ExplicitSSPRungeKutta::solve().

123 { return _dt; }

TimeIntegrator::_dt

Real & _dt

The current time step size.

Definition: TimeIntegrator.h:214

◆ duDotDuCoeff()

virtual Real TimeIntegrator::duDotDuCoeff ( ) const

inlineprotectedvirtualinherited

Returns: The _du_dot_du multiplicative coefficient, e.g. if _du_dot_du is equivalent to 2/dt, then this method returns 2

Reimplemented in CrankNicolson, NewmarkBeta, BDF2, ExplicitSSPRungeKutta, and CentralDifference.

Definition at line 184 of file TimeIntegrator.h.

Referenced by TimeIntegrator::computeDuDotDu().

184 { return 1; }

◆ enabled()

virtual bool MooseObject::enabled ( ) const

inlinevirtualinherited

Return the enabled status of the object.

Reimplemented in EigenKernel.

Definition at line 40 of file MooseObject.h.

Referenced by EigenKernel::enabled().

40 { return _enabled; }

MooseObject::_enabled

const bool & _enabled

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

Definition: MooseObject.h:51

◆ errorPrefix()

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

inherited

Returns: A prefix to be used in errors that contains the input file location associated with this object (if any) and the name and type of the object.

Definition at line 43 of file MooseBase.C.

Referenced by MooseBase::callMooseError(), MooseBaseErrorInterface::mooseDeprecated(), MooseBaseErrorInterface::mooseInfo(), MooseBaseErrorInterface::mooseWarning(), and MooseBaseParameterInterface::paramErrorMsg().

 {
   std::stringstream oss;
   if (const auto node = _params.getHitNode())
     if (!node->isRoot())
       oss << node->fileLocation() << ":\n";
   oss << "The following " << error_type << " occurred in the ";
   if (const auto base_ptr = _params.getBase())
     oss << *base_ptr;
   else
     oss << "object";
   oss << " '" << name() << "' of type " << type() << ".\n\n";
   return oss.str();
 }

◆ getCheckedPointerParam()

template<typename T >

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

inherited

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

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

Definition at line 286 of file MooseBaseParameterInterface.h.

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

◆ getDataFileName()

std::string DataFileInterface::getDataFileName ( const std::string & param ) const

inherited

Deprecated method.

The data file paths are now automatically set within the InputParameters object, so using getParam<DataFileName>("param_name") is now sufficient.

Definition at line 21 of file DataFileInterface.C.

 {
   _parent.mooseDeprecated("getDataFileName() is deprecated. The file path is now directly set "
                           "within the InputParameters.\nUse getParam<DataFileName>(\"",
                           param,
                           "\") instead.");
   return _parent.getParam<DataFileName>(param);
 }

◆ getDataFileNameByName()

std::string DataFileInterface::getDataFileNameByName ( const std::string & relative_path ) const

inherited

Deprecated method.

Use getDataFilePath() instead.

Definition at line 31 of file DataFileInterface.C.

 {
   _parent.mooseDeprecated("getDataFileNameByName() is deprecated. Use getDataFilePath(\"",
                           relative_path,
                           "\") instead.");
   return getDataFilePath(relative_path);
 }

◆ getDataFilePath()

std::string DataFileInterface::getDataFilePath ( const std::string & relative_path ) const

inherited

Returns the path of a data file for a given relative file path.

This can be used for hardcoded datafile names and will search the same locations as getDataFileName

Definition at line 40 of file DataFileInterface.C.

Referenced by DataFileInterface::getDataFileNameByName().

 {
   // This should only ever be used with relative paths. There is no point to
   // use this search path with an absolute path.
   if (std::filesystem::path(relative_path).is_absolute())
     _parent.mooseWarning("While using getDataFilePath(\"",
                          relative_path,
                          "\"): This API should not be used for absolute paths.");
 
   // Throw on error so that if getPath() fails, we can throw an error
   // with the context of _parent.mooseError()
   const auto throw_on_error_before = Moose::_throw_on_error;
   Moose::_throw_on_error = true;
   std::optional<std::string> error;
 
   // This will search the data paths for this relative path
   Moose::DataFileUtils::Path found_path;
   try
   {
     found_path = Moose::DataFileUtils::getPath(relative_path);
   }
   catch (std::exception & e)
   {
     error = e.what();
   }
 
   Moose::_throw_on_error = throw_on_error_before;
   if (error)
     _parent.mooseError(*error);
 
   mooseAssert(found_path.context == Moose::DataFileUtils::Context::DATA,
               "Should only ever obtain data");
   mooseAssert(found_path.data_name, "Should be set");
 
   const std::string msg =
       "Using data file '" + found_path.path + "' from " + *found_path.data_name + " data";
   _parent.mooseInfo(msg);
 
   return found_path.path;
 }

◆ getMooseApp()

MooseApp& MooseBase::getMooseApp ( ) const

inlineinherited

Get the MooseApp this class is associated with.

Definition at line 45 of file MooseBase.h.

Referenced by ChainControlSetupAction::act(), AddDefaultConvergenceAction::addDefaultMultiAppFixedPointConvergence(), AddDefaultConvergenceAction::addDefaultNonlinearConvergence(), FEProblemBase::advanceState(), ParsedChainControl::buildFunction(), ReporterTransferInterface::checkHasReporterValue(), AddDefaultConvergenceAction::checkUnusedMultiAppFixedPointConvergenceParameters(), AddDefaultConvergenceAction::checkUnusedNonlinearConvergenceParameters(), Coupleable::checkWritableVar(), ComponentPhysicsInterface::ComponentPhysicsInterface(), MooseBaseParameterInterface::connectControllableParams(), Coupleable::Coupleable(), MortarData::createMortarInterface(), EigenProblem::doFreeNonlinearPowerIterations(), Terminator::execute(), FEProblemSolve::FEProblemSolve(), SolutionInvalidInterface::flagInvalidSolutionInternal(), ChainControl::getChainControlDataSystem(), DefaultConvergenceBase::getSharedExecutionerParam(), ChainControlDataPostprocessor::initialSetup(), MaterialPropertyInterface::MaterialPropertyInterface(), MooseVariableDataFV< OutputType >::MooseVariableDataFV(), ProgressOutput::output(), PetscOutputInterface::petscLinearOutput(), PetscOutputInterface::petscNonlinearOutput(), PetscOutputInterface::PetscOutputInterface(), PostprocessorInterface::postprocessorsAdded(), MultiApp::preTransfer(), Reporter::Reporter(), ReporterInterface::reportersAdded(), and VectorPostprocessorInterface::vectorPostprocessorsAdded().

45 { return _app; }

MooseBase::_app

MooseApp & _app

The MOOSE application this is associated with.

Definition: MooseBase.h:84

◆ 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 117 of file TimeIntegrator.h.

117 { return _n_linear_iterations; }

TimeIntegrator::_n_linear_iterations

unsigned int _n_linear_iterations

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

Definition: TimeIntegrator.h:222

◆ getNumLinearIterationsLastSolve()

unsigned int TimeIntegrator::getNumLinearIterationsLastSolve ( ) const

protectedinherited

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

Definition at line 123 of file TimeIntegrator.C.

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

 {
   auto & nonlinear_solver = _nonlinear_implicit_system->nonlinear_solver;
   libmesh_assert(nonlinear_solver);
 
   return nonlinear_solver->get_total_linear_iterations();
 }

◆ 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 112 of file TimeIntegrator.h.

112 { return _n_nonlinear_iterations; }

TimeIntegrator::_n_nonlinear_iterations

unsigned int _n_nonlinear_iterations

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

Definition: TimeIntegrator.h:220

◆ getNumNonlinearIterationsLastSolve()

unsigned int TimeIntegrator::getNumNonlinearIterationsLastSolve ( ) const

protectedinherited

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

Definition at line 117 of file TimeIntegrator.C.

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

 {
   return _nonlinear_implicit_system->n_nonlinear_iterations();
 }

◆ getParam() [1/2]

template<typename T >

const T & MooseBaseParameterInterface::getParam ( const std::string & name ) const

inherited

Retrieve a parameter for the object.

Parameters

name	The name of the parameter

Returns: The value of the parameter

Definition at line 215 of file MooseBaseParameterInterface.h.

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

◆ getParam() [2/2]

template<typename T1 , typename T2 >

std::vector< std::pair< T1, T2 > > MooseBaseParameterInterface::getParam	(	const std::string &	param1,
		const std::string &	param2
	)		const

inherited

Retrieve two parameters and provide pair of parameters for the object.

Parameters

param1	The name of first parameter
param2	The name of second parameter

Returns: Vector of pairs of first and second parameters

Definition at line 279 of file MooseBaseParameterInterface.h.

 {
   return _pars.get<T1, T2>(param1, param2);
 }

◆ getRenamedParam()

template<typename T >

const T & MooseBaseParameterInterface::getRenamedParam	(	const std::string &	old_name,
		const std::string &	new_name
	)		const

inherited

Retrieve a renamed parameter for the object.

This helper makes sure we check both names before erroring, and that only one parameter is passed to avoid silent errors

Parameters

old_name	the old name for the parameter
new_name	the new name for the parameter

Definition at line 229 of file MooseBaseParameterInterface.h.

 {
   // this enables having a default on the new parameter but bypassing it with the old one
   // Most important: accept new parameter
   if (isParamSetByUser(new_name) && !isParamValid(old_name))
     return InputParameters::getParamHelper(new_name, _pars, static_cast<T *>(0), &_moose_base);
   // Second most: accept old parameter
   else if (isParamValid(old_name) && !isParamSetByUser(new_name))
     return InputParameters::getParamHelper(old_name, _pars, static_cast<T *>(0), &_moose_base);
   // Third most: accept default for new parameter
   else if (isParamValid(new_name) && !isParamValid(old_name))
     return InputParameters::getParamHelper(new_name, _pars, static_cast<T *>(0), &_moose_base);
   // Refuse: no default, no value passed
   else if (!isParamValid(old_name) && !isParamValid(new_name))
     mooseError(_pars.blockFullpath() + ": parameter '" + new_name +
                "' is being retrieved without being set.\n"
                "Did you misspell it?");
   // Refuse: both old and new parameters set by user
   else
     mooseError(_pars.blockFullpath() + ": parameter '" + new_name +
                "' may not be provided alongside former parameter '" + old_name + "'");
 }

◆ getRestartableData()

template<typename T , typename... Args>

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

protectedinherited

Declare a piece of data as "restartable" and initialize it Similar to declareRestartableData but returns a const reference to the object.

Forwarded arguments are not allowed in this case because we assume that the object is restarted and we won't need different constructors to initialize it.

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

Parameters

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

Definition at line 287 of file Restartable.h.

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

◆ getSharedPtr() [1/2]

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

inherited

Get another shared pointer to this object that has the same ownership group.

Wrapper around shared_from_this().

Definition at line 68 of file MooseObject.C.

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

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

◆ getSharedPtr() [2/2]

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

inherited

Definition at line 81 of file MooseObject.C.

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

◆ init()

void TimeIntegrator::init ( )

virtualinherited

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

Referenced by CrankNicolson::init().

 {
   if (!_var_restriction)
     return;
 
   const auto & var_names = getParam<std::vector<VariableName>>("variables");
   std::vector<unsigned int> var_num_vec;
   auto & lm_sys = _sys.system();
   lm_sys.get_all_variable_numbers(var_num_vec);
   std::unordered_set<unsigned int> var_nums(var_num_vec.begin(), var_num_vec.end());
   for (const auto & var_name : var_names)
     if (lm_sys.has_variable(var_name))
     {
       const auto var_num = lm_sys.variable_number(var_name);
       _vars.insert(var_num);
       var_nums.erase(var_num);
     }
 
   // If var_nums is empty then that means the user has specified all the variables in this system
   if (var_nums.empty())
   {
     _var_restriction = false;
     return;
   }
 
   std::vector<dof_id_type> var_dof_indices, work_vec;
   for (const auto var_num : _vars)
   {
     work_vec = _local_indices;
     _local_indices.clear();
     lm_sys.get_dof_map().local_variable_indices(var_dof_indices, lm_sys.get_mesh(), var_num);
     std::merge(work_vec.begin(),
                work_vec.end(),
                var_dof_indices.begin(),
                var_dof_indices.end(),
                std::back_inserter(_local_indices));
   }
 
   _solution_sub = NumericVector<Number>::build(_solution->comm());
   _solution_old_sub = NumericVector<Number>::build(_solution_old.comm());
 }

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

Definition at line 61 of file TimeIntegrator.h.

61 {}

◆ integratesVar()

bool TimeIntegrator::integratesVar ( const unsigned int var_num ) const

inherited

Returns: whether this integrator integrates the given variable

Definition at line 146 of file TimeIntegrator.C.

Referenced by TimeIntegrator::computeDuDotDu(), and CrankNicolson::computeTimeDerivatives().

 {
   if (!_var_restriction)
     return true;
 
   return _vars.count(var_num);
 }

◆ isExplicit()

virtual bool TimeIntegrator::isExplicit ( ) const

inlinevirtualinherited

Returns whether the explicit solvers are used.

Reimplemented in ExplicitTimeIntegrator.

Definition at line 128 of file TimeIntegrator.h.

Referenced by HDGKernel::HDGKernel().

128 { return false; }

◆ isLumped()

virtual const bool& TimeIntegrator::isLumped ( ) const

inlinevirtualinherited

Returns whether mass matrix is lumped.

Definition at line 146 of file TimeIntegrator.h.

146 { return _is_lumped; }

TimeIntegrator::_is_lumped

bool _is_lumped

Boolean flag that is set to true if lumped mass matrix is used.

Definition: TimeIntegrator.h:225

◆ isParamSetByUser()

bool MooseBaseParameterInterface::isParamSetByUser ( const std::string & nm ) const

inlineinherited

Test if the supplied parameter is set by a user, as opposed to not set or set to default.

Parameters

nm	The name of the parameter to test

Definition at line 128 of file MooseBaseParameterInterface.h.

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

128 { return _pars.isParamSetByUser(nm); }

InputParameters::isParamSetByUser

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

Method returns true if the parameter was set by the user.

Definition: InputParameters.C:1178

MooseBaseParameterInterface::_pars

const InputParameters & _pars

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

Definition: MooseBaseParameterInterface.h:173

◆ isParamValid()

bool MooseBaseParameterInterface::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 122 of file MooseBaseParameterInterface.h.

122 { return _pars.isParamValid(name); }

MooseBaseParameterInterface::_pars

const InputParameters & _pars

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

Definition: MooseBaseParameterInterface.h:173

InputParameters::isParamValid

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

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

Definition: InputParameters.C:390

◆ mooseDeprecated()

template<typename... Args>

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

inlineinherited

Definition at line 91 of file MooseBaseErrorInterface.h.

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

   {
     moose::internal::mooseDeprecatedStream(
         _console, false, true, _moose_base.errorPrefix("deprecation"), std::forward<Args>(args)...);
   }

◆ mooseDocumentedError()

template<typename... Args>

void MooseBaseErrorInterface::mooseDocumentedError	(	const std::string &	repo_name,
		const unsigned int	issue_num,
		Args &&...	args
	)		const

inlineinherited

Emits a documented error with object name and type.

Documented errors are errors that have an issue associated with them.

The repository name repo_name links a named repository to a URL and should be registered at the application level with registerRepository(). See Moose.C for an example of the "moose" repository registration.

Parameters

repo_name	The repository name where the issue resides
issue_num	The number of the issue
args	The error message to be combined

Definition at line 61 of file MooseBaseErrorInterface.h.

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

   {
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     const auto msg = moose::internal::formatMooseDocumentedError(repo_name, issue_num, oss.str());
     _moose_base.callMooseError(msg, /* with_prefix = */ true);
   }

◆ mooseError()

template<typename... Args>

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

inlineinherited

Emits an error prefixed with object name and type.

Definition at line 29 of file MooseBaseErrorInterface.h.

   {
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     _moose_base.callMooseError(oss.str(), /* with_prefix = */ true);
   }

◆ mooseErrorNonPrefixed()

template<typename... Args>

void MooseBaseErrorInterface::mooseErrorNonPrefixed ( Args &&... args ) const

inlineinherited

Emits an error without the prefixing included in mooseError().

Definition at line 40 of file MooseBaseErrorInterface.h.

   {
     std::ostringstream oss;
     moose::internal::mooseStreamAll(oss, std::forward<Args>(args)...);
     _moose_base.callMooseError(oss.str(), /* with_prefix = */ false);
   }

◆ mooseInfo()

template<typename... Args>

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

inlineinherited

Definition at line 98 of file MooseBaseErrorInterface.h.

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

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

◆ mooseWarning()

template<typename... Args>

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

inlineinherited

Emits a warning prefixed with object name and type.

Definition at line 75 of file MooseBaseErrorInterface.h.

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

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

◆ mooseWarningNonPrefixed()

template<typename... Args>

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

inlineinherited

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

Definition at line 85 of file MooseBaseErrorInterface.h.

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

◆ name()

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

inlinevirtualinherited

Get the name of the class.

Returns: The name of the class

Reimplemented in MooseVariableBase.

Definition at line 57 of file MooseBase.h.

57 { return _name; }

MooseBase::_name

const std::string _name

The name of this class.

Definition: MooseBase.h:90

◆ numStatesRequired()

virtual unsigned int TimeIntegrator::numStatesRequired ( ) const

inlinevirtualinherited

Return the number of states this requires in a linear system setting.

Definition at line 141 of file TimeIntegrator.h.

Referenced by ImplicitEuler::timeDerivativeRHSContribution().

141 { return 1; }

◆ order()

virtual int LStableDirk3::order ( )

inlineoverridevirtual

Implements TimeIntegrator.

Definition at line 47 of file LStableDirk3.h.

47 { return 3; }

◆ overridesSolve()

virtual bool LStableDirk3::overridesSolve ( ) const

inlineoverridevirtual

Returns: Whether the virtual solve method is overridden

Implements TimeIntegrator.

Definition at line 54 of file LStableDirk3.h.

54 { return true; }

◆ paramError()

template<typename... Args>

void MooseBaseParameterInterface::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 255 of file MooseBaseParameterInterface.h.

 {
   Moose::show_trace = false;
   _moose_base.callMooseError(paramErrorMsg(param, std::forward<Args>(args)...),
                              /* with_prefix = */ false);
   Moose::show_trace = true;
 }

◆ parameters()

const InputParameters& MooseBaseParameterInterface::parameters ( ) const

inlineinherited

Get the parameters of the object.

Returns: The parameters of the object

Definition at line 62 of file MooseBaseParameterInterface.h.

62 { return _pars; }

MooseBaseParameterInterface::_pars

const InputParameters & _pars

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

Definition: MooseBaseParameterInterface.h:173

◆ paramInfo()

template<typename... Args>

void MooseBaseParameterInterface::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 272 of file MooseBaseParameterInterface.h.

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

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

◆ paramWarning()

template<typename... Args>

void MooseBaseParameterInterface::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 265 of file MooseBaseParameterInterface.h.

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

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

◆ postResidual()

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

overridevirtual

Callback to the NonLinearTimeIntegratorInterface 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 NonlinearTimeIntegratorInterface.

Definition at line 130 of file LStableDirk3.C.

 {
   // Error if _stage got messed up somehow.
   if (_stage > 3)
     mooseError(
         "LStableDirk3::postResidual(): Member variable _stage can only have values 1, 2, or 3.");
 
   // In the standard RK notation, the residual of stage 1 of s is given by:
   //
   // R := M*(Y_i - y_n)/dt - \sum_{j=1}^s a_{ij} * f(t_n + c_j*dt, Y_j) = 0
   //
   // where:
   // .) M is the mass matrix
   // .) Y_i is the stage solution
   // .) dt is the timestep, and is accounted for in the _Re_time residual.
   // .) f are the "non-time" residuals evaluated for a given stage solution.
   // .) The minus signs are already "baked in" to the residuals and so do not appear below.
 
   // Store this stage's non-time residual.  We are calling operator=
   // here, and that calls close().
   *_stage_residuals[_stage - 1] = *_Re_non_time;
 
   // Build up the residual for this stage.
   residual.add(1., *_Re_time);
   for (unsigned int j = 0; j < _stage; ++j)
     residual.add(_a[_stage - 1][j], *_stage_residuals[j]);
   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 83 of file TimeIntegrator.h.

83 {}

◆ postStep()

virtual void TimeIntegrator::postStep ( )

inlinevirtualinherited

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

Reimplemented in CrankNicolson.

Definition at line 88 of file TimeIntegrator.h.

88 {}

◆ preSolve()

virtual void TimeIntegrator::preSolve ( )

inlinevirtualinherited

Reimplemented in ExplicitRK2, ExplicitTVDRK2, ExplicitTimeIntegrator, and ExplicitEuler.

Definition at line 68 of file TimeIntegrator.h.

68 {}

◆ preStep()

virtual void TimeIntegrator::preStep ( )

inlinevirtualinherited

Reimplemented in BDF2.

Definition at line 69 of file TimeIntegrator.h.

69 {}

◆ queryParam()

template<typename T >

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

inherited

Query a parameter for the object.

If the parameter is not valid, nullptr will be returned

Parameters

name	The name of the parameter

Returns: A pointer to the parameter value, if it exists

Definition at line 222 of file MooseBaseParameterInterface.h.

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

◆ restartableName()

std::string Restartable::restartableName ( const std::string & data_name ) const

protectedinherited

Gets the name of a piece of restartable data given a data name, adding the system name and object name prefix.

This should only be used in this interface and in testing.

Definition at line 66 of file Restartable.C.

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

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

◆ setNumIterationsLastSolve()

void TimeIntegrator::setNumIterationsLastSolve ( )

inherited

Record the linear and nonlinear iterations from a just finished solve.

Definition at line 110 of file TimeIntegrator.C.

 {
   _n_nonlinear_iterations = getNumNonlinearIterationsLastSolve();
   _n_linear_iterations = getNumLinearIterationsLastSolve();
 }

◆ solve()

void LStableDirk3::solve ( )

overridevirtual

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

Reimplemented from TimeIntegrator.

Definition at line 83 of file LStableDirk3.C.

 {
   // Time at end of step
   Real time_old = _fe_problem.timeOld();
 
   // Reset iteration counts
   _n_nonlinear_iterations = 0;
   _n_linear_iterations = 0;
 
   // A for-loop would increment _stage too far, so we use an extra
   // loop counter.
   for (unsigned int current_stage = 1; current_stage < 4; ++current_stage)
   {
     // Set the current stage value
     _stage = current_stage;
 
     // This ensures that all the Output objects in the OutputWarehouse
     // have had solveSetup() called, and sets the default solver
     // parameters for PETSc.
     _fe_problem.initPetscOutputAndSomeSolverSettings();
 
     _console << "Stage " << _stage << std::endl;
 
     // Set the time for this stage
     _fe_problem.time() = time_old + _c[_stage - 1] * _dt;
 
     // If we previously used coloring, destroy the old object so it doesn't leak when we allocate a
     // new object in the following lines
     _nl->destroyColoring();
 
     // Potentially setup finite differencing contexts for the solve
     _nl->potentiallySetupFiniteDifferencing();
 
     // Do the solve
     _nl->system().solve();
 
     // Update the iteration counts
     _n_nonlinear_iterations += getNumNonlinearIterationsLastSolve();
     _n_linear_iterations += getNumLinearIterationsLastSolve();
 
     // Abort time step immediately on stage failure - see TimeIntegrator doc page
     if (!_fe_problem.converged(_nl->number()))
       return;
   }
 }

◆ timeDerivativeMatrixContribution()

Real LinearTimeIntegratorInterface::timeDerivativeMatrixContribution ( const Real factor ) const

virtualinherited

The time derivative's contribution to the right hand side of a linear system.

For now, this does not depend of the DoF index, might change in the future.

Reimplemented in ImplicitEuler.

Definition at line 33 of file LinearTimeIntegratorInterface.C.

Referenced by LinearFVTimeDerivative::computeMatrixContribution().

 {
   mooseError("The time derivative matrix contribution has not been implemented yet",
              _linear_system ? " for time integrator of system " + _linear_system->name() : "",
              "!");
 }

◆ timeDerivativeRHSContribution()

Real LinearTimeIntegratorInterface::timeDerivativeRHSContribution	(	dof_id_type	dof_id,
		const std::vector< Real > &	factors = `{}`
	)		const

virtualinherited

The time derivative's contribution to the right hand side of a linear system.

Parameters

dof_id	The dof index at which this contribution should be fetched at
factors	Multiplicative factor (e.g. a material property) at multiple states (old, older, etc)

Reimplemented in ImplicitEuler.

Definition at line 24 of file LinearTimeIntegratorInterface.C.

Referenced by LinearFVTimeDerivative::computeRightHandSideContribution().

 {
   mooseError("The time derivative right hand side contribution has not been implemented yet",
              _linear_system ? " for time integrator of system " + _linear_system->name() : "",
              "!");
 }

◆ type()

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

inlineinherited

Get the type of this class.

Returns: the name of the type of this class

Definition at line 51 of file MooseBase.h.

51 { return _type; }

MooseBase::_type

const std::string _type

The type of this class.

Definition: MooseBase.h:87

◆ typeAndName()

std::string MooseBase::typeAndName ( ) const

inherited

Get the class's combined type and name; useful in error handling.

Returns: The type and name of this class in the form '<type()> "<name()>"'.

Definition at line 27 of file MooseBase.C.

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

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

◆ uDotDotFactorTag()

TagID NonlinearTimeIntegratorInterface::uDotDotFactorTag ( ) const

inlineinherited

Returns the tag for the nodal multiplication factor for the residual calculation of the udotdot term.

By default, this tag will be associated with udotdot.

Definition at line 62 of file NonlinearTimeIntegratorInterface.h.

62 { return _u_dotdot_factor_tag; }

NonlinearTimeIntegratorInterface::_u_dotdot_factor_tag

const TagID _u_dotdot_factor_tag

The vector tag for the nodal multiplication factor for the residual calculation of the udotdot term...

Definition: NonlinearTimeIntegratorInterface.h:89

◆ uDotFactorTag()

TagID NonlinearTimeIntegratorInterface::uDotFactorTag ( ) const

inlineinherited

Returns the tag for the nodal multiplication factor for the residual calculation of the udot term.

By default, this tag will be associated with udot.

Definition at line 55 of file NonlinearTimeIntegratorInterface.h.

55 { return _u_dot_factor_tag; }

NonlinearTimeIntegratorInterface::_u_dot_factor_tag

const TagID _u_dot_factor_tag

The vector tag for the nodal multiplication factor for the residual calculation of the udot term...

Definition: NonlinearTimeIntegratorInterface.h:86

◆ uniqueName()

MooseObjectName MooseBaseParameterInterface::uniqueName ( ) const

inlineinherited

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

Definition at line 67 of file MooseBaseParameterInterface.h.

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

   {
     return MooseObjectName(_pars.get<std::string>("_unique_name"));
   }

◆ uniqueParameterName()

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

inlineinherited

The unique parameter name of a valid parameter of this object for accessing parameter controls.

Definition at line 52 of file MooseBaseParameterInterface.h.

   {
     return MooseObjectParameterName(
         _pars.get<std::string>("_moose_base"), _moose_base.name(), parameter_name);
   }

◆ validParams()

InputParameters LStableDirk3::validParams ( )

static

Definition at line 19 of file LStableDirk3.C.

 {
   InputParameters params = TimeIntegrator::validParams();
   params.addClassDescription(
       "Third order diagonally implicit Runge Kutta method (Dirk) with three stages.");
   return params;
 }

Member Data Documentation

◆ _a

Real LStableDirk3::_a[3][3]

protected

Definition at line 81 of file LStableDirk3.h.

Referenced by LStableDirk3(), and postResidual().

◆ _action_factory

ActionFactory& MooseBaseParameterInterface::_action_factory

protectedinherited

Builds Actions.

Definition at line 179 of file MooseBaseParameterInterface.h.

Referenced by AddActionComponentAction::act(), CreateMeshSetupActionsForComponents::act(), ActionComponent::checkRequiredTasks(), PhysicsBase::checkRequiredTasks(), CommonOutputAction::create(), AddVariableAction::createInitialConditionAction(), DynamicObjectRegistrationAction::DynamicObjectRegistrationAction(), CreateExecutionerAction::setupAutoPreconditioning(), and ReadExecutorParamsAction::setupAutoPreconditioning().

◆ _app

MooseApp& MooseBase::_app

protectedinherited

The MOOSE application this is associated with.

Definition at line 84 of file MooseBase.h.

◆ _c

Real LStableDirk3::_c[3]

protected

Definition at line 74 of file LStableDirk3.h.

Referenced by LStableDirk3(), and solve().

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

The current time step size.

Definition at line 214 of file TimeIntegrator.h.

◆ _dt_old

Real& TimeIntegrator::_dt_old

protectedinherited

The previous time step size.

Definition at line 217 of file TimeIntegrator.h.

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

◆ _du_dot_du

std::vector<Real>& TimeIntegrator::_du_dot_du

protectedinherited

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

We will only modify the elements in this vector corresponding to the variables that we integrate

Definition at line 200 of file TimeIntegrator.h.

Referenced by TimeIntegrator::computeDuDotDu(), and CrankNicolson::computeTimeDerivatives().

◆ _enabled

const bool& MooseObject::_enabled

protectedinherited

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

Definition at line 51 of file MooseObject.h.

Referenced by MooseObject::enabled().

◆ _factory

Factory& MooseBaseParameterInterface::_factory

protectedinherited

The Factory associated with the MooseApp.

Definition at line 176 of file MooseBaseParameterInterface.h.

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

◆ _fe_problem

FEProblemBase& TimeIntegrator::_fe_problem

protectedinherited

Reference to the problem.

Definition at line 192 of file TimeIntegrator.h.

Referenced by CentralDifference::CentralDifference(), NewmarkBeta::computeTimeDerivatives(), ExplicitTimeIntegrator::ExplicitTimeIntegrator(), CrankNicolson::init(), ExplicitTimeIntegrator::init(), ExplicitTimeIntegrator::initialSetup(), ExplicitTimeIntegrator::meshChanged(), NewmarkBeta::NewmarkBeta(), ExplicitSSPRungeKutta::postResidual(), ActuallyExplicitEuler::postResidual(), ExplicitEuler::preSolve(), ExplicitTVDRK2::preSolve(), ExplicitRK2::preSolve(), ExplicitSSPRungeKutta::solve(), ActuallyExplicitEuler::solve(), LStableDirk2::solve(), solve(), ImplicitMidpoint::solve(), ExplicitTVDRK2::solve(), LStableDirk4::solve(), AStableDirk4::solve(), ExplicitRK2::solve(), ExplicitTimeIntegrator::solveLinearSystem(), ExplicitSSPRungeKutta::solveStage(), and TimeIntegrator::TimeIntegrator().

◆ _from_subvector

std::unique_ptr<NumericVector<Number> > TimeIntegrator::_from_subvector

protectedinherited

A vector that is used for creating 'from' subvectors in the copyVector() method.

Definition at line 238 of file TimeIntegrator.h.

Referenced by TimeIntegrator::copyVector().

◆ _gamma

const Real LStableDirk3::_gamma

protected

Definition at line 70 of file LStableDirk3.h.

Referenced by LStableDirk3().

◆ _is_lumped

bool TimeIntegrator::_is_lumped

protectedinherited

Boolean flag that is set to true if lumped mass matrix is used.

Definition at line 225 of file TimeIntegrator.h.

Referenced by CentralDifference::CentralDifference(), and TimeIntegrator::isLumped().

◆ _linear_implicit_system

libMesh::LinearImplicitSystem* LinearTimeIntegratorInterface::_linear_implicit_system

protectedinherited

Nonlinear implicit system, if applicable; otherwise, nullptr.

Definition at line 51 of file LinearTimeIntegratorInterface.h.

◆ _linear_system

LinearSystem* LinearTimeIntegratorInterface::_linear_system

protectedinherited

Pointer to the linear system, can happen that we dont have any.

Definition at line 48 of file LinearTimeIntegratorInterface.h.

Referenced by LinearTimeIntegratorInterface::timeDerivativeMatrixContribution(), and LinearTimeIntegratorInterface::timeDerivativeRHSContribution().

◆ _local_indices

std::vector<dof_id_type>& TimeIntegrator::_local_indices

protectedinherited

The local degree of freedom indices this time integrator is being applied to.

If this container is empty then the time integrator is applied to all indices

Definition at line 232 of file TimeIntegrator.h.

Referenced by ImplicitEuler::computeTimeDerivatives(), CrankNicolson::computeTimeDerivatives(), TimeIntegrator::copyVector(), TimeIntegrator::init(), ImplicitEuler::postResidual(), and CrankNicolson::postResidual().

◆ _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 222 of file TimeIntegrator.h.

Referenced by TimeIntegrator::getNumLinearIterations(), ExplicitTimeIntegrator::performExplicitSolve(), TimeIntegrator::setNumIterationsLastSolve(), ExplicitSSPRungeKutta::solve(), ActuallyExplicitEuler::solve(), LStableDirk2::solve(), solve(), ImplicitMidpoint::solve(), ExplicitTVDRK2::solve(), LStableDirk4::solve(), AStableDirk4::solve(), ExplicitRK2::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 220 of file TimeIntegrator.h.

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

◆ _name

const std::string MooseBase::_name

protectedinherited

The name of this class.

Definition at line 90 of file MooseBase.h.

◆ _nl

NonlinearSystemBase* NonlinearTimeIntegratorInterface::_nl

protectedinherited

Pointer to the nonlinear system, can happen that we dont have any.

Definition at line 74 of file NonlinearTimeIntegratorInterface.h.

Referenced by NonlinearTimeIntegratorInterface::addVector(), ExplicitTimeIntegrator::ExplicitTimeIntegrator(), CrankNicolson::init(), ExplicitTimeIntegrator::init(), CentralDifference::initialSetup(), ExplicitTimeIntegrator::initialSetup(), ActuallyExplicitEuler::solve(), LStableDirk2::solve(), solve(), ImplicitMidpoint::solve(), ExplicitTVDRK2::solve(), LStableDirk4::solve(), AStableDirk4::solve(), ExplicitRK2::solve(), and ExplicitSSPRungeKutta::solveStage().

◆ _nonlinear_implicit_system

libMesh::NonlinearImplicitSystem* NonlinearTimeIntegratorInterface::_nonlinear_implicit_system

protectedinherited

libMesh nonlinear implicit system, if applicable; otherwise, nullptr

Definition at line 77 of file NonlinearTimeIntegratorInterface.h.

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

◆ _pars

const InputParameters& MooseBaseParameterInterface::_pars

protectedinherited

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

Definition at line 173 of file MooseBaseParameterInterface.h.

◆ _Re_non_time

NumericVector<Number>* NonlinearTimeIntegratorInterface::_Re_non_time

protectedinherited

residual vector for non-time contributions

Definition at line 83 of file NonlinearTimeIntegratorInterface.h.

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

◆ _Re_time

NumericVector<Number>* NonlinearTimeIntegratorInterface::_Re_time

protectedinherited

residual vector for time contributions

Definition at line 80 of file NonlinearTimeIntegratorInterface.h.

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

◆ _restartable_app

MooseApp& Restartable::_restartable_app

protectedinherited

Reference to the application.

Definition at line 227 of file Restartable.h.

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

◆ _restartable_read_only

const bool Restartable::_restartable_read_only

protectedinherited

Flag for toggling read only status (see ReporterData)

Definition at line 236 of file Restartable.h.

Referenced by Restartable::registerRestartableDataOnApp().

◆ _restartable_system_name

const std::string Restartable::_restartable_system_name

protectedinherited

The system name this object is in.

Definition at line 230 of file Restartable.h.

Referenced by Restartable::restartableName().

◆ _restartable_tid

const THREAD_ID Restartable::_restartable_tid

protectedinherited

The thread ID for this object.

Definition at line 233 of file Restartable.h.

Referenced by Restartable::declareRestartableDataHelper().

◆ _solution

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

protectedinherited

Solution vectors for different states and variable restrictions

Definition at line 204 of file TimeIntegrator.h.

◆ _solution_old

const NumericVector<Number>& TimeIntegrator::_solution_old

protectedinherited

Definition at line 205 of file TimeIntegrator.h.

◆ _solution_old_sub

std::unique_ptr<NumericVector<Number> >& TimeIntegrator::_solution_old_sub

protectedinherited

Definition at line 207 of file TimeIntegrator.h.

Referenced by ImplicitEuler::computeTimeDerivatives(), CrankNicolson::computeTimeDerivatives(), and TimeIntegrator::init().

◆ _solution_sub

std::unique_ptr<NumericVector<Number> >& TimeIntegrator::_solution_sub

protectedinherited

Definition at line 206 of file TimeIntegrator.h.

Referenced by ImplicitEuler::computeTimeDerivatives(), CrankNicolson::computeTimeDerivatives(), and TimeIntegrator::init().

◆ _stage

unsigned int LStableDirk3::_stage

protected

Definition at line 64 of file LStableDirk3.h.

Referenced by postResidual(), and solve().

◆ _stage_residuals

NumericVector<Number>* LStableDirk3::_stage_residuals[3]

protected

Definition at line 67 of file LStableDirk3.h.

Referenced by LStableDirk3(), and postResidual().

◆ _sys

SystemBase& TimeIntegrator::_sys

protectedinherited

Reference to the system this time integrator operates on.

Definition at line 195 of file TimeIntegrator.h.

◆ _t_step

int& TimeIntegrator::_t_step

protectedinherited

The current time step number.

Definition at line 211 of file TimeIntegrator.h.

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

◆ _type

const std::string MooseBase::_type

protectedinherited

The type of this class.

Definition at line 87 of file MooseBase.h.

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

◆ _u_dot_factor_tag

const TagID NonlinearTimeIntegratorInterface::_u_dot_factor_tag

protectedinherited

The vector tag for the nodal multiplication factor for the residual calculation of the udot term.

Definition at line 86 of file NonlinearTimeIntegratorInterface.h.

Referenced by CentralDifference::computeTimeDerivatives(), CentralDifference::initialSetup(), and NonlinearTimeIntegratorInterface::uDotFactorTag().

◆ _u_dotdot_factor_tag

const TagID NonlinearTimeIntegratorInterface::_u_dotdot_factor_tag

protectedinherited

The vector tag for the nodal multiplication factor for the residual calculation of the udotdot term.

Definition at line 89 of file NonlinearTimeIntegratorInterface.h.

Referenced by CentralDifference::computeTimeDerivatives(), CentralDifference::initialSetup(), and NonlinearTimeIntegratorInterface::uDotDotFactorTag().

◆ _var_restriction

bool& TimeIntegrator::_var_restriction

protectedinherited

Whether the user has requested that the time integrator be applied to a subset of variables.

Definition at line 228 of file TimeIntegrator.h.

Referenced by ImplicitEuler::computeTimeDerivatives(), CrankNicolson::computeTimeDerivatives(), TimeIntegrator::copyVector(), TimeIntegrator::init(), TimeIntegrator::integratesVar(), ImplicitEuler::postResidual(), and CrankNicolson::postResidual().

◆ _vars

std::unordered_set<unsigned int>& TimeIntegrator::_vars

protectedinherited

The variables that this time integrator integrates.

Definition at line 235 of file TimeIntegrator.h.

Referenced by TimeIntegrator::init(), ExplicitTimeIntegrator::initialSetup(), and TimeIntegrator::integratesVar().

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

include/timeintegrators/LStableDirk3.h
src/timeintegrators/LStableDirk3.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

1 | (1/4)*(-6*gamma**2 + 16*gamma - 1) (1/4)*(6*gamma**2 - 20*gamma + 5) gamma

Member Typedef Documentation

◆ DataFileParameterType

Constructor & Destructor Documentation

◆ LStableDirk3()

Member Function Documentation

◆ addVector()

◆ advancesProblemState()

◆ callMooseError()

◆ computeADTimeDerivatives()

◆ computeDuDotDu()

◆ computeTimeDerivativeHelper()

◆ computeTimeDerivatives()

◆ connectControllableParams()

◆ copyVector()

◆ declareManagedRestartableDataWithContext()

◆ declareRecoverableData()

◆ declareRestartableData()

◆ declareRestartableDataWithContext()

◆ declareRestartableDataWithObjectName()

◆ declareRestartableDataWithObjectNameWithContext()

◆ dt()

◆ duDotDuCoeff()

◆ enabled()

◆ errorPrefix()

◆ getCheckedPointerParam()

◆ getDataFileName()

◆ getDataFileNameByName()

◆ getDataFilePath()

◆ getMooseApp()

◆ getNumLinearIterations()

◆ getNumLinearIterationsLastSolve()

◆ getNumNonlinearIterations()

◆ getNumNonlinearIterationsLastSolve()

◆ getParam() [1/2]

◆ getParam() [2/2]

◆ getRenamedParam()

◆ getRestartableData()

◆ getSharedPtr() [1/2]

◆ getSharedPtr() [2/2]

◆ init()

◆ initialSetup()

◆ integratesVar()

◆ isExplicit()

◆ isLumped()

◆ isParamSetByUser()

◆ isParamValid()

◆ mooseDeprecated()

◆ mooseDocumentedError()

◆ mooseError()

◆ mooseErrorNonPrefixed()

◆ mooseInfo()

◆ mooseWarning()

◆ mooseWarningNonPrefixed()

◆ name()

◆ numStatesRequired()

◆ order()

◆ overridesSolve()

◆ paramError()

◆ parameters()

◆ paramInfo()

◆ paramWarning()

◆ postResidual()

◆ postSolve()

◆ postStep()

◆ preSolve()

◆ preStep()

◆ queryParam()

◆ restartableName()

◆ setNumIterationsLastSolve()

◆ solve()

◆ timeDerivativeMatrixContribution()

◆ timeDerivativeRHSContribution()

1 | (1/4)(-6gamma**2 + 16gamma - 1) (1/4)(6*gamma**2 - 20*gamma + 5) gamma