modelUnitTests

Calculation of absolute, relative, and rms errors. Model is looked for in examples to identify variables included in regression unit tests as well.

Information

Note: If abs(x_reference[i]) <= tolerance then the relative error is simply x[i].

Parameters

TypeNameDefaultDescription
Integern1Array size of x and x_reference
Parameters: Error Calculation
BooleanerrorCalcsfalse=true to perform error calculations of x vs x_reference
RealerrorExpected1e-6if Error_rms < errorExpected then test = Passed
Realtolerance100*Modelica.Constants.epseps = tolerance*MachineError to avoid division by 0
BooleanprintResultfalseSave success/fail result to file
Stringname""Name of example for log file identification

Components

TypeNameDefaultDescription
Real[n]xVariables of interest
Real[n]x_referencefill(0, n)Reference values
RealError_rmsRoot Mean Square error sqrt(sum(Error_abs.^2)/n)
RealError_rmsRelRoot Mean Square error sqrt(sum(Error_rel.^2)/n)
RealError_absAbsolute error (x - x_reference)
Units.NonDimError_relRelative error (x - x_reference)/x_reference
BooleanallPassed=true if x = x_reference for all times within tolerance