Click or drag to resize

xOdeBase Class

Represents the base class for the Odes.
Inheritance Hierarchy

Namespace: DotNumerics.ODE
Assembly: DWSIM.MathOps.DotNumerics (in DWSIM.MathOps.DotNumerics.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
Copy
public abstract class xOdeBase
Request Example View Source

The xOdeBase type exposes the following members.

Constructors
 NameDescription
Protected methodxOdeBase 
Top
Properties
 NameDescription
Public propertyAbsTol An absolute error tolerance parameter
Public propertyAbsTolArray An absolute error tolerance array (length numEquations).
Public propertyErrorToleranceType Specifies the type of the relative error and absolute error tolerances.
Public propertyRelTol A relative error tolerance parameter.
Public propertyRelTolArray A relative error tolerance array ( length numEquations).
Top
Methods
 NameDescription
Protected methodCheckArguments 
Protected methodCheckInitialization 
Protected methodCheckTArray 
Public methodInitializeODEs(OdeFunction, Int32) Method that initialize the ODE to solve.
Public methodInitializeODEs(OdeFunction, Int32, Double, Double) Method that initialize the ODE to solve.
Public methodSetInitialValues Sets the initial values for the differential equations.
Top
Fields
 NameDescription
Protected field_AbsTol An absolute error tolerance parameter
Protected field_AbsTolArray An absolute error tolerance parameter(array of length NEQ)
Protected field_Errors Array containing the exception messages.
Private field_ErrorToleranceType 
Protected field_InvokeInitializeODEs Indicated if the InitializeODEs method need to be invoked.
Protected field_InvokeSetInitialValues Indicated if the SetInitialValues method need to be invoked.
Protected field_IPar User-specified array used to communicate integer parameter
Protected field_ITolAdamsGears For AdamsMoulton and OdeGearsBDF: MeITol = An indicator for the type of error control. ITOL RTOL ATOL EWT(i) MeITol =1 scalar scalar RTOL*ABS(Y(i)) + ATOL MeITol =2 scalar array RTOL*ABS(Y(i)) + ATOL(i) MeITol =3 array scalar RTOL(i)*ABS(Y(i)) + ATOL MeITol =4 array array RTOL(i)*ABS(Y(i)) + ATOL(i)
Protected field_ITolRK For Runge-Kutta ITol = An indicator for the type of error control. ITOL=0: BOTH RTOL AND ATOL ARE SCALARS. ITOL=1: BOTH RTOL AND ATOL ARE VECTORS.
Protected field_IWork MeIWork= An integer work array.
Protected field_Liw MeLiw= the length of the array IWORK
Protected field_Lrw MeLrw= The length of the array RWORK
Protected field_NEquations The number of equations
Protected field_RelTol A relative error tolerance parameter. The input parameters ITOL, RTOL, and ATOL determine the error control performed by the solver. The solver will control the vector e = (e(i)) of estimated local errors in Y, according to an inequality of the form rms-norm of ( e(i)/EWT(i) ) .le. 1, where EWT(i) = RTOL(i)*abs(Y(i)) + ATOL(i),
Protected field_RelTolArray A relative error tolerance parameter, either a scalar or an array of length NEQ.
Protected field_RPar User-specified array used to communicate real parameters
Protected field_RWork MeRWork= A real working array (double precision)
Protected field_T0 The initial independent variable value.
Protected field_Y Array used to set the initial values and to return the solution in some ODE solvers. This array must be initialized equal to the initial values in the first call.
Protected field_Y0 The initial conditions.
Top
Extension Methods
 NameDescription
Public Extension MethodGetEnumNames
(Defined by General)
Public Extension MethodIsValidDouble
(Defined by General)
Top
See Also