Semi-implicit Euler ODE solver of order (0)1. More...

Inheritance diagram for EulerSI:

Collaboration diagram for EulerSI:

[legend]

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

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

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

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 ()
	Destructor. More...

scalarField &	absTol ()

scalarField &	relTol ()

virtual void	solve (scalar &x, scalarField &y, stepState &step) const
	Solve the ODE system as far as possible upto 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 ()
	Destructor. More...

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

Private Attributes
scalarField	err_

scalarField	dydx_

scalarField	dfdx_

scalarSquareMatrix	dfdy_

scalarSquareMatrix	a_

labelList	pivotIndices_

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

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 &)
	Disallow default bitwise copy construct. More...

void	operator= (const ODESolver &)
	Disallow default bitwise assignment. More...

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

label	n_
	Size of the ODESystem. 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

Semi-implicit Euler ODE solver of order (0)1.

The method calculates the new state from:

$y_{n+1} = y_n + \delta_x\left[I - \delta_x\frac{\partial f}{\partial y}\right]^{-1} \cdot \left[f(y_n) + \delta_x\frac{\partial f}{\partial x}\right]$

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 61 of file EulerSI.H.

Constructor & Destructor Documentation

◆ EulerSI()

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

Construct from ODE.

Definition at line 40 of file EulerSI.C.

Member Function Documentation

◆ TypeName()

TypeName ( "EulerSI" )

Runtime type information.

◆ 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 56 of file EulerSI.C.

References forAll, Foam::LUBacksubstitute(), Foam::LUDecompose(), 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 96 of file EulerSI.C.

References adaptiveSolver::solve(), x, and y.

Here is the call graph for this function:

◆ solve() [3/5]

virtual void solve

inline

Inherit solve from ODESolver.

Definition at line 178 of file ODESolver.H.

◆ solve() [4/5]

void solve

Inherit solve from ODESolver.

Definition at line 86 of file ODESolver.C.

◆ solve() [5/5]

void solve

Inherit solve from ODESolver.

Definition at line 99 of file ODESolver.C.

Field Documentation

◆ err_

scalarField err_

mutableprivate

Definition at line 68 of file EulerSI.H.

◆ dydx_

scalarField dydx_

mutableprivate

Definition at line 69 of file EulerSI.H.

◆ dfdx_

scalarField dfdx_

mutableprivate

Definition at line 70 of file EulerSI.H.

◆ dfdy_

scalarSquareMatrix dfdy_

mutableprivate

Definition at line 71 of file EulerSI.H.

◆ a_

scalarSquareMatrix a_

mutableprivate

Definition at line 72 of file EulerSI.H.

◆ pivotIndices_

labelList pivotIndices_

mutableprivate

Definition at line 73 of file EulerSI.H.

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

src/ODE/ODESolvers/EulerSI/EulerSI.H
src/ODE/ODESolvers/EulerSI/EulerSI.C

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EulerSI()

Member Function Documentation

◆ TypeName()

◆ solve() [1/5]

◆ solve() [2/5]

◆ solve() [3/5]

◆ solve() [4/5]

◆ solve() [5/5]

Field Documentation

◆ err_

◆ dydx_

◆ dfdx_

◆ dfdy_

◆ a_

◆ pivotIndices_