Interface class for routines and member variables for time integrators relying on linear system assembly method. More...

#include <LinearTimeIntegratorInterface.h>

Inheritance diagram for LinearTimeIntegratorInterface:

[legend]

Public Member Functions
	LinearTimeIntegratorInterface (SystemBase &system)

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

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

Detailed Description

Interface class for routines and member variables for time integrators relying on linear system assembly method.

Definition at line 30 of file LinearTimeIntegratorInterface.h.

Constructor & Destructor Documentation

◆ LinearTimeIntegratorInterface()

LinearTimeIntegratorInterface::LinearTimeIntegratorInterface ( SystemBase & system )

Definition at line 16 of file LinearTimeIntegratorInterface.C.

   : _linear_system(dynamic_cast<LinearSystem *>(&system)),
     _linear_implicit_system(
         _linear_system ? dynamic_cast<LinearImplicitSystem *>(&_linear_system->system()) : nullptr)
 {
 }

Member Function Documentation

◆ timeDerivativeMatrixContribution()

Real LinearTimeIntegratorInterface::timeDerivativeMatrixContribution ( const Real factor ) const

virtual

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 BDF2, and 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

virtual

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 BDF2, and 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() : "",
              "!");
 }