Docstrings · FMI.jl

Core.Union — Method

(str::Union{fmi2Struct, fmi3Struct})(; t::Tuple{Float64, Float64}, kwargs...)

Wrapper for dispatch to fmiSimulate.

FMI.fmi2GetBooleanStatus — Method

fmi2GetBooleanStatus(fmu::FMU2, args...; kwargs...)

Wrapper for fmi2GetBooleanStatus!(c::FMU2Component, args...; kwargs...) without a provided FMU2Component. (Component c gets selected from fmu)

FMI.fmi2GetDependencies — Method

fmi2GetDependencies(fmu::FMU2)

Build dependency Matrix{Union{fmi2DependencyKind, Nothing}} of dimension n x n for fast look-ups on dependencies between value references (n is number of states of the fmu).

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.22]: 2.1.4 Inquire Platform and Version Number of Header Files
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions

FMI.fmi2GetIntegerStatus — Method

fmi2GetIntegerStatus(fmu::FMU2, args...; kwargs...)

Wrapper for fmi2GetIntegerStatus!(c::FMU2Component, args...; kwargs...) without a provided FMU2Component. (Component c gets selected from fmu)

FMI.fmi2GetRealStatus — Method

fmi2GetRealStatus(fmu::FMU2, args...; kwargs...)

Wrapper for fmi2GetRealStatus!(c::FMU2Component, args...; kwargs...) without a provided FMU2Component. (Component c gets selected from fmu)

FMI.fmi2GetStatus — Method

fmi2GetStatus(fmu::FMU2, args...; kwargs...)

Wrapper for fmi2GetStatus!(c::FMU2Component, args...; kwargs...) without a provided FMU2Component. (Component c gets selected from fmu)

FMI.fmi2GetStringStatus — Method

fmi2GetStringStatus(fmu::FMU2, args...; kwargs...)

Wrapper for fmi2GetStringStatus!(c::FMU2Component, args...; kwargs...) without a provided FMU2Component. (Component c gets selected from fmu)

FMI.fmi2Info — Method

 fmi2Info(fmu::FMU2)

Print information about the fmu.

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.22]: 2.1.4 Inquire Platform and Version Number of Header Files
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions

FMI.fmi2PrintDependencies — Method

fmi2PrintDependencies(fmu::FMU2)

Print the dependency matrix for fmu as returned by fmi2GetDependencies.

See also fmiSetState, fmiGetState.

FMI.fmiGet! — Method

fmiGet!(str::fmi2Struct, comp::FMU2Component, vrs::fmi2ValueReferenceFormat, dstArray::AbstractArray)

Stors the specific value of fmi2ScalarVariable containing the modelVariables with the identical fmi2ValueReference in an array.

Arguments

str::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
dstArray::AbstractArray: Stores the specific value of fmi2ScalarVariable containing the modelVariables with the identical fmi2ValueReference to the input variable vr (vr = vrs[i]). dstArray has the same length as vrs.

Returns

retcodes::Array{fmi2Status}: Returns an array of length length(vrs) with Type fmi2Status. Type fmi2Status is an enumeration and indicates the success of the function call.

More detailed:

fmi2OK: all well
fmi2Warning: things are not quite right, but the computation can continue
fmi2Discard: if the slave computed successfully only a subinterval of the communication step
fmi2Error: the communication step could not be carried out at all
fmi2Fatal: if an error occurred which corrupted the FMU irreparably
fmi2Pending: this status is returned if the slave executes the function asynchronously

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.23]: 2.1.6 Initialization, Termination, and Resetting an FMU
FMISpec2.0.2[p.18]: 2.1.3 Status Returned by Functions

FMI.fmiGet — Method

fmiGet(str::fmi2Struct, comp::FMU2Component, vrs::fmi2ValueReferenceFormat)

Returns the specific value of fmi2ScalarVariable containing the modelVariables with the identical fmi2ValueReference in an array.

Arguments

str::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
vrs::fmi2ValueReferenceFormat: wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi2ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi2ValueReference, Array{fmi2ValueReference,1}, Int64, Array{Int64,1}, Symbol}

Returns

dstArray::Array{Any,1}(undef, length(vrs)): Stores the specific value of fmi2ScalarVariable containing the modelVariables with the identical fmi2ValueReference to the input variable vr (vr = vrs[i]). dstArray is a 1-Dimensional Array that has the same length as vrs.

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.23]: 2.1.6 Initialization, Termination, and Resetting an FMU
FMISpec2.0.2[p.18]: 2.1.3 Status Returned by Functions

FMI.fmiGetBoolean! — Method

DEPRECATED fmiGetBoolean!(str::fmi2Struct, c::FMU2Component, vr::fmi2ValueReferenceFormat, values::Array{fmi2Boolean})

Writes the boolean values of an array of variables in the given field

fmi2GetBoolean! is only possible for arrays of values, please use an array instead of a scalar.

Arguments

str::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
vr::fmi2ValueReferenceFormat: Argument vr defines the value references of the variables.

More detailed: fmi2ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi2ValueReference, Array{fmi2ValueReference,1}, Int64, Array{Int64,1}, Symbol}

vr::Array{fmi2ValueReference}: Argument vr is an array of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::Union{Array{<:Integer}, <:Integer}: Argument values is an array or a single value with type Integer or any subtyp
value::Array{fmi2Integer}: Argument values is an array with the actual values of these variables.

Returns

status::fmi2Status: Return status is an enumeration of type fmi2Status and indicates the success of the function call.

More detailed:

fmi2OK: all well
fmi2Warning: things are not quite right, but the computation can continue
fmi2Discard: if the slave computed successfully only a subinterval of the communication step
fmi2Error: the communication step could not be carried out at all
fmi2Fatal: if an error occurred which corrupted the FMU irreparably
fmi2Pending: this status is returned if the slave executes the function asynchronously

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.24]: 2.1.7 Getting and Setting Variable Values
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions
FMISpec2.0.2[p.18]: 2.1.3 Status Returned by Functions

FMI.fmiGetBoolean — Method

DEPRECATED fmiGetBoolean(str::fmi2Struct, c::FMU2Component, vr::fmi2ValueReferenceFormat)

Returns the boolean values of an array of variables

Arguments

str::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
vr::fmi2ValueReferenceFormat: Argument vr defines the value references of the variables.

More detailed: fmi2ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi2ValueReference, Array{fmi2ValueReference,1}, Int64, Array{Int64,1}, Symbol}

Returns

values::Array{fmi2Boolean}: Return values is an array with the actual values of these variables.

FMI.fmiGetContinuousStates — Method

DEPRECATED fmiGetContinuousStates(s::fmi2Struct)

Return the new (continuous) state vector x

Arguments

s::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

s::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
s::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.

Returns

x::Array{fmi2Real}: Returns an array of fmi2Real values representing the new continuous state vector x.

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions (fmi2TypesPlatform.h)
FMISpec2.0.2[p.16]: 2.1.3 Status Returned by Functions
FMISpec2.0.2[p.83]: 3.2.2 Evaluation of Model Equations

FMI.fmiGetDependencies — Method

fmiGetDependencies(fmu::FMU2)

Wrapper for fmi2GetDependencies.

FMI.fmiGetDependencies — Method

fmiGetDependencies(fmu::FMU3)

Wrapper for fmi3GetDependencies.

FMI.fmiGetDirectionalDerivative! — Method

DEPRECATEDTODO -> Arguments fmiGetDirectionalDerivative!(str::fmi2Struct, c::FMU2Component, vUnknownref::AbstractArray{fmi2ValueReference}, vKnownref::AbstractArray{fmi2ValueReference}, dvUnknown::AbstractArray, dvKnown::Union{Array{fmi2Real}, Nothing} = nothing)

