Main Page | Modules | Data Structures | Directories | File List | Data Fields | Globals

Jacobian Matrix: J = df(x)/dx
[ODE Model: f(x,p,t) = dx/dt]

Collaboration diagram for Jacobian Matrix: J = df(x)/dx:

Constructing and Interfacing the Jacobian matrix of an ODE system. More...

Functions

SBML_ODESOLVER_API int ODEModel_constructJacobian (odeModel_t *om)
 Construct Jacobian Matrix for ODEModel.
SBML_ODESOLVER_API const ASTNode_t * ODEModel_getJacobianIJEntry (odeModel_t *om, int i, int j)
 Returns the ith/jth entry of the jacobian matrix.
SBML_ODESOLVER_API const ASTNode_t * ODEModel_getJacobianEntry (odeModel_t *om, variableIndex_t *vi1, variableIndex_t *vi2)
 Returns the entry (d(vi1)/dt)/d(vi2) of the jacobian matrix.
SBML_ODESOLVER_API ASTNode_t * ODEModel_constructDeterminant (odeModel_t *om)
 Constructs and returns the determinant of the jacobian matrix.

Detailed Description

Constructing and Interfacing the Jacobian matrix of an ODE system.

as used for CVODES and IDA Dense Solvers


Function Documentation

SBML_ODESOLVER_API int ODEModel_constructJacobian odeModel_t om  ) 
 

Construct Jacobian Matrix for ODEModel.

Once an ODE system has been constructed from an SBML model, this function calculates the derivative of each species' ODE with respect to all other species for which an ODE exists, i.e. it constructs the jacobian matrix of the ODE system. At the moment this matrix is freed together with the ODE model. A separate function will be available soon.
Returns 1 if successful, 0 otherwise.

SBML_ODESOLVER_API const ASTNode_t* ODEModel_getJacobianIJEntry odeModel_t om,
int  i,
int  j
 

Returns the ith/jth entry of the jacobian matrix.

Returns NULL if either the jacobian has not been constructed yet, or if i or j are >neq. Ownership remains within the odeModel structure.

SBML_ODESOLVER_API const ASTNode_t* ODEModel_getJacobianEntry odeModel_t om,
variableIndex_t vi1,
variableIndex_t vi2
 

Returns the entry (d(vi1)/dt)/d(vi2) of the jacobian matrix.

Returns NULL if either the jacobian has not been constructed yet, or if the v1 or vi2 are not ODE variables. Ownership remains within the odeModel structure.

SBML_ODESOLVER_API ASTNode_t* ODEModel_constructDeterminant odeModel_t om  ) 
 

Constructs and returns the determinant of the jacobian matrix.

The calling application takes ownership of the returned ASTNode_t and must free it, if not required.


Generated on Wed Dec 21 18:10:37 2005 for SBML ODE Solver Library API by  doxygen 1.4.4