/usr/include/kinsol/kinsol_spfgmr.h is in libsundials-dev 2.7.0+dfsg-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 | /*
* -----------------------------------------------------------------
* $Revision: 4378 $
* $Date: 2015-02-19 10:55:14 -0800 (Thu, 19 Feb 2015) $
* -----------------------------------------------------------------
* Programmer(s): Carol Woodward @ LLNL, based on kinsol_spgmr.h
* -----------------------------------------------------------------
* LLNS Copyright Start
* Copyright (c) 2014, Lawrence Livermore National Security
* This work was performed under the auspices of the U.S. Department
* of Energy by Lawrence Livermore National Laboratory in part under
* Contract W-7405-Eng-48 and in part under Contract DE-AC52-07NA27344.
* Produced at the Lawrence Livermore National Laboratory.
* All rights reserved.
* For details, see the LICENSE file.
* LLNS Copyright End
* -----------------------------------------------------------------
* This is the header file for the KINSOL Scaled Preconditioned GMRES
* linear solver module, KINSPFGMR.
* -----------------------------------------------------------------
*/
#ifndef _KINSPFGMR_H
#define _KINSPFGMR_H
#include <kinsol/kinsol_spils.h>
#include <sundials/sundials_spfgmr.h>
#ifdef __cplusplus /* wrapper to enable C++ usage */
extern "C" {
#endif
/*
* -----------------------------------------------------------------
* Function : KINSpfgmr
* -----------------------------------------------------------------
* KINSpfgmr links the main KINSOL solver module with the SPFGMR
* linear solver module. The routine establishes the inter-module
* interface by setting the generic KINSOL pointers linit, lsetup,
* lsolve, and lfree to KINSpfgmrInit, KINSpfgmrSetup, KINSpfgmrSolve,
* and KINSpfgmrFree, respectively.
*
* kinmem pointer to an internal memory block allocated during a
* prior call to KINCreate
*
* maxl maximum allowable dimension of Krylov subspace (passing
* a value of 0 (zero) will cause the default value
* KINSPILS_MAXL (predefined constant) to be used)
*
* -----------------------------------------------------------------
* KINSpfgmr Return Values
* -----------------------------------------------------------------
*
* The possible return values for the KINSpfgmr subroutine are the
* following:
*
* KINSPILS_SUCCESS : means the KINSPFGMR linear solver module
* (implementation of the GMRES method) was
* successfully initialized - allocated system
* memory and set shared variables to default
* values [0]
*
* KINSPILS_MEM_NULL : means a NULL KINSOL memory block pointer was
* given (must call the KINCreate and KINMalloc
* memory allocation subroutines prior to
* calling KINSpfgmr) [-1]
*
* KINSPILS_MEM_FAIL : means either insufficient system resources
* were available to allocate memory for the main
* KINSPFGMR data structure (type KINSpfgmrMemRec),
* or the SpfgmrMalloc subroutine failed (unable
* to allocate enough system memory for vector
* storage and/or the main SPFGMR data structure
* (type SpfgmrMemRec)) [-4]
*
* KINSPILS_ILL_INPUT : means a supplied parameter was invalid
* (check error message) [-3]
*
* The above constants are defined in kinsol_spils.h
* -----------------------------------------------------------------
*/
SUNDIALS_EXPORT int KINSpfgmr(void *kinmem, int maxl);
#ifdef __cplusplus
}
#endif
#endif
|