Setter Reference: Model Options
Rendered from 12_all_set_functions.ipynb.
Model options
option_general
Kind: Model-level category
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.option_general.allow_ponding(value) | user | bool | One model-level bool value | Writable model-level value |
m.set.option_general.flow_routing(value) | user | enum | One model-level enum value | Writable model-level value |
m.set.option_general.flow_units(value) | user | enum | One model-level enum value | Writable model-level value |
m.set.option_general.force_main_equation(value) | user | enum | One model-level enum value | Writable model-level value |
m.set.option_general.infiltration_model(value) | user | enum | One model-level enum value | Writable model-level value |
m.set.option_general.lateral_flow_tolerance(value) | user | float | One model-level float value | Writable model-level value |
m.set.option_general.link_offsets(value) | user | enum | One model-level enum value | Writable model-level value |
m.set.option_general.minimum_slope(value) | user | float | One model-level float value | Writable model-level value |
m.set.option_general.skip_steady_state(value) | user | bool | One model-level bool value | Writable model-level value |
m.set.option_general.system_flow_tolerance(value) | user | float | One model-level float value | Writable model-level value |
Copy-ready call list:
m.set.option_general.allow_ponding(value)
m.set.option_general.flow_routing(value)
m.set.option_general.flow_units(value)
m.set.option_general.force_main_equation(value)
m.set.option_general.infiltration_model(value)
m.set.option_general.lateral_flow_tolerance(value)
m.set.option_general.link_offsets(value)
m.set.option_general.minimum_slope(value)
m.set.option_general.skip_steady_state(value)
m.set.option_general.system_flow_tolerance(value)option_process
Kind: Model-level category
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.option_process.ignore_groundwater(value) | user | bool | One model-level bool value | Writable model-level value |
m.set.option_process.ignore_quality(value) | user | bool | One model-level bool value | Writable model-level value |
m.set.option_process.ignore_rainfall(value) | user | bool | One model-level bool value | Writable model-level value |
m.set.option_process.ignore_rdii(value) | user | bool | One model-level bool value | Writable model-level value |
m.set.option_process.ignore_routing(value) | user | bool | One model-level bool value | Writable model-level value |
m.set.option_process.ignore_snowmelt(value) | user | bool | One model-level bool value | Writable model-level value |
Copy-ready call list:
m.set.option_process.ignore_groundwater(value)
m.set.option_process.ignore_quality(value)
m.set.option_process.ignore_rainfall(value)
m.set.option_process.ignore_rdii(value)
m.set.option_process.ignore_routing(value)
m.set.option_process.ignore_snowmelt(value)option_date_time
Kind: Model-level category
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.option_date_time.dry_days(value) | user | float | One model-level float value | Writable model-level value |
m.set.option_date_time.dry_step(value) | user | time/duration | One model-level time/duration value | Writable model-level value |
m.set.option_date_time.end_date(value) | user | date | One model-level date value | Writable model-level value |
m.set.option_date_time.end_time(value) | user | time | One model-level time value | Writable model-level value |
m.set.option_date_time.report_start_date(value) | user | date | One model-level date value | Writable model-level value |
m.set.option_date_time.report_start_time(value) | user | time | One model-level time value | Writable model-level value |
m.set.option_date_time.report_step(value) | user | time/duration | One model-level time/duration value | Writable model-level value |
m.set.option_date_time.routing_step(value) | user | time/duration/float | One model-level time/duration/float value | Writable model-level value |
m.set.option_date_time.rule_step(value) | user | time/duration | One model-level time/duration value | Writable model-level value |
m.set.option_date_time.start_date(value) | user | date | One model-level date value | Writable model-level value |
m.set.option_date_time.start_time(value) | user | time | One model-level time value | Writable model-level value |
m.set.option_date_time.sweep_end(value) | user | date/day | One model-level date/day value | Writable model-level value |
m.set.option_date_time.sweep_start(value) | user | date/day | One model-level date/day value | Writable model-level value |
m.set.option_date_time.wet_step(value) | user | time/duration | One model-level time/duration value | Writable model-level value |
Copy-ready call list:
m.set.option_date_time.dry_days(value)
m.set.option_date_time.dry_step(value)
m.set.option_date_time.end_date(value)
m.set.option_date_time.end_time(value)
m.set.option_date_time.report_start_date(value)
m.set.option_date_time.report_start_time(value)
m.set.option_date_time.report_step(value)
m.set.option_date_time.routing_step(value)
m.set.option_date_time.rule_step(value)
m.set.option_date_time.start_date(value)
m.set.option_date_time.start_time(value)
m.set.option_date_time.sweep_end(value)
m.set.option_date_time.sweep_start(value)
m.set.option_date_time.wet_step(value)option_dynamic_wave
Kind: Model-level category
| Setter | Source | Declared type | Value input | Behavior |
|---|---|---|---|---|
m.set.option_dynamic_wave.head_tolerance(value) | user | float | One model-level float value | Writable model-level value |
m.set.option_dynamic_wave.inertial_damping(value) | user | enum | One model-level enum value | Writable model-level value |
m.set.option_dynamic_wave.lengthening_step(value) | user | float | One model-level float value | Writable model-level value |
m.set.option_dynamic_wave.maximum_trials(value) | user | integer | One model-level integer value | Writable model-level value |
m.set.option_dynamic_wave.minimum_step(value) | user | float | One model-level float value | Writable model-level value |
m.set.option_dynamic_wave.minimum_surface_area(value) | user | float | One model-level float value | Writable model-level value |
m.set.option_dynamic_wave.normal_flow_limited(value) | user | enum | One model-level enum value | Writable model-level value |
m.set.option_dynamic_wave.surcharge_method(value) | user | enum | One model-level enum value | Writable model-level value |
m.set.option_dynamic_wave.threads(value) | user | integer | One model-level integer value | Writable model-level value |
m.set.option_dynamic_wave.variable_step(value) | user | float/bool | One model-level float/bool value | Writable model-level value |
Copy-ready call list:
m.set.option_dynamic_wave.head_tolerance(value)
m.set.option_dynamic_wave.inertial_damping(value)
m.set.option_dynamic_wave.lengthening_step(value)
m.set.option_dynamic_wave.maximum_trials(value)
m.set.option_dynamic_wave.minimum_step(value)
m.set.option_dynamic_wave.minimum_surface_area(value)
m.set.option_dynamic_wave.normal_flow_limited(value)
m.set.option_dynamic_wave.surcharge_method(value)
m.set.option_dynamic_wave.threads(value)
m.set.option_dynamic_wave.variable_step(value)