Differences
This shows you the differences between two versions of the page.
| — |
ref:effort_measure [2020/01/03 14:19] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ====== EffortMeasure ====== | ||
| + | Measures the energy consumption of a model during simulation, according to various models. | ||
| + | |||
| + | Supported effort models: | ||
| + | * ''Constant'': constant energy measure | ||
| + | * ''TotalForce'': total muscle force | ||
| + | * ''Wang2012'': metabolic energy measure as defined in [Wang et al. 2012] | ||
| + | * ''Uchida2016'': metabolic energy measure as defined in [Uchida et al. 2012] | ||
| + | * ''SquaredMuscleStress'': summed squared muscle stress: (force / PCSA)^2 | ||
| + | |||
| + | This can also be used for cost-of-transport, using the ''use_cost_of_transport'' parameter. | ||
| + | |||
| + | **Inherits from** [[measure|Measure]]. | ||
| + | |||
| + | ==== Public Attributes ==== | ||
| + | ^ Parameter ^ Type ^ Description ^ | ||
| + | ^ measure_type | [[effort_measure_1adaa4b9692620b938c000cde156c5ec8e|EnergyMeasureType]] | Energy model to be used, can be: ''TotalForce'', ''Wang2012'', ''Uchida2016'', or ''Constant''; default = ''UnknownMeasure''. | | ||
| + | ^ use_cost_of_transport | bool | Flag indicating to use (energy / distance) as a result; default = 0. | | ||
| + | ^ specific_tension | Real | Value to use for specific tension; default = 0.25e6. | | ||
| + | ^ muscle_density | Real | Value to use for muscle density; default = 1059.7. | | ||
| + | ^ default_muscle_slow_twitch_ratio | Real | Default slow / twitch ratio if not defined per muscle (used by Uchida2016); default = 0.5. | | ||
| + | ^ use_symmetric_fiber_ratios | bool | Indicate if fiber ratios are the same for left and right (used by Uchida2016); default = true. | | ||
| + | ^ min_distance | Real | Minimum distance used for cost of transport computation; default = 1.0. | | ||
| + | ^ 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. | | ||
| + | ^ 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. | | ||
| + | |||
| + | <sub>Converted from doxygen using [[https://github.com/tgeijten/dokugen|dokugen]]</sub> | ||