/usr/include/kinsol/kinsol_impl.h is in libsundials-serial-dev 2.5.0-3+b3.
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 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 | /*
* -----------------------------------------------------------------
* $Revision: 1.7 $
* $Date: 2009/03/29 23:28:01 $
* -----------------------------------------------------------------
* Programmer(s): Allan Taylor, Alan Hindmarsh, Radu Serban, and
* Aaron Collier @ LLNL
* -----------------------------------------------------------------
* Copyright (c) 2002, The Regents of the University of California.
* Produced at the Lawrence Livermore National Laboratory.
* All rights reserved.
* For details, see the LICENSE file.
* -----------------------------------------------------------------
* KINSOL solver module header file (private version)
* -----------------------------------------------------------------
*/
#ifndef _KINSOL_IMPL_H
#define _KINSOL_IMPL_H
#ifdef __cplusplus /* wrapper to enable C++ usage */
extern "C" {
#endif
#include <stdarg.h>
#include <kinsol/kinsol.h>
/*
* =================================================================
* M A I N S O L V E R M E M O R Y B L O C K
* =================================================================
*/
/* KINSOL default constants */
#define PRINTFL_DEFAULT 0
#define MXITER_DEFAULT 200
#define MXNBCF_DEFAULT 10
#define MSBSET_DEFAULT 10
#define MSBSET_SUB_DEFAULT 5
#define OMEGA_MIN RCONST(0.00001)
#define OMEGA_MAX RCONST(0.9)
/*
* -----------------------------------------------------------------
* Types : struct KINMemRec and struct *KINMem
* -----------------------------------------------------------------
* A variable declaration of type struct *KINMem denotes a
* pointer to a data structure of type struct KINMemRec. The
* KINMemRec structure contains numerous fields that must be
* accessible by KINSOL solver module routines.
* -----------------------------------------------------------------
*/
typedef struct KINMemRec {
realtype kin_uround; /* machine epsilon (or unit roundoff error)
(defined in sundials_types.h) */
/* problem specification data */
KINSysFn kin_func; /* nonlinear system function implementation */
void *kin_user_data; /* work space available to func routine */
realtype kin_fnormtol; /* stopping tolerance on L2-norm of function
value */
realtype kin_scsteptol; /* scaled step length tolerance */
int kin_globalstrategy; /* choices are KIN_NONE and KIN_LINESEARCH */
int kin_printfl; /* level of verbosity of output */
long int kin_mxiter; /* maximum number of nonlinear iterations */
long int kin_msbset; /* maximum number of nonlinear iterations that
may be performed between calls to the
linear solver setup routine (lsetup) */
long int kin_msbset_sub; /* subinterval length for residual monitoring */
long int kin_mxnbcf; /* maximum number of beta condition failures */
int kin_etaflag; /* choices are KIN_ETACONSTANT, KIN_ETACHOICE1
and KIN_ETACHOICE2 */
booleantype kin_noMinEps; /* flag controlling whether or not the value
of eps is bounded below */
booleantype kin_setupNonNull; /* flag indicating if linear solver setup
routine is non-null and if setup is used */
booleantype kin_constraintsSet; /* flag indicating if constraints are being
used */
booleantype kin_jacCurrent; /* flag indicating if the Jacobian info.
used by the linear solver is current */
booleantype kin_callForcingTerm; /* flag set if using either KIN_ETACHOICE1
or KIN_ETACHOICE2 */
booleantype kin_noResMon; /* flag indicating if the nonlinear
residual monitoring scheme should be
used */
booleantype kin_retry_nni; /* flag indicating if nonlinear iteration
should be retried (set by residual
monitoring algorithm) */
booleantype kin_update_fnorm_sub; /* flag indicating if the fnorm associated
with the subinterval needs to be
updated (set by residual monitoring
algorithm) */
realtype kin_mxnewtstep; /* maximum allowable scaled step length */
realtype kin_sqrt_relfunc; /* relative error bound for func(u) */
realtype kin_stepl; /* scaled length of current step */
realtype kin_stepmul; /* step scaling factor */
realtype kin_eps; /* current value of eps */
realtype kin_eta; /* current value of eta */
realtype kin_eta_gamma; /* gamma value used in eta calculation
(choice #2) */
realtype kin_eta_alpha; /* alpha value used in eta calculation
(choice #2) */
booleantype kin_noInitSetup; /* flag controlling whether or not the KINSol
routine makes an initial call to the
linear solver setup routine (lsetup) */
realtype kin_sthrsh; /* threshold value for calling the linear
solver setup routine */
/* counters */
long int kin_nni; /* number of nonlinear iterations */
long int kin_nfe; /* number of calls made to func routine */
long int kin_nnilset; /* value of nni counter when the linear solver
setup was last called */
long int kin_nnilset_sub; /* value of nni counter when the linear solver
setup was last called (subinterval) */
long int kin_nbcf; /* number of times the beta-condition could not
be met in KINLineSearch */
long int kin_nbktrk; /* number of backtracks performed by
KINLineSearch */
long int kin_ncscmx; /* number of consecutive steps of size
mxnewtstep taken */
/* vectors */
N_Vector kin_uu; /* solution vector/current iterate (initially
contains initial guess, but holds approximate
solution upon completion if no errors occurred) */
N_Vector kin_unew; /* next iterate (unew = uu+pp) */
N_Vector kin_fval; /* vector containing result of nonlinear system
function evaluated at a given iterate
(fval = func(uu)) */
N_Vector kin_uscale; /* iterate scaling vector */
N_Vector kin_fscale; /* fval scaling vector */
N_Vector kin_pp; /* incremental change vector (pp = unew-uu) */
N_Vector kin_constraints; /* constraints vector */
N_Vector kin_vtemp1; /* scratch vector #1 */
N_Vector kin_vtemp2; /* scratch vector #2 */
/* space requirements for vector storage */
long int kin_lrw1; /* number of realtype-sized memory blocks needed
for a single N_Vector */
long int kin_liw1; /* number of int-sized memory blocks needed for
a single N_Vecotr */
long int kin_lrw; /* total number of realtype-sized memory blocks
needed for all KINSOL work vectors */
long int kin_liw; /* total number of int-sized memory blocks needed
for all KINSOL work vectors */
/* linear solver data */
/* function prototypes (pointers) */
int (*kin_linit)(struct KINMemRec *kin_mem);
int (*kin_lsetup)(struct KINMemRec *kin_mem);
int (*kin_lsolve)(struct KINMemRec *kin_mem, N_Vector xx, N_Vector bb,
realtype *res_norm );
void (*kin_lfree)(struct KINMemRec *kin_mem);
booleantype kin_inexact_ls; /* flag set by the linear solver module
(in linit) indicating whether this is an
iterative linear solver (TRUE), or a direct
linear solver (FALSE) */
void *kin_lmem; /* pointer to linear solver memory block */
realtype kin_fnorm; /* value of L2-norm of fscale*fval */
realtype kin_f1norm; /* f1norm = 0.5*(fnorm)^2 */
realtype kin_res_norm; /* value of L2-norm of residual (set by the linear
solver) */
realtype kin_sfdotJp; /* value of scaled func(u) vector (fscale*fval)
dotted with scaled J(u)*pp vector */
realtype kin_sJpnorm; /* value of L2-norm of fscale*(J(u)*pp) */
realtype kin_fnorm_sub; /* value of L2-norm of fscale*fval (subinterval) */
booleantype kin_eval_omega; /* flag indicating that omega must be evaluated. */
realtype kin_omega; /* constant value for real scalar used in test to
determine if reduction of norm of nonlinear
residual is sufficient. Unless a valid constant
value is specified by the user, omega is estimated
from omega_min and omega_max at each iteration. */
realtype kin_omega_min; /* lower bound on omega */
realtype kin_omega_max; /* upper bound on omega */
/*
* -----------------------------------------------------------------
* Note: The KINLineSearch subroutine scales the values of the
* variables sfdotJp and sJpnorm by a factor rl (lambda) that is
* chosen by the line search algorithm such that the sclaed Newton
* step satisfies the following conditions:
*
* F(u_k+1) <= F(u_k) + alpha*(F(u_k)^T * J(u_k))*p*rl
*
* F(u_k+1) >= F(u_k) + beta*(F(u_k)^T * J(u_k))*p*rl
*
* where alpha = 1.0e-4, beta = 0.9, u_k+1 = u_k + rl*p,
* 0 < rl <= 1, J denotes the system Jacobian, and F represents
* the nonliner system function.
* -----------------------------------------------------------------
*/
booleantype kin_MallocDone; /* flag indicating if KINMalloc has been
called yet */
/* message files */
/*-------------------------------------------
Error handler function and error ouput file
-------------------------------------------*/
KINErrHandlerFn kin_ehfun; /* Error messages are handled by ehfun */
void *kin_eh_data; /* dats pointer passed to ehfun */
FILE *kin_errfp; /* KINSOL error messages are sent to errfp */
KINInfoHandlerFn kin_ihfun; /* Info messages are handled by ihfun */
void *kin_ih_data; /* dats pointer passed to ihfun */
FILE *kin_infofp; /* where KINSol info messages are sent */
} *KINMem;
/*
* =================================================================
* I N T E R F A C E T O L I N E A R S O L V E R
* =================================================================
*/
/*
* -----------------------------------------------------------------
* Function : int (*kin_linit)(KINMem kin_mem)
* -----------------------------------------------------------------
* kin_linit initializes solver-specific data structures (including
* variables used as counters or for storing statistical information),
* but system memory allocation should be done by the subroutine
* that actually initializes the environment for liner solver
* package. If the linear system is to be preconditioned, then the
* variable setupNonNull (type booleantype) should be set to TRUE
* (predefined constant) and the kin_lsetup routine should be
* appropriately defined.
*
* kinmem pointer to an internal memory block allocated during
* prior calls to KINCreate and KINMalloc
*
* If the necessary variables have been successfully initialized,
* then the kin_linit function should return 0 (zero). Otherwise,
* the subroutine should indicate a failure has occurred by
* returning a non-zero integer value.
* -----------------------------------------------------------------
*/
/*
* -----------------------------------------------------------------
* Function : int (*kin_lsetup)(KINMem kin_mem)
* -----------------------------------------------------------------
* kin_lsetup interfaces with the user-supplied pset subroutine (the
* preconditioner setup routine), and updates relevant variable
* values (see KINSpgmrSetup/KINSpbcgSetup). Simply stated, the
* kin_lsetup routine prepares the linear solver for a subsequent
* call to the user-supplied kin_lsolve function.
*
* kinmem pointer to an internal memory block allocated during
* prior calls to KINCreate and KINMalloc
*
* If successful, the kin_lsetup routine should return 0 (zero).
* Otherwise it should return a non-zero value.
* -----------------------------------------------------------------
*/
/*
* -----------------------------------------------------------------
* Function : int (*kin_lsolve)(KINMem kin_mem, N_Vector xx,
* N_Vector bb, realtype *res_norm)
* -----------------------------------------------------------------
* kin_lsolve interfaces with the subroutine implementing the
* numerical method to be used to solve the linear system J*xx = bb,
* and must increment the relevant counter variable values in
* addition to computing certain values used by the global strategy
* and forcing term routines (see KINInexactNewton, KINLineSearch,
* KINForcingTerm, and KINSpgmrSolve/KINSpbcgSolve).
*
* kinmem pointer to an internal memory block allocated during
* prior calls to KINCreate and KINMalloc
*
* xx vector (type N_Vector) set to initial guess by kin_lsolve
* routine prior to calling the linear solver, but which upon
* return contains an approximate solution of the linear
* system J*xx = bb, where J denotes the system Jacobian
*
* bb vector (type N_Vector) set to -func(u) (negative of the
* value of the system function evaluated at the current
* iterate) by KINLinSolDrv before kin_lsolve is called
*
* res_norm holds the value of the L2-norm (Euclidean norm) of
* the residual vector upon return
*
* If successful, the kin_lsolve routine should return 0 (zero).
* Otherwise it should return a positive value if a re-evaluation
* of the lsetup function could recover, or a negative value if
* no such recovery is possible.
* -----------------------------------------------------------------
*/
/*
* -----------------------------------------------------------------
* Function : void (*kin_lfree)(KINMem kin_mem)
* -----------------------------------------------------------------
* kin_lfree is called by KINFree and should free (deallocate) all
* system memory resources allocated for the linear solver module
* (see KINSpgmrFree/KINSpbcgFree).
*
* kinmem pointer to an internal memory block allocated during
* prior calls to KINCreate and KINMalloc
* -----------------------------------------------------------------
*/
/*
* =================================================================
* K I N S O L I N T E R N A L F U N C T I O N S
* =================================================================
*/
/* High level error handler */
void KINProcessError(KINMem kin_mem,
int error_code, const char *module, const char *fname,
const char *msgfmt, ...);
/* Prototype of internal errHandler function */
void KINErrHandler(int error_code, const char *module, const char *function,
char *msg, void *user_data);
/* High level info handler */
void KINPrintInfo(KINMem kin_mem,
int info_code, const char *module, const char *fname,
const char *msgfmt, ...);
/* Prototype of internal infoHandler function */
void KINInfoHandler(const char *module, const char *function,
char *msg, void *user_data);
/*
* =================================================================
* K I N S O L E R R O R M E S S A G E S
* =================================================================
*/
#define MSG_MEM_FAIL "A memory request failed."
#define MSG_NO_MEM "kinsol_mem = NULL illegal."
#define MSG_BAD_NVECTOR "A required vector operation is not implemented."
#define MSG_FUNC_NULL "func = NULL illegal."
#define MSG_NO_MALLOC "Attempt to call before KINMalloc illegal."
#define MSG_BAD_PRINTFL "Illegal value for printfl."
#define MSG_BAD_MXITER "Illegal value for mxiter."
#define MSG_BAD_MSBSET "Illegal msbset < 0."
#define MSG_BAD_MSBSETSUB "Illegal msbsetsub < 0."
#define MSG_BAD_ETACHOICE "Illegal value for etachoice."
#define MSG_BAD_ETACONST "eta out of range."
#define MSG_BAD_GAMMA "gamma out of range."
#define MSG_BAD_ALPHA "alpha out of range."
#define MSG_BAD_MXNEWTSTEP "Illegal mxnewtstep < 0."
#define MSG_BAD_RELFUNC "relfunc < 0 illegal."
#define MSG_BAD_FNORMTOL "fnormtol < 0 illegal."
#define MSG_BAD_SCSTEPTOL "scsteptol < 0 illegal."
#define MSG_BAD_MXNBCF "mxbcf < 0 illegal."
#define MSG_BAD_CONSTRAINTS "Illegal values in constraints vector."
#define MSG_BAD_OMEGA "scalars < 0 illegal."
#define MSG_LSOLV_NO_MEM "The linear solver memory pointer is NULL."
#define MSG_UU_NULL "uu = NULL illegal."
#define MSG_BAD_GLSTRAT "Illegal value for global strategy."
#define MSG_BAD_USCALE "uscale = NULL illegal."
#define MSG_USCALE_NONPOSITIVE "uscale has nonpositive elements."
#define MSG_BAD_FSCALE "fscale = NULL illegal."
#define MSG_FSCALE_NONPOSITIVE "fscale has nonpositive elements."
#define MSG_INITIAL_CNSTRNT "Initial guess does NOT meet constraints."
#define MSG_LINIT_FAIL "The linear solver's init routine failed."
#define MSG_SYSFUNC_FAILED "The system function failed in an unrecoverable manner."
#define MSG_SYSFUNC_FIRST "The system function failed at the first call."
#define MSG_LSETUP_FAILED "The linear solver's setup function failed in an unrecoverable manner."
#define MSG_LSOLVE_FAILED "The linear solver's solve function failed in an unrecoverable manner."
#define MSG_LINSOLV_NO_RECOVERY "The linear solver's solve function failed recoverably, but the Jacobian data is already current."
#define MSG_LINESEARCH_NONCONV "The line search algorithm was unable to find an iterate sufficiently distinct from the current iterate."
#define MSG_LINESEARCH_BCFAIL "The line search algorithm was unable to satisfy the beta-condition for nbcfails iterations."
#define MSG_MAXITER_REACHED "The maximum number of iterations was reached before convergence."
#define MSG_MXNEWT_5X_EXCEEDED "Five consecutive steps have been taken that satisfy a scaled step length test."
#define MSG_SYSFUNC_REPTD "Unable to correct repeated recoverable system function errors."
/*
* =================================================================
* K I N S O L I N F O M E S S A G E S
* =================================================================
*/
#define INFO_RETVAL "Return value: %d"
#define INFO_ADJ "no. of lambda adjustments = %ld"
#if defined(SUNDIALS_EXTENDED_PRECISION)
#define INFO_NNI "nni = %4ld nfe = %6ld fnorm = %26.16Lg"
#define INFO_TOL "scsteptol = %12.3Lg fnormtol = %12.3Lg"
#define INFO_FMAX "scaled f norm (for stopping) = %12.3Lg"
#define INFO_PNORM "pnorm = %12.4Le"
#define INFO_PNORM1 "(ivio=1) pnorm = %12.4Le"
#define INFO_FNORM "fnorm(L2) = %20.8Le"
#define INFO_LAM "min_lam = %11.4Le f1norm = %11.4Le pnorm = %11.4Le"
#define INFO_ALPHA "fnorm = %15.8Le f1norm = %15.8Le alpha_cond = %15.8Le lam = %15.8Le"
#define INFO_BETA "f1norm = %15.8Le beta_cond = %15.8Le lam = %15.8Le"
#define INFO_ALPHABETA "f1norm = %15.8Le alpha_cond = %15.8Le beta_cond = %15.8Le lam = %15.8Le"
#elif defined(SUNDIALS_DOUBLE_PRECISION)
#define INFO_NNI "nni = %4ld nfe = %6ld fnorm = %26.16lg"
#define INFO_TOL "scsteptol = %12.3lg fnormtol = %12.3lg"
#define INFO_FMAX "scaled f norm (for stopping) = %12.3lg"
#define INFO_PNORM "pnorm = %12.4le"
#define INFO_PNORM1 "(ivio=1) pnorm = %12.4le"
#define INFO_FNORM "fnorm(L2) = %20.8le"
#define INFO_LAM "min_lam = %11.4le f1norm = %11.4le pnorm = %11.4le"
#define INFO_ALPHA "fnorm = %15.8le f1norm = %15.8le alpha_cond = %15.8le lam = %15.8le"
#define INFO_BETA "f1norm = %15.8le beta_cond = %15.8le lam = %15.8le"
#define INFO_ALPHABETA "f1norm = %15.8le alpha_cond = %15.8le beta_cond = %15.8le lam = %15.8le"
#else
#define INFO_NNI "nni = %4ld nfe = %6ld fnorm = %26.16g"
#define INFO_TOL "scsteptol = %12.3g fnormtol = %12.3g"
#define INFO_FMAX "scaled f norm (for stopping) = %12.3g"
#define INFO_PNORM "pnorm = %12.4e"
#define INFO_PNORM1 "(ivio=1) pnorm = %12.4e"
#define INFO_FNORM "fnorm(L2) = %20.8e"
#define INFO_LAM "min_lam = %11.4e f1norm = %11.4e pnorm = %11.4e"
#define INFO_ALPHA "fnorm = %15.8e f1norm = %15.8e alpha_cond = %15.8e lam = %15.8e"
#define INFO_BETA "f1norm = %15.8e beta_cond = %15.8e lam = %15.8e"
#define INFO_ALPHABETA "f1norm = %15.8e alpha_cond = %15.8e beta_cond = %15.8e lam = %15.8e"
#endif
#ifdef __cplusplus
}
#endif
#endif
|