Docstrings · FMIImport.jl

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

FMICore.fmi3ActivateModelPartition — Method

Source: FMISpec3.0, Version D5ef1c1: 5.2.2. State: Clock Activation Mode

During Clock Activation Mode (see 5.2.2.) after fmi3ActivateModelPartition has been called for a calculated, tunable or changing Clock the FMU provides the information on when the Clock will tick again, i.e. when the corresponding model partition has to be scheduled the next time.

Each fmi3ActivateModelPartition call is associated with the computation of an exposed model partition of the FMU and therefore to an input Clock.

FMICore.fmi3CompletedIntegratorStep! — Method

Source: FMISpec3.0, Version D5ef1c1: 3.2.1. State: Continuous-Time Mode

This function must be called by the environment after every completed step of the integrator provided the capability flag needsCompletedIntegratorStep = true. If enterEventMode == fmi3True, the event mode must be entered If terminateSimulation == fmi3True, the simulation shall be terminated

FMICore.fmi3DeSerializeFMUState! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.4. Getting and Setting the Complete FMU State

fmi3DeSerializeFMUstate deserializes the byte vector serializedState of length size, constructs a copy of the FMU state and returns FMUstate, the pointer to this copy.

FMICore.fmi3DoStep! — Method

Source: FMISpec3.0, Version D5ef1c1: 4.2.1. State: Step Mode

The computation of a time step is started.

FMICore.fmi3EnterConfigurationMode — Method

Source: FMISpec3.0, Version D5ef1c1: 2.3.2. State: Instantiated

If the importer needs to change structural parameters, it must move the FMU into Configuration Mode using fmi3EnterConfigurationMode.

FMICore.fmi3EnterContinuousTimeMode — Method

Source: FMISpec3.0, Version D5ef1c1: 2.3.5. State: Event Mode

FMICore.fmi3EnterEventMode — Method

Source: FMISpec3.0, Version D5ef1c1: 3.2.1. State: Continuous-Time Mode

The model enters Event Mode.

For more information call ?fmi3EnterEventMode

FMICore.fmi3EnterEventMode — Method

Source: FMISpec3.0, Version D5ef1c1: 3.2.1. State: Continuous-Time Mode

The model enters Event Mode from the Continuous-Time Mode in ModelExchange oder Step Mode in CoSimulation and discrete-time equations may become active (and relations are not “frozen”).

FMICore.fmi3EnterInitializationMode — Function

Source: FMISpec3.0, Version D5ef1c1: 2.3.2. State: Instantiated

FMU enters Initialization mode.

For more information call ?fmi3EnterInitializationMode

FMICore.fmi3EnterInitializationMode — Method

Source: FMISpec3.0, Version D5ef1c1: 2.3.2. State: Instantiated

Informs the FMU to enter Initialization Mode. Before calling this function, all variables with attribute <Datatype initial = "exact" or "approx"> can be set with the “fmi3SetXXX” functions (the ScalarVariable attributes are defined in the Model Description File, see section 2.4.7). Setting other variables is not allowed. Also sets the simulation start and stop time.

FMICore.fmi3EnterStepMode — Method

Source: FMISpec3.0, Version D5ef1c1: 2.3.5. State: Event Mode

This function must be called to change from Event Mode into Step Mode in Co-Simulation (see 4.2.).

FMICore.fmi3EvaluateDiscreteStates — Method

Source: FMISpec3.0, Version D5ef1c1: 2.3.3. State: Initialization Mode

This function is called to trigger the evaluation of fdisc to compute the current values of discrete states from previous values. The FMU signals the support of fmi3EvaluateDiscreteStates via the capability flag providesEvaluateDiscreteStates.

FMICore.fmi3ExitConfigurationMode — Method

Source: FMISpec3.0, Version D5ef1c1: 2.3.6. State: Configuration Mode

Exits the Configuration Mode and returns to state Instantiated.

FMICore.fmi3ExitInitializationMode — Method

Source: FMISpec3.0, Version D5ef1c1: 2.3.3. State: Initialization Mode

Informs the FMU to exit Initialization Mode.

FMICore.fmi3FreeFMUState! — Method

function fmi3FreeFMUState(c::FMU3Instance, FMUstate::Ref{fmi3FMUState})

Free the allocated memory for the FMU state.

For more information call ?fmi3FreeFMUstate

FMICore.fmi3FreeFMUState! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.4. Getting and Setting the Complete FMU State

fmi3FreeFMUstate frees all memory and other resources allocated with the fmi3GetFMUstate call for this FMUstate.

FMICore.fmi3FreeInstance! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.3.1. Super State: FMU State Setable

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 argument instance, the function call is ignored (does not have an effect).

FMICore.fmi3GetAdjointDerivative! — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.11. Getting Partial Derivatives

Computes adjoint derivatives.

For more information call ?fmi3GetAdjointDerivative

FMICore.fmi3GetAdjointDerivative! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.11. Getting Partial Derivatives

This function computes the adjoint derivatives v^T{sensitivity}= v^T{seed} ⋅ J of an FMU.

unknowns - contains value references to the unknowns.

nUnknowns - contains the length of argument unknowns.

knowns - contains value references of the knowns.

nKnowns - contains the length of argument knowns.

seed - contains the components of the seed vector.

nSeed - contains the length of seed.

sensitivity - contains the components of the sensitivity vector.

nSensitivity - contains the length of sensitivity.

This function can only be called if the 'ProvidesAdjointDerivatives' tag in the ModelDescription is set.

FMICore.fmi3GetBinary! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValues - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3GetBinary! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3Binary variables.

For more information call ?fmi3GetBinary!

FMICore.fmi3GetBoolean! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3GetBoolean! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3Boolean variables.

For more information call ?fmi3GetBoolean!

FMICore.fmi3GetClock! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3GetClock! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3Clock variables.

For more information call ?fmi3GetClock!

FMICore.fmi3GetContinuousStateDerivatives — Method

Source: FMISpec3.0, Version D5ef1c1: 3.2.1. State: Continuous-Time Mode

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

FMICore.fmi3GetContinuousStateDerivatives — Method

Source: FMISpec3.0, Version D5ef1c1: 3.2.1. State: Continuous-Time Mode

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

For more information call ?fmi3GetContinuousDerivatives

FMICore.fmi3GetContinuousStates! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.3.3. State: Initialization Mode

Return the states at the current time instant.

