Simulation

This section provides detailed documentation for DYCOVE simulation-related classes.

Base Simulation Module

HydroSimulationBase(engine)	Base class for running hydrodynamic simulations.
HydroEngineBase()	Abstract interface for hydrodynamic engines.

Hydrodynamic Model Engines

ANUGA Hydrodynamic Engine

ANUGA(anuga_domain[, vegetation])	Hydrodynamic simulation wrapper for the ANUGA model.
AnugaEngine(anuga_domain[, vegetation])	Engine interface for ANUGA hydrodynamic model.

Delft3D-FM Hydrodynamic Engine

DFM(dfm_path, config_path, mdu_path[, ...])	Hydrodynamic simulation wrapper for the Delft3D FM model.
DFMEngine(dfm_path, config_path, mdu_path[, ...])	Engine interface for DFM hydro-morphodynamic model.

Baptist Operator (ANUGA)

Baptist_operator(domain[, veg_diameter, ...])

Applies vegetation-induced flow drag based on the Baptist formulation.

Simulation Helper Classes

Model Coupling

VegetationCoupler(engine)

Class to handle coupling between hydrodynamic model and vegetation model.

Output Management

OutputManager(engine[, save_freq, save_mort])

For saving VegCohort instances to output files.

Simulation Data

SimulationTimeState(eco_year, ets, sim_time, ...)	Tracks and manages simulation time state variables.
HydrodynamicStats(n_hydro_substeps, n_cells)	Stores hydrodynamic model outputs used to compute vegetation responses.

Vegetation Modules

Species Classes

VegetationSpecies(input_veg_filename[, ...])	A single vegetation species.
MultipleVegetationSpecies(species_list)	A class for handling multiple vegetation species.
SharedVegMethods()

Species Data

VegetationAttributes(age_max, nls, ...)	Container for vegetation trait parameters and life-cycle settings.
VegCohort(name, fraction, density, diameter, ...)	Represents a vegetation cohort (single colonization event) tracked through time.