bluemath_tk.wrappers.sfincs package

Submodules

bluemath_tk.wrappers.sfincs.sfincs_example module

bluemath_tk.wrappers.sfincs.sfincs_wrapper module

class bluemath_tk.wrappers.sfincs.sfincs_wrapper.SfincsModelWrapper(*args, **kwargs)[source]

Bases: BaseModelWrapper

Wrapper for the SFINCS model.

default_parameters

The default parameters type for the wrapper.

Type:: dict

available_launchers

The available launchers for the wrapper.

Type:: dict

available_launchers = {'cluster': 'launchSfincs.sh', 'docker': 'docker run --rm -v .:/case_dir -w /case_dir deltares/sfincs-cpu'}

build_case(case_context: dict, case_dir: str) → None[source]: Build the base SFINCS model. This includes setting up the grid, depth, friction, mask, outflow and waterlevel mask. It also applies the precipitation and waterlevel forcing if specified.

build_template_case() → None[source]: Build a base SFINCS model case used as a template for multiple simulations. This function sets up all the static components of the model that are common to all cases, such as grid definition, DEM, friction, infiltration, subgrid configuration, and boundary masks.

default_parameters = {}

set_ctimes(case_context: dict) → str[source]: Determine the start time (TSTART) end time (TSTOP) for the simulation based on precipitation and water level forcing, add 1 hour, and return it formatted as ‘YYYYMMDD HHMMSS’.

setup_dem(sf: SfincsModel, case_context: dict) → List[dict][source]: Setup the DEM for the SFINCS model.

setup_friction(sf: SfincsModel, case_context: dict) → List[dict][source]: Setup the friction for the SFINCS model.

setup_infiltration(sf: SfincsModel, case_context: dict) → List[dict][source]: Setup the infiltration for the SFINCS model.

setup_outflow(sf: SfincsModel, case_context: dict) → None[source]: Setup the outflow for the SFINCS model.

setup_waterlevel_mask(sf: SfincsModel, case_context: dict) → None[source]: Setup the waterlevel mask for the SFINCS model.

Module contents