This function must be called if fmi3UpdateDiscreteStates returned with valuesOfContinuousStatesChanged == fmi3True. Not allowed in Co-Simulation and Scheduled Execution.

FMICore.fmi3GetDirectionalDerivative! — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.11. Getting Partial Derivatives

Computes directional derivatives.

For more information call ?fmi3GetDirectionalDerivative

FMICore.fmi3GetDirectionalDerivative! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.11. Getting Partial Derivatives

This function computes the directional derivatives v{sensitivity} = J ⋅ v{seed} of an FMU.

unknowns - contains value references to the unknowns.

nUnknowns - contains the length of argument unknowns.

knowns - contains value references of the knowns.

nKnowns - contains the length of argument knowns.

seed - contains the components of the seed vector.

nSeed - contains the length of seed.

sensitivity - contains the components of the sensitivity vector.

nSensitivity - contains the length of sensitivity.

This function can only be called if the 'ProvidesDirectionalDerivatives' tag in the ModelDescription is set.

FMICore.fmi3GetEventIndicators! — Method

Source: FMISpec3.0, Version D5ef1c1: 3.2.1. State: Continuous-Time Mode

Compute event indicators at the current time instant and for the current states. EventIndicators signal Events by their sign change.

FMICore.fmi3GetFMUState! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.4. Getting and Setting the Complete FMU State

fmi3GetFMUstate makes a copy of the internal FMU state and returns a pointer to this copy

FMICore.fmi3GetFloat32! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3GetFloat32! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3Float32 variables.

For more information call ?fmi3GetFloat32!

FMICore.fmi3GetFloat64! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3GetFloat64! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3Float64 variables.

For more information call ?fmi3GetFloat64!

FMICore.fmi3GetInt16! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3GetInt16! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3Int16 variables.

For more information call ?fmi3GetInt16!

FMICore.fmi3GetInt32! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3GetInt32! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3Int32 variables.

For more information call ?fmi3GetInt32!

FMICore.fmi3GetInt64! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3GetInt64! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3Int64 variables.

For more information call ?fmi3GetInt64!

FMICore.fmi3GetInt8! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3GetInt8! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3Int8 variables.

For more information call ?fmi3GetInt8!

FMICore.fmi3GetIntervalDecimal! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.9. Clocks

fmi3GetIntervalDecimal retrieves the interval until the next clock tick.

For input Clocks it is allowed to call this function to query the next activation interval. For changing aperiodic Clock, this function must be called in every Event Mode where this clock was activated. For countdown aperiodic Clock, this function must be called in every Event Mode. Clock intervals are computed in fmi3UpdateDiscreteStates (at the latest), therefore, this function should be called after fmi3UpdateDiscreteStates. For information about fmi3IntervalQualifiers, call ?fmi3IntervalQualifier

FMICore.fmi3GetIntervalFraction! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.9. Clocks

fmi3GetIntervalFraction retrieves the interval until the next clock tick.

FMICore.fmi3GetNominalsOfContinuousStates! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.3.3. State: Initialization Mode

Return the nominal values of the continuous states.

If fmi3UpdateDiscreteStates returned with nominalsOfContinuousStatesChanged == fmi3True, then at least one nominal value of the states has changed and can be inquired with fmi3GetNominalsOfContinuousStates. Not allowed in Co-Simulation and Scheduled Execution.

FMICore.fmi3GetNumberOfContinuousStates! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.3.2. State: Instantiated

This function returns the number of continuous states. This function can only be called in Model Exchange.

fmi3GetNumberOfContinuousStates must be called after a structural parameter is changed. As long as no structural parameters changed, the number of states is given in the modelDescription.xml, alleviating the need to call this function.

FMICore.fmi3GetNumberOfEventIndicators! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.3.2. State: Instantiated

This function returns the number of event indicators. This function can only be called in Model Exchange.

fmi3GetNumberOfEventIndicators must be called after a structural parameter is changed. As long as no structural parameters changed, the number of states is given in the modelDescription.xml, alleviating the need to call this function.

FMICore.fmi3GetOutputDerivatives! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.12. Getting Derivatives of Continuous Outputs

Retrieves the n-th derivative of output values.

valueReferences - is a vector of value references that define the variables whose derivatives shall be retrieved. If multiple derivatives of a variable shall be retrieved, list the value reference multiple times.

nValueReferences - is the dimension of the arguments valueReferences and orders.

orders - contains the orders of the respective derivative (1 means the first derivative, 2 means the second derivative, …, 0 is not allowed). If multiple derivatives of a variable shall be retrieved, provide a list of them in the orders array, corresponding to a multiply occurring value reference in the valueReferences array. The highest order of derivatives retrievable can be determined by the 'maxOutputDerivativeOrder' tag in the ModelDescription.

values - is a vector with the values of the derivatives. The order of the values elements is derived from a twofold serialization: the outer level corresponds to the combination of a value reference (e.g., valueReferences[k]) and order (e.g., orders[k]), and the inner level to the serialization of variables as defined in Section 2.2.6.1. The inner level does not exist for scalar variables.

nValues - is the size of the argument values. nValues only equals nValueReferences if all corresponding output variables are scalar variables.

FMICore.fmi3GetShiftDecimal! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.9. Clocks

fmi3GetShiftDecimal retrieves the delay to the first Clock tick from the FMU.

FMICore.fmi3GetShiftFraction! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.9. Clocks

fmi3GetShiftFraction retrieves the delay to the first Clock tick from the FMU.

FMICore.fmi3GetString! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3GetString! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3String variables.

For more information call ?fmi3GetString!

FMICore.fmi3GetUInt16! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3GetUInt16! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3UInt16 variables.

For more information call ?fmi3GetUInt16!

FMICore.fmi3GetUInt32! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3GetUInt32! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3UInt32 variables.

For more information call ?fmi3GetUInt32!

FMICore.fmi3GetUInt64! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3GetUInt64! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3UInt64 variables.

For more information call ?fmi3GetUInt64!

FMICore.fmi3GetUInt8! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3GetUInt8! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3UInt8 variables.

For more information call ?fmi3GetUInt8!

FMICore.fmi3GetVariableDependencies! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.10. Dependencies of Variables

The actual dependencies (of type dependenciesKind) can be retrieved by calling the function fmi3GetVariableDependencies:

dependent - specifies the valueReference of the variable for which the dependencies should be returned.