fmiGetDirectionalDerivative!(str::fmi2Struct, c::FMU2Component,
                                   vUnknown_ref::AbstractArray{fmi2ValueReference},
                                   nUnknown::Csize_t,
                                   vKnown_ref::AbstractArray{fmi2ValueReference},
                                   nKnown::Csize_t,
                                   dvKnown::AbstractArray{fmi2Real},
                                   dvUnknown::AbstractArray)

Wrapper Function call to compute the partial derivative with respect to the variables vKnown_ref.

Computes the directional derivatives of an FMU. An FMU has different Modes and in every Mode an FMU might be described by different equations and different unknowns.The precise definitions are given in the mathematical descriptions of Model Exchange (section 3.1) and Co-Simulation (section 4.1). In every Mode, the general form of the FMU equations are: 𝐯unknown = 𝐡(𝐯known, 𝐯_rest)

v_unknown: vector of unknown Real variables computed in the actual Mode:
- Initialization Mode: unkowns kisted under <ModelStructure><InitialUnknowns> that have type Real.
- Continuous-Time Mode (ModelExchange): The continuous-time outputs and state derivatives. (= the variables listed under <ModelStructure><Outputs> with type Real and variability = continuous and the variables listed as state derivatives under <ModelStructure><Derivatives>).
- Event Mode (ModelExchange): The same variables as in the Continuous-Time Mode and additionally variables under <ModelStructure><Outputs> with type Real and variability = discrete.
- Step Mode (CoSimulation): The variables listed under <ModelStructure><Outputs> with type Real and variability = continuous or discrete. If <ModelStructure><Derivatives> is present, also the variables listed here as state derivatives.
v_known: Real input variables of function h that changes its value in the actual Mode.
v_rest:Set of input variables of function h that either changes its value in the actual Mode but are non-Real variables, or do not change their values in this Mode, but change their values in other Modes

Computes a linear combination of the partial derivatives of h with respect to the selected input variables 𝐯_known:

Δvunknown = (δh / δvknown) Δv_known

Arguments

str::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
vUnknown_ref::AbstracArray{fmi2ValueReference}: Argument vUnknown_ref contains values of typefmi2ValueReference which are identifiers of a variable value of the model. vUnknown_ref can be equated with v_unknown(variable described above).
vKnown_ref::AbstractArray{fmi2ValueReference}: Argument vKnown_ref contains values of type fmi2ValueReference which are identifiers of a variable value of the model.vKnown_ref can be equated with v_known(variable described above).
dvUnknown::AbstractArray: Stores the directional derivative vector values.
dvKnown::Union{Array{fmi2Real}, Nothing} = nothing: If no seed vector is passed the value nothing is used. The vector values Compute the partial derivative with respect to the given entries in vector vKnown_ref with the matching evaluate of dvKnown.
dvKnown::AbstractArray{fmi2Real}:The vector values Compute the partial derivative with respect to the given entries in vector vKnown_ref with the matching evaluate of dvKnown.
nUnknown::Csize_t:
nKnown::Csize_t:

Returns

status::fmi2Status: Return status is an enumeration of type fmi2Status and indicates the success of the function call.

More detailed:

fmi2OK: all well
fmi2Warning: things are not quite right, but the computation can continue
fmi2Discard: if the slave computed successfully only a subinterval of the communication step
fmi2Error: the communication step could not be carried out at all
fmi2Fatal: if an error occurred which corrupted the FMU irreparably
fmi2Pending: this status is returned if the slave executes the function asynchronously

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions (fmi2TypesPlatform.h)
FMISpec2.0.2[p.16]: 2.1.3 Status Returned by Functions
FMISpec2.0.2[p.25]: 2.1.9 Getting Partial Derivatives

FMI.fmiGetDirectionalDerivative — Method

DEPRECATED fmiGetDirectionalDerivative(str::fmi2Struct, c::FMU2Component, vUnknownref::AbstractArray{fmi2ValueReference}, vKnownref::AbstractArray{fmi2ValueReference}, dvKnown::Union{AbstractArray{fmi2Real}, Nothing} = nothing)

fmi2GetDirectionalDerivative(str::fmi2Struct, c::FMU2Component,
                                    vUnknown_ref::fmi2ValueReference,
                                    vKnown_ref::fmi2ValueReference,
                                    dvKnown::fmi2Real = 1.0)

The Wrapper Function and the Direct function call to compute the partial derivative with respect to vKnown_ref.

v_unknown: vector of unknown Real variables computed in the actual Mode:
- Initialization Mode: unkowns kisted under <ModelStructure><InitialUnknowns> that have type Real.
- Continuous-Time Mode (ModelExchange): The continuous-time outputs and state derivatives. (= the variables listed under <ModelStructure><Outputs> with type Real and variability = continuous and the variables listed as state derivatives under <ModelStructure><Derivatives>).
- Event Mode (ModelExchange): The same variables as in the Continuous-Time Mode and additionally variables under <ModelStructure><Outputs> with type Real and variability = discrete.
- Step Mode (CoSimulation): The variables listed under <ModelStructure><Outputs> with type Real and variability = continuous or discrete. If <ModelStructure><Derivatives> is present, also the variables listed here as state derivatives.
v_known: Real input variables of function h that changes its value in the actual Mode.
v_rest:Set of input variables of function h that either changes its value in the actual Mode but are non-Real variables, or do not change their values in this Mode, but change their values in other Modes

Computes a linear combination of the partial derivatives of h with respect to the selected input variables 𝐯_known:

Δv_unknown = (δh / δv_known) Δv_known

Arguments

str::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
vUnknown_ref::AbstractArray{fmi2ValueReference}: Argument vUnknown_ref contains values of typefmi2ValueReference which are identifiers of a variable value of the model. vUnknown_ref can be equated with v_unknown(variable described above).
vUnknown_ref::fmi2ValueReference: Argument vUnknown_ref contains a value of typefmi2ValueReference which is an identifier of a variable value of the model. vUnknown_ref can be equated with v_unknown(variable described above).
vKnown_ref::AbstractArray{fmi2ValueReference}: Argument vKnown_ref contains values of type fmi2ValueReference which are identifiers of a variable value of the model.vKnown_ref can be equated with v_known(variable described above).
vKnown_ref::fmi2ValueReference: Argument vKnown_ref contains a value of typefmi2ValueReference which is an identifier of a variable value of the model. vKnown_ref can be equated with v_known(variable described above).
dvKnown::Union{AbstractArray{fmi2Real}, Nothing} = nothing: If no seed vector is passed the value nothing is used. The vector values Compute the partial derivative with respect to the given entries in vector vKnown_ref with the matching evaluate of dvKnown.
dvKnown::Fmi2Real = 1.0: If no seed value is passed the value dvKnown = 1.0 is used. Compute the partial derivative with respect to vKnown_ref with the value dvKnown = 1.0. # gehört das zu den v_rest values

Returns

dvUnknown::Array{fmi2Real}: Return dvUnknown contains the directional derivative vector values.

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions (fmi2TypesPlatform.h)
FMISpec2.0.2[p.16]: 2.1.3 Status Returned by Functions
FMISpec2.0.2[p.25]: 2.1.9 Getting Partial Derivatives

FMI.fmiGetEventIndicators — Method

DEPRECATED fmiGetEventIndicators(str::fmi2Struct)

Returns the event indicators of the FMU

Arguments

str::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.

Returns

eventIndicators::Array{fmi2Real}:The event indicators are returned as a vector represented by an array of "fmi2Real" values.

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions (fmi2TypesPlatform.h)
FMISpec2.0.2[p.16]: 2.1.3 Status Returned by Functions
FMISpec2.0.2[p.83]: 3.2.2 Evaluation of Model Equations

FMI.fmiGetGUID — Method

fmiGetGUID(str::fmi2StructMD)

Return the guid from str's model description.

Wrapper for fmi2GetGUID.

FMI.fmiGetGenerationDateAndTime — Method

fmiGetGenerationDateAndTime(str::fmi2StructMD)

Returns the generationdateandtime from str's model description.

Wrapper for fmi2GetGenerationDateAndTime.

