abstract base class for defining Differential Algebraic Equation systems More...

#include <numeric_DAE.h>

Inheritance diagram for ObjectiveDae:

Public Member Functions
	ObjectiveDae (void)

virtual bool	operator() (double time, const std::vector< double > &x, const std::vector< double > &xdot, std::vector< double > &y)=0

virtual bool	jacColumn (int j, double time, const std::vector< double > &x, const std::vector< double > &xdot, std::vector< double > &y, double cj, double *JC)=0

bool	usejac (void) const

Public Attributes
int	verbosityLocal

Protected Attributes
bool	usejac_

Detailed Description

abstract base class for defining Differential Algebraic Equation systems

#include <libpf/core/numeric_DAE.h>

Remarks

Warning: Thread safe:; Extendable:; Platform dependencies:

Constructor & Destructor Documentation

◆ ObjectiveDae()

ObjectiveDae::ObjectiveDae ( void )

inline

Member Function Documentation

◆ jacColumn()

virtual bool ObjectiveDae::jacColumn	(	int	j,
		double	time,
		const std::vector< double > &	x,
		const std::vector< double > &	xdot,
		std::vector< double > &	y,
		double	cj,
		double *	JC
	)

pure virtual

Jacobian column returns the j-th column of the Jacobian into the colum vector JC

Implemented in ObjectiveDaeDynamic.

◆ operator()()

virtual bool ObjectiveDae::operator()	(	double	time,
		const std::vector< double > &	x,
		const std::vector< double > &	xdot,
		std::vector< double > &	y
	)

pure virtual

residual function returns the Boolean value true if the function residual encountered an error in the input values or false otherwise

Parameters

time	where we are in the integration
x	vector of algebraic and differential unknowns
xdot	vector of derivatives of differential unknowns
y	y = f(xdot,x,t) is the residual to be brought to 0

Implemented in ObjectiveDaeDynamic.

◆ usejac()

bool ObjectiveDae::usejac ( void ) const

inline

Member Data Documentation

◆ usejac_

bool ObjectiveDae::usejac_

protected

◆ verbosityLocal

int ObjectiveDae::verbosityLocal

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

numeric_DAE.h

Public Member Functions

Public Attributes

Protected Attributes