nDependencies - specifies the number of dependencies that the calling environment allocated space for in the result buffers, and should correspond to value obtained by calling fmi3GetNumberOfVariableDependencies.

elementIndicesOfDependent - must point to a buffer of size_t values of size nDependencies allocated by the calling environment. It is filled in by this function with the element index of the dependent variable that dependency information is provided for. The element indices start with 1. Using the element index 0 means all elements of the variable. (Note: If an array has more than one dimension the indices are serialized in the same order as defined for values in Section 2.2.6.1.)

independents - must point to a buffer of fmi3ValueReference values of size nDependencies allocated by the calling environment. It is filled in by this function with the value reference of the independent variable that this dependency entry is dependent upon.

elementIndicesIndependents - must point to a buffer of size_t values of size nDependencies allocated by the calling environment. It is filled in by this function with the element index of the independent variable that this dependency entry is dependent upon. The element indices start with 1. Using the element index 0 means all elements of the variable. (Note: If an array has more than one dimension the indices are serialized in the same order as defined for values in Section 2.2.6.1.)

dependencyKinds - must point to a buffer of dependenciesKind values of size nDependencies allocated by the calling environment. It is filled in by this function with the enumeration value describing the dependency of this dependency entry. For more information about dependenciesKinds, call ?fmi3DependencyKind

If this function is called before the fmi3ExitInitializationMode call, it returns the initial dependencies. If this function is called after the fmi3ExitInitializationMode call, it returns the runtime dependencies. The retrieved dependency information of one variable becomes invalid as soon as a structural parameter linked to the variable or to any of its depending variables are set. As a consequence, if you change structural parameters affecting B or A, the dependency of B becomes invalid. The dependency information must change only if structural parameters are changed.

This information can only be retrieved if the 'providesPerElementDependencies' tag in the ModelDescription is set.

FMICore.fmi3GetVersion — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.4. Inquire Version Number of Header Files

This function returns fmi3Version of the fmi3Functions.h header file which was used to compile the functions of the FMU. This function call is allowed always and in all interface types.

The standard header file as documented in this specification has version "3.0-beta.2", so this function returns "3.0-beta.2".

FMICore.fmi3Reset — Method

Source: FMISpec3.0, Version D5ef1c1: 2.3.1. Super State: FMU State Setable

Is called by the environment to reset the FMU after a simulation run. The FMU goes into the same state as if fmi3InstantiateXXX would have been called.

FMICore.fmi3SerializeFMUState! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.4. Getting and Setting the Complete FMU State

fmi3SerializeFMUstate serializes the data which is referenced by pointer FMUstate and copies this data in to the byte vector serializedState of length size

FMICore.fmi3SerializedFMUStateSize! — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.4. Getting and Setting the Complete FMU State

fmi3SerializedFMUstateSize returns the size of the byte vector which is needed to store FMUstate in it.

FMICore.fmi3SetBinary — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3SetBinary — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Set the values of an array of fmi3Binary variables.

For more information call ?fmi3SetBinary

FMICore.fmi3SetBoolean — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3SetBoolean — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Set the values of an array of fmi3Boolean variables.

For more information call ?fmi3SetBoolean

FMICore.fmi3SetClock — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3SetClock — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Set the values of an array of fmi3Clock variables.

For more information call ?fmi3SetClock

FMICore.fmi3SetContinuousStates — Method

Source: FMISpec3.0, Version D5ef1c1: 3.2.1. State: Continuous-Time Mode

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

FMICore.fmi3SetContinuousStates — Method

Source: FMISpec3.0, Version D5ef1c1: 3.2.1. State: Continuous-Time Mode

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

For more information call ?fmi3SetContinuousStates

FMICore.fmi3SetDebugLogging — Method

Source: FMISpec3.0, Version D5ef1c1: 2.3.1. Super State: FMU State Setable

The function controls debug logging that is output via the logger function callback. If loggingOn = fmi3True, debug logging is enabled, otherwise it is switched off.

FMICore.fmi3SetDebugLogging — Method

Source: FMISpec3.0, Version D5ef1c1: 2.3.1. Super State: FMU State Setable

Set the DebugLogger for the FMU.

FMICore.fmi3SetFMUState — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.4. Getting and Setting the Complete FMU State

fmi3SetFMUstate copies the content of the previously copied FMUstate back and uses it as actual new FMU state.

FMICore.fmi3SetFloat32 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3SetFloat32 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Set the values of an array of fmi3Float32 variables.

For more information call ?fmi3SetFloat32

FMICore.fmi3SetFloat64 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3SetFloat64 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Set the values of an array of fmi3Float64 variables.

For more information call ?fmi3SetFloat64

FMICore.fmi3SetInt16 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3SetInt16 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Set the values of an array of fmi3Int16 variables.

For more information call ?fmi3SetInt16

FMICore.fmi3SetInt32 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3SetInt32 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Set the values of an array of fmi3Int32 variables.

For more information call ?fmi3SetInt32

FMICore.fmi3SetInt64 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3SetInt64 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Set the values of an array of fmi3Int64 variables.

For more information call ?fmi3SetInt64

FMICore.fmi3SetInt8 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3SetInt8 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Set the values of an array of fmi3Int8 variables.

For more information call ?fmi3SetInt8

FMICore.fmi3SetIntervalFraction — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.9. Clocks

fmi3SetIntervalFraction sets the interval until the next clock tick Only allowed if the attribute 'supportsFraction' is set.

FMICore.fmi3SetString — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3SetString — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Set the values of an array of fmi3String variables.

For more information call ?fmi3SetString

FMICore.fmi3SetTime — Method

Source: FMISpec3.0, Version D5ef1c1: 3.2.1. State: Continuous-Time Mode

FMICore.fmi3SetTime — Method

Source: FMISpec3.0, Version D5ef1c1: 3.2.1. State: Continuous-Time Mode

Set independent variable time and reinitialize chaching of variables that depend on time.

For more information call ?fmi3SetTime

FMICore.fmi3SetUInt16 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3SetUInt16 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Set the values of an array of fmi3UInt16 variables.

For more information call ?fmi3SetUInt16

FMICore.fmi3SetUInt32 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3SetUInt32 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Set the values of an array of fmi3UInt32 variables.

For more information call ?fmi3SetUInt32

FMICore.fmi3SetUInt64 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3SetUInt64 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Set the values of an array of fmi3UInt64 variables.

For more information call ?fmi3SetUInt64

FMICore.fmi3SetUInt8 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

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

