pytuflow.FVCRunState

pytuflow.FVCRunState#

class FVCRunState(build_state, context, parent)#

Bases: ControlFileRunState, ModelRunMixin, FVCBase

Parameters:

__init__(build_state, context, parent)#

Parameters:

build_state (BuildState) – The BuildState object that the RunState object is based on.
context (Context) – The context object that the RunState object is based on.
parent (ControlFile) – The parent control file.

Methods

`bc_dbase`	Generates a virtual boundary database file from the BC blocks.
`bc_default_update_dt`	Returns the default BC Update dt interval.
`context`	Returns the ScopeList that makes up the objects Context for the given RunState Object.
`event_database`	Returns the EventDatabase object.
`find_input`	Find a particular input(s) using a search filter.
`fvptm`
`fvsed`
`fvwq`
`include_salinity`	Returns whether salinity is turned on.
`include_sediment`	Returns whether sediment is turned on.
`include_temperature`	Returns whether temperature is turned on.
`input`	Returns the input with the given UUID.
`is_3d`	Returns whether the model is has 3D hydrodynamics enabled.
`mat_file`
`run`	Run the control file in context using the specified TUFLOWFV binary.
`sediment_fraction_count`	Returns the number of sediment groups.
`sediment_fractions`	Returns a unique list of the sediment fraction names.
`tef`
`test`	Run the control file in context using the specified TUFLOWFV binary in test mode.
`tracer_count`	Returns the number of tracers in the model.
`water_quality_model`	Returns the name of the water quality model being used.
`wq_constituent_count`	Returns the number of water quality constituents used in the model.
`wq_constituents`	Returns a unique list of the water quality constituents in the model.

Attributes

`TUFLOW_TYPE`	Return the TUFLOW type of the input.
`fvc`
`root_cf`	Allows overriding by FVC to be the fvc rather than the tcf.
`scope`	List of scopes associated with the object.
`bs`	the BuildState object that the RunState object is based on.
`parent`	the parent control file
`fpath`	the path to the control file
`config`	the configuration settings for the model.
`inputs`	list of inputs and comments in the control file
`loaded`	whether the control file has been loaded from disk or not.
`ctx`	the context object that the RunState object is based on.