wolfhece.PyGui

Author: HECE - University of Liege, Pierre Archambeau Date: 2024

Copyright (c) 2024 University of Liege. All rights reserved.

This script and its content are protected by copyright law. Unauthorized copying or distribution of this file, via any medium, is strictly prohibited.

Module Contents

wolfhece.PyGui.GEOM_GROUP_NAME

wolfhece.PyGui.MAGN_GROUP_NAME

class wolfhece.PyGui.GenMapManager(*args, **kw)

Bases: wx.Frame

Default class for a Wolf Map Manager.

Will be overriden by the specific classes MapManager, GPU2DModel, HydrologyModel, Wolf2DModel.

It is not suitable for direct use.

setup_mapviewer(title: str, wolfparent)

Setup of a WolfMapViewer

get_mapviewer() → wolfhece.PyDraw.WolfMapViewer

Retourne une instance WolfMapViewer

get_configuration() → wolfhece.PyConfig.WolfConfiguration

Retourne la configuration de Wolf

class wolfhece.PyGui.MapManager(*args, **kw)

Bases: GenMapManager

Default class for a Wolf Map Manager.

Will be overriden by the specific classes MapManager, GPU2DModel, HydrologyModel, Wolf2DModel.

It is not suitable for direct use.

class wolfhece.PyGui.HydrologyModel(dir: str = '', splash=True, *args, **kw)

Bases: GenMapManager

Default class for a Wolf Map Manager.

Will be overriden by the specific classes MapManager, GPU2DModel, HydrologyModel, Wolf2DModel.

It is not suitable for direct use.

mydir: str

mydircharact: str

mydirwhole: str

files_hydrology_array: dict

files_hydrology_vectors: dict

mainparams: wolfhece.PyParams.Wolf_Param

basinparams: wolfhece.PyParams.Wolf_Param

SPWstations: wolfhece.RatingCurve.SPWMIGaugingStations

DCENNstations: wolfhece.RatingCurve.SPWDCENNGaugingStations

mycatchment: wolfhece.hydrology.Catchment.Catchment

myexchanges: wolfhece.hydrology.forcedexchanges.forced_exchanges

class wolfhece.PyGui.Wolf2DPartArrays(sim: wolfhece.mesh2d.wolf2dprev.prev_sim2D, mapviewer: wolfhece.PyDraw.WolfMapViewer)

setup_gui()

Create the GUI

A listbox in the upper part of the window will list the different part arrays.

When a part array is selected, the listbox on the left will list the files associated with the selected part array. The listbox on the right will list the blocks associated with the selected file.

on_toviewer(event)

Add the selected array to the mapviewer

on_list(event)

When a part array is selected

on_list_files(event)

When a file is selected

on_list_blocks(event)

on_addfile(event)

Add a file to the selected part array

on_delfile(event)

Delete the selected file

on_apply(event)

Show()

class wolfhece.PyGui.Wolf2DInfiltration(sim: wolfhece.mesh2d.wolf2dprev.prev_sim2D = None)

property number_of_infiltration

setup_gui()

on_apply(event)

_fillgrid()

Fill the CpGrid

on_adjust(event)

Adjust the number of rows and columns of the CpGrid

on_plus(event)

Add a zone or steps

on_minus(event)

Remove a zone or steps

on_check(event)

on_reload(event)

on_plot(event)

Show()

class wolfhece.PyGui.Wolf2DModel(*args, dir: str = '', **kw)

Bases: GenMapManager

Default class for a Wolf Map Manager.

Will be overriden by the specific classes MapManager, GPU2DModel, HydrologyModel, Wolf2DModel.

It is not suitable for direct use.

property mymnap

property xyzones

property mysuxsuy

property blocfile

property writing_mode

property writing_frequency

property dx_fine

property dy_fine

property scheme_rk

property is_multiblock

Deprecated, use the property from the infiltration object

property nb_blocks

Deprecated, use the property from the infiltration object

