Docstrings · FMIImport.jl

FMIImport.lk_fmi2FreeInstance — Constant

fmi2FreeInstance!(c::FMU2Component; popComponent::Bool = true)

Disposes the given instance, unloads the loaded model, and frees all the allocated memory and other resources that have been allocated by the functions of the FMU interface. If a null pointer is provided for “c”, the function call is ignored (does not have an effect).

Removes the component from the FMUs component list.

Arguments

c::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.

Returns

nothing

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2[p.22]: 2.1.5 Creation, Destruction and Logging of FMU Instances
FMISpec2.0.2[p.16]: 2.1.2 Platform Dependent Definitions

See also fmi2GetBoolean!.

FMICore.fmi2GetBoolean! — Method

fmi2GetBoolean!(c::FMU2Component, vr::fmi2ValueReferenceFormat, values::AbstractArray{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::AbstractArray{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::AbstractArray{fmi2Boolean}: Argument value is an array with the actual values of these variables

Returns

Return singleton instance of type Nothing, if there is no value to return (as in a C void function) or when a variable or field holds no value.

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

See also fmi2GetBoolean!.

FMICore.fmi2GetBooleanStatus! — Method

fmi2GetBooleanStatus!(c::FMU2Component, 
                        s::fmi2StatusKind, 
                        value::Ref{fmi2Boolean})

Informs the master about the actual status of the simulation run. Which status information is to be returned is specified by the argument fmi2StatusKind.

Arguments

c::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
s::fmi2StatusKind: Argument s defines which status information is to be returned. fmi2StatusKind is an enumeration that defines which status is inquired.

The following status information can be retrieved from a slave:

fmi2DoStepStatus::fmi2Status: Can be called when the fmi2DoStep function returned fmi2Pending. The function delivers fmi2Pending if the computation is not finished. Otherwise the function returns the result of the asynchronously executed fmi2DoStep call.
fmi2PendingStatus::fmi2String: Can be called when the fmi2DoStep function returned fmi2Pending. The function delivers a string which informs about the status of the currently running asynchronous fmi2DoStep computation
fmi2LastSuccessfulTime:: fmi2Real: Returns the end time of the last successfully completed communication step. Can be called after fmi2DoStep(..) returned fmi2Discard.
fmi2Terminated::fmi2Boolean: Returns fmi2True, if the slave wants to terminate the simulation. Can be called after fmi2DoStep(..) returned fmi2Discard. Use fmi2LastSuccessfulTime to determine the time instant at which the slave terminated.
value::Ref{fmi2Boolean}: Argument value points to the return value (fmi2Boolean) which was requested. fmi2Boolean is a alias type for Boolean data type.

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.106]: 4.2.3 Retrieving Status Information from the Slave

See also fmi2GetEventIndicators!.

FMICore.fmi2GetDerivatives! — Method

fmi2GetDerivatives!(c::FMU2Component,
                   derivatives::AbstractArray{fmi2Real},
                   nx::Csize_t)

Compute state derivatives at the current time instant and for the current states.

Arguments

c::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
derivatives::AbstractArray{fmi2Real}: Argument derivatives contains values of type fmi2Real which is a alias type for Real data type.derivatives is the AbstractArray which contains the Real values of the vector that represent the derivatives. The ordering of the elements of the derivatives vector is identical to the ordering of the state vector.
nx::Csize_t: Argument nx defines the length of vector derivatives 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.2 Evaluation of Model Equations

See also fmi2GetEventIndicators!.

FMICore.fmi2GetEventIndicators! — Method

fmi2GetEventIndicators!(c::FMU2Component, eventIndicators::AbstractArray{fmi2Real})

Returns the event indicators of the FMU.

Arguments

c::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
eventIndicators::AbstractArray{fmi2Real}:The event indicators are in an AbstractArray represented by an array of "fmi2Real" values.

Returns

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

FMICore.fmi2GetFMUstate! — Method

fmi2GetFMUstate!(c::FMU2Component, FMUstate::Ref{fmi2FMUstate})

Makes a copy of the internal FMU state and returns a pointer to this copy.

Arguments

str::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
FMUstate::Ref{fmi2FMUstate}:If on entry FMUstate == NULL, a new allocation is required. If FMUstate != NULL, then FMUstate points to a previously returned FMUstate that has not been modified since.

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

See also fmi2GetEventIndicators!.

FMICore.fmi2GetReal! — Method

fmi2GetReal!(c::FMU2Component, vr::AbstractArray{fmi2ValueReference}, nvr::Csize_t, value::AbstractArray{fmi2Real})

Functions to get and set values of variables idetified by their valueReference

Arguments

c::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
vr::AbstractArray{fmi2ValueReference}: Argument vr is an AbstractArray 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::AbstractArray{fm2Real}: Argument values is an AbstractArray 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.18]: 2.1.3 Status Returned by Functions
FMISpec2.0.2[p.24]: 2.1.7 Getting and Setting Variable Values

See also fmi2GetString!.

FMICore.fmi2GetString! — Method

fmi2GetString!(c::FMU2Component, vr::fmi2ValueReferenceFormat, values::AbstractArray{fmi2String})

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}

values::AbstractArray{fmi2String}: Argument values is an AbstractArray with the actual values of these variables

Returns

Return singleton instance of type Nothing, if there is no value to return (as in a C void function) or when a variable or field holds no value.

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

See also fmi2GetString!.

