Flood Adapt v2.0.3
FloodAdapt
Class that contains the main functionality of FloodAdapt.
| FloodAdapt |
Setup and configuration
Configuration settings for FloodAdapt.
| Settings | The configuration settings for the FloodAdapt database and integrator. |
| Site | The expected variables and data types of attributes of the Site class. |
GUI
Configuration settings for visualizations and the GUI
| GuiModel | The accepted input for the variable gui in Site. |
| GuiUnitModel | The unit system used in the GUI. |
| OutputLayers | The configuration of the mapbox layers in the gui. |
| VisualizationLayer | The configuration of a layer to visualize in the gui. |
| VisualizationLayers | The configuration of the layers you might want to visualize in the gui. |
| PlottingModel | The configuration of the plotting in the gui. |
| StandardObjectModel | The accepted input for the variable standard_object in Site. |
| FloodMapLayer | |
| AggregationDmgLayer | |
| FootprintsDmgLayer | |
| BenefitsLayer | |
| SyntheticTideModel | Configuration for the synthetic tide. |
Hazard
Configuration settings for hazard models
| Cstype | The accepted input for the variable cstype in Site. |
| CycloneTrackDatabaseModel | The accepted input for the variable cyclone_track_database in Site. |
| DatumModel | The accepted input for the variable datums in WaterlevelReferenceModel. |
| DemModel | The accepted input for the variable dem in Site. |
| FloodFrequencyModel | The accepted input for the variable flood_frequency in Site. |
| FloodModel | The accepted input for the variable overland_model and offshore_model in Site. |
| ObsPointModel | The accepted input for the variable obs_point in Site. |
| RiverModel | Model that describes the accepted input for the variable river in Site. |
| SCSModel | Class describing the accepted input for the variable scs. |
| Scstype | |
| SlrScenariosModel | The accepted input for the variable slr_scenarios. |
| WaterlevelReferenceModel | The accepted input for the variable water_level in Site. |
Sfincs
Configuration settings for Sfincs models
| SfincsConfigModel | The expected variables and data types of attributes of the SfincsConfig class. |
| SfincsModel | The expected variables and data types of attributes of the Sfincs class. |
Impacts
Configuration settings for impact models
| AggregationModel | The accepted input for the variable aggregation in Site. |
| BenefitsModel | The accepted input for the variable benefits in Site. |
| EquityModel | The accepted input for the variable equity in Site. |
| FloodmapType | The accepted input for the variable floodmap in Site. |
| NoFootprintsModel | The configuration on the how to show objects with no footprints. |
| RiskModel | The accepted input for the variable risk in Site. |
Fiat
Configuration settings for Fiat models
| FiatConfigModel | Configuration settings for the FIAT model. |
| FiatModel | The expected variables and data types of attributes of the Fiat class. |
Object models
Object models in FloodAdapt are the components that are saved in the database. They define the configuration, input and output of the model kernels. The database stores Objects, and returns Objects when queried.
| Object | Base class for FloodAdapt objects. |
Measures
Various flood protection and mitigation measures available that can interact with the models. Can be impact measures or a hazard measures, where impact measures do not affect the hazard model at all, and hazard measures do.
| Measure | The expected variables and data types of attributes common to all measures. |
| MeasureType | Class describing the accepted input for the variable ‘type’ in Measure. |
| SelectionType | Class describing the accepted input for the variable ‘selection_type’ in Measures. |
| FloodWall | The expected variables and data types of the “floodwall” hazard measure. |
| GreenInfrastructure | The expected variables and data types of the “green infrastructure” hazard measure. |
| Pump | The expected variables and data types of the “pump” hazard measure. |
| Buyout | The expected variables and data types of the “buyout” impact measure. |
| Elevate | The expected variables and data types of the “elevate” impact measure. |
| FloodProof | The expected variables and data types of the “floodproof” impact measure. |
Strategies
A collection of measures that can be used to define a strategy for flood risk management.
| Strategy | Class representing a strategy in FloodAdapt. |
Events
Event types including historical, synthetic, and hurricane events.
| Event | The accepted input for an event in FloodAdapt. |
| SyntheticEvent | BaseModel describing the expected variables and data types for parameters of Synthetic that extend the parent class Event. |
| HistoricalEvent | BaseModel describing the expected variables and data types for parameters of HistoricalEvent that extend the parent class Event. |
| HurricaneEvent | BaseModel describing the expected variables and data types for parameters of HurricaneEvent that extend the parent class Event. |
| EventSet | BaseModel describing the expected variables and data types for parameters of EventSet. |
| TimeFrame | Class representing a time frame for a simulation. |
| IForcing | BaseModel describing the expected variables and data types for forcing parameters of hazard model. |
| ForcingType | Enum class for the different types of forcing parameters. |
| Template | Class describing the accepted input for the variable template in Event. |
| Mode | Class describing the accepted input for the variable mode in Event. |
| SubEventModel | The accepted input for a sub event in FloodAdapt. |
Projections
Climate and socio-economic projections for future scenario analysis.
| Projection | The accepted input for a projection in FloodAdapt. |
| PhysicalProjection | The accepted input for a physical projection in FloodAdapt. |
| SocioEconomicChange | The accepted input for socio-economic change in FloodAdapt. |
Scenarios
Scenario modeling for assessing different flood risk management approaches. Scenarios consist of a combination of event, projection, and strategy.
| Scenario | BaseModel describing the expected variables and data types of a scenario. |
Benefits
Benefit calculation for different flood risk management strategies. Benefits can be used to perform cost benefit analysis on a strategy, which is calculated based on the impact of the event on the population and infrastructure.
| Benefit | BaseModel describing the expected variables and data types of a Benefit analysis object. |
| CurrentSituationModel | The accepted input for a current situation in FloodAdapt. |
Unit system
Unit system for FloodAdapt. The unit system is used to convert between different units of measurement, and to define the units of the input and output of the models.
| ValueUnitPair | Represents a value with associated units. |
| UnitfulLength | Combination of length and unit. |
| UnitfulHeight | Combination of height and unit. |
| UnitfulArea | Combination of area and unit. |
| UnitfulVelocity | Combination of velocity and unit. |
| UnitfulDirection | Combination of direction and unit. |
| UnitfulDischarge | Combination of discharge and unit. |
| UnitfulIntensity | Combination of intensity and unit. |
| UnitfulVolume | Combination of volume and unit. |
| UnitfulTime | Combination of time and unit. |
| UnitfulLengthRefValue | Combination of length and unit with a reference value. |
| UnitTypesLength | Units of length. |
| UnitTypesArea | Units of area. |
| UnitTypesVolume | Units of volume. |
| UnitTypesVelocity | Units of velocity. |
| UnitTypesDirection | Units of direction. |
| UnitTypesTime | Units of time. |
| UnitTypesDischarge | Units of discharge. |
| UnitTypesIntensity | Units of intensity. |
| VerticalReference | Vertical reference for height. |
Database Builder
Database builder for FloodAdapt. The database builder is used to create the database schema and to populate the database with data.
| create_database | Create a new database from a configuration file or ConfigModel. |
| ConfigModel | Main configuration model for FloodAdapt database builder. |
| UnitSystems | Enumeration for supported unit systems. |
| GuiConfigModel | Configuration for FloodAdapt GUI visualization scaling. |
| SpatialJoinModel | Model for representing a spatial join between geometries and tabular data. |
| FootprintsOptions | Enumeration for building footprints data sources. |
| SviConfigModel | Model for Social Vulnerability Index (SVI) spatial join. |
| Basins | Enumeration of global cyclone basins. |
| TideGaugeConfigModel | Model for tide gauge configuration. |
| TideGaugeSource | The accepted input for the variable source in tide_gauge. |
Metrics configuration
Settings for metrics and infographics in FloodAdapt.
| MetricModel | Represents a metric configuration for infometric analysis. |
| BuildingsInfographicModel | Model for building infographic configuration. |
| EventInfographicModel | Model for event-based infographic configuration. |
| HomesInfographicModel | Model for Homes and SVI (Social Vulnerability Index) infographic configuration. |
| RiskInfographicModel | Model for risk-based infographic configuration. |
| RoadsInfographicModel | Model for roads infographic configuration. |
| ImpactCategoriesModel | Model for defining impact categories with associated colors, field, unit, and bins. |
| FloodExceedanceModel | Model for flood exceedance probability configuration. |
| TypeMapping | Container for multiple field mappings that define object type filtering. |
| FieldMapping | Represents a mapping of a database field to a list of allowed values. |
| SviModel | Model for Social Vulnerability Index (SVI) configuration. |