mydir: str

sim: wolfhece.mesh2d.wolf2dprev.prev_sim2D

filenamegen: str

SPWstations: wolfhece.RatingCurve.SPWMIGaugingStations

DCENNstations: wolfhece.RatingCurve.SPWDCENNGaugingStations

_dx_block(idx)

_dy_block(idx)

_add_arrays_to_mapviewer(force_reload=False)

Add arrays to the mapviewer

_add_vectors_to_mapviewer()

Add vectors to the mapviewer

mimic_mask(source: wolfhece.wolf_array.WolfArray)

Copy the mask of the source array to all arrays in the model.

show_properties()

Show the properties of the model

_set_bc(e: wx.EVT_BUTTON)

Set the boundary conditions

_set_infiltration(e: wx.EVT_BUTTON)

_set_part_arrays(e: wx.EVT_BUTTON)

add_boundary_condition(i: int, j: int, bc_type: wolfhece.mesh2d.cst_2D_boundary_conditions.BCType_2D, bc_value: float, border: wolfhece.mesh2d.cst_2D_boundary_conditions.Direction)

alias

reset_boundary_conditions()

Reset the boundary conditions

_check_errors(e: wx.EVT_BUTTON)

Check the errors in the model

_write_files(e: wx.EVT_BUTTON)

Write the files to disk

_run(e: wx.EVT_BUTTON)

Run the simulation

_results(e: wx.EVT_BUTTON)

Display the results

_results2ic(e: wx.EVT_BUTTON)

Choose one result as initial conditions

_copy2gpu(e: wx.EVT_BUTTON)

Click on the button to copy to the GPU

_wizard(e: wx.EVT_BUTTON)

Launch the wizard

_mesher(e: wx.EVT_BUTTON)

Call the mesher

_create_arrays(e: wx.EVT_BUTTON)

Create the fine arrays

_add_blocks(e: wx.EVT_BUTTON)

Add blocks to the model

_create_from_vector(e: wx.EVT_BUTTON)

Create a simulation from a vector

_create_from_array(e: wx.EVT_BUTTON)

Create a simulation from an array

_create_from_footprint(e: wx.EVT_BUTTON)

Create a simulation from a footprint

_set_magnetic_grid(e: wx.EVT_BUTTON)

Set the magnetic grid

_choose_fine_resolution(e: wx.EVT_BUTTON)

Choose the fine resolution

_add_block(e: wx.EVT_BUTTON)

Add a block to the model

_remove_block(e: wx.EVT_BUTTON)

Remove a block from the model

_update_structure(e: wx.EVT_BUTTON)

Update the structure of the model

_all_parameters(e: wx.EVT_CHECKBOX)

Show all parameters

_force_update(e: wx.EVT_CHECKBOX)

Force the update

_update_layout()

Update the layout of the frame

_fill_buttons_genblocks()

Fill the buttons for the blocks

_get_togglestates()

Get the toggle states of the buttons

_show_glob_properties()

Show the general properties

_set_default_background()

Set the default background

_set_color_background()

Set the color background

OnToggleGen(e: wx.EVT_TOGGLEBUTTON)

Toggle the global properties

OnToggleBlock(e: wx.EVT_TOGGLEBUTTON)

Toggle the properties of a block

_append_magnetic_grid_to_prop()

Append the magnetic grid to the properties

_append_geometry_block_to_prop(idx: int)

Append the geometry of the block to the properties

_apply_changes(e: wx.EVT_BUTTON)

Apply the changes to the parameters

extend_bed_elevation()

Extension du modèle topographique

extend_freesurface_elevation(selection: list)

Extension des Conditions Initiales

extend_roughness(selection: list)

Extension du frottement

set_type_ic(which: wolfhece.mesh2d.wolf2dprev.Literal[1, 2, 3] = 2, dialog: bool = True)

Définition du type de conditions initiales

replace_external_contour(newvec: wolfhece.mesh2d.wolf2dprev.vector, interior: bool)

