bluemath_tk.wrappers.delft3d package

Submodules

bluemath_tk.wrappers.delft3d.delft3d_wrapper module

class bluemath_tk.wrappers.delft3d.delft3d_wrapper.Delft3dModelWrapper(templates_dir: str, metamodel_parameters: dict, fixed_parameters: dict, output_dir: str, templates_name: dict = 'all', debug: bool = True)[source]

Bases: BaseModelWrapper

Wrapper for the Delft3d model.

default_parameters

The default parameters type for the wrapper.

Type:

dict

available_launchers

The available launchers for the wrapper.

Type:

dict

available_launchers = {'geoocean-cluster': 'launchDelft3d.sh'}
default_parameters = {}
class bluemath_tk.wrappers.delft3d.delft3d_wrapper.GreenSurgeModelWrapper(templates_dir: str, metamodel_parameters: dict, fixed_parameters: dict, output_dir: str, templates_name: dict = 'all', debug: bool = True)[source]

Bases: Delft3dModelWrapper

Wrapper for the Delft3d model for Greensurge.

build_case(case_context: dict, case_dir: str) → None[source]

Build the input files for a case.

Parameters:

  • case_context (dict) – The case context.

  • case_dir (str) – The case directory.

generate_wnd_files_D3DFM_Tri(case_context: dict, case_dir: str, ds_GFD_info: Dataset, wind_magnitude: float, simul_time: int, dir_steps: int)[source]

Generate the wind files for a case.

Parameters:

  • case_context (dict) – The case context.

  • case_dir (str) – The case directory.

  • ds_GFD_info (xr.Dataset) – The dataset with the GFD information.

  • wind_magnitude (float) – The wind magnitude.

  • simul_time (int) – The simulation time.

  • dir_steps (int) – The number of direction steps.

bluemath_tk.wrappers.delft3d.delft3d_wrapper.create_triangle_mask(lon_grid: ndarray, lat_grid: ndarray, triangle: ndarray) → ndarray[source]

Create a mask for a triangle defined by its vertices.

Parameters:

  • lon_grid (np.ndarray) – The longitude grid.

  • lat_grid (np.ndarray) – The latitude grid.

  • triangle (np.ndarray) – The triangle vertices.

Returns:

The mask for the triangle.

Return type:

np.ndarray

bluemath_tk.wrappers.delft3d.delft3d_wrapper.format_matrix(mat)[source]
bluemath_tk.wrappers.delft3d.delft3d_wrapper.format_zeros(mat_shape)[source]

Module contents