FloodModel

config.FloodModel()

The accepted input for the variable overland_model and offshore_model in Site.

Attributes

name : str

The name of the directory in static/templates/<directory> that contains the template model files.

reference : str

The name of the vertical reference model that is used as the reference datum. Should be defined in water_level.datums.

vertical_offset : Optional[us.UnitfulLength], default = None

The vertical offset of the vertical reference model relative to the main reference. Given that the height of the vertical reference model is often determined by external sources, this vertical offset can be used to correct systematic over-/underestimation of a vertical reference model.

Back to top