FMI.fmiGetGenerationDateAndTime — Method

fmiGetGenerationDateAndTime(str::fmi3StructMD)

Returns the generationdateandtime from str's model description.

Wrapper for fmi3GetGenerationDateAndTime.

FMI.fmiGetGenerationTool — Method

fmiGetGenerationTool(str::fmi2StructMD)

Returns the generationtool from str's model description.

Wrapper for fmi2GetGenerationTool.

FMI.fmiGetGenerationTool — Method

fmiGetGenerationTool(str::fmi3StructMD)

Returns the generationtool from str's model description.

Wrapper for fmi3GetGenerationTool.

FMI.fmiGetInteger! — Method

DEPRECATED function fmiGetInteger!(str::fmi2Struct, c::FMU2Component, vr::fmi2ValueReferenceFormat, values::Array{fmi2Integer})

function fmiGetInteger!(str::fmi2Struct, c::FMU2Component, vr::fmi2ValueReferenceFormat, values::Array{fmi2Integer})

Writes the integer values of an array of variables in the given field

fmi2GetInteger! is only possible for arrays of values, please use an array instead of a scalar.

Arguments

str::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
vr::fmi2ValueReferenceFormat: Argument vr defines the value references of the variables.

More detailed: fmi2ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi2ValueReference, Array{fmi2ValueReference,1}, Int64, Array{Int64,1}, Symbol}

vr::Array{fmi2ValueReference}: Argument vr is an array of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::Array{fmi2Integer}: Argument values is an array with the actual values of these variables.

Returns

status::fmi2Status: Return status is an enumeration of type fmi2Status and indicates the success of the function call.

More detailed:

fmi2OK: all well
fmi2Warning: things are not quite right, but the computation can continue
fmi2Discard: if the slave computed successfully only a subinterval of the communication step
fmi2Error: the communication step could not be carried out at all
fmi2Fatal: if an error occurred which corrupted the FMU irreparably
fmi2Pending: this status is returned if the slave executes the function asynchronously

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.24]: 2.1.7 Getting and Setting Variable Values
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions
FMISpec2.0.2[p.18]: 2.1.3 Status Returned by Functions

FMI.fmiGetInteger — Method

DEPRECATED fmiGetInteger(str::fmi2Struct,c::FMU2Component, vr::fmi2ValueReferenceFormat)

Returns the integer values of an array of variables

Arguments

str::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
vr::fmi2ValueReferenceFormat: Argument vr defines the value references of the variables

More detailed: fmi2ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi2ValueReference, Array{fmi2ValueReference,1}, Int64, Array{Int64,1}, Symbol}

Returns

values::Array{fmi2Integer}: Return values is an array with the actual values of these variables.

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.24]: 2.1.7 Getting and Setting Variable Values
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions
FMISpec2.0.2[p.18]: 2.1.3 Status Returned by Functions

FMI.fmiGetModelIdentifier — Method

fmiGetModelIdentifier(fmu::Union{FMU2, FMU3})

Returns the tag 'modelIdentifier' from CS or ME section.

Arguments

fmu::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
fmu::FMU3: Mutable struct representing a FMU and all it instantiated instances in the FMI 3.0 Standard.

Returns

fmu.modelDescription.coSimulation.modelIdentifier: The function fmiGetModelIdentifier returns the tag 'coSimulation.modelIdentifier' from the model description of the FMU2 or FMU3-struct (fmu.modelDescription), if the FMU supports co simulation.
fmu.modelDescription.modelExchange.modelIdentifier: The function fmiGetModelIdentifier returns the tag 'modelExchange.modelIdentifier' from the model description of the FMU2 or FMU3-struct (fmu.modelDescription), if the FMU supports model exchange
fmu.modelDescription.modelExchange.modelIdentifier: The function fmiGetModelIdentifier returns the tag 'scheduledExecution.modelIdentifier' from the model description of the FMU3-struct (fmu.modelDescription), if the FMU supports scheduled execution

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.22]: 2.1.4 Inquire Platform and Version Number of Header Files
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions

Also see fmi2GetModelIdentifier, FMU2, fmi3GetModelIdentifier, FMU3.

FMI.fmiGetModelName — Method

fmiGetModelName(str::fmi2StructMD)

Return the modelName from str's model description.

Wrapper for fmi2GetModelName.

FMI.fmiGetModelName — Method

fmiGetModelName(str::fmi3StructMD)

Return the modelName from str's model description.

Wrapper for fmi3GetModelName.

FMI.fmiGetNominalsOfContinuousStates — Method

DEPRECATED fmiGetNominalsOfContinuousStates(s::fmi2Struct)

Return the new (continuous) state vector x

Arguments

s::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

s::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
s::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.

Returns

x::Array{fmi2Real}: Returns an array of fmi2Real values representing the new continuous state vector x.

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions (fmi2TypesPlatform.h)
FMISpec2.0.2[p.16]: 2.1.3 Status Returned by Functions
FMISpec2.0.2[p.83]: 3.2.2 Evaluation of Model Equations

FMI.fmiGetNumberOfEventIndicators — Method

fmiGetNumberOfEventIndicators(str::fmi2StructMD)

Returns the numberOfEventIndicators from str's model description.

Wrapper for fmi2GetNumberOfEventIndicators.

FMI.fmiGetNumberOfEventIndicators — Method

fmiGetNumberOfEventIndicators(str::fmi3StructMD)

Returns the numberOfEventIndicators from str's model description.

Wrapper for fmi3GetNumberOfEventIndicators.

FMI.fmiGetNumberOfStates — Method

fmiGetNumberOfStates(str::Union{fmi2Struct, fmi3Struct})

Returns the number of states of the FMU.

Arguments

str::Union{fmi2Struct, fmi3Struct}: Representative for an FMU in the FMI 2.0.2 Standard or FMI 3.0 Standard. Other notation:

More detailed: fmi2Struct = Union{FMU2, FMU2Component} More detailed: fmi3StructMD = Union{FMU3, FMU3Instance, fmi3ModelDescription}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
str::FMU3: Mutable struct representing an FMU in the FMI 3.0 Standard.
str::FMU3Instance: Mutable struct represents a pointer to an FMU specific data structure that contains the information needed. Also in FMI 3.0 Standard.

Returns

Returns the length of the md.valueReferences::Array{fmi2ValueReference} corresponding to the number of states of the FMU.

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.22]: 2.1.4 Inquire Platform and Version Number of Header Files
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions

FMI.fmiGetReal! — Method

DEPRECATED fmiGetReal!(str::fmi2Struct, c::FMU2Component, vr::fmi2ValueReferenceFormat, values::Array{fmi2Real})

fmiGetReal!(str::fmi2Struct, c::FMU2Component, vr::Array{fmi2ValueReference}, nvr::Csize_t, value::Array{fmi2Real})

Writes the real values of an array of variables in the given field

Arguments

str::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
vr::fmi2ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi2ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi2ValueReference, Array{fmi2ValueReference,1}, Int64, Array{Int64,1}, Symbol}

vr::Array{fmi2ValueReference}: Argument vr is an array of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::Array{fm2Real}: Argument values is an array with the actual values of these variables.

Returns

status::fmi2Status: Return status is an enumeration of type fmi2Status and indicates the success of the function call.

More detailed:

fmi2OK: all well
fmi2Warning: things are not quite right, but the computation can continue
fmi2Discard: if the slave computed successfully only a subinterval of the communication step
fmi2Error: the communication step could not be carried out at all
fmi2Fatal: if an error occurred which corrupted the FMU irreparably
fmi2Pending: this status is returned if the slave executes the function asynchronously

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.24]: 2.1.7 Getting and Setting Variable Values
FMISpec2.0.2[p.18]: 2.1.3 Status Returned by Functions

FMI.fmiGetReal — Method

fmiGetReal(str::fmi2Struct, vr::fmi2ValueReferenceFormat)

Returns the real values of an array of variables

Arguments

