Detailed Description

template<typename Implementation, unsigned NumEquations>
class MathLib::ODE::ConcreteODESolver< Implementation, NumEquations >

ODE solver with a bounds-safe interface using a concrete implementation.

This class makes contact between the abstract ODESolver interface and a certain solver Implementation.

The interface of this class inherits the array bounds checking from ODESolver. Its methods forward calls to the Implementation erasing array bounds info by passing std::array and Eigen::Matrix arguments as raw pointers.

Thus the Implementation does not need template to be templated which makes it possible for Implementation to use the pimpl idiom whereby the headers of external libraries only have to be included in the final cpp file. Thereby our namespaces do not get polluted with symbols from external libraries.

Template Parameters

NumEquations	the number of equations in the ODE system.
Implementation	a concrete ODE solver implementation used as a backend.

Definition at line 55 of file ConcreteODESolver.h.

#include <ConcreteODESolver.h>

Inheritance diagram for MathLib::ODE::ConcreteODESolver< Implementation, NumEquations >:

[legend]

Collaboration diagram for MathLib::ODE::ConcreteODESolver< Implementation, NumEquations >:

[legend]

Public Member Functions
void	setFunction (Function< NumEquations > f, JacobianFunction< NumEquations > df) override

void	setTolerance (const std::array< double, NumEquations > &abstol, const double reltol) override

void	setTolerance (const double abstol, const double reltol) override

void	setIC (const double t0, std::initializer_list< double > const &y0) override

void	setIC (const double t0, Eigen::Matrix< double, NumEquations, 1, Eigen::ColMajor > const &y0) override
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...

void	preSolve () override

bool	solve (const double t) override

MappedConstVector< NumEquations >	getSolution () const override
	Returns the solution vector `y`. More...

double	getTime () const override

Eigen::Matrix< double, NumEquations, 1, Eigen::ColMajor >	getYDot (const double t, const MappedConstVector< NumEquations > &y) const override

Public Member Functions inherited from MathLib::ODE::ODESolver< NumEquations >
virtual unsigned	getNumberOfEquations () const
	Returns the number of equations. More...

virtual	~ODESolver ()=default

Private Member Functions
	ConcreteODESolver (BaseLib::ConfigTree const &config)
	Instances of this class shall only be constructed by createODESolver(). More...

Friends
std::unique_ptr< ODESolver< NumEquations > >	createODESolver (BaseLib::ConfigTree const &config)

Constructor & Destructor Documentation

◆ ConcreteODESolver()

template<typename Implementation , unsigned NumEquations>

MathLib::ODE::ConcreteODESolver< Implementation, NumEquations >::ConcreteODESolver ( BaseLib::ConfigTree const & config )

inlineexplicitprivate

Instances of this class shall only be constructed by createODESolver().

Definition at line 108 of file ConcreteODESolver.h.

         : Implementation{config, NumEquations}
     {
     }

Member Function Documentation

◆ getSolution()

template<typename Implementation , unsigned NumEquations>

MappedConstVector<NumEquations> MathLib::ODE::ConcreteODESolver< Implementation, NumEquations >::getSolution ( ) const

inlineoverridevirtual

Returns the solution vector y.

Implements MathLib::ODE::ODESolver< NumEquations >.

Definition at line 93 of file ConcreteODESolver.h.

     {
         return MappedConstVector<NumEquations>{Implementation::getSolution()};
     }

◆ getTime()

template<typename Implementation , unsigned NumEquations>

double MathLib::ODE::ConcreteODESolver< Implementation, NumEquations >::getTime ( ) const

inlineoverridevirtual

Returns the time that the solver has reached.

The return value should be equal to the time t passed to solve() if everything went fine.

Implements MathLib::ODE::ODESolver< NumEquations >.

Definition at line 97 of file ConcreteODESolver.h.

97 { return Implementation::getTime(); }

◆ getYDot()

template<typename Implementation , unsigned NumEquations>

Eigen::Matrix<double, NumEquations, 1, Eigen::ColMajor> MathLib::ODE::ConcreteODESolver< Implementation, NumEquations >::getYDot	(	const double	t,
		const MappedConstVector< NumEquations > &	y
	)		const

inlineoverridevirtual

Computes \( \dot y = f(t,y) \).

This method is provided for convenience only.

Implements MathLib::ODE::ODESolver< NumEquations >.

Definition at line 98 of file ConcreteODESolver.h.

     {
         Eigen::Matrix<double, NumEquations, 1, Eigen::ColMajor> y_dot;
         Implementation::getYDot(t, y.data(), y_dot.data());
         return y_dot;
     }

◆ preSolve()

template<typename Implementation , unsigned NumEquations>

void MathLib::ODE::ConcreteODESolver< Implementation, NumEquations >::preSolve ( )

inlineoverridevirtual

Finishes setting up the ODE solver, makes it ready to solve the provided ODE.

This method applies settings to the ODE solver, hence it has to be called after calling setters.

Note: preSolve() has to be called once before calling solve, it is not necessary to call it after each setter.

Implements MathLib::ODE::ODESolver< NumEquations >.

Definition at line 91 of file ConcreteODESolver.h.

91 { Implementation::preSolve(); }

◆ setFunction()

template<typename Implementation , unsigned NumEquations>

