Getter Reference: Model Options
Rendered from 11_all_get_functions.ipynb.
Model options
option_general
Kind: Model-level category
| Getter | Source | Declared type | Declared size | Output note |
|---|---|---|---|---|
m.get.option_general.allow_ponding(format=None) | user | bool | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_general.flow_routing(format=None) | user | enum | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_general.flow_units(format=None) | user | enum | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_general.force_main_equation(format=None) | user | enum | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_general.infiltration_model(format=None) | user | enum | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_general.lateral_flow_tolerance(format=None) | user | float | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_general.link_offsets(format=None) | user | enum | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_general.minimum_slope(format=None) | user | float | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_general.skip_steady_state(format=None) | user | bool | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_general.system_flow_tolerance(format=None) | user | float | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
Copy-ready call list:
m.get.option_general.allow_ponding(format=None)
m.get.option_general.flow_routing(format=None)
m.get.option_general.flow_units(format=None)
m.get.option_general.force_main_equation(format=None)
m.get.option_general.infiltration_model(format=None)
m.get.option_general.lateral_flow_tolerance(format=None)
m.get.option_general.link_offsets(format=None)
m.get.option_general.minimum_slope(format=None)
m.get.option_general.skip_steady_state(format=None)
m.get.option_general.system_flow_tolerance(format=None)option_process
Kind: Model-level category
| Getter | Source | Declared type | Declared size | Output note |
|---|---|---|---|---|
m.get.option_process.ignore_groundwater(format=None) | user | bool | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_process.ignore_quality(format=None) | user | bool | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_process.ignore_rainfall(format=None) | user | bool | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_process.ignore_rdii(format=None) | user | bool | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_process.ignore_routing(format=None) | user | bool | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_process.ignore_snowmelt(format=None) | user | bool | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
Copy-ready call list:
m.get.option_process.ignore_groundwater(format=None)
m.get.option_process.ignore_quality(format=None)
m.get.option_process.ignore_rainfall(format=None)
m.get.option_process.ignore_rdii(format=None)
m.get.option_process.ignore_routing(format=None)
m.get.option_process.ignore_snowmelt(format=None)option_date_time
Kind: Model-level category
| Getter | Source | Declared type | Declared size | Output note |
|---|---|---|---|---|
m.get.option_date_time.dry_days(format=None) | user | float | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_date_time.dry_step(format=None) | user | time/duration | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_date_time.end_date(format=None) | user | date | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_date_time.end_time(format=None) | user | time | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_date_time.report_start_date(format=None) | user | date | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_date_time.report_start_time(format=None) | user | time | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_date_time.report_step(format=None) | user | time/duration | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_date_time.routing_step(format=None) | user | time/duration/float | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_date_time.rule_step(format=None) | user | time/duration | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_date_time.start_date(format=None) | user | date | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_date_time.start_time(format=None) | user | time | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_date_time.sweep_end(format=None) | user | date/day | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_date_time.sweep_start(format=None) | user | date/day | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_date_time.wet_step(format=None) | user | time/duration | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
Copy-ready call list:
m.get.option_date_time.dry_days(format=None)
m.get.option_date_time.dry_step(format=None)
m.get.option_date_time.end_date(format=None)
m.get.option_date_time.end_time(format=None)
m.get.option_date_time.report_start_date(format=None)
m.get.option_date_time.report_start_time(format=None)
m.get.option_date_time.report_step(format=None)
m.get.option_date_time.routing_step(format=None)
m.get.option_date_time.rule_step(format=None)
m.get.option_date_time.start_date(format=None)
m.get.option_date_time.start_time(format=None)
m.get.option_date_time.sweep_end(format=None)
m.get.option_date_time.sweep_start(format=None)
m.get.option_date_time.wet_step(format=None)option_dynamic_wave
Kind: Model-level category
| Getter | Source | Declared type | Declared size | Output note |
|---|---|---|---|---|
m.get.option_dynamic_wave.head_tolerance(format=None) | user | float | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_dynamic_wave.inertial_damping(format=None) | user | enum | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_dynamic_wave.lengthening_step(format=None) | user | float | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_dynamic_wave.maximum_trials(format=None) | user | integer | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_dynamic_wave.minimum_step(format=None) | user | float | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_dynamic_wave.minimum_surface_area(format=None) | user | float | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_dynamic_wave.normal_flow_limited(format=None) | user | enum | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_dynamic_wave.surcharge_method(format=None) | user | enum | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_dynamic_wave.threads(format=None) | user | integer | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
m.get.option_dynamic_wave.variable_step(format=None) | user | float/bool | single | Model-level scalar, sequence, mapping, or table depending on the declared type |
Copy-ready call list:
m.get.option_dynamic_wave.head_tolerance(format=None)
m.get.option_dynamic_wave.inertial_damping(format=None)
m.get.option_dynamic_wave.lengthening_step(format=None)
m.get.option_dynamic_wave.maximum_trials(format=None)
m.get.option_dynamic_wave.minimum_step(format=None)
m.get.option_dynamic_wave.minimum_surface_area(format=None)
m.get.option_dynamic_wave.normal_flow_limited(format=None)
m.get.option_dynamic_wave.surcharge_method(format=None)
m.get.option_dynamic_wave.threads(format=None)
m.get.option_dynamic_wave.variable_step(format=None)