str::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
vr::fmi2ValueReferenceFormat: wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi2ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi2ValueReference, Array{fmi2ValueReference,1}, Int64, Array{Int64,1}, Symbol}

Returns

values::Array{fm2Real}: returns values of an array of fmi2Real variables with the dimension of fmi2ValueReferenceFormat length.

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.24]: 2.1.7 Getting and Setting Variable Values
FMISpec2.0.2[p.18]: 2.1.3 Status Returned by Functions

FMI.fmiGetStartValue — Method

fmiGetStartValue(s::fmi2Struct, vr::fmi2ValueReferenceFormat)

Returns the start/default value for a given value reference.

Arguments

md::fmi2ModelDescription: Struct which provides the static information of ModelVariables.
vrs::fmi2ValueReferenceFormat = md.valueReferences: wildcards for how a user can pass a fmi[X]ValueReference (default = md.valueReferences)

More detailed: fmi2ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi2ValueReference, Array{fmi2ValueReference,1}, Int64, Array{Int64,1}, Symbol}

Returns

starts::Array{fmi2ValueReferenceFormat}: start/default value for a given value reference

FMI.fmiGetState — Method

fmiGetState(str::fmi2Struct)

Wrapper for fmi2GetFMUstate.

FMI.fmiGetState — Method

fmiGetState(str::fmi3Struct)

Wrapper for fmi3GetFMUState.

FMI.fmiGetString! — Method

DEPRECATED fmiGetString!(str::fmi2Struct, c::FMU2Component, vr::fmi2ValueReferenceFormat, values::Array{fmi2String})

fmiGetString!(str::fmi2Struct, c::FMU2Component, vr::Array{fmi2ValueReference}, nvr::Csize_t, value::Vector{Ptr{Cchar}})

Writes the string values of an array of variables in the given field

These functions are especially used to get the actual values of output variables if a model is connected with other models.

Arguments

str::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
vr::fmi2ValueReferenceFormat: Argument vr defines the value references of the variables.

More detailed: fmi2ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi2ValueReference, Array{fmi2ValueReference,1}, Int64, Array{Int64,1}, Symbol}

vr::Array{fmi2ValueReference}: Array of the FMI2 Data Typ fmi2ValueReference
nvr::Csize_t: Argument nvr defines the size of vr.
values::Union{Array{Bool}, Bool}: Argument values is an array or a single value with type Boolean or any subtyp.
value::Vector{Ptr{Cchar}}: Argument values is an vector with the actual values of these variables.

Returns

status::fmi2Status: Return status is an enumeration of type fmi2Status and indicates the success of the function call.

More detailed:

fmi2OK: all well
fmi2Warning: things are not quite right, but the computation can continue
fmi2Discard: if the slave computed successfully only a subinterval of the communication step
fmi2Error: the communication step could not be carried out at all
fmi2Fatal: if an error occurred which corrupted the FMU irreparably
fmi2Pending: this status is returned if the slave executes the function asynchronously

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.24]: 2.1.7 Getting and Setting Variable Values
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions
FMISpec2.0.2[p.18]: 2.1.3 Status Returned by Functions

FMI.fmiGetString — Method

DEPRECATED fmiGetString(str::fmi2Struct, c::FMU2Component, vr::fmi2ValueReferenceFormat)

Returns the string values of an array of variables

Arguments

str::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
vr::fmi2ValueReferenceFormat: Argument vr defines the value references of the variables.

More detailed: fmi2ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi2ValueReference, Array{fmi2ValueReference,1}, Int64, Array{Int64,1}, Symbol}

Returns

values::Array{fmi2String}: Return values is an array with the actual values of these variables.

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.24]: 2.1.7 Getting and Setting Variable Values
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions
FMISpec2.0.2[p.18]: 2.1.3 Status Returned by Functions

FMI.fmiGetTypesPlatform — Method

fmiGetTypesPlatform(str::fmi2Struct)

Returns the header file used to compile the FMU. By default returns default, version independent.

Arguments

str::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.

Returns

Returns the string to uniquely identify the “fmi2TypesPlatform.h” header file used for compilation of the functions of the FMU.

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.22]: 2.1.4 Inquire Platform and Version Number of Header Files
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions

FMI.fmiGetVariableNamingConvention — Method

fmiGetVariableNamingConvention(str::fmi2StructMD)

Returns the varaiblenamingconvention from str's model description.

Wrapper for fmi2GetVariableNamingConvention.

FMI.fmiGetVariableNamingConvention — Method

fmiGetVariableNamingConvention(str::fmi3StructMD)

Returns the varaiblenamingconvention from str's model description.

Wrapper for fmi3GetVariableNamingConvention.

FMI.fmiGetVersion — Method

fmiGetVersion(str::Union{fmi2Struct, fmi3Struct})

Returns the version of the FMU, version independent.

Arguments

str::Union{fmi2Struct, fmi3Struct}: Representative for an FMU in the FMI 2.0.2 Standard or FMI 3.0 Standard. Other notation:

More detailed: fmi2Struct = Union{FMU2, FMU2Component} More detailed: fmi3StructMD = Union{FMU3, FMU3Instance, fmi3ModelDescription}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
str::FMU3: Mutable struct representing an FMU in the FMI 3.0 Standard.
str::FMU3Instance: Mutable struct represents a pointer to an FMU specific data structure that contains the information needed. Also in FMI 3.0 Standard.

Returns

Returns a string from the address of a C-style (NUL-terminated) string. The string represents the version of the “fmiXFunctions.h” header file which was used to compile the functions of the FMU. The function returns “fmiVersion” which is defined in this header file. The standard header file as documented in this specification has version “2.0” or "3.0"

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.22]: 2.1.4 Inquire Platform and Version Number of Header Files
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions
FMISpec3.0[p. ]: 2.2.5. Inquire Version Number of Header Files

FMI.fmiInfo — Method

fmiInfo(str::fmi2Struct)

Prints FMU-specific information into the REPL.

Arguments

str::Union{fmi2Struct, fmi3Struct}: Representative for an FMU in the FMI 2.0.2 Standard or FMI 3.0 Standard. Other notation:

More detailed: fmi2Struct = Union{FMU2, FMU2Component} More detailed: fmi3StructMD = Union{FMU3, FMU3Instance, fmi3ModelDescription}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
str::FMU3: Mutable struct representing an FMU in the FMI 3.0 Standard.
str::FMU3Instance: Mutable struct represents a pointer to an FMU specific data structure that contains the information needed. Also in FMI 3.0 Standard.

Returns

Prints FMU related information.

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec3.0 Link: https://fmi-standard.org/

FMI.fmiInstantiate! — Method

DEPRECATED fmiInstantiate!(fmu::FMU2; pushComponents::Bool = true, visible::Bool = false, loggingOn::Bool = false, externalCallbacks::Bool = false, logStatusOK::Bool=true, logStatusWarning::Bool=true, logStatusDiscard::Bool=true, logStatusError::Bool=true, logStatusFatal::Bool=true, logStatusPending::Bool=true)

Creates a new instance of the FMU, version independent.

Create a new instance of the given fmu, adds a logger if logginOn == true.

Arguments

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.

Keywords

pushComponents::Bool = true: pushComponents if the item component should be inserted in fmu.components(default = true).
visible::Bool = false: visible if the FMU should be started with graphic interface, if supported (default=false)
loggingOn::Bool = false: loggingOn if the FMU should log and display function calls (default=false)
externalCallbacks::Bool = false: externalCallbacks if an external DLL should be used for the fmi2CallbackFunctions, this may improve readability of logging messages (default=false)
logStatusOK::Bool=true: logStatusOK whether to log status of kind fmi2OK (default=true)
logStatusWarning::Bool=true: logStatusWarning whether to log status of kind fmi2Warning (default=true)
logStatusDiscard::Bool=true: logStatusDiscard whether to log status of kind fmi2Discard (default=true)
logStatusError::Bool=true: logStatusError whether to log status of kind fmi2Error (default=true)
logStatusFatal::Bool=true: logStatusFatal whether to log status of kind fmi2Fatal (default=true)
logStatusPending::Bool=true: logStatusPending whether to log status of kind fmi2Pending (default=true)

