odedrivers.h

Go to the documentation of this file.

/*----------------------------------------------------------------------------
 ADOL-C -- Automatic Differentiation by Overloading in C++
 File:     drivers/odedrivers.h
 Revision: $Id$
 Contents: Easy to use drivers for ordinary differential equations (ODE)
           (with C and C++ callable interfaces including Fortran
            callable versions).
 
 Copyright (c) Andrea Walther, Andreas Griewank, Andreas Kowarz,
               Hristo Mitev, Sebastian Schlenkrich, Jean Utke, Olaf Vogel
 
 This file is part of ADOL-C. This software is provided as open source.
 Any use, reproduction, or distribution of the software constitutes
 recipient's acceptance of the terms of the accompanying license file.
 
----------------------------------------------------------------------------*/
#if !defined(ADOLC_DRIVERS_ODEDRIVERS_H)
#define ADOLC_DRIVERS_ODEDRIVERS_H 1
 
#include <adolc/adolcexport.h>
#include <adolc/interfaces.h>
#include <adolc/internal/common.h>
 
BEGIN_C_DECLS
 
/****************************************************************************/
/*                                                         DRIVERS FOR ODEs */
 
/*--------------------------------------------------------------------------*/
/*                                                                  forodec */
/* forodec(tag, n, tau, dold, dnew, X[n][d+1])                              */
ADOLC_API int forodec(short, int, double, int, int, double **);
ADOLC_API fint forodec_(fint *, fint *, fdouble *, fint *, fint *, fdouble *);
 
/*--------------------------------------------------------------------------*/
/*                                                                  accodec */
/* accodec(n, tau, d, Z[n][n][d+1], B[n][n][d+1], nz[n][n])                 */
ADOLC_API void accodec(int, double, int, double ***, double ***, short **);
ADOLC_API fint accodec_(fint *, fdouble *, fint *, fdouble *, fdouble *);
 
END_C_DECLS
 
/****************************************************************************/
/****************************************************************************/
/*                                                       Now the C++ THINGS */
#if defined(__cplusplus)
 
/****************************************************************************/
/*                                       DRIVERS FOR ODEs, overloaded calls */
 
/*--------------------------------------------------------------------------*/
/*                                                                   forode */
/* forode(tag, n, tau, dold, dnew, X[n][d+1])                               */
ADOLC_API inline int forode(short tag,  // tape identifier
                            int n,      // space dimension
                            double tau, // scaling
                            int dold,   // previous degree defaults to zero
                            int dnew,   // New degree of consistency
                            double **X) // Taylor series
{
  return forodec(tag, n, tau, dold, dnew, X);
}
 
/*--------------------------------------------------------------------------*/
/*                                                                   forode */
/*        the scaling tau defaults to 1                                     */
/*                                                                          */
/*  forode(tag, n, dold, dnew, X[n][d+1])                                   */
ADOLC_API inline int forode(short tag, int n, int dold, int dnew, double **X) {
  return forodec(tag, n, 1.0, dold, dnew, X);
}
 
/*--------------------------------------------------------------------------*/
/*                                                                   forode */
/*        previous order defaults to 0                                      */
/*                                                                          */
/* forode(tag, n, tau, dnew, X[n][d+1])                                     */
ADOLC_API inline int forode(short tag, int n, double tau, int deg, double **X) {
  return forodec(tag, n, tau, 0, deg, X);
}
 
/*--------------------------------------------------------------------------*/
/*                                                                   forode */
/*        both tau and dold default                                         */
/*                                                                          */
/* forode(tag, n, dnew, X[n][d+1])                                          */
ADOLC_API inline int forode(short tag, int n, int deg, double **X) {
  return forode(tag, n, 1.0, 0, deg, X);
}
 
/*--------------------------------------------------------------------------*/
/*                                                                   accode */
/* accode(n, tau, d, Z[n][n][d+1], B[n][n][d+1], nz[n][n])                  */
ADOLC_API inline void
accode(int n,               // space dimension
       double tau,          // scaling defaults to 1.0
       int deg,             // highest degree
       double ***A,         // input tensor of "partial" Jacobians
       double ***B,         // output tensor of "total" Jacobians
       short **nonzero = 0) // optional sparsity characterization
{
  accodec(n, tau, deg, A, B, nonzero);
}
 
/*--------------------------------------------------------------------------*/
/*                                                                   accode */
/*       scaling defaults to 1                                              */
/*                                                                          */
/* accode(n, d, Z[n][n][d+1], B[n][n][d+1], nz[n][n])                       */
ADOLC_API inline void
accode(int n,               // space dimension
       int deg,             // highest degree
       double ***A,         // input tensor of "partial" Jacobians
       double ***B,         // output tensor of "total" Jacobians
       short **nonzero = 0) // optional sparsity characterization
{
  accodec(n, 1.0, deg, A, B, nonzero);
}
 
#endif
 
/****************************************************************************/
#endif