pytuflow.FVWQ

class FVWQ(*args, **kwargs)

Bases: ControlFileLoadMixin, FVControlFileBuildState, FVWQMixin

Initialises the FV Water Quality Control File class in a build state.

If the class is initialised with the fpath parameter set to None, an empty class will be initialised.

Parameters:

• fpath (PathLike, optional) – The path to the control file (str or Path). If set to None, the FVWQ will be initialised as an empty control file.

• **kwargs (optional parameters) –

  • configFVCConfig, optional

    This object stores useful information such as variable mappings, the event database, current spatial database etc. If set to None, a new FVCConfig object will be created.

  • parentControlFile, optional

    Will set the parent of the control file to another control file e.g. for a TGC, the parent should be set to the FVC.

  • scopeScopeList, optional

    A list of scope objects that will be inherited by the control file itself. Not currently used but reserved in case this is useful information in the future.

  • log_levelstr, optional

    The logging level to use for the control file. Options are ‘DEBUG’, ‘INFO’, ‘WARNING’, ‘ERROR’, ‘CRITICAL’. Default is ‘WARNING’.

  • log_to_filePathLike, optional

    If set, will log the control file to the given file path. Default is None.

__init__(*args, **kwargs)

Methods

append_input	Appends a new input to the end of the control file.
comment_out	Comments out a given input.
context	Create a RunState version of this object.
find_input	Find a particular input(s) using a search filter.
input	Returns the input with the given UUID.
insert_input	Inserts an input before, or after, another reference input.
organic_matter_model	Returns the organics matter model.
pathogens	Returns the pathogens as (name, model) pairs.
phosphorus_model	Returns the phosphorus model.
phytos	Returns the phytoplankten as (name, model) pairs.
preview	Preview the control file in stdout.
remove_input	Removes the input from the control file.
reset	Resets all recorded changes made to the control file since the last call to write().
simulation_class	Returns the simulation class being used.
uncomment	Uncomment a given input.
undo	Undo the last recorded change.
wq_constituents	Returns a list of water quality constiutents present in the model.
write	Write the object to file.

Attributes

TUFLOW_TYPE	A string identifying the PyTUFLOW object type.
dirty	Whether the object has been changed since it was last written to file.
fpath	The path to the control file.
fvc
root_cf	Allows overriding by FVC to be the fvc rather than the tcf.
scope	List of scopes associated with the object.
parser	The parser iterable that is used to load the control file.
config	The configuration settings for the model.
inputs	The list of inputs and comments in the control file
parent	The parent control file
altered_inputs	The list of all changes made to the control file since the last time write() was called.
loaded	Whether the control file has been loaded from disk or not.