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

More documents

Recommendations

Info

3.2 Function types Purpose KINDenseJacFn KINDenseJacFn - type for user provided dense Jacobian function. Synopsis This is a script file. Description KINDenseJacFn - type for user provided dense Jacobian function. The function DJACFUN must be defined as FUNCTION [J, IER] = DJACFUN(Y,FY) and must return a matrix J corresponding to the Jacobian of f(y). The input argument FY contains the current value of f(y). 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 DJACFUN must be defined as FUNCTION [J, IER, NEW_DATA] = DJACFUN(Y,FY,DATA) If the local modifications to the user data structure are needed in other user-provided functions then, besides setting the matrix J and the flag IER, the DJACFUN 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: DJACFUN is specified through the property JacobianFn to KINSetOptions and is used only if the property LinearSolver was set to ’Dense’. Purpose KINGcommFn KINGcommFn - type for user provided communication function (BBDPre). Synopsis This is a script file. Description KINGcommFn - type for user provided communication function (BBDPre). The function GCOMFUN must be defined as FUNCTION [] = GCOMFUN(Y) and can be used to perform all interprocess communication necessary to evaluate the approximate right-hand side function for the BBDPre 45
preconditioner module. If a user data structure DATA was specified in KINMalloc, then GCOMFUN must be defined as FUNCTION [NEW_DATA] = GCOMFUN(Y,DATA) If the local modifications to the user data structure are needed in other user-provided functions then the GCOMFUN 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 KINGlocalFn, KINSetOptions NOTES: GCOMFUN is specified through the GcommFn property in KINSetOptions and is used only if the property PrecModule is set to ’BBDPre’. Purpose Each call to GCOMFUN is preceded by a call to the system function SYSFUN with the same argument Y. Thus GCOMFUN can omit any communication done by SYSFUN if relevant to the evaluation of G by GLOCFUN. If all necessary communication was done by SYSFUN, GCOMFUN need not be provided. KINGlocalFn KINGlocalFn - type for user provided RHS approximation function (BBDPre). Synopsis This is a script file. Description KINGlocalFn - type for user provided RHS approximation function (BBDPre). The function GLOCFUN must be defined as FUNCTION G = GLOCFUN(Y) and must return a vector G corresponding to an approximation to f(y) which will be used in the BBDPRE preconditioner module. The case where G is mathematically identical to F is allowed. If a user data structure DATA was specified in KINMalloc, then GLOCFUN must be defined as FUNCTION [G, NEW_DATA] = GLOCFUN(Y,DATA) If the local modifications to the user data structure are needed in other user-provided functions then, besides setting the vector G, the GLOCFUN 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 KINGcommFn, KINSetOptions NOTE: GLOCFUN is specified through the GlocalFn property in KINSetOptions and is used only if the property PrecModule is set to ’BBDPre’. 46
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 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 ...

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

Delete template?

Save as template?