Returns

nothing: if the instantiation failed. In addition, an error message appears.
component: Returns the instance of a new FMU component.

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.19]: 2.1.5 Creation, Destruction and Logging of FMU Instances

FMI.fmiIsCoSimulation — Method

fmiIsCoSimulation(str::Union{fmi2StructMD, fmi3StructMD})

Returns true, if the FMU supports co simulation

Arguments

str::Union{fmi2StructMD, fmi3StructMD}: Representative for an FMU in the FMI 2.0.2 Standard or FMI 3.0 Standard. Other notation:

More detailed: fmi2StructMD = Union{FMU2, FMU2Component, fmi2ModelDescription} More detailed: fmi3StructMD = Union{FMU3, FMU3Instance, fmi3ModelDescription}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
str::fmi2ModelDescription: Struct witch provides the static information of ModelVariables.
str::FMU3: Mutable struct representing an FMU in the FMI 3.0 Standard.
str::FMU3Instance: Mutable struct represents a pointer to an FMU specific data structure that contains the information needed. Also in FMI 3.0 Standard.
str::fmi3ModelDescription: Struct witch provides the static information of ModelVariables.

Returns

::Bool: The function fmi2IsCoSimulation returns True, if the FMU supports co simulation

FMI.fmiIsModelExchange — Method

fmiIsModelExchange(str::Union{fmi2StructMD, fmi3StructMD})

Returns true, if the FMU supports model exchange

Arguments

str::Union{fmi2StructMD, fmi3StructMD}: Representative for an FMU in the FMI 2.0.2 Standard or FMI 3.0 Standard. Other notation:

More detailed: fmi2StructMD = Union{FMU2, FMU2Component, fmi2ModelDescription} More detailed: fmi3StructMD = Union{FMU3, FMU3Instance, fmi3ModelDescription}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
str::fmi2ModelDescription: Struct witch provides the static information of ModelVariables.
str::FMU3: Mutable struct representing an FMU in the FMI 3.0 Standard.
str::FMU3Instance: Mutable struct represents a pointer to an FMU specific data structure that contains the information needed. Also in FMI 3.0 Standard.
str::fmi3ModelDescription: Struct witch provides the static information of ModelVariables.

Returns

::Bool: The function fmi2IsModelExchange returns True, if the FMU supports model exchange.

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.22]: 2.1.4 Inquire Platform and Version Number of Header Files
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions

FMI.fmiIsScheduledExecution — Method

fmiIsScheduledExecution(str::fmi3StructMD)

Returns true, if the FMU supports scheduled execution

Arguments

str::fmi3StructMD: Representative for an FMU in the FMI 3.0 Standard. Other notation:

More detailed: fmi3StructMD = Union{FMU3, FMU3Instance, fmi3ModelDescription}

str::FMU3: Mutable struct representing an FMU in the FMI 3.0 Standard.
str::FMU3Instance: Mutable struct represents a pointer to an FMU specific data structure that contains the information needed. Also in FMI 3.0 Standard.
str::fmi3ModelDescription: Struct witch provides the static information of ModelVariables.

Returns

::Bool: The function fmi3IsScheduledExecution returns True, if the FMU supports scheduled execution.

FMI.fmiLoad — Method

fmiLoad(pathToFMU::String; unpackPath=nothing, type=nothing)

Load FMUs independent of the FMI version, currently supporting version 2.0.X and 3.0.

Arguments

pathToFMU::String: String that contains the paths of ziped and unziped FMU folders.

Keywords

unpackPath=nothing: Via optional argument unpackPath, a path to unpack the FMU can be specified (default: system temporary directory).
type::Union{CS, ME, SE} = nothing: Via type, a FMU type can be selected. If none of the unified type set is used, the default value type = nothing will be used.

Returns

Returns the instance of the FMU struct.

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.22]: 2.1.4 Inquire Platform and Version Number of Header Files
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions

See also fmi2Reload, fmi3Reload.

FMI.fmiReset — Method

DEPRECATED fmiReset(str::fmi2Struct)

Resets the FMU after a simulation run, version independent.

Arguments

str::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.

Returns

Returns a warning if str.state is not called in fmi2ComponentStateTerminated or fmi2ComponentStateError.
Returns an error if the reinstantiation failed.
status::fmi2Status: Return status is an enumeration of type fmi2Status and indicates the success of the function call.

More detailed:

fmi2OK: all well
fmi2Warning: things are not quite right, but the computation can continue
fmi2Discard: if the slave computed successfully only a subinterval of the communication step
fmi2Error: the communication step could not be carried out at all
fmi2Fatal: if an error occurred which corrupted the FMU irreparably
fmi2Pending: this status is returned if the slave executes the function asynchronously

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.23]: 2.1.6 Initialization, Termination, and Resetting an FMU
FMISpec2.0.2[p.18]: 2.1.3 Status Returned by Functions

FMI.fmiSampleJacobian! — Method

#TODO Samples the values of the jacobian (in-place).

FMI.fmiSampleJacobian — Method

fmiSampleJacobian(str::fmi2Struct, c::FMU2Component,
                                   vUnknown_ref::Array{fmi2ValueReference},
                                   vKnown_ref::Array{fmi2ValueReference},
                                   steps::Array{fmi2Real} = ones(fmi2Real, length(vKnown_ref)).*1e-5)
fmiSampleJacobian(str::fmi2Struct, c::FMU2Component,
                                   vUnknown_ref::AbstractArray{fmi2ValueReference},
                                   vKnown_ref::AbstractArray{fmi2ValueReference},
                                   steps::Union{AbstractArray{fmi2Real}, Nothing} = nothing)

This function samples the jacobian by manipulating corresponding values (central differences).

Arguments

str::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
vUnknown_ref::Array{fmi2ValueReference}: Argument vUnKnown_ref contains values of type fmi2ValueReference which are identifiers of a variable value of the model.vKnown_ref is the Array of the vector values of Real input variables of function h that changes its value in the actual Mode.
vKnown_ref::Array{fmi2ValueReference}: Argument vKnown_ref contains values of type fmi2ValueReference which are identifiers of a variable value of the model.vKnown_ref is the Array of the vector values of Real input variables of function h that changes its value in the actual Mode.
steps::Array{fmi2Real} = ones(fmi2Real, length(vKnown_ref)).*1e-5: Predefined step size vector steps, where all entries have the value 1e-5.
steps::Union{AbstractArray{fmi2Real}, Nothing} = nothing: Step size to be used for numerical differentiation. If nothing, a default value will be chosen automatically.

Returns

dvUnknown::Arrya{fmi2Real}:

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions (fmi2TypesPlatform.h)

FMI.fmiSaveSolution — Method

fmiSaveSolution(solution::FMUSolution, filepath::AbstractString [; keyword="solution"])

Save a solution of an FMU simulation at filepath.

Currently .mat, .jld2 and .csv are supported for saving and selected by the ending of filepath. For JLD2 the keyword is used as key. Loading a FMUSolution into FMI.jl is currently only possible for .jld2 files.

FMI.fmiSerializeFMUstate — Method

DEPRECATED fmiSerializeFMUstate(str::fmi2Struct, c::FMU2Component, state::fmi2FMUstate)

Serializes the data referenced by the pointer FMUstate and copies this data into the byte vector serializedState of length size to be provided by the environment.

Arguments

str::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
state::fmi2FMUstate: Argument state is a pointer to a data structure in the FMU that saves the internal FMU state of the actual or a previous time instant.

Returns

serialized:: Array{fmi2Byte}: Return serializedState contains the copy of the serialized data referenced by the pointer FMUstate

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions (fmi2TypesPlatform.h)
FMISpec2.0.2[p.16]: 2.1.3 Status Returned by Functions
FMISpec2.0.2[p.25]: 2.1.8 Getting and Setting the Complete FMU State