nValue - is different from nvr if the value reference represents an array and therefore are more values tied to a single value reference.

FMICore.fmi3SetUInt8 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Set the values of an array of fmi3UInt8 variables.

For more information call ?fmi3SetUInt8

FMICore.fmi3Terminate — Method

Source: FMISpec3.0, Version D5ef1c1: 2.3.4. Super State: Initialized

Informs the FMU that the simulation run is terminated.

FMICore.fmi3UpdateDiscreteStates — Method

Source: FMISpec3.0, Version D5ef1c1: 2.3.5. State: Event Mode

This function is called to signal a converged solution at the current super-dense time instant. fmi3UpdateDiscreteStates must be called at least once per super-dense time instant.

FMICore.fmi3UpdateDiscreteStates — Method

Source: FMISpec3.0, Version D5ef1c1: 2.3.5. State: Event Mode

This function is called to signal a converged solution at the current super-dense time instant. fmi3UpdateDiscreteStates must be called at least once per super-dense time instant.

For more information call ?fmi3UpdateDiscreteStates

FMIImport.fmi2CallbackAllocateMemory — Method

Source: FMISpec2.0.2[p.21-22]: 2.1.5 Creation, Destruction and Logging of FMU Instances

Function that is called in the FMU if memory needs to be allocated. If attribute “canNotUseMemoryManagementFunctions = true” in <fmiModelDescription><ModelExchange / CoSimulation>, then function allocateMemory is not used in the FMU and a void pointer can be provided. If this attribute has a value of “false” (which is the default), the FMU must not use malloc, calloc or other memory allocation functions. One reason is that these functions might not be available for embedded systems on the target machine. Another reason is that the environment may have optimized or specialized memory allocation functions. allocateMemory returns a pointer to space for a vector of nobj objects, each of size “size” or NULL, if the request cannot be satisfied. The space is initialized to zero bytes [(a simple implementation is to use calloc from the C standard library)].

FMIImport.fmi2CallbackFreeMemory — Method

Source: FMISpec2.0.2[p.22]: 2.1.5 Creation, Destruction and Logging of FMU Instances

Function that must be called in the FMU if memory is freed that has been allocated with allocateMemory. If a null pointer is provided as input argument obj, the function shall perform no action [(a simple implementation is to use free from the C standard library; in ANSI C89 and C99, the null pointer handling is identical as defined here)]. If attribute “canNotUseMemoryManagementFunctions = true” in <fmiModelDescription><ModelExchange / CoSimulation>, then function freeMemory is not used in the FMU and a null pointer can be provided.

FMIImport.fmi2CallbackLogger — Method

Source: FMISpec2.0.2[p.21]: 2.1.5 Creation, Destruction and Logging of FMU Instances

Function that is called in the FMU, usually if an fmi2XXX function, does not behave as desired. If “logger” is called with “status = fmi2OK”, then the message is a pure information message. “instanceName” is the instance name of the model that calls this function. “category” is the category of the message. The meaning of “category” is defined by the modeling environment that generated the FMU. Depending on this modeling environment, none, some or all allowed values of “category” for this FMU are defined in the modelDescription.xml file via element “<fmiModelDescription><LogCategories>”, see section 2.2.4. Only messages are provided by function logger that have a category according to a call to fmi2SetDebugLogging (see below). Argument “message” is provided in the same way and with the same format control as in function “printf” from the C standard library. [Typically, this function prints the message and stores it optionally in a log file.]

FMIImport.fmi2CallbackStepFinished — Method

Source: FMISpec2.0.2[p.22]: 2.1.5 Creation, Destruction and Logging of FMU Instances

Optional call back function to signal if the computation of a communication step of a co-simulation slave is finished. A null pointer can be provided. In this case the master must use fmiGetStatus(..) to query the status of fmi2DoStep. If a pointer to a function is provided, it must be called by the FMU after a completed communication step.

FMIImport.fmi2CanGetSetState — Method

Returns true, if the FMU supports the getting/setting of states

ToDo: update docstring format.

FMIImport.fmi2CanSerializeFMUstate — Method

Returns true, if the FMU state can be serialized

ToDo: update docstring format.

FMIImport.fmi2CompletedIntegratorStep — Method

TODO: FMI specification reference.

This function must be called by the environment after every completed step If enterEventMode == fmi2True, the event mode must be entered If terminateSimulation == fmi2True, the simulation shall be terminated

For more information call ?fmi2CompletedIntegratorStep

FMIImport.fmi2DeSerializeFMUstate — Method

TODO: FMI specification reference.

Deserialize the data in the serializedState fmi2Byte field.

For more information call ?fmi2DeSerzializeFMUstate

FMIImport.fmi2DependenciesSupported — Method

Returns if the FMU model description contains dependency information.

ToDo: update docstring format.

FMIImport.fmi2DerivativeDependenciesSupported — Method

Returns if the FMU model description contains dependency information for derivatives.

ToDo: update docstring format.

FMIImport.fmi2GetBoolean — Method

TODO: FMI specification reference.

Get the values of an array of fmi2Boolean variables.

For more information call ?fmi2GetBoolean!

FMIImport.fmi2GetContinuousStates — Method

TODO: FMI specification reference.

Return the new (continuous) state vector x.

For more information call ?fmi2GetContinuousStates

FMIImport.fmi2GetDefaultStartTime — Method

Returns startTime from DefaultExperiment if defined else defaults to nothing.

ToDo: update docstring format.

FMIImport.fmi2GetDefaultStepSize — Method

Returns stepSize from DefaultExperiment if defined else defaults to nothing.

ToDo: update docstring format.

FMIImport.fmi2GetDefaultStopTime — Method

Returns stopTime from DefaultExperiment if defined else defaults to nothing.

ToDo: update docstring format.

FMIImport.fmi2GetDefaultTolerance — Method

Returns tolerance from DefaultExperiment if defined else defaults to nothing.

ToDo: update docstring format.

FMIImport.fmi2GetDerivateValueReferencesAndNames — Method

ToDo: update docstring format.

FMIImport.fmi2GetDerivativeNames — Method

Returns names of derivatives

ToDo: update docstring format.

FMIImport.fmi2GetDerivatives — Method

TODO: FMI specification reference.

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

For more information call ?fmi2GetDerivatives

FMIImport.fmi2GetDirectionalDerivative — Function

TODO: FMI specification reference.

Computes directional derivatives.

