Docstrings · FMIImport.jl

FMICore.FMU2 — Method

(fmu::FMU2)(;dx::Union{AbstractVector{<:Real}, Nothing}=nothing,
             y::Union{AbstractVector{<:Real}, Nothing}=nothing,
             y_refs::Union{AbstractVector{fmi2ValueReference}, Nothing}=nothing,
             x::Union{AbstractVector{<:Real}, Nothing}=nothing, 
             u::Union{AbstractVector{<:Real}, Nothing}=nothing,
             u_refs::Union{AbstractVector{fmi2ValueReference}, Nothing}=nothing,
             t::Union{Real, Nothing}=nothing)

Evaluates a FMU2 by setting the component state x, inputs u and/or time t. If no component is available, one is allocated. The result of the evaluation might be the system output y and/or state-derivative dx. Not all options are available for any FMU type, e.g. setting state is not supported for CS-FMUs. Assertions will be generated for wrong use.

Keywords

dx: An array to store the state-derivatives in. If not provided but necessary, a suitable array is allocated and returned. Not supported by CS-FMUs.
y: An array to store the system outputs in. If not provided but requested, a suitable array is allocated and returned.
y_refs: An array of value references to indicate which system outputs shall be returned.
x: An array containing the states to be set. Not supported by CS-FMUs.
u: An array containing the inputs to be set.
u_refs: An array of value references to indicate which system inputs want to be set.
t: A scalar value holding the system time to be set.

Returns (as Tuple)

y::Union{AbstractVector{<:Real}, Nothing}: The system output y (if requested, otherwise nothing).
dx::Union{AbstractVector{<:Real}, Nothing}: The system state-derivaitve (if ME-FMU, otherwise nothing).

FMICore.FMU2Component — Method

(c::FMU2Component)(;dx::Union{AbstractVector{<:Real}, Nothing}=nothing,
                    y::Union{AbstractVector{<:Real}, Nothing}=nothing,
                    y_refs::Union{AbstractVector{fmi2ValueReference}, Nothing}=nothing,
                    x::Union{AbstractVector{<:Real}, Nothing}=nothing, 
                    u::Union{AbstractVector{<:Real}, Nothing}=nothing,
                    u_refs::Union{AbstractVector{fmi2ValueReference}, Nothing}=nothing,
                    t::Union{Real, Nothing}=nothing)

Evaluates a FMU2Component by setting the component state x, inputs u and/or time t. The result of the evaluation might be the system output y and/or state-derivative dx. Not all options are available for any FMU type, e.g. setting state is not supported for CS-FMUs. Assertions will be generated for wrong use.

Keywords

dx: An array to store the state-derivatives in. If not provided but necessary, a suitable array is allocated and returned. Not supported by CS-FMUs.
y: An array to store the system outputs in. If not provided but requested, a suitable array is allocated and returned.
y_refs: An array of value references to indicate which system outputs shall be returned.
x: An array containing the states to be set. Not supported by CS-FMUs.
u: An array containing the inputs to be set.
u_refs: An array of value references to indicate which system inputs want to be set.
t: A scalar value holding the system time to be set.

Returns (as Tuple)

y::Union{AbstractVector{<:Real}, Nothing}: The system output y (if requested, otherwise nothing).
dx::Union{AbstractVector{<:Real}, Nothing}: The system state-derivaitve (if ME-FMU, otherwise nothing).

FMICore.fmi2CancelStep — Method

fmi2CancelStep(c::FMU2Component)

Can be called if fmi2DoStep returned fmi2Pending in order to stop the current asynchronous execution.

Arguments

c::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.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.104]: 4.2.2 Computation

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

fmi2SetContinuousStates(c::FMU2Component, x::AbstractArray{fmi2Real}, nx::Csize_t)

Set a new (continuous) state vector and re-initialize caching of variables that depend on the states. Argument nx is the length of vector x and is provided for checking purposes

Arguments

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

See also fmi2GetString!.

Source: FMISpec2.0.2[p.24]: 2.1.7 Getting and Setting Variable Values

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

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 fmi2GetString!.

FMIImport.fmi2GetUnit — Method

fmi2GetUnit(mv::fmi2ScalarVariable)

Returns the unit entry of the corresponding model variable.

Arguments

fmi2GetStartValue(mv::fmi2ScalarVariable): The “ModelVariables” element consists of an ordered set of “ScalarVariable” elements. A “ScalarVariable” represents a variable of primitive type, like a real or integer variable.

Returns

mv._Real.unit: Returns the unit entry of the corresponding ScalarVariable representing a variable of the primitive type Real. Otherwise nothing is returned.

Source

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

FMIImport.fmi2GetValueReferencesAndNames — Method

fmi2GetValueReferencesAndNames(md::fmi2ModelDescription; vrs=md.valueReferences)

fmi2GetValueReferencesAndNames(fmu::FMU2)

Returns a dictionary Dict(fmi2ValueReference, Array{String}) of value references and their corresponding names

Arguments

md::fmi2ModelDescription: Struct which provides the static information of ModelVariables.
fmu::FMU2: Mutable struct representing a FMU and all it instantiated instances in the FMI 2.0.2 Standard.

Keywords

vrs=md.valueReferences: Additional attribute valueReferences::Array{fmi2ValueReference} of the Model Description that is a handle to a (base type) variable value. Handle and base type uniquely identify the value of a variable. (default = md.valueReferences::Array{fmi2ValueReference})

Returns

dict::Dict{fmi2ValueReference, Array{String}}: Returns a dictionary that constructs a hash table with keys of type fmi2ValueReference and values of type Array{String}.

FMIImport.fmi2GetVariableNamingConvention — Method

fmi2GetVariableNamingConvention(fmu::FMU2)

Returns the tag 'varaiblenamingconvention' from the model description.

Arguments

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

Returns

fmu.modelDescription.variableNamingConvention::Union{fmi2VariableNamingConvention, Nothing}: Returns the tag 'variableNamingConvention' from the model description.

FMIImport.fmi2GetVariableNamingConvention — Method

fmi2GetVariableNamingConvention(md::fmi2ModelDescription)

Returns the tag 'varaiblenamingconvention' from the model description.

Arguments

md::fmi2ModelDescription: Struct which provides the static information of ModelVariables.

Returns

md.variableNamingConvention::Union{fmi2VariableNamingConvention, Nothing}: Returns the tag 'variableNamingConvention' from the model description.

FMIImport.fmi2Instantiate! — Method

function 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)