FMICore.fmi2GetStringStatus! — Method

fmi2GetStringStatus!(c::FMU2Component, 
                        s::fmi2StatusKind, 
                        value::Ref{fmi2String})

Informs the master about the actual status of the simulation run. Which status information is to be returned is specified by the argument fmi2StatusKind.

Arguments

c::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
s::fmi2StatusKind: Argument s defines which status information is to be returned. fmi2StatusKind is an enumeration that defines which status is inquired.

The following status information can be retrieved from a slave:

fmi2DoStepStatus::fmi2Status: Can be called when the fmi2DoStep function returned fmi2Pending. The function delivers fmi2Pending if the computation is not finished. Otherwise the function returns the result of the asynchronously executed fmi2DoStep call.
fmi2PendingStatus::fmi2String: Can be called when the fmi2DoStep function returned fmi2Pending. The function delivers a string which informs about the status of the currently running asynchronous fmi2DoStep computation
fmi2LastSuccessfulTime:: fmi2Real: Returns the end time of the last successfully completed communication step. Can be called after fmi2DoStep(..) returned fmi2Discard.
fmi2Terminated::fmi2Boolean: Returns fmi2True, if the slave wants to terminate the simulation. Can be called after fmi2DoStep(..) returned fmi2Discard. Use fmi2LastSuccessfulTime to determine the time instant at which the slave terminated.
value:Ref{fmi2String}: Argument value points to the return value (fmi2String) which was requested. fmi2String is a alias type for String data type.

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.106]: 4.2.3 Retrieving Status Information from the Slave

See also fmi2GetBoolean!.

FMICore.fmi2SetContinuousStates — Method

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

Set a new (continuous) state vector and reinitialize chaching of variables that depend on states.

Arguments

c::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.
x::Union{AbstractArray{Float32},AbstractArray{Float64}}:Argument x is the AbstractArray of the vector values of Float64 or Float32.

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

See also fmi2GetString!.

FMICore.fmi2SetString — Method

fmi2SetString(c::FMU2Component, vr::fmi2ValueReferenceFormat, values::Union{AbstractArray{String}, String})

Set the values of an array of string variables

Arguments

c::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}

values::Union{Array{String}, String}: Argument values is an array or a single value with type String.

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

See also fmi2GetBoolean!.

FMIImport.fmi2GetContinuousStates — Method

fmi2GetContinuousStates(c::FMU2Component)

Return the new (continuous) state vector x

Arguments

c::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

See also fmi2GetEventIndicators!.

FMIImport.fmi2GetDerivatives — Method

fmi2GetDerivatives(c::FMU2Component)

Compute state derivatives at the current time instant and for the current states.

Arguments

c::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.

Returns

derivatives::Array{fmi2Real}: Returns an array of fmi2Real values representing the derivatives for the current states. The ordering of the elements of the derivatives vector is identical to the ordering of the state

vector.

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

See also fmi2GetEventIndicators!.

FMIImport.fmi2GetFMUstate — Method

fmi2GetFMUstate(c::FMU2Component)

Makes a copy of the internal FMU state and returns a pointer to this copy.

Arguments

c::FMU2Component: Mutable struct represents an instantiated instance of an FMU in the FMI 2.0.2 Standard.

Returns

Return state is a pointer to a copy of the internal FMU state.

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.25]: 2.1.8 Getting and Setting the Complete FMU State

See also fmi2GetString!.

FMIImport.fmi2Instantiate! — Method

fmi2Instantiate!(fmu::FMU2;
                    instanceName::String=fmu.modelName,
                    type::fmi2Type=fmu.type,
                    pushComponents::Bool = true,
                    visible::Bool = false,
                    loggingOn::Bool = fmu.executionConfig.loggingOn,
                    externalCallbacks::Bool = fmu.executionConfig.externalCallbacks,
                    logStatusOK::Bool=true,
                    logStatusWarning::Bool=true,
                    logStatusDiscard::Bool=true,
                    logStatusError::Bool=true,
                    logStatusFatal::Bool=true,
                    logStatusPending::Bool=true)

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

Arguments

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

Keywords

instanceName::String=fmu.modelName: Name of the instance
type::fmi2Type=fmu.type: Defines whether a Co-Simulation or Model Exchange is present
pushComponents::Bool = true: Defines if the fmu components should be pushed in the application.
visible::Bool = false if the FMU should be started with graphic interface, if supported (default=false)
loggingOn::Bool = fmu.executionConfig.loggingOn if the FMU should log and display function calls (default=false)
externalCallbacks::Bool = fmu.executionConfig.externalCallbacks if an external shared library should be used for the fmi2CallbackFunctions, this may improve readability of logging messages (default=false)
logStatusOK::Bool=true whether to log status of kind fmi2OK (default=true)
logStatusWarning::Bool=true whether to log status of kind fmi2Warning (default=true)
logStatusDiscard::Bool=true whether to log status of kind fmi2Discard (default=true)
logStatusError::Bool=true whether to log status of kind fmi2Error (default=true)
logStatusFatal::Bool=true whether to log status of kind fmi2Fatal (default=true)
logStatusPending::Bool=true whether to log status of kind fmi2Pending (default=true)

Returns

Returns the instance of a new FMU component.

Source

FMISpec2.0.2 Link: https://fmi-standard.org/
FMISpec2.0.2: 2.2.7 Definition of Model Variables (ModelVariables)