Base (abstract) class that stores information of temporal integration. More...

#include <timeintegration.h>

Inheritance diagram for petibm::timeintegration::TimeIntegrationBase:

Public Member Functions
	TimeIntegrationBase ()
	Default constructor. More...

	TimeIntegrationBase (const std::string &inName, const std::string &inScheme, const PetscReal &inImplicitCoeff, const PetscInt &inNEcplicit, const type::RealVec1D &inExplicitCoeffs)
	Constructor (normally not being used publicly). More...

virtual	~TimeIntegrationBase ()=default
	Destructor. More...

PetscErrorCode	printInfo () const
	Print information to standard output. More...

Public Attributes
const std::string	name
	Name of current instance. More...

const std::string	scheme
	Name of the scheme. More...

const PetscReal	implicitCoeff
	Coefficient of implicit term. More...

const PetscInt	nExplicit
	Number of explicit terms. More...

const type::RealVec1D	explicitCoeffs
	Coefficients of explicit terms. More...

Detailed Description

Base (abstract) class that stores information of temporal integration.

See also: Time-integration schemes

Definition at line 44 of file timeintegration.h.

Constructor & Destructor Documentation

◆ TimeIntegrationBase() [1/2]

petibm::timeintegration::TimeIntegrationBase::TimeIntegrationBase ( )

inline

Default constructor.

Definition at line 63 of file timeintegration.h.

◆ TimeIntegrationBase() [2/2]

petibm::timeintegration::TimeIntegrationBase::TimeIntegrationBase	(	const std::string &	inName,
		const std::string &	inScheme,
		const PetscReal &	inImplicitCoeff,
		const PetscInt &	inNEcplicit,
		const type::RealVec1D &	inExplicitCoeffs
	)

inline

Constructor (normally not being used publicly).

Parameters

inName	[in] the name of the instance.
inScheme	[in] the name of the scheme.
inImplicitCoeff	[in] implicit coefficient.
inNEcplicit	[in] number of explicit coefficients.
inExplicitCoeffs	[in] a std::vector holding all explicit coefficients.

Definition at line 74 of file timeintegration.h.

◆ ~TimeIntegrationBase()

virtual petibm::timeintegration::TimeIntegrationBase::~TimeIntegrationBase ( )

virtualdefault

Destructor.

Member Function Documentation

◆ printInfo()

PetscErrorCode petibm::timeintegration::TimeIntegrationBase::printInfo ( ) const

Print information to standard output.

Returns: PetscErrorCode.

Definition at line 15 of file timeintegration.cpp.

Member Data Documentation

◆ explicitCoeffs

const type::RealVec1D petibm::timeintegration::TimeIntegrationBase::explicitCoeffs

Coefficients of explicit terms.

Definition at line 60 of file timeintegration.h.

◆ implicitCoeff

const PetscReal petibm::timeintegration::TimeIntegrationBase::implicitCoeff

Coefficient of implicit term.

Definition at line 54 of file timeintegration.h.

◆ name

const std::string petibm::timeintegration::TimeIntegrationBase::name

Name of current instance.

Definition at line 48 of file timeintegration.h.

◆ nExplicit

const PetscInt petibm::timeintegration::TimeIntegrationBase::nExplicit

Number of explicit terms.

Definition at line 57 of file timeintegration.h.

◆ scheme

const std::string petibm::timeintegration::TimeIntegrationBase::scheme

Name of the scheme.

Definition at line 51 of file timeintegration.h.

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

include/petibm/timeintegration.h
src/timeintegration/timeintegration.cpp

Public Member Functions

Public Attributes