FMI.fmiSerializedFMUstateSize — Method

DEPRECATED fmiSerializedFMUstateSize(str::fmi2Struct, c::FMU2Component, state::fmi2FMUstate)

Returns the size of the byte vector in which the FMUstate can be stored.

Arguments

str::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
state::fmi2FMUstate: Argument state is a pointer to a data structure in the FMU that saves the internal FMU state of the actual or a previous time instant.

Returns

Return size is an object that safely references a value of type Csize_t.

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions (fmi2TypesPlatform.h)
FMISpec2.0.2[p.16]: 2.1.3 Status Returned by Functions
FMISpec2.0.2[p.25]: 2.1.8 Getting and Setting the Complete FMU State

FMI.fmiSet — Method

fmiSet(str::fmi2Struct, comp::FMU2Component, vrs::fmi2ValueReferenceFormat, srcArray::AbstractArray; filter=nothing)

Arguments

str::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
srcArray::AbstractArray: Stores the specific value of fmi2ScalarVariable containing the modelVariables with the identical fmi2ValueReference to the input variable vr (vr = vrs[i]). srcArray has the same length as vrs.

Keywords

filter=nothing: whether the individual values of "fmi2ScalarVariable" are to be stored

Returns

retcodes::Array{fmi2Status}: Returns an array of length length(vrs) with Type fmi2Status. Type fmi2Status is an enumeration and indicates the success of the function call.

More detailed:

fmi2OK: all well
fmi2Warning: things are not quite right, but the computation can continue
fmi2Discard: if the slave computed successfully only a subinterval of the communication step
fmi2Error: the communication step could not be carried out at all
fmi2Fatal: if an error occurred which corrupted the FMU irreparably
fmi2Pending: this status is returned if the slave executes the function asynchronously

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.23]: 2.1.6 Initialization, Termination, and Resetting an FMU
FMISpec2.0.2[p.18]: 2.1.3 Status Returned by Functions

FMI.fmiSetBoolean — Method

DEPRECATED fmiSetBoolean(str::fmi2Struct, c::FMU2Component, vr::Array{fmi2ValueReference}, nvr::Csize_t, value::Array{fmi2Boolean})

fmiSetBoolean(str::fmi2Struct, c::FMU2Component, vr::fmi2ValueReferenceFormat, values::Union{Array{Bool}, Bool})

Set the values of an array of boolean variables

Arguments

str::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
vr::fmi2ValueReferenceFormat: Argument vr defines the value references of the variables.

More detailed: fmi2ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi2ValueReference, Array{fmi2ValueReference,1}, Int64, Array{Int64,1}, Symbol}

vr::Array{fmi2ValueReference}: Array of the FMI2 Data Typ fmi2ValueReference
nvr::Csize_t: Argument nvr defines the size of vr.
values::Union{Array{Bool}, Bool}: Argument values is an array or a single value with type Boolean or any subtyp
value::Array{fmi2Boolean}: Argument values is an array with the actual values of these variables.

Returns

status::fmi2Status: Return status is an enumeration of type fmi2Status and indicates the success of the function call.

More detailed:

fmi2OK: all well
fmi2Warning: things are not quite right, but the computation can continue
fmi2Discard: if the slave computed successfully only a subinterval of the communication step
fmi2Error: the communication step could not be carried out at all
fmi2Fatal: if an error occurred which corrupted the FMU irreparably
fmi2Pending: this status is returned if the slave executes the function asynchronously

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.24]: 2.1.7 Getting and Setting Variable Values
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions
FMISpec2.0.2[p.18]: 2.1.3 Status Returned by Functions

FMI.fmiSetContinuousStates — Method

DEPRECATED fmiSetContinuousStates(str::fmi2Struct, c::FMU2Component, x::AbstractArray{fmi2Real}, nx::Csize_t)

fmiSetContinuousStates(str::fmi2Struct, c::FMU2Component,
                             x::Union{AbstractArray{Float32},AbstractArray{Float64}})

Set a new (continuous) state vector

Arguments

str::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
x::AbstractArray{fmi2Real}: Argument x contains values of type fmi2Real which is a alias type for Real data type.x is the AbstractArray of the vector values of Real input variables of function h that changes its value in the actual Mode.
x::Union{AbstractArray{Float32},AbstractArray{Float64}}:
nx::Csize_t: Argument nx defines the length of vector x and is provided for checking purposes

Returns

status::fmi2Status: Return status is an enumeration of type fmi2Status and indicates the success of the function call.

More detailed:

fmi2OK: all well
fmi2Warning: things are not quite right, but the computation can continue
fmi2Discard: if the slave computed successfully only a subinterval of the communication step
fmi2Error: the communication step could not be carried out at all
fmi2Fatal: if an error occurred which corrupted the FMU irreparably
fmi2Pending: this status is returned if the slave executes the function asynchronously

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions (fmi2TypesPlatform.h)
FMISpec2.0.2[p.16]: 2.1.3 Status Returned by Functions
FMISpec2.0.2[p.83]: 3.2.1 Providing Independent Variables and Re-initialization of Caching

FMI.fmiSetDebugLogging — Method

DEPRECATED fmiSetDebugLogging(str::fmi2Struct)

Control the use of the logging callback function, version independent.

Arguments

str::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.

Returns

status::fmi2Status: Return status is an enumeration of type fmi2Status and indicates the success of the function call.

More detailed:

fmi2OK: all well
fmi2Warning: things are not quite right, but the computation can continue
fmi2Discard: if the slave computed successfully only a subinterval of the communication step
fmi2Error: the communication step could not be carried out at all
fmi2Fatal: if an error occurred which corrupted the FMU irreparably
fmi2Pending: this status is returned if the slave executes the function asynchronously

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.22]: 2.1.2 Platform Dependent Definitions (fmi2TypesPlatform.h)
FMISpec2.0.2[p.22]: 2.1.3 Status Returned by Functions
FMISpec2.0.2[p.22]: 2.1.5 Creation, Destruction and Logging of FMU Instances

FMI.fmiSetInteger — Method

DEPRECATED fmiSetInteger(str::fmi2Struct, c::FMU2Component, vr::fmi2ValueReferenceFormat, values::Union{Array{<:Integer}, <:Integer})

fmiSetInteger(str::fmi2Struct, c::FMU2Component, vr::Array{fmi2ValueReference}, nvr::Csize_t, value::Array{fmi2Integer})

Set the values of an array of integer variables

Arguments

str::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
vr::fmi2ValueReferenceFormat: Argument vr defines the value references of the variables.

More detailed: fmi2ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi2ValueReference, Array{fmi2ValueReference,1}, Int64, Array{Int64,1}, Symbol}

vr::Array{fmi2ValueReference}: Argument vr is an array of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::Union{Array{<:Integer}, <:Integer}: Argument values is an array or a single value with type Integer or any subtyp
value::Array{fmi2Integer}: Argument values is an array with the actual values of these variables.

Returns

status::fmi2Status: Return status indicates the success of the function call.

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.24]: 2.1.7 Getting and Setting Variable Values
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions
FMISpec2.0.2[p.18]: 2.1.3 Status Returned by Functions

FMI.fmiSetReal — Method

DEPRECATED fmiSetReal(str::fmi2Struct, c::FMU2Component, vr::fmi2ValueReferenceFormat, values::Union{Array{<:Real}, <:Real})

fmiSetReal(str::fmi2Struct, c::FMU2Component, vr::Array{fmi2ValueReference}, nvr::Csize_t, value::Array{fmi2Real})

Set the values of an array of real variables

Arguments

str::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
vr::fmi2ValueReferenceFormat: Wildcards for how a user can pass a fmi[X]ValueReference

More detailed: fmi2ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi2ValueReference, Array{fmi2ValueReference,1}, Int64, Array{Int64,1}, Symbol}

vr::Array{fmi2ValueReference}: Argument vr is an array of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
values::Union{Array{<:Real}, <:Real}: Argument values is an array with the actual values of these variables.

Returns

status::fmi2Status: Return status is an enumeration of type fmi2Status and indicates the success of the function call.

More detailed:

fmi2OK: all well
fmi2Warning: things are not quite right, but the computation can continue
fmi2Discard: if the slave computed successfully only a subinterval of the communication step
fmi2Error: the communication step could not be carried out at all
fmi2Fatal: if an error occurred which corrupted the FMU irreparably
fmi2Pending: this status is returned if the slave executes the function asynchronously

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.24]: 2.1.7 Getting and Setting Variable Values
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions
FMISpec2.0.2[p.18]: 2.1.3 Status Returned by Functions

FMI.fmiSetRealInputDerivatives — Method

DEPRECATED#Todo: Add types according spec

fmiSetRealInputDerivatives(str::fmi2Struct, c::FMU2Component, vr::fmi2ValueReferenceFormat, order, values)

fmiSetRealInputDerivatives(str::fmi2Struct, c::FMU2Component, vr::Array{fmi2ValueReference}, nvr::Csize_t, order::Array{fmi2Integer}, value::Array{fmi2Real})

Sets the n-th time derivative of real input variables.

Arguments

str::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
vr::fmi2ValueReferenceFormat: Argument vr defines the value references of the variables

More detailed: fmi2ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi2ValueReference, Array{fmi2ValueReference,1}, Int64, Array{Int64,1}, Symbol}

vr::Array{fmi2ValueReference}: Argument vr is an array of nvr value handels called "ValueReference" that define the variable that shall be inquired.
nvr::Csize_t: Argument nvr defines the size of vr.
order::Array{fmi2Integer}: Argument order is an array of fmi2Integer values witch specifys the corresponding order of derivative of the real input variable.
values::Array{fmi2Real}: Argument values is an array with the actual values of these variables.

Returns

status::fmi2Status: Return status is an enumeration of type fmi2Status and indicates the success of the function call.

More detailed:

fmi2OK: all well
fmi2Warning: things are not quite right, but the computation can continue
fmi2Discard: if the slave computed successfully only a subinterval of the communication step
fmi2Error: the communication step could not be carried out at all
fmi2Fatal: if an error occurred which corrupted the FMU irreparably
fmi2Pending: this status is returned if the slave executes the function asynchronously

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions
FMISpec2.0.2[p.18]: 2.1.3 Status Returned by Functions
FMISpec2.0.2[p.104]: 4.2.1 Transfer of Input / Output Values and Parameters

FMI.fmiSetState — Method

fmiSetState(str::fmi2Struct, args...; kwargs...)

Wrapper for fmi2SetFMUstate.

FMI.fmiSetState — Method

fmiSetState(str::fmi3Struct, args...; kwargs...)

Wrapper for fmi3SetFMUState.

FMI.fmiSetString — Method

DEPRECATED fmiSetString(str::fmi2Struct, c::FMU2Component, vr::fmi2ValueReferenceFormat, values::Union{Array{String}, String})

fmiSetString(str::fmi2Struct, c::FMU2Component, vr::Array{fmi2ValueReference}, nvr::Csize_t, value::Union{Array{Ptr{Cchar}}, Array{Ptr{UInt8}}})

Set the values of an array of string variables

For the exact rules on which type of variables fmi2SetXXX can be called see FMISpec2.0.2 section 2.2.7 , as well as FMISpec2.0.2 section 3.2.3 in case of ModelExchange and FMISpec2.0.2 section 4.2.4 in case of CoSimulation.

Arguments

str::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
vr::fmi2ValueReferenceFormat: Argument vr defines the value references of the variables.

More detailed: fmi2ValueReferenceFormat = Union{Nothing, String, Array{String,1}, fmi2ValueReference, Array{fmi2ValueReference,1}, Int64, Array{Int64,1}, Symbol}

vr::Array{fmi2ValueReference}: Array of the FMI2 Data Typ fmi2ValueReference
nvr::Csize_t: Argument nvr defines the size of vr.
values::Union{Array{String}, String}: Argument values is an array or a single value with type String.
value::Vector{Ptr{Cchar}}: Argument values is an vector with the actual values of these variables.

Returns

status::fmi2Status: Return status is an enumeration of type fmi2Status and indicates the success of the function call.

More detailed:

fmi2OK: all well
fmi2Warning: things are not quite right, but the computation can continue
fmi2Discard: if the slave computed successfully only a subinterval of the communication step
fmi2Error: the communication step could not be carried out at all
fmi2Fatal: if an error occurred which corrupted the FMU irreparably
fmi2Pending: this status is returned if the slave executes the function asynchronously

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions
FMISpec2.0.2[p.18]: 2.1.3 Status Returned by Functions
FMISpec2.0.2[p.24]: 2.1.7 Getting and Setting Variable Values
FMISpec2.0.2[p.46]: 2.2.7 Definition of Model Variables
FMISpec2.0.2[p.46]: 3.2.3 State Machine of Calling Sequence
FMISpec2.0.2[p.108]: 4.2.4 State Machine of Calling Sequence from Master to Slave

FMI.fmiSetTime — Method

DEPRECATED fmiSetTime(c::fmi2Struct, c::FMU2Component, time::fmi2Real)

fmiSetTime(c::fmi2Struct, c::FMU2Component, t::Real)

Set a new time instant and re-initialize caching of variables that depend on time.

Arguments

c::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

c::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
c::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
time::fmi2Real: Argument time contains a value of type fmi2Real which is a alias type for Real data type. time sets the independent variable time t.
t::Real: Argument t contains a value of type Real. t sets the independent variable time t.

Returns

status::fmi2Status: Return status is an enumeration of type fmi2Status and indicates the success of the function call.

More detailed:

fmi2OK: all well
fmi2Warning: things are not quite right, but the computation can continue
fmi2Discard: if the slave computed successfully only a subinterval of the communication step
fmi2Error: the communication step could not be carried out at all
fmi2Fatal: if an error occurred which corrupted the FMU irreparably
fmi2Pending: this status is returned if the slave executes the function asynchronously

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions (fmi2TypesPlatform.h)
FMISpec2.0.2[p.16]: 2.1.3 Status Returned by Functions
FMISpec2.0.2[p.83]: 3.2.1 Providing Independent Variables and Re-initialization of Caching

FMI.fmiSetupExperiment — Method

DEPRECATED fmiSetupExperiment(str::fmi2Struct, c::FMU2Component, startTime::Union{Real, Nothing} = nothing, stopTime::Union{Real, Nothing} = nothing; tolerance::Union{Real, Nothing} = nothing)

Initialize the Simulation boundries

Arguments

str::fmi2Struct: Representative for an FMU in the FMI 2.0.2 Standard.

More detailed: fmi2Struct = Union{FMU2, FMU2Component}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
startTime::Union{Real, Nothing} = nothing: startTime is a real number which sets the value of starting time of the experiment. The default value is set automatically if doing nothing (default = nothing).
stopTime::Union{Real, Nothing} = nothing: stopTime is a real number which sets the value of ending time of the experiment. The default value is set automatically if doing nothing (default = nothing).

Keywords

tolerance::Union{Real, Nothing} = nothing: tolerance is a real number which sets the value of tolerance range. The default value is set automatically if doing nothing (default = nothing).

Returns

Returns a warning if str.state is not called in fmi2ComponentStateInstantiated.
status::fmi2Status: Return status is an enumeration of type fmi2Status and indicates the success of the function call.

More detailed:

fmi2OK: all well
fmi2Warning: things are not quite right, but the computation can continue
fmi2Discard: if the slave computed successfully only a subinterval of the communication step
fmi2Error: the communication step could not be carried out at all
fmi2Fatal: if an error occurred which corrupted the FMU irreparably
fmi2Pending: this status is returned if the slave executes the function asynchronously

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.23]: 2.1.6 Initialization, Termination, and Resetting an FMU
FMISpec2.0.2[p.18]: 2.1.3 Status Returned by Functions

