Company Events Academic Community Support Solutions Products & Services Contact NI MyNI

ODE Solver Parameters (MathScript RT Module)

LabVIEW 2012 MathScript RT Module Help

Edition Date: June 2012

Part Number: 373123C-01

»View Product Info
Download Help (Windows Only)

The following table lists the parameters the MathScript RT Module uses to configure MathScript ODE solvers and the characteristics of these parameters. Use the odepset function to get or set these parameters.


Parameter NameLegacy NameDescriptionPossible Values
AbsTolAbsTolSpecifies the absolute tolerance the ODE solvers use to control the error. For y' = f(y), the following equation represents the error the MathScript RT Module ODE solvers maintain: error |y|*RelTol + AbsTol.AbsTol is a positive scalar. The default is 1E–6.
InitialStepInitialStepSpecifies the time step size for the first time step.InitialStep is a positive scalar. The default is 0.01.
MaxStepMaxStepSpecifies the largest time step size the ODE solvers use.MaxStep is a positive scalar. The default is 0.1.
MinStepN/ASpecifies the smallest time step size the ODE solvers use.MinStep is a positive scalar. The default is 1E–8.
RelTolRelTolSpecifies the relative tolerance the ODE solvers use to control the error. For y' = f(y), the following equation represents the error the MathScript RT Module ODE solvers maintain: error |y|*RelTol + AbsTol.RelTol is a positive scalar. The default is 0.0001.


The following table lists the MathScript RT Module ODE solver parameters that are ignored when specified.


Parameter NameLegacy NameDescriptionPossible Values
NormCntlNormControlSpecifies the type of error tolerance calculation of the solver.NormCntl is a Boolean scalar. The default is false.
Output_FcnOutputFcnSpecifies an output function for displaying the results of the solver.Output_Fcn is a string. The default is ''.
Output_SelOutputSelSpecifies the components for which output has to be performed if an output function is specified by Output_Fcn.Output_Sel is an integer vector. The default is empty.
ExpandRefineSpecifies the interpolation factor that is used to increase the quality for the output values if an output function is also set.Expand is a positive integer. The default is 0.
StatsStatsSpecifies whether to print cost statistics about the solving process.Stats is a Boolean scalar. The default is false.
NonNegativeNonNegativeSpecifies to set solution variables to zero even if their real solution would be negative.NonNegative is an integer vector. The default is empty.
EventsEventsSpecifies an event function to be used to find zero crossings in one of the results.Events is a string. The default is ''.
JacobianJacobianSpecifies a Jacobian matrix for ODE solvers to achieve faster and better results.Jacobian is a matrix. The default is empty.
Jacobian_PatternJPatternSpecifies a matrix that consists of {0, 1}.Jacobian_Pattern is a matrix of {0, 1}. The default is empty.
VectorizedVectorizedSpecifies solving a vectorized ODE function.Vectorized is a Boolean scalar. The default is false.
MassMassSpecifies a mass matrix for solving DAE equations.Mass is a matrix. The default is empty.
MState_DepMStateDependenceSpecifies the dependence of the mass matrix.MState_Dep is a string that accepts the following values:

'none'
'weak' (default)
'strong'
Mv_PatternMvPatternSpecifies a matrix that consists of {0, 1}.Mv_Pattern is a matrix. The default is empty.
Mass_SingularMassSingularSpecifies whether the mass matrix is singular.Mass_Singular is a string that accepts the following values:

'yes'
'no'
'maybe' (default)
InitialSlopeInitialSlopeSpecifies the initial slope.InitialSlope is a vector. The default is empty.
MaxOrderMaxOrderSpecifies the maximum order of the backward differentiation.MaxOrder is a positive integer belonging to [1, 5]. The default is 5.
BDFBDFSpecifies whether to use the backward differentiation formulas.BDF is a Boolean scalar. The default is false.

 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit