The WatlabExport class#
What it does#
The export class should in general not be used. Most of the functions are private and they simply intend to export in an appropriate way the data describing the mesh and the physical model you want to solve. It still is possible to modify the input and output folders name by accessing this class properties.
Documentation#
- class watlab.watlab.WatlabExport(mesh: Mesh, model: WatlabModel)#
The WatlabExport class is the basic export class.
It allows the user to export the nodes, cells, output times etc,..
More specific quantities such as boundary conditions, initial conditions, data file should be written in specific solver file.
- Parameters:
mesh (mesh) – a mesh object from the hydroflow lib
model (model) – a model object
- property cells_file_path#
- property data_file_path#
- property discharge_measurement_section_file_path#
- property edges_file_path#
- property gauge_file_path#
- property initial_conditions_file_path#
- property input_folder_name#
The name of the input folder
- Getter:
Returns the name of the input folder
- Setter:
Sets the name of the input folder
- Type:
string
- property input_folder_path#
The path of the input folder
- Getter:
Returns the path of the input folder
- Type:
string
- property meshchecker_export_file_path#
- property nodes_file_path#
- property output_folder_name#
The name of the output folder
- Getter:
Returns the name of the output folder
- Setter:
Sets the name of the output folder
- Type:
string
- property output_folder_path#
The path of the output folder
- Getter:
Returns the path of the output folder
- Type:
string
- property pictures_file_path#