FMI.fmiSimulate — Method

fmiSimulate(str::fmi2Struct, args...; kwargs...)

Start a simulation of the FMU instance str for the matching FMU version and type.

Wrapper for fmi2Simulate.

FMI.fmiSimulate — Method

fmiSimulate(str::fmi3Struct, args...; kwargs...)

Start a simulation of the FMU instance str for the matching FMU version and type.

Wrapper for fmi3Simulate.

FMI.fmiSimulateCS — Function

fmiSimulateCS(str::fmi2Struct, tspan::Union{Tuple{Float64, Float64}, Nothing}=nothing, args...; kwargs...)

Start a simulation of the Co-Simulation FMU instance str.

Wrapper for fmi2SimulateCS.

FMI.fmiSimulateCS — Method

fmiSimulateCS(str::fmi3Struct, args...; kwargs...)

Start a simulation of the Co-Simulation FMU instance str.

Wrapper for fmi3SimulateCS.

FMI.fmiSimulateME — Function

fmiSimulateME(str::Union{fmi2Struct,fmi3Struct}, tspan::Union{Tuple{Float64, Float64}, Nothing}=nothing;
                tolerance::Union{Real, Nothing} = nothing,
                dt::Union{Real, Nothing} = nothing,
                solver = nothing,
                customFx = nothing,
                recordValues::fmi2ValueReferenceFormat = nothing,
                saveat = nothing,
                x0::Union{AbstractArray{<:Real}, Nothing} = nothing,
                setup::Union{Bool, Nothing} = nothing,
                reset::Union{Bool, Nothing} = nothing,
                instantiate::Union{Bool, Nothing} = nothing,
                freeInstance::Union{Bool, Nothing} = nothing,
                terminate::Union{Bool, Nothing} = nothing,
                inputValueReferences::fmi2ValueReferenceFormat = nothing,
                inputFunction = nothing,
                parameters::Union{Dict{<:Any, <:Any}, Nothing} = nothing,
                dtmax::Union{Real, Nothing} = nothing,
                callbacks = [],
                showProgress::Bool = true,
                kwargs...)

Simulates a FMU instance for the given simulation time interval.

Arguments

str::Union{fmi2StructMD, fmi3StructMD}: Representative for an FMU in the FMI 2.0.2 Standard or FMI 3.0 Standard. Other notation:

More detailed: fmi2Struct = Union{FMU2, FMU2Component} More detailed: fmi3Struct = Union{FMU3, FMU3Instance}

str::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.
str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
str::FMU3: Mutable struct representing an FMU in the FMI 3.0 Standard.
str::FMU3Instance: Mutable struct represents a pointer to an FMU specific data structure that contains the information needed. Also in FMI 3.0 Standard.
tspan::Union{Tuple{Float64, Float64}, Nothing}=nothing: Sets the time span as a tuple or the default value from the model description is used.

Keywords

tolerance::Union{Real, Nothing} = nothing: Real number to set the tolerance for any OED-solver
dt::Union{Real, Nothing} = nothing: Real number to set the step size of the OED-solver. Defaults to an automatic choice if the method is adaptive. More Info: DifferentialEquations.jl Documentation
solver = nothing: Any Julia-supported OED-solver (default is Tsit5). More Info: DifferentialEquations.jl Documentation
customFx = nothing: [deperecated] Ability to give a custom state derivative function ẋ=f(x,t)
recordValues::fmi2ValueReferenceFormat = nothing: AbstractArray of variables (strings or variableIdentifiers) to record. Results are returned as DiffEqCallbacks.SavedValues
saveat = nothing: Time points to save values at (interpolated). More Info: DifferentialEquations.jl Documentation
x0::Union{AbstractArray{<:Real}, Nothing} = nothing: Stores the specific value of fmi2ScalarVariable containing the modelVariables with the identical fmi2ValueReference to the input variable vr (vr = vrs[i]). And is therefore passed within prepareSolveFMU to fmi2Set , to set the start state.
setup::Bool = true: Boolean, if FMU should be setup (default: setup=true)
reset::Union{Bool, Nothing} = nothing: Boolean, if FMU should be reset before simulation (default: reset:=auto)
instantiate::Union{Bool, Nothing} = nothing: Boolean value that decides whether to create a new instance of the specified fmu.
freeInstance::Union{Bool, Nothing} = nothing: Boolean value that determines whether to dispose of the given instance, unload the loaded model, and free the allocated memory and other resources allocated by the FMU interface functions.
terminate::Union{Bool, Nothing} = nothing: Boolean value that tells the FMU that the simulation run will be aborted.
inputValueReferences::fmi2ValueReferenceFormat = nothing: AbstractArray of input variables (strings or variableIdentifiers) to set at every simulation step
inputFunction = nothing: Function to retrieve the values to set the inputs to
parameters::Union{Dict{<:Any, <:Any}, Nothing} = nothing: Dictionary of parameter variables (strings or variableIdentifiers) and values (Real, Integer, Boolean, String) to set parameters during initialization
dtmax::Union{Real, Nothing} = nothing: Real number for setting maximum dt for adaptive timestepping for the ODE solver. The default values are package dependent. More Info: DifferentialEquations.jl Documentation
callbacks = []: custom callbacks to add.
showProgress::Bool = true: Boolean value that determines whether a progress bar is generated for a task
kwargs...: Further parameters of already defined functions solve(args..., kwargs...) from the library DifferentialEquations.jl

Returns

If keyword recordValues is not set, a struct of type ODESolution.
If keyword recordValues is set, a tuple of type (ODESolution, DiffEqCallbacks.SavedValues).

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.22]: 2.1.4 Inquire Platform and Version Number of Header Files
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions

FMI.fmiStringToValueReference — Method

fmiStringToValueReference(dataStruct::Union{FMU2, fmi2ModelDescription}, identifier::Union{String, AbstractArray{String}})

Wrapper for fmi2StringToValueReference.

Pattern [`c`: current component, `t`: current time, returning array of values to be passed to `fmi2SetReal(..., inputValueReferences, inputFunction(...))`]:

Pattern [`c`: current component, `u`: current state ,`t`: current time, returning array of values to be passed to `fmi2SetReal(..., inputValueReferences, inputFunction(...))`]:

Pattern [`c`: current instance, `t`: current time, returning array of values to be passed to `fmi3SetFloat64(..., inputValueReferences, inputFunction(...))`]:

Pattern [`c`: current instance, `u`: current state ,`t`: current time, returning array of values to be passed to `fmi3SetFloat64(..., inputValueReferences, inputFunction(...))`]:

Pattern [c: current component, t: current time, returning array of values to be passed to fmi2SetReal(..., inputValueReferences, inputFunction(...))]:

Pattern [c: current component, u: current state ,t: current time, returning array of values to be passed to fmi2SetReal(..., inputValueReferences, inputFunction(...))]:

Pattern [c: current instance, t: current time, returning array of values to be passed to fmi3SetFloat64(..., inputValueReferences, inputFunction(...))]:

Pattern [c: current instance, u: current state ,t: current time, returning array of values to be passed to fmi3SetFloat64(..., inputValueReferences, inputFunction(...))]:

Pattern [`c`: current component, `t`: current time, returning array of values to be passed to `fmi2SetReal(..., inputValueReferences, inputFunction(...))`]:

Pattern [`c`: current component, `u`: current state ,`t`: current time, returning array of values to be passed to `fmi2SetReal(..., inputValueReferences, inputFunction(...))`]:

Pattern [`c`: current instance, `t`: current time, returning array of values to be passed to `fmi3SetFloat64(..., inputValueReferences, inputFunction(...))`]:

Pattern [`c`: current instance, `u`: current state ,`t`: current time, returning array of values to be passed to `fmi3SetFloat64(..., inputValueReferences, inputFunction(...))`]: