cvode_dense.h

Go to the documentation of this file.
00001 /*
00002  * -----------------------------------------------------------------
00003  * $Revision: 1.4 $
00004  * $Date: 2006/11/29 00:05:06 $
00005  * ----------------------------------------------------------------- 
00006  * Programmer(s): Scott D. Cohen, Alan C. Hindmarsh and
00007  *                Radu Serban @ LLNL
00008  * -----------------------------------------------------------------
00009  * Copyright (c) 2002, The Regents of the University of California.
00010  * Produced at the Lawrence Livermore National Laboratory.
00011  * All rights reserved.
00012  * For details, see the LICENSE file.
00013  * -----------------------------------------------------------------
00014  * This is the header file for the CVODE dense linear solver, CVDENSE.
00015  * -----------------------------------------------------------------
00016  */
00017 
00018 #ifndef _CVDENSE_H
00019 #define _CVDENSE_H
00020 
00021 #ifdef __cplusplus  /* wrapper to enable C++ usage */
00022 extern "C" {
00023 #endif
00024 
00025 #include <cvode/cvode_direct.h>
00026 #include <sundials/sundials_dense.h>
00027 
00028 /*
00029  * -----------------------------------------------------------------
00030  * Function: CVDense
00031  * -----------------------------------------------------------------
00032  * A call to the CVDense function links the main integrator with
00033  * the CVDENSE linear solver.
00034  *
00035  * cvode_mem is the pointer to the integrator memory returned by
00036  *           CVodeCreate.
00037  *
00038  * N is the size of the ODE system.
00039  *
00040  * The return value of CVDense is one of:
00041  *    CVDIRECT_SUCCESS   if successful
00042  *    CVDIRECT_MEM_NULL  if the cvode memory was NULL
00043  *    CVDIRECT_MEM_FAIL  if there was a memory allocation failure
00044  *    CVDIRECT_ILL_INPUT if a required vector operation is missing
00045  * -----------------------------------------------------------------
00046  */
00047 
00048 SUNDIALS_EXPORT int CVDense(void *cvode_mem, int N);
00049 
00050 #ifdef __cplusplus
00051 }
00052 #endif
00053 
00054 #endif

Generated on Fri Sep 26 07:44:09 2008 for SimTKcore by  doxygen 1.5.6