Euler-implicit integration scheme. More...

Inheritance diagram for Euler:

Collaboration diagram for Euler:

Public Member Functions
	TypeName ("Euler")
	Runtime type information. More...

	Euler (const ODESystem &ode, const dictionary &dict)
	Construct from ODESystem. More...

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

virtual bool	resize ()
	Resize the ODE solver. More...

virtual scalar	solve (const scalar x0, const scalarField &y0, const scalarField &dydx0, const scalar dx, scalarField &y) const
	Solve a single step dx and return the error. More...

virtual void	solve (scalar &x, scalarField &y, scalar &dxTry) const
	Solve the ODE system and the update the state. More...

virtual void	solve (scalar &x, scalarField &y, scalar &dxTry) const
	Inherit solve from ODESolver. More...

virtual void	solve (scalar &x, scalarField &y, stepState &step) const
	Inherit solve from ODESolver. More...

virtual void	solve (const scalar xStart, const scalar xEnd, scalarField &y, scalar &dxEst) const
	Inherit solve from ODESolver. More...

Public Member Functions inherited from ODESolver
	TypeName ("ODESolver")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, ODESolver, dictionary,(const ODESystem &ode, const dictionary &dict),(ode, dict))

	ODESolver (const ODESystem &ode, const dictionary &dict)
	Construct for given ODESystem. More...

	ODESolver (const ODESystem &ode, const scalarField &absTol, const scalarField &relTol)
	Construct for given ODESystem specifying tolerances. More...

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

label	nEqns () const
	Return the number of equations to solve. More...

scalarField &	absTol ()
	Return access to the absolute tolerance field. More...

scalarField &	relTol ()
	Return access to the relative tolerance field. More...

virtual bool	resize ()=0
	Resize the ODE solver. More...

template<class Type >
void	resizeField (UList< Type > &f) const

void	resizeMatrix (scalarSquareMatrix &m) const

virtual void	solve (scalar &x, scalarField &y, scalar &dxTry) const
	Solve the ODE system as far as possible up to dxTry. More...

virtual void	solve (scalar &x, scalarField &y, stepState &step) const
	Solve the ODE system as far as possible up to dxTry. More...

virtual void	solve (const scalar xStart, const scalar xEnd, scalarField &y, scalar &dxEst) const
	Solve the ODE system from xStart to xEnd, update the state. More...

Public Member Functions inherited from adaptiveSolver
	adaptiveSolver (const ODESystem &ode, const dictionary &dict)
	Construct from ODESystem. More...

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

bool	resize (const label n)
	Resize the ODE solver. More...

virtual scalar	solve (const scalar x0, const scalarField &y0, const scalarField &dydx0, const scalar dx, scalarField &y) const =0
	Solve a single step dx and return the error. More...

void	solve (const ODESystem &ode, scalar &x, scalarField &y, scalar &dxTry) const
	Solve the ODE system and the update the state. More...

Additional Inherited Members
Static Public Member Functions inherited from ODESolver
static autoPtr< ODESolver >	New (const ODESystem &ode, const dictionary &dict)
	Select null constructed. More...

template<class Type >
static void	resizeField (UList< Type > &f, const label n)

Protected Member Functions inherited from ODESolver
scalar	normalizeError (const scalarField &y0, const scalarField &y, const scalarField &err) const
	Return the nomalized scalar error. More...

	ODESolver (const ODESolver &)=delete
	No copy construct. More...

void	operator= (const ODESolver &)=delete
	No copy assignment. More...

Protected Attributes inherited from ODESolver
const ODESystem &	odes_
	Reference to ODESystem. More...

const label	maxN_
	Maximum size of the ODESystem. More...

label	n_
	Size of the ODESystem (adjustable) More...

scalarField	absTol_
	Absolute convergence tolerance per step. More...

scalarField	relTol_
	Relative convergence tolerance per step. More...

label	maxSteps_
	The maximum number of sub-steps allowed for the integration step. More...

Detailed Description

Euler-implicit integration scheme.

Euler ODE solver of order (0)1.

\[ \Delta \phi = (A - B \phi^n) \frac{\Delta t}{1 + B \Delta t} \]

The method calculates the new state from:

\[ y_{n+1} = y_n + \delta_x f \]

The error is estimated directly from the change in the solution, i.e. the difference between the 0th and 1st order solutions:

\[ err_{n+1} = y_{n+1} - y_n \]

Source files

Definition at line 65 of file Euler.H.

Constructor & Destructor Documentation

◆ Euler()

Euler	(	const ODESystem &	ode,
		const dictionary &	dict
	)

Construct from ODESystem.

Definition at line 43 of file Euler.C.

◆ ~Euler()

virtual ~Euler ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "Euler" )

Runtime type information.

◆ resize()

bool resize ( )

virtual

Resize the ODE solver.

Implements ODESolver.

Definition at line 53 of file Euler.C.

References Euler::resize(), and ODESolver::resize().

Referenced by PtrDynList< Foam::Field< label > >::capacity(), PtrListDetail< CloudFunctionObject< CloudType > >::checkNonNull(), directions::directions(), GlobalIOList< Type >::GlobalIOList(), IOField< Type >::IOField(), IOList< label >::IOList(), IOMap< T >::IOMap(), CompactIOField< Foam::Field< label >, label >::operator=(), PtrListDictionary< T >::PtrListDictionary(), Euler::resize(), EulerSI::resize(), RKCK45::resize(), RKDP45::resize(), RKF45::resize(), rodas23::resize(), rodas34::resize(), Rosenbrock12::resize(), Rosenbrock23::resize(), Rosenbrock34::resize(), Trapezoid::resize(), cellZoneSet::updateSet(), faceZoneSet::updateSet(), pointZoneSet::updateSet(), and CompactIOList< face, label >::writeObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ solve() [1/5]

Foam::scalar solve	(	const scalar	x0,
		const scalarField &	y0,
		const scalarField &	dydx0,
		const scalar	dx,
		scalarField &	y
	)		const

virtual

Solve a single step dx and return the error.

Implements adaptiveSolver.

Definition at line 68 of file Euler.C.

References forAll, y, and Foam::y0().

Here is the call graph for this function:

◆ solve() [2/5]

void solve	(	scalar &	x,
		scalarField &	y,
		scalar &	dxTry
	)		const

virtual

Solve the ODE system and the update the state.

Reimplemented from ODESolver.

Definition at line 93 of file Euler.C.

References solve(), x, and y.

Here is the call graph for this function:

◆ solve() [3/5]

void solve	(	scalar &	x,
		scalarField &	y,
		scalar &	dxTry
	)		const

virtual

Inherit solve from ODESolver.

Reimplemented from ODESolver.

Definition at line 197 of file ODESolver.C.

◆ solve() [4/5]

void solve	(	scalar &	x,
		scalarField &	y,
		stepState &	step
	)		const

virtual

Inherit solve from ODESolver.

Reimplemented from ODESolver.

Definition at line 208 of file ODESolver.C.

◆ solve() [5/5]

void solve	(	const scalar	xStart,
		const scalar	xEnd,
		scalarField &	y,
		scalar &	dxEst
	)		const

virtual

Inherit solve from ODESolver.

Reimplemented from ODESolver.

Definition at line 217 of file ODESolver.C.

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

src/ODE/ODESolvers/Euler/Euler.H
src/ODE/ODESolvers/Euler/Euler.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Euler()

◆ ~Euler()

Member Function Documentation

◆ TypeName()

◆ resize()

◆ solve() [1/5]

◆ solve() [2/5]

◆ solve() [3/5]

◆ solve() [4/5]

◆ solve() [5/5]