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

More documents

Recommendations

Info

Purpose KINJacTimesVecFn KINJacTimesVecFn - type for user provided Jacobian times vector function. Synopsis This is a script file. Description KINJacTimesVecFn - type for user provided Jacobian times vector function. The function JTVFUN must be defined as FUNCTION [JV, FLAG, IER] = JTVFUN(Y,V,FLAG) and must return a vector JV corresponding to the product of the Jacobian of f(y) with the vector v. On input, FLAG indicates if the iterate has been updated in the interim. JV must be update or reevaluated, if appropriate, unless FLAG=false. This flag must be reset by the user. If successful, IER should be set to 0. If an error occurs, IER should be set to a nonzero value. If a user data structure DATA was specified in KINMalloc, then JTVFUN must be defined as FUNCTION [JV, FLAG, IER, NEW_DATA] = JTVFUN(Y,V,FLAG,DATA) If the local modifications to the user data structure are needed in other user-provided functions then, besides setting the vector JV, and flags FLAG and IER, the JTVFUN function must also set NEW_DATA. Otherwise, it should set NEW_DATA=[] (do not set NEW_DATA = DATA as it would lead to unnecessary copying). See also KINSetOptions NOTE: JTVFUN is specified through the property JacobianFn to KINSetOptions and is used only if the property LinearSolver was set to ’GMRES’ or ’BiCGStab’. Purpose KINPrecSetupFn KINPrecSetupFn - type for user provided preconditioner setup function. Synopsis This is a script file. Description KINPrecSetupFn - type for user provided preconditioner setup function. The user-supplied preconditioner setup subroutine should compute the right-preconditioner matrix P used to form the scaled preconditioned linear system: 47
(Df*J(y)*(P^-1)*(Dy^-1)) * (Dy*P*x) = Df*(-F(y)) where Dy and Df denote the diagonal scaling matrices whose diagonal elements are stored in the vectors YSCALE and FSCALE, respectively. The preconditioner setup routine (referenced by iterative linear solver modules via pset (type KINSpilsPrecSetupFn)) will not be called prior to every call made to the psolve function, but will instead be called only as often as necessary to achieve convergence of the Newton iteration. Note: If the PRECSOLVE function requires no preparation, then a preconditioner setup function need not be given. The function PSETFUN must be defined as FUNCTION [IER] = PSETFUN(Y,YSCALE,FY,FSCALE) If successful, PSETFUN must return IER=0. If an error occurs, then IER must be set to a non-zero value. The input argument FY contains the current value of f(y), while YSCALE and FSCALE are the scaling vectors for solution and system function, respectively (as passed to KINSol) If a user data structure DATA was specified in KINMalloc, then PSETFUN must be defined as FUNCTION [IER, NEW_DATA] = PSETFUN(Y,YSCALE,FY,FSCALE,DATA) If the local modifications to the user data structure are needed in other user-provided functions then, besides setting the flag IER, the PSETFUN function must also set NEW_DATA. Otherwise, it should set NEW_DATA=[] (do not set NEW_DATA = DATA as it would lead to unnecessary copying). See also KINPrecSolveFn, KINSetOptions, KINSol NOTE: PSETFUN is specified through the property PrecSetupFn to KINSetOptions and is used only if the property LinearSolver was set to ’GMRES’ or ’BiCGStab’. Purpose KINPrecSolveFn KINPrecSolveFn - type for user provided preconditioner solve function. Synopsis This is a script file. Description KINPrecSolveFn - type for user provided preconditioner solve function. The user-supplied preconditioner solve function PSOLFN is to solve a linear system P z = r in which the matrix P is the preconditioner matrix (possibly set implicitely by PSETFUN) 48
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 42 and 43: Adjoint Problem The function PSOLFU
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 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 ...

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?