The HydroflowExport class#

What it does#

The export class is an internal class used by the model. It is not supposed to be exposed to the end-user. Hydroflow extends WatlabExport. It adds two properties and overrides the export() function.

Documentation#

class watlab.hydroflow.HydroflowExport(mesh: Mesh, model: HydroflowModel)#

Exports the input files

Parameters:
  • mesh (mesh) – a mesh object from the hydroflow lib

  • model (model) – a model object

export()#

Export all .txt files in the input folder:

Returns:

self.__NODES_NAME, self.__CELLS_NAME, self.__EDGES_NAME, self.__INITIAL_CONDITIONS_NAME, self.__FRICTION_NAME self.__BOUNDARY_NAME, self.__PICTURE_NAME, self.__DATA_NAME, self.__SEDIMENT_LEVEL_NAME

Return type:

.txt

property fixed_bedrock_level_path#
property friction_file_path#