Struct Instance 

pub struct Instance<'a, Tag> { /* private fields */ }

An imported FMI 3.0 instance

Implementations

impl<'a> Instance<'a, CS>

pub fn new( import: &'a Fmi3Import, instance_name: &str, visible: bool, logging_on: bool, event_mode_used: bool, early_return_allowed: bool, required_intermediate_variables: &[fmi3ValueReference], ) -> Result<Self, Error>

Returns a new CoSimulation instance.

An FMU can be instantiated many times (provided capability flag can_be_instantiated_only_once_per_process = false).

Arguments:

• instance_name: a unique identifier for the FMU instance. It is used to name the instance, for example, in error or information messages generated by one of the fmi3XXX functions. The argument instance_name must be a non empty string (in other words, must have at least one character that is not a white space). If only one FMU is simulated, either the attribute crate::fmi3::schema::Fmi3ModelDescription::model_name or one of

  • crate::fmi3::schema::Fmi3ModelExchange::model_identifier,
  • crate::fmi3::schema::Fmi3CoSimulation::model_identifier, or
  • crate::fmi3::schema::Fmi3ScheduledExecution::model_identifier can be used as instance_name.

• visible: Defines that the interaction with the user should be reduced to a minimum (no application window, no plotting, no animation, etc.). In other words, the FMU is executed in batch mode. If visible = true, the FMU is executed in interactive mode, and the FMU might require to explicitly acknowledge start of simulation / instantiation / initialization (acknowledgment is non-blocking).

• logging_on: If = false, then any logging is disabled and the logMessage callback function must not be called by the FMU. If logging_on = true, then all LogCategories are enabled. The function crate::fmi3::traits::Common::set_debug_logging gives more detailed control about enabling specific LogCategories.

• event_mode_used: If = true the importer can handle events. The flag may only be true, if has_event_mode = true, otherwise the FMU must raise an error. For FMUs that have clocks, event_mode_used = true is required.

• early_return_allowed: If = true the importer can handle early return. Only in this case, crate::fmi3::traits::CoSimulation::do_step() may return with early_return = true.

• required_intermediate_variables: An array of the value references of all input variables that the simulation algorithm intends to set and all output variables it intends to get during intermediate updates. This set may be empty (nRequiredIntermediateVariables = 0) when the simulation algorithm does not intend to use intermediate update. Only the variables in requiredIntermediateVariables may be accessed by the simulation algorithm using fmi3Set{VariableType} and fmi3Get{VariableType} during Intermediate Update Mode. All variables referenced in this set must be marked with the attribute intermediateUpdate = “true” in modelDescription.xml.

See: https://fmi-standard.org/docs/3.0.1/#fmi3InstantiateCoSimulation

impl<'a> Instance<'a, ME>

pub fn new( import: &'a Fmi3Import, instance_name: &str, visible: bool, logging_on: bool, ) -> Result<Self, Error>

impl<'a> Instance<'a, SE>

pub fn new( import: &'a Fmi3Import, instance_name: &str, visible: bool, logging_on: bool, ) -> Result<Self, Error>

impl<'a, Tag> Instance<'a, Tag>

where Self: Common,

pub fn get_variable_dimensions(&mut self, var_refs: &[u32]) -> usize

Get the sum of the product of the dimensions of the variables with the given value references.

Trait Implementations

impl CoSimulation for Instance<'_, CS>

fn enter_step_mode(&mut self) -> Result<Fmi3Res, Fmi3Error>

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

fn do_step( &mut self, current_communication_point: f64, communication_step_size: f64, no_set_fmustate_prior_to_current_point: bool, event_handling_needed: &mut bool, terminate_simulation: &mut bool, early_return: &mut bool, last_successful_time: &mut f64, ) -> Result<Fmi3Res, Fmi3Error>

The importer requests the computation of the next time step.

impl<'a, Tag> Common for Instance<'a, Tag>

fn get_version(&self) -> &str

The FMI-standard version string

fn set_debug_logging( &mut self, logging_on: bool, categories: &[&str], ) -> Result<Fmi3Res, Fmi3Error>

The function controls the debug logging that is output by the FMU

fn enter_configuration_mode(&mut self) -> Result<Fmi3Res, Fmi3Error>

Changes state to Reconfiguration Mode.

fn exit_configuration_mode(&mut self) -> Result<Fmi3Res, Fmi3Error>

Exits the Configuration Mode and returns to state Instantiated.

fn enter_initialization_mode( &mut self, tolerance: Option<f64>, start_time: f64, stop_time: Option<f64>, ) -> Result<Fmi3Res, Fmi3Error>

Changes state to Initialization Mode.

fn exit_initialization_mode(&mut self) -> Result<Fmi3Res, Fmi3Error>

Changes the state, depending on the instance type:

fn enter_event_mode(&mut self) -> Result<Fmi3Res, Fmi3Error>

This function changes the state to Event Mode.

fn terminate(&mut self) -> Result<Fmi3Res, Fmi3Error>

Changes state to Terminated.

fn reset(&mut self) -> Result<Fmi3Res, Fmi3Error>

Is called by the environment to reset the FMU after a simulation run. The FMU goes into the same state as if newly created. All variables have their default values. Before starting a new run Common::enter_initialization_mode() has to be called.

fn update_discrete_states( &mut self, discrete_states_need_update: &mut bool, terminate_simulation: &mut bool, nominals_of_continuous_states_changed: &mut bool, values_of_continuous_states_changed: &mut bool, next_event_time: &mut Option<f64>, ) -> Result<Fmi3Res, Fmi3Error>

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

impl<'a, Tag> Drop for Instance<'a, Tag>

fn drop(&mut self)

Executes the destructor for this type.

impl FmiEventHandler for Instance<'_, CS>

fn enter_event_mode(&mut self) -> Result<Fmi3Res, Fmi3Error>

fn update_discrete_states( &mut self, discrete_states_need_update: &mut bool, terminate_simulation: &mut bool, nominals_of_continuous_states_changed: &mut bool, values_of_continuous_states_changed: &mut bool, next_event_time: &mut Option<f64>, ) -> Result<Fmi3Res, Fmi3Error>

impl FmiEventHandler for Instance<'_, ME>

fn enter_event_mode(&mut self) -> Result<Fmi3Res, Fmi3Error>

fn update_discrete_states( &mut self, discrete_states_need_update: &mut bool, terminate_simulation: &mut bool, nominals_of_continuous_states_changed: &mut bool, values_of_continuous_states_changed: &mut bool, next_event_time: &mut Option<f64>, ) -> Result<Fmi3Res, Fmi3Error>

impl<'a, Tag> FmiInstance for Instance<'a, Tag>

type ModelDescription = Fmi3ModelDescription

type ValueRef = <Fmi3Import as FmiImport>::ValueRef

type Status = Fmi3Status

fn name(&self) -> &str

Get the instance name

fn get_version(&self) -> &str

Get the version of the FMU

fn model_description(&self) -> &Self::ModelDescription

Get the model description of the FMU

fn set_debug_logging( &mut self, logging_on: bool, categories: &[&str], ) -> Result<Fmi3Res, Fmi3Error>

The function controls the debug logging that is output by the FMU

fn get_number_of_continuous_state_values(&mut self) -> usize

Get the number of values required to store the continuous states. Array dimensions are expanded.

fn get_number_of_event_indicator_values(&mut self) -> usize

Get the number of values required to store the event indicators. Array dimensions are expanded.

fn enter_initialization_mode( &mut self, tolerance: Option<f64>, start_time: f64, stop_time: Option<f64>, ) -> Result<Fmi3Res, Fmi3Error>

fn exit_initialization_mode(&mut self) -> Result<Fmi3Res, Fmi3Error>

fn terminate(&mut self) -> Result<Fmi3Res, Fmi3Error>

Changes state to Terminated.

fn reset(&mut self) -> Result<Fmi3Res, Fmi3Error>

Is called by the environment to reset the FMU after a simulation run. The FMU goes into the same state as if newly created. All variables have their default values. Before starting a new run FmiInstance::enter_initialization_mode() has to be called.

impl FmiModelExchange for Instance<'_, ME>

fn enter_continuous_time_mode(&mut self) -> Result<Fmi3Res, Fmi3Error>

fn enter_event_mode(&mut self) -> Result<Fmi3Res, Fmi3Error>

fn update_discrete_states( &mut self, discrete_states_need_update: &mut bool, terminate_simulation: &mut bool, nominals_of_continuous_states_changed: &mut bool, values_of_continuous_states_changed: &mut bool, next_event_time: &mut Option<f64>, ) -> Result<Fmi3Res, Fmi3Error>

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

fn completed_integrator_step( &mut self, no_set_fmu_state_prior: bool, enter_event_mode: &mut bool, terminate_simulation: &mut bool, ) -> Result<Fmi3Res, Fmi3Error>

fn set_time(&mut self, time: f64) -> Result<Fmi3Res, Fmi3Error>

fn get_continuous_states( &mut self, continuous_states: &mut [f64], ) -> Result<Fmi3Res, Fmi3Error>

fn set_continuous_states( &mut self, states: &[f64], ) -> Result<Fmi3Res, Fmi3Error>

fn get_continuous_state_derivatives( &mut self, derivatives: &mut [f64], ) -> Result<Fmi3Res, Fmi3Error>

fn get_nominals_of_continuous_states( &mut self, nominals: &mut [f64], ) -> Result<Fmi3Res, Fmi3Error>

fn get_event_indicators( &mut self, event_indicators: &mut [f64], ) -> Result<bool, <Self::Status as FmiStatus>::Err>

fn get_number_of_event_indicators(&mut self) -> Result<usize, Fmi3Error>

impl<'a, Tag> GetSet for Instance<'a, Tag>

type ValueRef = <Fmi3Import as FmiImport>::ValueRef

fn get_boolean( &mut self, vrs: &[fmi3ValueReference], values: &mut [bool], ) -> Fmi3Status

Get the values of the specified variable references.

fn set_boolean( &mut self, vrs: &[fmi3ValueReference], values: &[bool], ) -> Fmi3Status

Set the values of the specified variable references.

fn get_float32( &mut self, vrs: &[fmi3ValueReference], values: &mut [f32], ) -> Fmi3Status

Get the values of the specified variable references.

fn set_float32( &mut self, vrs: &[fmi3ValueReference], values: &[f32], ) -> Fmi3Status

Set the values of the specified variable references.

fn get_float64( &mut self, vrs: &[fmi3ValueReference], values: &mut [f64], ) -> Fmi3Status

Get the values of the specified variable references.

fn set_float64( &mut self, vrs: &[fmi3ValueReference], values: &[f64], ) -> Fmi3Status

Set the values of the specified variable references.

fn get_int8( &mut self, vrs: &[fmi3ValueReference], values: &mut [i8], ) -> Fmi3Status

Get the values of the specified variable references.

fn set_int8(&mut self, vrs: &[fmi3ValueReference], values: &[i8]) -> Fmi3Status

Set the values of the specified variable references.

fn get_int16( &mut self, vrs: &[fmi3ValueReference], values: &mut [i16], ) -> Fmi3Status

Get the values of the specified variable references.

fn set_int16( &mut self, vrs: &[fmi3ValueReference], values: &[i16], ) -> Fmi3Status

Set the values of the specified variable references.

fn get_int32( &mut self, vrs: &[fmi3ValueReference], values: &mut [i32], ) -> Fmi3Status

Get the values of the specified variable references.

fn set_int32( &mut self, vrs: &[fmi3ValueReference], values: &[i32], ) -> Fmi3Status

Set the values of the specified variable references.

fn get_int64( &mut self, vrs: &[fmi3ValueReference], values: &mut [i64], ) -> Fmi3Status

Get the values of the specified variable references.

fn set_int64( &mut self, vrs: &[fmi3ValueReference], values: &[i64], ) -> Fmi3Status

Set the values of the specified variable references.

fn get_uint8( &mut self, vrs: &[fmi3ValueReference], values: &mut [u8], ) -> Fmi3Status

Get the values of the specified variable references.

fn set_uint8(&mut self, vrs: &[fmi3ValueReference], values: &[u8]) -> Fmi3Status

Set the values of the specified variable references.

fn get_uint16( &mut self, vrs: &[fmi3ValueReference], values: &mut [u16], ) -> Fmi3Status

Get the values of the specified variable references.

fn set_uint16( &mut self, vrs: &[fmi3ValueReference], values: &[u16], ) -> Fmi3Status

Set the values of the specified variable references.

fn get_uint32( &mut self, vrs: &[fmi3ValueReference], values: &mut [u32], ) -> Fmi3Status

Get the values of the specified variable references.

fn set_uint32( &mut self, vrs: &[fmi3ValueReference], values: &[u32], ) -> Fmi3Status

Set the values of the specified variable references.

fn get_uint64( &mut self, vrs: &[fmi3ValueReference], values: &mut [u64], ) -> Fmi3Status

Get the values of the specified variable references.

fn set_uint64( &mut self, vrs: &[fmi3ValueReference], values: &[u64], ) -> Fmi3Status

Set the values of the specified variable references.

fn get_string( &mut self, vrs: &[Self::ValueRef], values: &mut [CString], ) -> Result<(), Fmi3Error>

fn set_string( &mut self, vrs: &[Self::ValueRef], values: &[CString], ) -> Result<(), Fmi3Error>

fn get_binary( &mut self, value_references: &[fmi3ValueReference], value_buffers: &mut [&mut [u8]], ) -> Result<Vec<usize>, Fmi3Error>

Get binary values from the FMU.

fn set_binary( &mut self, vrs: &[fmi3ValueReference], values: &[&[u8]], ) -> Result<(), Fmi3Error>

Set binary values in the FMU.

impl ModelExchange for Instance<'_, ME>

fn enter_continuous_time_mode(&mut self) -> Result<Fmi3Res, Fmi3Error>

This function must be called to change from Event Mode into Continuous-Time Mode in Model Exchange.

fn completed_integrator_step( &mut self, no_set_fmu_state_prior: bool, enter_event_mode: &mut bool, terminate_simulation: &mut bool, ) -> Result<Fmi3Res, Fmi3Error>

This function is called after every completed step of the integrator provided the capability flag crate::fmi3::schema::Fmi3ModelExchange::needs_completed_integrator_step = true.

fn set_time(&mut self, time: f64) -> Result<Fmi3Res, Fmi3Error>

Set a new value for the independent variable (typically a time instant).

fn get_continuous_states( &mut self, continuous_states: &mut [f64], ) -> Result<Fmi3Res, Fmi3Error>

Return the current continuous state vector.

fn set_continuous_states( &mut self, states: &[f64], ) -> Result<Fmi3Res, Fmi3Error>

Set new continuous state values.

fn get_continuous_state_derivatives( &mut self, derivatives: &mut [f64], ) -> Result<Fmi3Res, Fmi3Error>

Fetch the first-order derivatives with respect to the independent variable (usually time) of the continuous states.

fn get_nominals_of_continuous_states( &mut self, nominals: &mut [f64], ) -> Result<Fmi3Res, Fmi3Error>

Return the nominal values of the continuous states.

fn get_event_indicators( &mut self, event_indicators: &mut [f64], ) -> Result<bool, Fmi3Error>

Returns the event indicators signaling state events by their sign changes.

fn get_number_of_event_indicators(&mut self) -> Result<usize, Fmi3Error>

This function returns the number of event indicators.

impl<'a> ScheduledExecution for Instance<'a, SE>

fn activate_model_partition( &mut self, clock_reference: Self::ValueRef, activation_time: f64, ) -> Result<Fmi3Res, Fmi3Error>

Each activate_model_partition call relates to one input Clock which triggers the computation of its associated model partition.