For more information call ?fmi2GetDirectionalDerivatives

FMIImport.fmi2GetDirectionalDerivative — Function

TODO: FMI specification reference.

Computes directional derivatives.

For more information call ?fmi2GetDirectionalDerivatives

FMIImport.fmi2GetEventIndicators — Method

TODO: FMI specification reference.

Returns the event indicators of the FMU.

For more information call ?fmi2GetEventIndicators

FMIImport.fmi2GetFMUstate — Method

TODO: FMI specification reference.

Get the pointer to the current FMU state.

For more information call ?fmi2GetFMUstate

FMIImport.fmi2GetFullJacobian! — Method

Fills the jacobian over the FMU fmu for FMU value references rdx and rx, so that the function returns the jacobian ∂rdx / ∂rx.

If FMI built-in directional derivatives are supported, they are used. As fallback, directional derivatives will be sampled with central differences. No performance optimization, for an optimized version use fmi2GetJacobian!.

If sampling is used, sampling step size can be set (for each direction individually) using optional argument steps.

FMIImport.fmi2GetFullJacobian — Method

Builds the jacobian over the FMU fmu for FMU value references rdx and rx, so that the function returns the jacobian ∂rdx / ∂rx.

If sampling is used, sampling step size can be set (for each direction individually) using optional argument steps.

FMIImport.fmi2GetGUID — Method

Returns the tag 'guid' from the model description.

ToDo: update docstring format.

FMIImport.fmi2GetGenerationDateAndTime — Method

Returns the tag 'generationdateandtime' from the model description.

ToDo: update docstring format.

FMIImport.fmi2GetGenerationTool — Method

Returns the tag 'generationtool' from the model description.

ToDo: update docstring format.

FMIImport.fmi2GetInitial — Method

Returns the inital entry of the corresponding model variable.

ToDo: update docstring format.

FMIImport.fmi2GetInputNames — Method

Returns names of inputs

ToDo: update docstring format.

FMIImport.fmi2GetInputNamesAndStarts — Method

Returns a dictionary of input variables with their starting values

ToDo: update docstring format.

FMIImport.fmi2GetInputValueReferencesAndNames — Method

Returns a dict with (vrs, names of inputs)

ToDo: update docstring format.

FMIImport.fmi2GetInteger — Method

TODO: FMI specification reference.

Get the values of an array of fmi2Integer variables.

For more information call ?fmi2GetInteger!

FMIImport.fmi2GetJacobian! — Method

Fills the jacobian over the FMU fmu for FMU value references rdx and rx, so that the function returns the jacobian ∂rdx / ∂rx.

If FMI built-in directional derivatives are supported, they are used. As fallback, directional derivatives will be sampled with central differences. For optimization, if the FMU's model description has the optional entry 'dependencies', only dependent variables are sampled/retrieved. This drastically boosts performance for systems with large variable count (like CFD).

If sampling is used, sampling step size can be set (for each direction individually) using optional argument steps.

FMIImport.fmi2GetJacobian — Method

Builds the jacobian over the FMU fmu for FMU value references rdx and rx, so that the function returns the jacobian ∂rdx / ∂rx.

If sampling is used, sampling step size can be set (for each direction individually) using optional argument steps.

FMIImport.fmi2GetModelIdentifier — Method

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

ToDo: update docstring format.

FMIImport.fmi2GetModelName — Method

Returns the tag 'modelName' from the model description.

ToDo: update docstring format.

FMIImport.fmi2GetModelVariableIndices — Method

Returns a array of indices corresponding to value references vrs

ToDo: update docstring format.

FMIImport.fmi2GetNames — Method

Returns a array of names corresponding to value references vrs

If there are multiple names per value reference, availabel modes are :first (default, pick only the first one), :group (pick all and group them into an array) and :flat (pick all, but flat them out into a 1D-array together with all other names)

ToDo: update docstring format.

FMIImport.fmi2GetNamesAndDescriptions — Method

Returns a dictionary of variables with their descriptions

ToDo: update docstring format.

FMIImport.fmi2GetNamesAndInitials — Method

Returns a dictionary of variables with their initial values (please note: initial != start)

ToDo: update docstring format.

FMIImport.fmi2GetNamesAndUnits — Method

Returns a dictionary of variables with their units

ToDo: update docstring format.

FMIImport.fmi2GetNominalsOfContinuousStates — Method

TODO: FMI specification reference.

Return the new (continuous) state vector x.

For more information call ?fmi2GetNominalsOfContinuousStates

FMIImport.fmi2GetNumberOfEventIndicators — Method

Returns the tag 'numberOfEventIndicators' from the model description.

ToDo: update docstring format.

FMIImport.fmi2GetNumberOfStates — Method

Returns the number of states of the FMU.

FMIImport.fmi2GetNumberOfStates — Method

Returns the number of states of the FMU.

ToDo: update docstring format.

FMIImport.fmi2GetOutputNames — Method

Returns names of outputs

ToDo: update docstring format.

FMIImport.fmi2GetOutputValueReferencesAndNames — Method

ToDo: update docstring format.

FMIImport.fmi2GetParameterNames — Method

Returns names of parameters

ToDo: update docstring format.

FMIImport.fmi2GetParameterValueReferencesAndNames — Method

ToDo: update docstring format.

FMIImport.fmi2GetReal — Method

TODO: FMI specification reference.

Get the values of an array of fmi2Real variables.

For more information call ?fmi2GetReal!

FMIImport.fmi2GetRealOutputDerivatives — Method

TODO: FMI specification reference.

vr defines the value references of the variables the array order specifies the corresponding order of derivation of the variables

For more information call ?fmi2GetRealOutputDerivatives

FMIImport.fmi2GetStartValue — Function

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

TODO: Add this command in the documentation.

FMIImport.fmi2GetStartValue — Method

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

TODO: Add this command in the documentation.

FMIImport.fmi2GetStateNames — Method

Returns names of states

ToDo: update docstring format.

FMIImport.fmi2GetStateValueReferencesAndNames — Method

Returns dict(vrs, names of states)

ToDo: update docstring format.

FMIImport.fmi2GetStatus — Method

ToDo

FMIImport.fmi2GetString — Method

TODO: FMI specification reference.

Get the values of an array of fmi2String variables.

For more information call ?fmi2GetString!

FMIImport.fmi2GetUnit — Method

Returns the unit entry of the corresponding model variable.

ToDo: update docstring format.