void MathLib::ODE::ConcreteODESolver< Implementation, NumEquations >::setFunction	(	Function< NumEquations >	f,
		JacobianFunction< NumEquations >	df
	)

inlineoverridevirtual

Sets functions that compute \(\dot y\) and the Jacobian \(\partial \dot y/\partial y\).

If no Jacobian function shall be set, nullptr can be passed for df.

Remarks: solve() cannot be directly called after this method, rather preSolve() has to be called first!

Implements MathLib::ODE::ODESolver< NumEquations >.

Definition at line 59 of file ConcreteODESolver.h.

     {
         Implementation::setFunction(
             std::make_unique<detail::FunctionHandlesImpl<NumEquations>>(f, df));
     }

◆ setIC() [1/2]

template<typename Implementation , unsigned NumEquations>

void MathLib::ODE::ConcreteODESolver< Implementation, NumEquations >::setIC	(	const double	t0,
		Eigen::Matrix< double, NumEquations, 1, Eigen::ColMajor > const &	y0
	)

inlineoverridevirtual

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Implements MathLib::ODE::ODESolver< NumEquations >.

Definition at line 84 of file ConcreteODESolver.h.

     {
         Implementation::setIC(t0, y0.data());
     }

◆ setIC() [2/2]

template<typename Implementation , unsigned NumEquations>

void MathLib::ODE::ConcreteODESolver< Implementation, NumEquations >::setIC	(	const double	t0,
		std::initializer_list< double > const &	y0
	)

inlineoverridevirtual

Sets the conditions.

Parameters

t0	initial time.
y0	initial values.

Remarks: solve() cannot be directly called after this method, rather preSolve() has to be called first!

Implements MathLib::ODE::ODESolver< NumEquations >.

Definition at line 77 of file ConcreteODESolver.h.

     {
         assert(y0.size() == NumEquations);
         Implementation::setIC(t0, y0.begin());
     }

◆ setTolerance() [1/2]

template<typename Implementation , unsigned NumEquations>

void MathLib::ODE::ConcreteODESolver< Implementation, NumEquations >::setTolerance	(	const double	abstol,
		const double	reltol
	)

inlineoverridevirtual

Sets the tolerances for the ODE solver.

Parameters

abstol	absolute tolerance, one value for all equations.
reltol	relative tolerance.

Remarks: solve() cannot be directly called after this method, rather preSolve() has to be called first!

Implements MathLib::ODE::ODESolver< NumEquations >.

Definition at line 72 of file ConcreteODESolver.h.

     {
         Implementation::setTolerance(abstol, reltol);
     }

◆ setTolerance() [2/2]

template<typename Implementation , unsigned NumEquations>

void MathLib::ODE::ConcreteODESolver< Implementation, NumEquations >::setTolerance	(	const std::array< double, NumEquations > &	abstol,
		const double	reltol
	)

inlineoverridevirtual

Sets the tolerances for the ODE solver.

Parameters

abstol	absolute tolerance, one value each equation.
reltol	relative tolerance.

Remarks: solve() cannot be directly called after this method, rather preSolve() has to be called first!

Implements MathLib::ODE::ODESolver< NumEquations >.

Definition at line 66 of file ConcreteODESolver.h.

     {
         Implementation::setTolerance(abstol.data(), reltol);
     }

◆ solve()

template<typename Implementation , unsigned NumEquations>

bool MathLib::ODE::ConcreteODESolver< Implementation, NumEquations >::solve ( const double t )

inlineoverridevirtual

Solves the ODE from the set initial condition to time t.

Returns: true or false indicating whether solving succeeded.

Precondition: preSolve() has to be called before this method.

Implements MathLib::ODE::ODESolver< NumEquations >.

Definition at line 92 of file ConcreteODESolver.h.

92 { return Implementation::solve(t); }

Friends And Related Function Documentation

◆ createODESolver

template<typename Implementation , unsigned NumEquations>

std::unique_ptr<ODESolver<NumEquations> > createODESolver ( BaseLib::ConfigTree const & config )

friend

Creates a new ODESolver instance from the given config.

Template Parameters

NumEquations the number of equations in the ODE system to be solved.

Definition at line 39 of file ODESolverBuilder.h.

 {
 #ifdef CVODE_FOUND
     return std::unique_ptr<ODESolver<NumEquations>>(
         new ConcreteODESolver<CVodeSolver, NumEquations>(config));
 #endif
     (void)config;  // Unused parameter warning if no library is available.
  
     OGS_FATAL(
         "No ODE solver could be created. Maybe it is because you did not build"
         " OGS6 with support for any external ODE solver library.");
 }

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

MathLib/ODE/ConcreteODESolver.h

Detailed Description

template<typename Implementation, unsigned NumEquations> class MathLib::ODE::ConcreteODESolver< Implementation, NumEquations >

Public Member Functions

Private Member Functions

Friends

Constructor & Destructor Documentation

◆ ConcreteODESolver()

Member Function Documentation

◆ getSolution()

◆ getTime()

◆ getYDot()

◆ preSolve()

◆ setFunction()

◆ setIC() [1/2]

◆ setIC() [2/2]

◆ setTolerance() [1/2]

◆ setTolerance() [2/2]

◆ solve()

Friends And Related Function Documentation

◆ createODESolver

template<typename Implementation, unsigned NumEquations>
class MathLib::ODE::ConcreteODESolver< Implementation, NumEquations >