Differences
This shows you the differences between two versions of the page.
| — |
ref:joint_load_measure [2020/06/19 15:47] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ====== JointLoadMeasure ====== | ||
| + | [[measure|Measure]] for penalizing joint load, if above a specific threshold. | ||
| + | |||
| + | See [[range_penalty|RangePenalty]] for details on how to set range, abs_penalty and squared_penalty. | ||
| + | |||
| + | **Inherits from** [[measure|Measure]], [[range_penalty|RangePenalty< Real >]]. | ||
| + | |||
| + | ==== Public Attributes ==== | ||
| + | ^ Parameter ^ Type ^ Description ^ | ||
| + | ^ name | String | Name of the [[measure|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|Controller]] becomes active; default = 0. | | ||
| + | ^ stop_time | TimeInSeconds | Time [s] at which [[controller|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. | | ||
| + | ^ abs_penalty | Real | Absolute penalty factor when value is out of range; default = 0. | | ||
| + | ^ squared_penalty | Real | Squared penalty factor when value out of range; default = 0. | | ||
| + | ^ mode_ | penalty_mode | Use the peek range violation instead of average range violation; default = 0. | | ||
| + | ^ min | Real | Minimum value or lower bound of the range; default = -inf. | | ||
| + | ^ max | Real | Maximum value or upper bound of the range; default = inf. | | ||
| + | |||
| + | <sub>Converted from doxygen using [[https://github.com/tgeijten/dokugen|dokugen]]</sub> | ||