Parameter Name | Data Type | Possible Values | Default Value | Description | |
|---|---|---|---|---|---|
pause_simulation | Boolean | TRUE FALSE | FALSE | The FMU does not step and returns the old values of outputs when this value is True. When it is False, the FMU process the inputs, internally steps the model and returns the new outputs. | |
output_rate | Integer | Any value in integer range | As specified in the plant export dialog box | This is the multiplier which is applied to the communication interval between parent and child which determines the interval at which Adams output files (.res) are written. This is also dependent on another parameter, namely communication_scale. Output files are updated at the period determined by communication interval * communication_scale*output_rate | |
solver_selection | Enumeration | 1 (F77 solver) 2 (CXX solver) | As specified in the plant export dialog box | Specifies the solver that is to be used by the Adams FMU | |
communication_mode | Enumeration | 1 (PIPE) 2 (TCP/IP) 3 (DIRECT) | As specified in the plant export dialog box | Specifies the communication mode to be used between the parent and child. Note that DIRECT mode can be used only with non-Adams parents and with CXX solver | |
communication_scale | Integer | Any value in integer range | 1 | This specifies the scaling factor between the parent and the child. | |
initial_static_analysis | Boolean | TRUE FALSE | As specified in the plant export dialog box | This specifies whether Adams should run a static analysis before the dynamic simulation. | |
initialize_inputs_to_zero | Boolean | TRUE FALSE | TRUE | This specifies whether Adams should retain the initial values of inputs as specified in the model or they should be set to zero. Default behavior is to initialize them to zero. | |
initial_warmup_analysis | Boolean | TRUE FALSE | TRUE if FMU is exported using communication_mode as DIRECT. FALSE otherwise | This specifies whether a short dynamic analysis is to be executed before the actual analysis. This is useful in real-time scenarios to prime the solver and avoid initial overruns. | |
solver_thread_stats | Boolean | TRUE FALSE | FALSE | This option works only when running Adams on Concurrent's SimWB. It displays the statistics of different solver threads and is useful for debugging to find out where more time is being used. | |
adams_path_for_fmu | String | Any string value | Empty string | This is used to specify the Adams installation path that is to be used by the FMU (typically used if FMU is exported with one version of Adams and is to be used with a different version). This obviates the need for setting the environment variable "ADAMS_PATH_FOR_FMU". The environment variable, if set, takes precedence over this value and is useful for FMI Parents that do not support strings. | |
thread_affinity_set0 | String | String values that contain numbers (indicating cores/processors) separated by - or , | Empty string | Specifies the processor affinity for set0 threads as comma separated individual values or a range. For example, if five threads are to run on cores 1,2,3,5,7 this can be specified as 1-3,5,7. See section Thread Affinity Settings in Adams for more information. | |
thread_affinity_set1 | String | String values that contain numbers (indicating cores/processors) separated by - or , | Empty string | Specifies the processor affinity for set1 threads as comma separated individual values or a range. This parameter activates Extended Parallelization (EP) when set, and it must specify at least two CPUs that are not included in thread_affinity_set0. | |
msc_adams_realtime | String | See the description of all possible values in section Options in the msc_adams_realtime parameter below. | Empty string | Specifies many options for real time simulations. For example, to change the number of iterations, turn on messages, change integrator settings, etc. You may instead use the environment variable MSC_ADAMS_REAL_TIME. The environment variable, if set, takes precedence over this value and is useful for FMI Parents that do not support strings. | |
realtime_mode | Boolean | TRUE or FALSE | False (True for FMU exported for SIMWB/dSPACE SCALEXIO) | Set this to either TRUE/FALSE to set turn on/off realtime mode during Adams simulation. Not applicable when visibility is ON. See Importing an FMU. | |
save_results | Boolean | TRUE or FALSE | FALSE | Set this flag to TRUE/FALSE to turn on/off results during the Adams simulation. Not applicable when visibility is ON. See Importing an FMU. | |
save_messages | Boolean | TRUE or FALSE | FALSE | Set this to TRUE/FALSE to turn on/off message file generation during Adams simulation. Not applicable when visibility is ON. See Importing an FMU. | |
adams_hostname | String | Any string value. | Host name of the PC from which FMU is exported | This is used to override the default host name that specifies the PC where Adams would run (typically the same PC from where the FMU is exported). The host name or IP address of some other PC can be specified which has Adams installed. | |
input_interpolation_order | Enumeration | FMI V1 | FMI V2 | 1 for FMI V1 0 for FMI V2 | This can be used to specify the interpolation order for Adams child inputs. Accordingly, the solver interpolates the value before using it every step. |
1 (zero order) | 0 (zero order) | ||||
2 (Linear) | 1 (Linear) | ||||
3 (Quadratic) | 2 (Quadratic) | ||||
4 (Linear least squares) | 3 (Linear least squares) | ||||
output_extrapolation_order | Enumeration | FMI V1 | FMI V2 | 1 for FMI V1 0 for FMI V2 | This can be used to specify the extrapolation order for Adams child outputs. This works only if the communication_scale is greater than 1. |
1 (zero order) | 0 (zero order) | ||||
2 (Linear) | 1 (Linear) | ||||
3 (Quadratic) | 2 (Quadratic) | ||||
4 (Linear least squares) | 3 (Linear least squares) | ||||
animation | Boolean | TRUE FALSE | TRUE if "Real Time Animation" radio button is set to On in the Real Time Animation Settings dialog before performing a files only analysis in Adams Car, Adams Driveline and so on, FALSE otherwise. | This is used to enable real-time animation with Adams. It is available only for non-Adams View products (like Adams Car, Adams Driveline and so on) | |
rta_hostname | String | Any string value | localhost | This is used to specify the host-name of the PC on which the real-time animation would run. It is available only for non-Adams View products (like Adams Car, Adams Driveline and so on) | |
mtl_file | String | Any string value that points to the material file path (in the format required by ACar). | mdids://acar_shared/shell_graphics.tbl/adams_vtd_mat.mtl | This is used to specify the material file that is to be used for real-time animation. It is available only for non-Adams View products (like Adams Car, Adams Driveline and so on) | |
startup_time | Real | Any real value | 5.0 | This specifies the startup time for the real-time animation and the units is seconds. It is available only for non-Adams View products (like Adams Car, Adams Driveline and so on) | |
sample_time | Real | Any real value | 0.01 | This specifies the communication frequency between Adams and the real-time animation component. Units is seconds. It is available only for non-Adams View products (like Adams Car, Adams Driveline and son on) | |
road_grid_size | Real | Any real value | 200 | This specifies the grid size of the road for real-time animation and units are in m. It is available only for non-Adams View products (like Adams Car, Adams Driveline and so on) | |
road_grid_spacing | Real | Any real value | 1 | This specifies the grid spacing of the road for real-time animation and units are in mm. It is available only for non-Adams View products (like Adams Car, Adams Driveline and so on) | |
Solver_thread_count | Integer | Greater than 0 and preferably limited to the number of cores available in the PC | As specified in the model settings during plant export | This setting overrides the thread count specified in the model during plant export as long as the newly set value is greater than 0. | |
initialSpeed | Real | Any real value | As specified in the event during files_only analysis before a plant export | This specifies the initial speed of the vehicle. It is available only for non-Adams View products (like Adams Car, Adams Driveline and so on) | |