Interface class for routines and member variables for time integrators relying on Newton's method. More...

#include <NonlinearTimeIntegratorInterface.h>

Inheritance diagram for NonlinearTimeIntegratorInterface:

Public Member Functions
	NonlinearTimeIntegratorInterface (FEProblemBase &problem, SystemBase &system)

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

virtual void	postJacobian (libMesh::SparseMatrix< Number > &)
	Callback to the NonLinearTimeIntegratorInterface called after the element, face, Dirac and constraint contributions to the system Jacobian are computed, before nodal boundary conditions modify its rows.

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

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

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

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

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

NumericVector< Number > *	_Re_time
	residual vector for time contributions

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

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

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

Detailed Description

Interface class for routines and member variables for time integrators relying on Newton's method.

Definition at line 36 of file NonlinearTimeIntegratorInterface.h.

Constructor & Destructor Documentation

◆ NonlinearTimeIntegratorInterface()

NonlinearTimeIntegratorInterface::NonlinearTimeIntegratorInterface	(	FEProblemBase &	problem,
		SystemBase &	system
	)

Definition at line 18 of file NonlinearTimeIntegratorInterface.C.

  : _nl(dynamic_cast<NonlinearSystemBase *>(&system)),
    _nonlinear_implicit_system(_nl ? dynamic_cast<NonlinearImplicitSystem *>(&_nl->system())
                                   : nullptr),
    _Re_time(_nl ? &_nl->getResidualTimeVector() : nullptr),
    _Re_non_time(_nl ? &_nl->getResidualNonTimeVector() : nullptr),
    _u_dot_factor_tag(problem.addVectorTag(Moose::SOLUTION_DOT_TAG, Moose::VECTOR_TAG_SOLUTION)),
    _u_dotdot_factor_tag(
        problem.addVectorTag(Moose::SOLUTION_DOTDOT_TAG, Moose::VECTOR_TAG_SOLUTION))
{
}

Member Function Documentation

◆ addVector()

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

protected

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 32 of file NonlinearTimeIntegratorInterface.C.

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

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

◆ postJacobian()

virtual void NonlinearTimeIntegratorInterface::postJacobian ( libMesh::SparseMatrix< Number > & )

inlinevirtual

Callback to the NonLinearTimeIntegratorInterface called after the element, face, Dirac and constraint contributions to the system Jacobian are computed, before nodal boundary conditions modify its rows.

Integrators whose postResidual() weights the time and non-time residuals differently apply the same weights to the Jacobian here.

Reimplemented in AStableDirk4, ImplicitMidpoint, LStableDirk2, LStableDirk3, and LStableDirk4.

Definition at line 57 of file NonlinearTimeIntegratorInterface.h.

57{}

◆ postResidual()

virtual void NonlinearTimeIntegratorInterface::postResidual ( NumericVector< Number > & )

inlinevirtual

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 in ActuallyExplicitEuler, AStableDirk4, BDF2, CrankNicolson, ExplicitEuler, ExplicitRK2, ExplicitSSPRungeKutta, ExplicitTVDRK2, ImplicitEuler, ImplicitMidpoint, LStableDirk2, LStableDirk3, LStableDirk4, and NewmarkBeta.