Detailed Description

template<unsigned N>
struct MathLib::ODE::detail::FunctionHandlesImpl< N >

Function handles for an ODE system of N equations.

Definition at line 58 of file FunctionHandles.h.

#include <FunctionHandles.h>

Inheritance diagram for MathLib::ODE::detail::FunctionHandlesImpl< N >:

Collaboration diagram for MathLib::ODE::detail::FunctionHandlesImpl< N >:

Public Member Functions
	FunctionHandlesImpl (Function< N > &f, JacobianFunction< N > &df)

bool	call (const double t, const double const y, double const ydot) override

bool	callJacobian (const double t, const double const y, double const ydot, double *const jac) override

bool	hasJacobian () const override
	Tells whether a Jacobian function has been set.

unsigned	getNumberOfEquations () const override
	Returns the number of equations in the ODE system.

Public Member Functions inherited from MathLib::ODE::detail::FunctionHandles
virtual	~FunctionHandles ()=default

Public Attributes
Function< N >	f

JacobianFunction< N >	df

Constructor & Destructor Documentation

◆ FunctionHandlesImpl()

template<unsigned N>

MathLib::ODE::detail::FunctionHandlesImpl< N >::FunctionHandlesImpl	(	Function< N > &	f,
		JacobianFunction< N > &	df )

inline

Definition at line 60 of file FunctionHandles.h.

                                                                 : f(f), df(df)
    {
    }

Member Function Documentation

◆ call()

template<unsigned N>

bool MathLib::ODE::detail::FunctionHandlesImpl< N >::call	(	const double	t,
		const double *const	y,
		double *const	ydot )

inlineoverridevirtual

Calls the stored function f computing \(\dot y\).

The raw pointers passed to this method are wrapped in some Eigen::Map objects before being passed to f. Thereby the information about the size of the vectors is restored. No memory is copied for that.

Returns: true or false indicating whether the function succeeded.

Implements MathLib::ODE::detail::FunctionHandles.

Definition at line 72 of file FunctionHandles.h.

    {
        if (f)
        {
            MappedVector<N> ydot_mapped{ydot};
            return f(t, MappedConstVector<N>{y}, ydot_mapped);
        }
        return false;
    }

References MathLib::ODE::detail::FunctionHandlesImpl< N >::f, and MathLib::t.

◆ callJacobian()

template<unsigned N>

bool MathLib::ODE::detail::FunctionHandlesImpl< N >::callJacobian	(	const double	t,
		const double *const	y,
		double *const	ydot,
		double *const	jac )

inlineoverridevirtual

Calls the stored function computing \(\mathtt{jac} := \partial \dot y/\partial y\).

Returns: true or false indicating whether the function succeeded.

See also: call()

Implements MathLib::ODE::detail::FunctionHandles.

Definition at line 89 of file FunctionHandles.h.

    {
        if (df)
        {
            MappedMatrix<N, N> jac_mapped{jac};
            return df(t,
                      MappedConstVector<N>{y},
                      MappedConstVector<N>{ydot},
                      jac_mapped);
        }
        return false;
    }