FMIImport.fmi2GetValueReferencesAndNames — Method

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

ToDo: update docstring format.

FMIImport.fmi2GetVariableNamingConvention — Method

Returns the tag 'varaiblenamingconvention' from the model description.

ToDo: update docstring format.

FMIImport.fmi2Instantiate! — Method

TODO: FMI specification reference.

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

Returns the instance of a new FMU component.

For more information call ?fmi2Instantiate

Keywords

visible if the FMU should be started with graphic interface, if supported (default=false)
loggingOn if the FMU should log and display function calls (default=false)
externalCallbacks if an external DLL should be used for the fmi2CallbackFunctions, this may improve readability of logging messages (default=false)
logStatusOK whether to log status of kind fmi2OK (default=true)
logStatusWarning whether to log status of kindfmi2Warning(default=true`)
logStatusDiscard whether to log status of kindfmi2Discard(default=true`)
logStatusError whether to log status of kindfmi2Error(default=true`)
logStatusFatal whether to log status of kindfmi2Fatal(default=true`)
logStatusPending whether to log status of kindfmi2Pending(default=true`)

FMIImport.fmi2IsCoSimulation — Method

Returns true, if the FMU supports co simulation

ToDo: update docstring format.

FMIImport.fmi2IsModelExchange — Method

Returns true, if the FMU supports model exchange

ToDo: update docstring format.

FMIImport.fmi2Load — Method

Sets the properties of the fmu by reading the modelDescription.xml. Retrieves all the pointers of binary functions.

Returns the instance of the FMU struct.

Via optional argument unpackPath, a path to unpack the FMU can be specified (default: system temporary directory).

FMIImport.fmi2LoadModelDescription — Method

Extract the FMU variables and meta data from the ModelDescription

ToDo: New docstring format!

FMIImport.fmi2ModelVariablesForValueReference — Method

Returns the model variable(s) fitting the value reference.

FMIImport.fmi2NewDiscreteStates — Method

TODO: FMI specification reference.

Increment the super dense time in event mode.

For more information call ?fmi2NewDiscretestates

FMIImport.fmi2ProvidesDirectionalDerivative — Method

Returns true, if the FMU provides directional derivatives

ToDo: update docstring format.

FMIImport.fmi2Reload — Method

Reloads the FMU-binary. This is useful, if the FMU does not support a clean reset implementation.

FMIImport.fmi2SampleDirectionalDerivative — Function

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

FMIImport.fmi2SampleDirectionalDerivative — Function

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

FMIImport.fmi2SampleDirectionalDerivative! — Function

This function samples the directional derivative by manipulating corresponding values (central differences) and saves in-place.

FMIImport.fmi2SampleDirectionalDerivative! — Function

This function samples the directional derivative by manipulating corresponding values (central differences) and saves in-place.

FMIImport.fmi2SerializeFMUstate — Method

TODO: FMI specification reference.

Serialize the data in the FMU state pointer.

For more information call ?fmi2SerzializeFMUstate

FMIImport.fmi2SerializedFMUstateSize — Method

TODO: FMI specification reference.

Returns the size of a byte vector the FMU can be stored in.

For more information call ?fmi2SerzializedFMUstateSize

FMIImport.fmi2StringToValueReference — Method

Returns an array of ValueReferences coresponding to the variable names.

FMIImport.fmi2StringToValueReference — Method

Returns the ValueReference coresponding to the variable name.

FMIImport.fmi2Unload — Function

Unload a FMU.

Free the allocated memory, close the binaries and remove temporary zip and unziped FMU model description.

FMIImport.fmi2Unzip — Method

Create a copy of the .fmu file as a .zip folder and unzips it. Returns the paths to the zipped and unzipped folders.

Via optional argument unpackPath, a path to unpack the FMU can be specified (default: system temporary directory).

FMIImport.fmi2ValueReferenceToString — Method

Returns an array of variable names matching a fmi2ValueReference.

FMIImport.fmi3CallbackClockUpdate — Method

Source: FMISpec3.0, Version D5ef1c1: 5.2.2. State: Clock Activation Mode

A model partition of a Scheduled Execution FMU calls fmi3CallbackClockUpdate to signal that a triggered output Clock ticked or a new interval for a countdown Clock is available. fmi3CallbackClockUpdate switches the FMU itself then into the Clock Update Mode (see 5.2.3.). The callback may be called from several model partitions.

instanceEnvironment - is the instance name of the model that calls this function.

FMIImport.fmi3CallbackIntermediateUpdate — Method

Source: FMISpec3.0, Version D5ef1c1: 4.2.2. State: Intermediate Update Mode

When a Co-Simulation FMU provides values for its output variables at intermediate points between two consecutive communication points, and is able to receive new values for input variables at these intermediate points, the Intermediate Update Callback function is called. This is typically required when the FMU uses a numerical solver to integrate the FMU's internal state between communication points in fmi3DoStep. The callback function switches the FMU from Step Mode (see 4.2.1.) in the Intermediate Update Mode (see 4.2.2.) and returns to Step Mode afterwards. The parameters of this function are:

instanceEnvironment - is the instance name of the model that calls this function.

intermediateUpdateTime - is the internal value of the independent variable [typically simulation time] of the FMU at which the callback has been called for intermediate and final steps. If an event happens or an output Clock ticks, intermediateUpdateTime is the time of event or output Clock tick. In Co-Simulation, intermediateUpdateTime is restricted by the arguments to fmi3DoStep as follows: currentCommunicationPoint ≤ intermediateUpdateTime ≤ (currentCommunicationPoint + communicationStepSize). The FMU must not call the callback function fmi3CallbackIntermediateUpdate with an intermediateUpdateTime that is smaller than the intermediateUpdateTime given in a previous call of fmi3CallbackIntermediateUpdate with intermediateStepFinished == fmi3True.

If intermediateVariableSetRequested == fmi3True, the co-simulation algorithm may provide intermediate values for continuous input variables with intermediateUpdate = true by calling fmi3Set{VariableType}. The set of variables for which the co-simulation algorithm will provide intermediate values is declared through the requiredIntermediateVariables argument to fmi3InstantiateXXX. If a co-simulation algorithm does not provide a new value for any of the variables contained in the set it registered, the last value set remains.

If intermediateVariableGetAllowed == fmi3True, the co-simulation algorithm may collect intermediate output variables by calling fmi3Get{VariableType} for variables with intermediateUpdate = true. The set of variables for which the co-simulation algorithm can get values is supplied through the requiredIntermediateVariables argument to fmi3InstantiateXXX.

If intermediateStepFinished == fmi3False, the intermediate outputs of the FMU that the co-simulation algorithm inquires with fmi3Get{VariableType} resulting from tentative internal solver states and may still change for the same intermediateUpdateTime [e.g., if the solver deems the tentative state to cause a too high approximation error, it may go back in time and try to re-estimate the state using smaller internal time steps]. If intermediateStepFinished == fmi3True, intermediate outputs inquired by the co-simulation algorithm with fmi3Get{VariableType} correspond to accepted internal solver step.

When canReturnEarly == fmi3True the FMU signals to the co-simulation algorithm its ability to return early from the current fmi3DoStep.

earlyReturnRequested - If and only if canReturnEarly == fmi3True, the co-simulation algorithm may request the FMU to return early from fmi3DoStep by setting earlyReturnRequested == fmi3True.

earlyReturnTime is used to signal the FMU at which time to return early from the current fmi3DoStep, if the return value of earlyReturnRequested == fmi3True. If the earlyReturnTime is greater than the last signaled intermediateUpdateTime, the FMU may integrate up to the time instant earlyReturnTime.

If the ModelDescription has the "providesIntermediateUpdate" flag, the Intermediate update callback function is called. That flag is ignored in ModelExchange and ScheduledExecution.

FMIImport.fmi3CanGetSetState — Method

Returns true, if the FMU supports the getting/setting of states

FMIImport.fmi3CanSerializeFMUState — Method

Returns true, if the FMU state can be serialized

FMIImport.fmi3CompletedIntegratorStep — Method

Source: FMISpec3.0, Version D5ef1c1: 3.2.1. State: Continuous-Time Mode

This function must be called by the environment after every completed step If enterEventMode == fmi3True, the event mode must be entered If terminateSimulation == fmi3True, the simulation shall be terminated

For more information call ?fmi3CompletedIntegratorStep

FMIImport.fmi3DeSerializeFMUState — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.4. Getting and Setting the Complete FMU State

Deserialize the data in the serializedState fmi3Byte field.

For more information call ?fmi3DeSerzializeFMUstate

FMIImport.fmi3GetAdjointDerivative — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.11. Getting Partial Derivatives

Computes adjoint derivatives.

For more information call ?fmi3GetAdjointDerivative

FMIImport.fmi3GetAdjointDerivative — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.11. Getting Partial Derivatives

Computes adjoint derivatives.

For more information call ?fmi3GetAdjointDerivative

FMIImport.fmi3GetBinary — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3Binary variables.

For more information call ?fmi3GetBinary

FMIImport.fmi3GetBoolean — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3Boolean variables.

For more information call ?fmi3GetBoolean

FMIImport.fmi3GetClock — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3Clock variables.

For more information call ?fmi3GetClock

FMIImport.fmi3GetContinuousStates — Method

Source: FMISpec3.0, Version D5ef1c1: 2.3.3. State: Initialization Mode

Return the new (continuous) state vector x.

For more information call ?fmi3GetContinuousStates

FMIImport.fmi3GetDefaultStartTime — Method

Returns startTime from DefaultExperiment if defined else defaults to nothing.

FMIImport.fmi3GetDefaultStepSize — Method

Returns stepSize from DefaultExperiment if defined else defaults to nothing.

FMIImport.fmi3GetDefaultStopTime — Method

Returns stopTime from DefaultExperiment if defined else defaults to nothing.

FMIImport.fmi3GetDefaultTolerance — Method

Returns tolerance from DefaultExperiment if defined else defaults to nothing.

FMIImport.fmi3GetDirectionalDerivative — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.11. Getting Partial Derivatives

Computes directional derivatives.

For more information call ?fmi3GetDirectionalDerivative

FMIImport.fmi3GetDirectionalDerivative — Function

Source: FMISpec3.0, Version D5ef1c1: 2.2.11. Getting Partial Derivatives

Computes directional derivatives.

For more information call ?fmi3GetDirectionalDerivative

FMIImport.fmi3GetEventIndicators — Method

Source: FMISpec3.0, Version D5ef1c1: 3.2.1. State: Continuous-Time Mode

Returns the event indicators of the FMU.

For more information call ?fmi3GetEventIndicators

FMIImport.fmi3GetFMUState — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.4. Getting and Setting the Complete FMU State

Get the pointer to the current FMU state.

For more information call ?fmi3GetFMUstate

FMIImport.fmi3GetFloat32 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3Float32 variables.

For more information call ?fmi3GetFloat32

FMIImport.fmi3GetFloat64 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3Float64 variables.

For more information call ?fmi3GetFloat64

FMIImport.fmi3GetFullJacobian! — Method

Fills the jacobian over the FMU fmu for FMU value references rdx and rx, so that the function returns the jacobian ∂rdx / ∂rx.

If sampling is used, sampling step size can be set (for each direction individually) using optional argument steps.

FMIImport.fmi3GetFullJacobian — Method

Builds the jacobian over the FMU fmu for FMU value references rdx and rx, so that the function returns the jacobian ∂rdx / ∂rx.

If sampling is used, sampling step size can be set (for each direction individually) using optional argument steps.

FMIImport.fmi3GetGenerationDateAndTime — Method

Returns the tag 'generationdateandtime' from the model description.

FMIImport.fmi3GetGenerationTool — Method

Returns the tag 'generationtool' from the model description.

FMIImport.fmi3GetInstantiationToken — Method

Returns the tag 'instantionToken' from the model description.

FMIImport.fmi3GetInt16 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3Int16 variables.

For more information call ?fmi3GetInt16

FMIImport.fmi3GetInt32 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3Int32 variables.

For more information call ?fmi3GetInt32

FMIImport.fmi3GetInt64 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3Int64 variables.

For more information call ?fmi3GetInt64

FMIImport.fmi3GetInt8 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3Int8 variables.

For more information call ?fmi3GetInt8

FMIImport.fmi3GetJacobian! — Method

Fills the jacobian over the FMU fmu for FMU value references rdx and rx, so that the function returns the jacobian ∂rdx / ∂rx.

If sampling is used, sampling step size can be set (for each direction individually) using optional argument steps.

FMIImport.fmi3GetJacobian — Method

Builds the jacobian over the FMU fmu for FMU value references rdx and rx, so that the function returns the jacobian ∂rdx / ∂rx.

If sampling is used, sampling step size can be set (for each direction individually) using optional argument steps.

FMIImport.fmi3GetModelIdentifier — Method

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

FMIImport.fmi3GetModelName — Method

Returns the tag 'modelName' from the model description.

FMIImport.fmi3GetNominalsOfContinuousStates — Method

Source: FMISpec3.0, Version D5ef1c1: 2.3.3. State: Initialization Mode

Return the new (continuous) state vector x.

For more information call ?fmi3GetNominalsOfContinuousStates

FMIImport.fmi3GetNumberOfContinuousStates — Method

Source: FMISpec3.0, Version D5ef1c1: 2.3.2. State: Instantiated

This function returns the number of continuous states. This function can only be called in Model Exchange. For more information call ?fmi3GetNumberOfContinuousStates

FMIImport.fmi3GetNumberOfEventIndicators — Method

Source: FMISpec3.0, Version D5ef1c1: 2.3.2. State: Instantiated

This function returns the number of event indicators. This function can only be called in Model Exchange. For more information call ?fmi3GetNumberOfEventIndicators

FMIImport.fmi3GetNumberOfEventIndicators — Method

Returns the number of EventIndicators from the model description.

FMIImport.fmi3GetNumberOfVariableDependencies — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.10. Dependencies of Variables

The number of dependencies of a given variable, which may change if structural parameters are changed, can be retrieved by calling the following function: For more information call ?fmi3GetNumberOfVariableDependencies

FMIImport.fmi3GetOutputDerivatives — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.12. Getting Derivatives of Continuous Outputs

Retrieves the n-th derivative of output values.

vr defines the value references of the variables the array order specifies the corresponding order of derivation of the variables

For more information call ?fmi3GetOutputDerivatives

FMIImport.fmi3GetOutputDerivatives — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.12. Getting Derivatives of Continuous Outputs

Retrieves the n-th derivative of output values.

vr defines the value references of the variables the array order specifies the corresponding order of derivation of the variables

For more information call ?fmi3GetOutputDerivatives

FMIImport.fmi3GetStartValue — Method

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

TODO: Add this command in the documentation.

FMIImport.fmi3GetString — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3String variables.

For more information call ?fmi3GetString

FMIImport.fmi3GetUInt16 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3UInt16 variables.

For more information call ?fmi3GetUInt16

FMIImport.fmi3GetUInt32 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3UInt32 variables.

For more information call ?fmi3GetUInt32

FMIImport.fmi3GetUInt64 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3UInt64 variables.

For more information call ?fmi3GetUInt64

FMIImport.fmi3GetUInt8 — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.2. Getting and Setting Variable Values

Get the values of an array of fmi3UInt8 variables.

For more information call ?fmi3GetUInt8

FMIImport.fmi3GetVariableDependencies — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.10. Dependencies of Variables

The actual dependencies (of type dependenciesKind) can be retrieved by calling the function fmi3GetVariableDependencies: For more information call ?fmi3GetVariableDependencies

FMIImport.fmi3GetVariableNamingConvention — Method

Returns the tag 'varaiblenamingconvention' from the model description.

FMIImport.fmi3InstantiateCoSimulation! — Method

Source: FMISpec3.0, Version D5ef1c1:: 2.3.1. Super State: FMU State Setable Create a new instance of the given fmu, adds a logger if logginOn == true. Returns the instance of a new FMU component. For more information call ?fmi3InstantiateCoSimulation

FMIImport.fmi3InstantiateModelExchange! — Method

FMIImport.fmi3InstantiateScheduledExecution! — Method

FMIImport.fmi3IsCoSimulation — Method

Returns true, if the FMU supports co simulation

FMIImport.fmi3IsModelExchange — Method

Returns true, if the FMU supports model exchange

FMIImport.fmi3IsScheduledExecution — Method

Returns true, if the FMU supports scheduled execution

FMIImport.fmi3Load — Method

Sets the properties of the fmu by reading the modelDescription.xml. Retrieves all the pointers of binary functions. Returns the instance of the FMU struct. Via optional argument unpackPath, a path to unpack the FMU can be specified (default: system temporary directory).

FMIImport.fmi3LoadModelDescription — Method

Extract the FMU variables and meta data from the ModelDescription

FMIImport.fmi3ModelVariablesForValueReference — Method

Returns the model variable(s) fitting the value reference.

FMIImport.fmi3ProvidesAdjointDerivatives — Method

Returns true, if the FMU provides adjoint derivatives

FMIImport.fmi3ProvidesDirectionalDerivatives — Method

Returns true, if the FMU provides directional derivatives

FMIImport.fmi3Reload — Method

Reloads the FMU-binary. This is useful, if the FMU does not support a clean reset implementation.

FMIImport.fmi3SampleDirectionalDerivative — Function

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

FMIImport.fmi3SampleDirectionalDerivative — Function

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

FMIImport.fmi3SampleDirectionalDerivative! — Function

This function samples the directional derivative by manipulating corresponding values (central differences) and saves in-place.

FMIImport.fmi3SampleDirectionalDerivative! — Function

This function samples the directional derivative by manipulating corresponding values (central differences) and saves in-place.

FMIImport.fmi3SerializeFMUState — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.4. Getting and Setting the Complete FMU State

Serialize the data in the FMU state pointer.

For more information call ?fmi3SerzializeFMUstate

FMIImport.fmi3SerializedFMUStateSize — Method

Source: FMISpec3.0, Version D5ef1c1: 2.2.6.4. Getting and Setting the Complete FMU State

Returns the size of a byte vector the FMU can be stored in.

For more information call ?fmi3SerzializedFMUstateSize

FMIImport.fmi3StringToValueReference — Method

Returns an array of ValueReferences coresponding to the variable names.

FMIImport.fmi3StringToValueReference — Method

Returns the ValueReference coresponding to the variable name.

FMIImport.fmi3Unload — Function

Unload a FMU. Free the allocated memory, close the binaries and remove temporary zip and unziped FMU model description.

FMIImport.fmi3Unzip — Method

Create a copy of the .fmu file as a .zip folder and unzips it. Returns the paths to the zipped and unzipped folders. Via optional argument unpackPath, a path to unpack the FMU can be specified (default: system temporary directory).

FMIImport.fmi3ValueReferenceToString — Method

Returns an array of variable names matching a fmi3ValueReference.