Base class for integrating the first order ODE (IVP) More...

Inheritance diagram for integration:

Collaboration diagram for integration:

Public Member Functions
	TypeInfo ("integration")
	Type info. More...

	integration (const word &baseName, repository &owner, const pointStructure &pStruct, const word &method)
	Construct from components. More...

	integration (const integration &)=default
	Copy constructor. More...

	integration (integration &&)=default
	Move constructor. More...

integration &	operator= (const integration &)=default
	Copy assignment. More...

integration &	operator= (integration &&)=default
	Move assignment. More...

virtual uniquePtr< integration >	clone () const =0
	Polymorphic copy/cloning. More...

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

	create_vCtor (integration, word,(const word &baseName, repository &owner, const pointStructure &pStruct, const word &method),(baseName, owner, pStruct, method))
	Add a virtual constructor. More...

const auto &	pStruct () const
	Const ref to pointStructure. More...

const word &	baseName () const
	Base name. More...

repository &	owner ()
	Ref to the owner repository. More...

virtual bool	predict (real dt, realx3Vector_D &y, realx3Vector_D &dy)=0
	Prediction step in integration. More...

virtual bool	correct (real dt, realx3Vector_D &y, realx3Vector_D &dy)=0
	Correction/main integration step. More...

virtual bool	setInitialVals (const int32IndexContainer &newIndices, const realx3Vector &y)=0
	Set the initial values for new indices. More...

virtual bool	needSetInitialVals () const =0
	Check if the method requires any set initial vals. More...

Static Public Member Functions
static uniquePtr< integration >	create (const word &baseName, repository &owner, const pointStructure &pStruct, const word &method)
	Create the polymorphic object based on inputs. More...

Protected Attributes
repository &	owner_
	The owner repository that all fields are storred in. More...

const word	baseName_
	The base name for integration. More...

const pointStructure &	pStruct_
	A reference to pointStructure. More...

Detailed Description

Base class for integrating the first order ODE (IVP)

The ODE should be in the following form:

\[ \frac{dy}{dt} = f(y,t) \]

for example the equation of motion is in the following form:

\[ m\frac{d\vec{v}}{dt} = m\vec{g} + \sum \vec{f_c}(\vec{v},t) \]

The integration method can be either one-step or predictor-corrector type.

Definition at line 49 of file integration.hpp.

Constructor & Destructor Documentation

◆ integration() [1/3]

integration	(	const word &	baseName,
		repository &	owner,
		const pointStructure &	pStruct,
		const word &	method
	)

Construct from components.

Definition at line 24 of file integration.cpp.

References CONSUME_PARAM.

◆ integration() [2/3]

integration ( const integration & )

default

Copy constructor.

◆ integration() [3/3]

integration ( integration && )

default

Move constructor.

◆ ~integration()

virtual ~integration ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeInfo()

TypeInfo ( "integration" )

Type info.

◆ operator=() [1/2]

integration& operator= ( const integration & )

default

Copy assignment.

◆ operator=() [2/2]

integration& operator= ( integration && )

default

Move assignment.

◆ clone()

virtual uniquePtr<integration> clone ( ) const

pure virtual

Polymorphic copy/cloning.

Implemented in AdamsBashforth5, AdamsBashforth4, AdamsBashforth3, AdamsMoulton5, AdamsMoulton4, AdamsMoulton3, and AdamsBashforth2.

◆ create_vCtor()

create_vCtor	(	integration	,
		word	,
		(const word &baseName, repository &owner, const pointStructure &pStruct, const word &method)	,
		(baseName, owner, pStruct, method)
	)