Flux
This block is used to perform co-simulation with Altair Flux.
Library
Activate/CoSimulation
Parameters
Name | Label | Description | Data Type | Valid Values |
---|---|---|---|---|
Namepb | Flux to Twin Activate component file name | Enter the file name of the Flux to Twin Activate project created by Flux. The file has the same name as the Flux project and uses the .F2STA extension. | String | |
MultiplexedMode | Multiplexed inputs/outputs | Select vector or scalar mode for the input/output. | Number | 0 |
nin | Number of input ports | The number of input parameters stored in the *.F2TSA file. | Number | |
inports | Inputs | Structure | ||
inports/label | Label | Cell of strings | ||
nout | Number of output ports | The number of output parameters stored in the *.F2TSA file. | Number | |
outports | Outputs | Structure | ||
outports/label | Label | Cell of strings |
Name | Label | Description | Data Type | Valid Values |
---|---|---|---|---|
externalActivation | External activation | Specifies whether the block receives an external activation or inherits its activation through its regular input ports. When External Activation is selected, an additional activation port is added to the block. By default, external activation is not selected. If external activation is selected, the Flux engine performs a computation only at event instants, for example at periodic events defined by an external clock. In addition, the Minimum variation (%) for the Flux computation and Maximum computation intervals is disabled. | Number | 0 |
ExtraPoint | Extra Flux calls at Twin Activate event instants | When deselected, Twin Activate invokes Flux only at the Twin Activate solver mesh points to update the Flux block outputs. When selected, Twin Activate also invokes Flux at all Twin Activate discrete event instants. | Number | 0 |
EpsInput | Minimum input variation (%) to run Flux computation | Specifies the percentage of input variation between two calculation steps under which a Flux calculation should not occur. When the Flux calculation is not carried out, outputs are computed based on the 'Output extrapolation order' that is defined. This allows several Twin Activate time steps to be carried out without any Flux calculations. | Scalar | |
maxComputationInterval | Maximum computation interval | If a non-zero 'Maximum computation interval' is provided, and a non-zero 'Minimal input variation' is specified, the Flux engine is forced to perform a computation not later than the 'Maximum computation interval' since the last computation, even if the input values have not changed. | Scalar | |
extrapolateOrder | Output extrapolation order | Choose the output extrapolation order (0 : no extrapolation, 1 : linear extrapolation). | Number | |
ndepu | Break algebraic loop | Add a one-step delay to help avoid the algebraic loops caused by the Flux block. In order to breake the algebraic loop, the block provides the option to delays at input(s) or outputs. | Number | 0 |
delayType | Delay type | It is also possible to declare the block as a block with no input-output dependency which is not recommanded. | String | 'Delay |
Name | Label | Description | Data Type | Valid Values |
---|---|---|---|---|
Subsampling | Subsampling (reduced result storage) | N (>2) means one out of N data is stored in the result data file in Flux. This feature is available in Flux version 2018 and above. | Scalar | |
ConsoleDisplay | Flux console display | Select the check box to turn on the Flux display console, though this may drastically slow down the computation. | Number | 0 |
log_file_name | Log file name (*.log) | Twin Activate messages as well as messages communicated from Flux to Twin Activate are logged into this file. | String |
Name | Label | Description | Data Type | Valid Values |
---|---|---|---|---|
InstalledFluxVersion | Current Flux version | Displays the Flux version in use. | String | |
Version | Flux component version | Flux version used to generate the coupling component. | String | |
Appli | Flux solver | Displays the Flux solver in use. | String | |
RSize | Numerical memory (MB) | Specifies the memory used for the various modeling actions. 3D mesh and solving processes (Flux 2D-3D) include a high memory demand. Memory allocation is a function of the application type (real/complex) and matrix size for the solving process. | Scalar | |
CSize | Character memory (MB) | Character memory is used for storing entity names (parameters, transformations, regions) and project names presented in the directory. | Scalar | |
nCORES | Number of cores | Number of cores used by Flux during co-simulation. This feature is available in Flux version 2018 and above. | Number |
Ports
Name | Type | Description | IO Type | Number |
---|---|---|---|---|
Port 1 | explicit | output | nout-MultiplexedMode*nout+MultiplexedMode | |
Port 2 | explicit | input | nin-MultiplexedMode*nin+MultiplexedMode | |
Port 3 | activation | input | externalActivation |