Commit e708ae81 authored by Simon Barner's avatar Simon Barner
Browse files

Spelling of "co-simulation"

Issue-Ref: 4069
Issue-Url: https://af3-developer.fortiss.org/issues/4069

Signed-off-by: Simon Barner's avatarSimon Barner <barner@fortiss.org>
parent c0e32197
......@@ -2,7 +2,7 @@ BehaviorMod.ContentPage.html 8add0e6ba4dffc4715af499f681576b90d24a252 GREEN
ModandSim.MainPage.html 2ffbbecd7d06ade3f5a0a0ca3b3f8407d6ba5879 GREEN
code_specification.html 2212a40a032718892a24ab7aef701f40a90e4f7a GREEN
component_architecture.html d122d62d6622714a597a6ffbbf12bf0c8a092861 GREEN
cosimulation_with_af3.html e1ce2b64ebe2b3500cc828e65a12ddc60d0613a7 YELLOW
cosimulation_with_af3.html 220d893a0d6e1dd5003b679fc888c2162bbd9fad YELLOW
data_dictionary.html f16333315733a5223868fdf2e0b1ec06c0419d43 GREEN
hierarchical_state_automaton.html b1e1f12b3bd667fce2158df8d0dd7379b7fb7703 GREEN
mode_automaton.html 57688d041d31a074174bd8708118fb4833626753 GREEN
......
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- User documentation for Cosimulation feature. -->
<!-- User documentation for Co-simulation feature. -->
<html>
<head>
......@@ -122,7 +122,7 @@
<h1>Coupling AutoFOCUS3 with other Tools using Co-Simulation</h1>
<p>The following sections provide introduction and discuss cosimulation functionality in detail.
<p>The following sections provide introduction and discuss co-simulation functionality in detail.
The <a href="../example_co-simulation.html">inverted pendulum example</a> illustrates the concepts introduced in this section with a co-simulation comprising three tools.</p>
<h2>Introduction</h2>
......@@ -132,20 +132,20 @@ Other tools are often needed, e.g., for modeling continuous behavior
for interoperability with legacy tools, or simply for using non-AF3 features in combination with AF3
(e.g., visualization). </p>
<p>
In such cases, AF3 has <i>cosimulation</i> capabilities which allows to use AF3 <a href="simulation_with_af3.html">simulation</a>
In such cases, AF3 has <i>co-simulation</i> capabilities which allows to use AF3 <a href="simulation_with_af3.html">simulation</a>
with other tools in a synchronous manner.
AF3 offers cosimulation functionality in the following two ways:
AF3 offers co-simulation functionality in the following two ways:
<ul> <li>
The AF3 model can be exported as an <a target="_blank" rel="noopener noreferrer" href="http://www.fmi-standard.org">FMU</a>, which can be used as one of the components for cosimulation in other tools.</li>
The AF3 model can be exported as an <a target="_blank" rel="noopener noreferrer" href="http://www.fmi-standard.org">FMU</a>, which can be used as one of the components for co-simulation in other tools.</li>
<li>AF3 provides the environment for FMUs cosimulation by utilizing Cosimulation Orchestration Engine (<a target="_blank" rel="noopener noreferrer" href="https://into-cps-association.github.io/simulation/coe.html">COE</a>)
provided by INTO-CPS as a service. Thus, the FMUs from different tools can be imported and cosimulated together along with the AF3 components.</li>
<li>AF3 provides the environment for FMUs co-simulation by utilizing Co-simulation Orchestration Engine (<a target="_blank" rel="noopener noreferrer" href="https://into-cps-association.github.io/simulation/coe.html">COE</a>)
provided by INTO-CPS as a service. Thus, the FMUs from different tools can be imported and co-simulated together along with the AF3 components.</li>
</ul>
</p>
<h2>Cosimulation using FMI (Functional Mockup Interface)</h2>
<h2>Co-simulation using FMI (Functional Mockup Interface)</h2>
<p>
This feature supports for now only FMU export satisfying the following constraints:
......@@ -170,7 +170,7 @@ To export anyone of them to the FMU, right-click on it in the model navigator an
<img src="./pictures/FMI_menu.png"/>
<p> AF3 works with logical time, however cosimulation is generally achieved with tools modeling reality and therefore working with real time.
<p> AF3 works with logical time, however co-simulation is generally achieved with tools modeling reality and therefore working with real time.
Therefore, the FMI standard requires that AF3 notion of time is translated to real time.
For that, a function with the name 'samplingTime()' can be defined in the data dictionary and used inside the AF3 component's behavior.
If the samplingTime() is not defined, the user will be
......@@ -181,15 +181,15 @@ asked to provide the required frequency (equivalent to sampling time) for the co
<p> You will then be asked where to store the generated FMU.
Once this is done, a message confirming that generation was successful appears and you can find the generated FMU in the directory that you selected.
You can then make use of the <a target="_blank" rel="noopener noreferrer" href="https://www.fmi-standard.org/tools">numerous cosimulation tools</a> along with AF3 itself, supporting FMI to cosimulate the generated AF3 model's FMU.</p>
You can then make use of the <a target="_blank" rel="noopener noreferrer" href="https://www.fmi-standard.org/tools">numerous co-simulation tools</a> along with AF3 itself, supporting FMI to co-simulate the generated AF3 model's FMU.</p>
<h2>Importing FMUs and their cosimulation</h2>
<h2>Importing FMUs and their co-simulation</h2>
<p>
The FMU's from other tools can be imported in AF3 for the cosimulation together with the AF3's own behavior components.</p>
The FMU's from other tools can be imported in AF3 for the co-simulation together with the AF3's own behavior components.</p>
<h3>Creating an FMU Specification</h3>
<p>
To use the cosimulation feature, you have to create the <i>FMU Specification</i> inside the component.
To use the co-simulation feature, you have to create the <i>FMU Specification</i> inside the component.
Only the entire component architecture can be simulated having FMUs or other AF3 behaviors inside its subcomponents.</p>
<p>To create an <i>FMU specification</i> for a component, open the context menu of the component and select "FMU Specification".</p>
......@@ -210,19 +210,19 @@ It has a field with:
<img src="./pictures/externalSpecificationEditor.png"/>
<p>Different AF3 component and the FMUs are connected with each other through the input and output ports. The outputs that has to be displayed as a result of the
cosimulation are assigned to the Component Architecture's root component.</p>
co-simulation are assigned to the Component Architecture's root component.</p>
<img src="./pictures/cosimulationComponentsConnection.png"/>
<h3>Running a Cosimulation</h3>
<h3>Running a Co-simulation</h3>
<p>To start the cosimulation, right-click on the <i>Component Architecture</i> element in the <i>Model Navigator</i> and select "Run Cosimulator". Remember
<p>To start the co-simulation, right-click on the <i>Component Architecture</i> element in the <i>Model Navigator</i> and select "Run Co-simulator". Remember
that this option will only be available, if there is at least two atomic component and one of them has an FMU Specification behavior.</p>
<img src="./pictures/runCosimulator.png"/>
<p>
If there would be no error in the model, then Cosimulation Configuration window will open containing two sections:
If there would be no error in the model, then Co-simulation Configuration window will open containing two sections:
<ul>
<li><i>Simulation time:</i> The step size, start and end time values has to be provided for which the simulation needs to be run.
The end time should be greater than the start time and the step size should be greater than zero and within the range of start and end time. </li>
......@@ -230,12 +230,12 @@ The end time should be greater than the start time and the step size should be g
</ul>
</p>
<p>Then press OK to proceed or cancel to stop the cosimulator.</p>
<p>Then press OK to proceed or cancel to stop the co-simulator.</p>
<img src="./pictures/cosimulationConfigurations.png"/>
<p> OK will execute the cosimulation of the components and at last the window with graph having the results will pop up.</p>
<p> OK will execute the co-simulation of the components and at last the window with graph having the results will pop up.</p>
<img src="./pictures/cosimulationResults.png"/>
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment