HeightMeasure
Public Attributes
Parameter | Type | Description |
---|---|---|
target_body | String | Body for which to measure the height, leave empty to use COM (default). |
use_average_height | bool | Use average height instead of peak hight for measure; default = false. |
terminate_on_peak | bool | Terminate simulation when a peak is detected; default = true. |
termination_height | double | Relative height of COM at which to terminate the simulation; default = 0.5. |
name | String | Name of the Measure, to be used in reporting; defaults to measure type. |
weight | Real | Weighting factor applied to the result of the measure; default = 1. |
threshold | Real | Threshold above / below which the measure becomes zero; default = 0. |
threshold_transition | Real | Transition range above threshold between which the measure linearly decreases to zero; default = 0. |
result_offset | Real | Offset added to measure result; default = 0. |
minimize | bool | Indicate whether this measure should be minimized; default value depends on the measure type (usually true). |
start_time | TimeInSeconds | Time [s] at which Controller becomes active; default = 0. |
stop_time | TimeInSeconds | Time [s] at which Controller becomes inactive; default = until simulation ends. |
signature_prefix | String | Prefix signature with custom string. Special tags: DATE_TIME, DATE_TIME_EXACT, SCONE_VERSION. |
signature_postfix | String | Append custom string to signature. Special tags: DATE_TIME, DATE_TIME_EXACT, SCONE_VERSION. |
signature | String | Set custom signature and omit the auto-generated signature. |
Converted from doxygen using dokugen