00001 /* 00002 * ----------------------------------------------------------------- 00003 * $Revision: 1.3 $ 00004 * $Date: 2006/11/29 00:05:06 $ 00005 * ----------------------------------------------------------------- 00006 * Programmer: Radu Serban @ LLNL 00007 * ----------------------------------------------------------------- 00008 * Copyright (c) 2006, The Regents of the University of California. 00009 * Produced at the Lawrence Livermore National Laboratory. 00010 * All rights reserved. 00011 * For details, see the LICENSE file. 00012 * ----------------------------------------------------------------- 00013 * Header file for the CVODE dense linear solver CVLAPACK. 00014 * ----------------------------------------------------------------- 00015 */ 00016 00017 #ifndef _CVLAPACK_H 00018 #define _CVLAPACK_H 00019 00020 #ifdef __cplusplus /* wrapper to enable C++ usage */ 00021 extern "C" { 00022 #endif 00023 00024 #include <cvode/cvode_direct.h> 00025 #include <sundials/sundials_lapack.h> 00026 00027 /* 00028 * ================================================================= 00029 * E X P O R T E D F U N C T I O N S 00030 * ================================================================= 00031 */ 00032 00033 /* 00034 * ----------------------------------------------------------------- 00035 * Function : CVLapackDense 00036 * ----------------------------------------------------------------- 00037 * A call to the CVLapackDense function links the main integrator 00038 * with the CVLAPACK linear solver using dense Jacobians. 00039 * 00040 * cvode_mem is the pointer to the integrator memory returned by 00041 * CVodeCreate. 00042 * 00043 * N is the size of the ODE system. 00044 * 00045 * The return value of CVLapackDense is one of: 00046 * CVLAPACK_SUCCESS if successful 00047 * CVLAPACK_MEM_NULL if the CVODE memory was NULL 00048 * CVLAPACK_MEM_FAIL if there was a memory allocation failure 00049 * CVLAPACK_ILL_INPUT if a required vector operation is missing 00050 * ----------------------------------------------------------------- 00051 */ 00052 00053 SUNDIALS_EXPORT int CVLapackDense(void *cvode_mem, int N); 00054 00055 /* 00056 * ----------------------------------------------------------------- 00057 * Function : CVLapackBand 00058 * ----------------------------------------------------------------- 00059 * A call to the CVLapackBand function links the main integrator 00060 * with the CVLAPACK linear solver using banded Jacobians. 00061 * 00062 * cvode_mem is the pointer to the integrator memory returned by 00063 * CVodeCreate. 00064 * 00065 * N is the size of the ODE system. 00066 * 00067 * mupper is the upper bandwidth of the band Jacobian approximation. 00068 * 00069 * mlower is the lower bandwidth of the band Jacobian approximation. 00070 * 00071 * The return value of CVLapackBand is one of: 00072 * CVLAPACK_SUCCESS if successful 00073 * CVLAPACK_MEM_NULL if the CVODE memory was NULL 00074 * CVLAPACK_MEM_FAIL if there was a memory allocation failure 00075 * CVLAPACK_ILL_INPUT if a required vector operation is missing or 00076 * if a bandwidth has an illegal value. 00077 * ----------------------------------------------------------------- 00078 */ 00079 00080 SUNDIALS_EXPORT int CVLapackBand(void *cvode_mem, int N, int mupper, int mlower); 00081 00082 #ifdef __cplusplus 00083 } 00084 #endif 00085 00086 #endif
1.5.6