CoastalME (Coastal Modelling Environment)
Simulates the long-term behaviour of complex coastlines
All Data Structures Files Functions Variables Typedefs Friends Pages
File List
Here is a list of all files with brief descriptions:
[detail level 123]
  src
  cshore
 cshore.h
  inc
 cshore.h
 2d_point.cppGeometry class used to represent 2D point objects with floating-point coordinates
 2d_point.hContains CGeom2DPoint definitions
 2d_shape.cppAbstract class, used as a base class for 2D objects (line, area, etc.)
 2d_shape.hContains CA2DShape definitions
 2di_point.cppGeometry class used to represent 2D point objects with integer coordinates
 2di_point.hContains CGeom2DIPoint definitions
 2di_shape.cppAbstract class, used as a base class for integer 2D objects (line, area, etc.)
 2di_shape.hContains CA2DIShape definitions
 assign_landforms.cppAssigns landform categories to coastlines and coastal cells, and to all other dryland cells
 calc_curvature.cppCalculates curvature of 2D vectors
 calc_external_forcing.cppCalculates external forcings
 calc_shadow_zones.cppLocates shadow zones, is part of wave propagation calculations
 calc_waves.cppSimulates wave propagation using CShore or the COVE approach
 cell.cppCGeomCell routines
 cell.hContains CGeomCell definitions
 cell_landform.cppCRWCellLandform routines
 cell_landform.hContains CRWCellLandform definitions
 cell_layer.cppCRWCellLayer routines
 cell_layer.hContains CRWCellLayer definitions
 cell_sediment.cppCRWCellSediment routines
 cell_sediment.hContains CRWCellSediment definitions
 cliff.cppCRWCliff routines
 cliff.hContains CRWCliff definitions
 cme.cppThe start-up routine for CoastalME
 cme.hThis file contains global definitions for CoastalME
 coast.cppCRWCoast routines
 coast.hContains CRWCoast definitions
 coast_landform.cppCACoastLandform routines
 coast_landform.hContains CACoastLandform definitions
 coast_polygon.cppCGeomCoastPolygon routines
 coast_polygon.hContains CGeomCoastPolygon definitions
 create_polygons.cppCreates coast polygons for sediment transport calcs
 create_profiles.cppCreates profiles which are approximately normal to the coastline, these will become inter-polygon boundaries
 do_beach_potential_erosion.cppCalculates potential (i.e. not constrained by the availability of unconsolidated sediment) beach erosion of unconsolidated sediment on coastal polygons
 do_beach_sediment_movement.cppDoes between-polygon actual (supply-limited) redistribution of transported beach sediment
 do_beach_within_polygon.cppDoes within-polygon actual erosion and distribution of transported beach sediment
 do_cliff_collapse.cppCollapses cliffs if a critical notch depth is exceeded. Then distributes both consolidated and unconsolidated sediment from the collapse onto the shore polygons as unconsolidated talus
 do_intervention.cppChecks for new interventions
 do_sediment_input_event.cppDeposits sediment onto the grid
 do_shore_platform_erosion.cppErodes the consolidated sediment of the shore platform. Eroded sediment from the shore platform becomes unconsolidated sediment stored in coastal polygons
 drift.cppCRWDrift routines
 drift.hContains CRWDrift definitions
 gis_raster.cppThese functions use GDAL (at least version 2) to read and write raster GIS files in several formats
 gis_utils.cppVarious GIS-related functions, requires GDAL
 gis_vector.cppThese functions use GDAL to read and write vector GIS files in several formats. This version will build with GDAL version 2 and upwards
 hermite_cubic.cppSome routines from the hermite_cubic library
 hermite_cubic.hDefinitions of some routines from the hermite_cubic library
 i_line.cppCGeomILine routines
 i_line.hContains CGeomILine definitions
 init_grid.cppInitialises the raster grid and calculates sea depth on each cell
 interpolate.cppReturns interpolated value at x from parallel arrays
 interpolate.hDefinitions of routines which return interpolated value at x from parallel arrays
 intervention.cppCRWIntervention routines
 intervention.hContains CRWIntervention definitions
 line.cppCGeomLine routines
 line.hContains CGeomLine definitions
 locate_coast.cppFinds the coastline on the raster grid
 multi_line.cppCGeomMultiLine routines
 multi_line.hContains CGeomMultiLine definitions
 profile.cppCGeomProfile routines
 profile.hContains CGeomProfile definitions
 raster_grid.cppCGeomRasterGrid routines
 raster_grid.hContains CGeomRasterGrid definitions
 read_input.cppReads non-GIS input files
 sediment_input_event.cppCSedInputEvent routines
 sediment_input_event.hContains CSedInputEvent definitions
 simulation.cppThe start-of-simulation routine
 simulation.hContains CSimulation definitions
 smooth_line.cppSmoothing routines for CGeomLine objects
 update_grid.cppUpdates the raster grid
 utils.cppUtility routines
 utils_global.cppGlobally-available utility routines
 write_output.cppWrites non-GIS output files