Struct ModelInstance 

pub struct ModelInstance<M, C>
where
    M: UserModel,
    C: Context<M>,
{ /* private fields */ }

An exportable FMU instance, generic over model type M and context type C

Implementations

impl<M, C> ModelInstance<M, C>

where M: Model + UserModel, C: Context<M>,

pub fn new( name: String, instantiation_token: &str, context: C, instance_type: InterfaceType, ) -> Result<Self, Fmi3Error>

pub fn instance_name(&self) -> &str

pub fn instance_type(&self) -> InterfaceType

pub fn context(&self) -> &C

pub fn assert_instance_type( &self, expected: InterfaceType, ) -> Result<(), Fmi3Error>

Trait Implementations

impl<M, C> CoSimulation for ModelInstance<M, C>

where M: Model + UserModel + ModelGetSet<M> + ModelGetSetStates, C: Context<M>,

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 get_output_derivatives( &mut self, vrs: &[fmi3ValueReference], orders: &[i32], _values: &mut [f64], ) -> Result<Fmi3Res, Fmi3Error>

The returned values correspond to the derivatives at the current time of the FMU. For example, after a successful call to CoSimulation::do_step, the returned values are related to the end of the communication step.

fn do_step( &mut self, current_communication_point: f64, communication_step_size: f64, no_set_fmu_state_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<M, C> Common for ModelInstance<M, C>

where M: Model + UserModel + ModelGetSet<M>, C: Context<M>,

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_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 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 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_event_mode(&mut self) -> Result<Fmi3Res, Fmi3Error>

This function changes the state to Event Mode.

fn update_discrete_states( &mut self, event_flags: &mut EventFlags, ) -> 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 get_number_of_variable_dependencies( &mut self, _vr: fmi3ValueReference, ) -> Result<usize, Fmi3Error>

This function returns the number of dependencies for a given variable.

fn get_variable_dependencies( &mut self, _dependent: fmi3ValueReference, ) -> Result<Vec<VariableDependency>, Fmi3Error>

This function returns the dependency information for a single variable.

impl<M, C> GetSet for ModelInstance<M, C>

where M: Model + UserModel + ModelGetSet<M>, C: Context<M>,

Blanket implementation of the GetSet trait for ModelInstance.

These implementations delegate to the underlying user model’s get/set methods which are generated by the derive macro). Here we have special handling for the ‘time’ variable reference (implicitly always VR=0).

The generated get/set methods do not take into account ‘time’ as VR=0, and expect VRs to be zero-based indices into the model’s variables.

Only the float64 getter has special handling for ‘time’ VR=0, as it is the only type that can represent time.

fn get_boolean( &mut self, vrs: &[fmi3ValueReference], values: &mut [bool], ) -> Result<Fmi3Res, Fmi3Error>

Get the values of the specified variable references.

fn set_boolean( &mut self, vrs: &[fmi3ValueReference], values: &[bool], ) -> Result<Fmi3Res, Fmi3Error>

Set the values of the specified variable references.

fn get_float32( &mut self, vrs: &[fmi3ValueReference], values: &mut [f32], ) -> Result<Fmi3Res, Fmi3Error>

Get the values of the specified variable references.

fn set_float32( &mut self, vrs: &[fmi3ValueReference], values: &[f32], ) -> Result<Fmi3Res, Fmi3Error>

Set the values of the specified variable references.

fn get_int8( &mut self, vrs: &[fmi3ValueReference], values: &mut [i8], ) -> Result<Fmi3Res, Fmi3Error>

Get the values of the specified variable references.

fn set_int8( &mut self, vrs: &[fmi3ValueReference], values: &[i8], ) -> Result<Fmi3Res, Fmi3Error>

Set the values of the specified variable references.

fn get_int16( &mut self, vrs: &[fmi3ValueReference], values: &mut [i16], ) -> Result<Fmi3Res, Fmi3Error>

Get the values of the specified variable references.

fn set_int16( &mut self, vrs: &[fmi3ValueReference], values: &[i16], ) -> Result<Fmi3Res, Fmi3Error>

Set the values of the specified variable references.

fn get_int32( &mut self, vrs: &[fmi3ValueReference], values: &mut [i32], ) -> Result<Fmi3Res, Fmi3Error>

Get the values of the specified variable references.

fn set_int32( &mut self, vrs: &[fmi3ValueReference], values: &[i32], ) -> Result<Fmi3Res, Fmi3Error>

Set the values of the specified variable references.

fn get_int64( &mut self, vrs: &[fmi3ValueReference], values: &mut [i64], ) -> Result<Fmi3Res, Fmi3Error>

Get the values of the specified variable references.

fn set_int64( &mut self, vrs: &[fmi3ValueReference], values: &[i64], ) -> Result<Fmi3Res, Fmi3Error>

Set the values of the specified variable references.

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

Get the values of the specified variable references.

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

Set the values of the specified variable references.

fn get_uint16( &mut self, vrs: &[fmi3ValueReference], values: &mut [u16], ) -> Result<Fmi3Res, Fmi3Error>

Get the values of the specified variable references.

fn set_uint16( &mut self, vrs: &[fmi3ValueReference], values: &[u16], ) -> Result<Fmi3Res, Fmi3Error>

Set the values of the specified variable references.

fn get_uint32( &mut self, vrs: &[fmi3ValueReference], values: &mut [u32], ) -> Result<Fmi3Res, Fmi3Error>

Get the values of the specified variable references.

fn set_uint32( &mut self, vrs: &[fmi3ValueReference], values: &[u32], ) -> Result<Fmi3Res, Fmi3Error>

Set the values of the specified variable references.

fn get_uint64( &mut self, vrs: &[fmi3ValueReference], values: &mut [u64], ) -> Result<Fmi3Res, Fmi3Error>

Get the values of the specified variable references.

fn set_uint64( &mut self, vrs: &[fmi3ValueReference], values: &[u64], ) -> Result<Fmi3Res, Fmi3Error>

Set the values of the specified variable references.

fn get_float64( &mut self, vrs: &[fmi3ValueReference], values: &mut [f64], ) -> Result<Fmi3Res, Fmi3Error>

Get the values of the specified variable references.

fn set_float64( &mut self, vrs: &[fmi3ValueReference], values: &[f64], ) -> Result<Fmi3Res, Fmi3Error>

Set the values of the specified variable references.

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

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

fn get_binary( &mut self, vrs: &[fmi3ValueReference], values: &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.

fn get_clock( &mut self, vrs: &[fmi3ValueReference], values: &mut [fmi3Clock], ) -> Result<Fmi3Res, Fmi3Error>

fn set_clock( &mut self, _vrs: &[fmi3ValueReference], _values: &[fmi3Clock], ) -> Result<Fmi3Res, Fmi3Error>

impl<M, C> ModelExchange for ModelInstance<M, C>

where M: Model + UserModel + ModelGetSet<M> + ModelGetSetStates, C: Context<M>,

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 set_continuous_states( &mut self, states: &[f64], ) -> Result<Fmi3Res, Fmi3Error>

Set new continuous state values.

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

Return the current continuous state vector.

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_event_indicators( &mut self, indicators: &mut [f64], ) -> Result<bool, Fmi3Error>

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

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

Return the nominal values of the continuous states.

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

This function returns the number of event indicators.

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

This function returns the number of continuous states.

impl<M, C> ScheduledExecution for ModelInstance<M, C>

where M: Model + UserModel + ModelGetSet<M> + ModelGetSetStates, C: Context<M>,

fn activate_model_partition( &mut self, _clock_reference: fmi3ValueReference, _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.