sundialsTB, a Matlab Interface to SUNDIALS - Site Index Page ...

More documents

Recommendations

Info

Adjoint Problem The function PSOLFUNB must be defined either as FUNCTION [ZB, ERR] = PSOLFUNB(T,Y,YB,FYB,RB) or as FUNCTION [ZB, ERR, NEW_DATA] = PSOLFUNB(T,Y,YB,FYB,RB,DATA) depending on whether a user data structure DATA was specified in CVodeMalloc. In either case, it must return the vector ZB and the flag ERR. See also CVPrecSetupFn, CVodeSetOptions NOTE: PSOLFUN and PSOLFUNB are specified through the property PrecSolveFn to CVodeSetOptions and are used only if the property LinearSolver was set to ’GMRES’ or ’BiCGStab’ and if the property PrecType is not ’None’. 37
3 matlab Interface to kinsol The matlab interface to kinsol provides access to all functionality of the kinsol solver. The interface consists of 5 user-callable functions. The user must provide several required and optional user-supplied functions which define the problem to be solved. The user-callable functions and the types of user-supplied functions are listed in Table 2 and fully documented later in this section. For more in depth details, consult also the kinsol user guide [1]. To illustrate the use of the kinsol matlab interface, several example problems are provided with sundialsTB, both for serial and parallel computations. Most of them are matlab translations of example problems provided with kinsol. Functions Function types Table 2: kinsol matlab interface functions KINSetOptions creates an options structure for kinsol. KINMalloc allocates and initializes memory for kinsol. KINSol solves the nonlinear problem. KINGetStats returns statistics for the kinsol solver. KINFree deallocates memory for the kinsol solver. KINSysFn system function KINDenseJacFn dense Jacobian function KINJactimesVecFn Jacobian times vector function KINPrecSetupFn preconditioner setup function KINPrecSolveFn preconditioner solve function KINGlocalFn system approximation function (BBDPre) KINGcommFn communication function (BBDPre) 38
Page 1 and 2: UCRL-SM-212121 sundialsTB, a Matlab
Page 3: sundialsTB, a matlab Interface to s
Page 6 and 7: 1 Introduction sundials [2], SUite
Page 8 and 9: 2 matlab Interface to cvodes The ma
Page 10 and 11: The relative and absolute tolerance
Page 12 and 13: (see PrecModule), it specifies the
Page 14 and 15: to (centered or forward) finite dif
Page 16 and 17: If quadratures were computed (see C
Page 18 and 19: o RootInfo - strucutre with rootfin
Page 20 and 21: Jacobian approximation Fields in LS
Page 22 and 23: o cntr [ true | false ] If true, CV
Page 24 and 25: 123 f o r j = 1 :N 124 y ( j , i )
Page 26 and 27: 231 box on ; 232 g r i d on ; 233 x
Page 28 and 29: 339 s e t ( hc ( 4 ) , ’XData ’
Page 30 and 31: 447 end 448 f p r i n t f ( ’−
Page 32 and 33: Purpose CVDenseJacFn - type for use
Page 34 and 35: The function GLOCFUN must be define
Page 36 and 37: evaluated on the backward phase. Se
Page 38 and 39: See also CVodeSetOptions NOTE: ODES
Page 40 and 41: M = I - gamma*J. Here J is the syst
Page 44 and 45: 3.1 Interface functions Purpose KIN
Page 46 and 47: Jacobian-vector product. PrecModule
Page 48 and 49: then KINSol attempts to solve the s
Page 50 and 51: 3.2 Function types Purpose KINDense
Page 52 and 53: Purpose KINJacTimesVecFn KINJacTime
Page 54 and 55: The function PSOLFUN must be define
Page 56 and 57: 4.1 nvector functions Purpose N_VDo
Page 58 and 59: 13 14 i f nargin == 1 15 16 r e t =
Page 60 and 61: N_VWL2Norm returns the weighted Euc
Page 62 and 63: 4.2 Parallel utilities Purpose mpir
Page 64 and 65: 19 f p r i n t f ( ’ waiting f o
Page 66 and 67: 53 e r r o r ( ’ LAM Init : : can
Page 68 and 69: 161 162 i f NHL > 0 % a c c u r a t
Page 70 and 71: 269 %RPI STR F u l l LAM SSI RPI s

sundialsTB, a Matlab Interface to SUNDIALS - Site Index Page ...

Create successful ePaper yourself

Delete template?

Save as template?