Remplacement du contour externe

transfer_ic(vector)

Transfert de conditions initiales

help_files()

Aide sur les fichiers

Deprecated, use the method from the infiltration object

check_infiltration()

Vérification des zones d’infiltration

Deprecated, use the method from the infiltration object

copy2gpu(dirout: str = '')

Copie des matrices pour le code GPU

Deprecated, use the method from the simulation object

write_bloc_file()

Mise à jour du fichier de blocs

get_header_MB(abs=False)

Renvoi d’un header avec les infos multi-blocs

Parameters:

abs (bool) – If True, the header will be absolute, if False, it will be relative

Returns:

header_wolf

get_header(abs=False)

Renvoi d’un header de matrice “fine” non MB

Parameters:

abs (bool) – If True, the header will be absolute, if False, it will be relative

Returns:

header_wolf

read_fine_array(which: str = '')

Lecture d’une matrice fine

Parameters:

which (str) – suffixe du fichier

read_MB_array(which: str = '')

Lecture d’une matrice MB

Parameters:

which (str) – suffixe du fichier

read_fine_nap() → wolfhece.mesh2d.wolf2dprev.np.ndarray

Lecture de la matrice nap sur le maillage fin

class wolfhece.PyGui.Wolf2DGPUModel(*args, dir: str = '', **kw)

Bases: GenMapManager

Default class for a Wolf Map Manager.

Will be overriden by the specific classes MapManager, GPU2DModel, HydrologyModel, Wolf2DModel.

It is not suitable for direct use.

property sim

Alias

_add_arrays_to_mapviewer(force_reload: bool = False)

Add the arrays to the mapviewer

_add_vectors_to_mapviewer()

Add the vectors to the mapviewer

show_properties_sim()

Show the properties of the model

_callbackwp()

Callback for wolfparam

_callbackwp_destroy()

Callback for wolfparam

_set_bc(e: wx.EVT_BUTTON)

Set the boundary conditions

_set_infiltration(e: wx.EVT_BUTTON)

add_boundary_condition(i: int, j: int, bc_type: wolfhece.mesh2d.cst_2D_boundary_conditions.BCType_2D_GPU, bc_value: float, border: wolfhece.mesh2d.cst_2D_boundary_conditions.Direction)

alias

reset_boundary_conditions()

Reset the boundary conditions

_check_errors(e: wx.EVT_BUTTON)

Check the errors in the model

_enable_disable_buttons(errors: bool = False)

Enable or isable buttons

_write_files(e: wx.EVT_BUTTON)

Write the files to disk

_run(e: wx.EVT_BUTTON)

Run the simulation

_results(e: wx.EVT_BUTTON)

Display the results

_results2ic(e: wx.EVT_BUTTON)

Choose one result as initial conditions

_wizard(e: wx.EVT_BUTTON)

Launch the wizard

_add_arrays2viewer(e: wx.EVT_BUTTON)

Create the fine arrays

_apply_mask(e: wx.EVT_BUTTON)

Apply the mask

_create_from_vector(e: wx.EVT_BUTTON)

Create a simulation from a vector

_create_from_array(e: wx.EVT_BUTTON)

Create a simulation from an array

_create_from_footprint(e: wx.EVT_BUTTON)

Create a simulation from a footprint

_set_magnetic_grid(e: wx.EVT_BUTTON)

Set the magnetic grid

_choose_resolution(e: wx.EVT_BUTTON)

Choose the fine resolution

_copy2dir(e: wx.EVT_BUTTON)

Copy the simulation to another directory

_apply_changes(e: wx.EVT_BUTTON)

Apply the changes

show_properties()

Show the properties of the model

onclose(e: wx.EVT_CLOSE)

Close the properties frame

_append_magnetic_grid_to_prop()

Append the magnetic grid to the properties

update_wp()

Update the properties

clear_infos()

Clear the information zone

append_infos(text)

Append text to the information zone