This class runs CoastalME simulations. More...

#include <simulation.h>

Public Member Functions
	CSimulation (void)
	The CSimulation constructor.

	~CSimulation (void)
	The CSimulation destructor.

int	nGetCoastPolygonSize (void) const
	Returns the size of the coast polygon vector.

CGeomCoastPolygon *	pGetPolygon (int const) const
	Returns a pointer to a coast polygon, in down-coast sequence.

void	AppendPolygon (CGeomCoastPolygon *)
	Appends a pointer to a coast polygon to the coast polygon vector.

double	dGetMissingValue (void) const
	Returns the NODATA value.

double	dGetThisIterSWL (void) const
	Returns this timestep's still water level.

double	dGetThisIterTotWaterLevel (void) const
	Returns this timestep's total water level.

int	nGetGridXMax (void) const
	Returns the cell size.

int	nGetGridYMax (void) const
	Returns the size of the grid in the Y direction.

double	dGetD50Fine (void) const
	Returns the global d50 value for fine sediment.

double	dGetD50Sand (void) const
	Returns the global d50 value for sand sediment.

double	dGetD50Coarse (void) const
	Returns the global d50 value for coarse sediment.

int	nDoSimulation (int, char const *[])
	Runs the simulation.

void	DoSimulationEnd (int const)
	Carries out end-of-simulation tidying (error messages etc.)

Data Fields
ofstream	LogStream

Private Member Functions
int	nHandleCommandLineParams (int, char const *[])
	Handles command-line parameters.

bool	bReadIniFile (void)
	The bReadIniFile member function reads the initialization file.

bool	bReadRunDataFile (void)
	Reads the run details input file and does some initialization.

bool	bOpenLogFile (void)
	Opens the log file.

bool	bSetUpTSFiles (void)
	The bSetUpTSFiles member function sets up the time series files.

void	WriteStartRunDetails (void)
	Writes beginning-of-run information to Out and Log files.

bool	bWritePerTimestepResults (void)
	Write the results for this timestep to the .out file.

bool	bWritePerTimestepResultsFixedWidth (void)
	Write the results for this timestep to the .out file in fixed-width format.

bool	bWritePerTimestepResultsCSV (void)
	Write the results for this timestep to the .out file in CSV format.

bool	bWriteTSFiles (void)
	Write the results for this timestep to the time series CSV files.

int	nWriteEndRunDetails (void)
	Writes end-of-run information to Out, Log and time-series files.

int	nReadShapeFunctionFile (void)
	Reads the shape of the erosion potential distribution (see shape function in Walkden & Hall, 2005)

int	nReadWaveStationInputFile (int const)
	Reads the deep water wave station input data. Each point in m_strDeepWaterWavesInputFile is a triad of wave height, orientation and period for each time step.

int	nReadSedimentInputEventFile (void)
	Reads the sediment input event file.

int	nReadTideDataFile (void)
	Reads the tide time series data.

int	nSaveProfile (int const, CGeomProfile const , int const, vector< double > const , vector< double > const , vector< double > const , vector< double > const , vector< double > const , vector< double > const , vector< double > const , vector< CGeom2DIPoint > const, vector< double > const ) const
	Save a coastline-normal profile.

bool	bWriteProfileData (int const, CGeomProfile const , int const, vector< double > const , vector< double > const , vector< double > const , vector< double > const , vector< double > const , vector< double > const , vector< double > const , vector< CGeom2DIPoint > const, vector< double > const ) const
	Writes values for a single profile, for checking purposes.

int	nSaveParProfile (int const, CGeomProfile const , int const, int const, int const, vector< double > const , vector< double > const , vector< double > const , vector< double > const , vector< double > const , vector< double > const , vector< double > const , vector< CGeom2DIPoint > const, vector< double > const ) const
	Save a coastline-normal parallel profile.

bool	bWriteParProfileData (int const, int const, int const, int const, int const, vector< double > const , vector< double > const , vector< double > const , vector< double > const , vector< double > const , vector< double > const , vector< double > const , vector< CGeom2DIPoint > const, vector< double > const *) const
	Writes values for a single parallel profile, for checking purposes.

void	WriteLookUpData (void)
	Output the erosion potential look-up values, for checking purposes.

void	InitializeGDALPerformance (void)
	Initialize GDAL with performance optimizations.

int	nReadRasterBasementDEM (void)
	Reads a raster DEM of basement elevation data to the Cell array.

int	nReadRasterGISFile (int const, int const)
	Reads all other raster GIS datafiles into the RasterGrid array.

int	nReadVectorGISFile (int const)
	Reads vector GIS datafiles using OGR.

bool	bWriteRasterGISFile (int const, string const *, int const =0, double const =0)
	Writes GIS raster files using GDAL, using data from the RasterGrid array.

bool	bWriteVectorGISFile (int const, string const *)
	Writes vector GIS files using OGR.

void	GetRasterOutputMinMax (int const, double &, double &, int const, double const)
	Finds the max and min values in order to scale raster output if we cannot write doubles.

void	SetRasterFileCreationDefaults (void)
	Sets per-driver defaults for raster files created using GDAL.

int	nInterpolateWavesToPolygonCells (vector< double > const , vector< double > const , vector< double > const , vector< double > const )
	Interpolates wave properties from all profiles to all within-polygon sea cells, using GDALGridCreate(), the library version of external utility gdal_grid.

bool	bCreateErosionPotentialLookUp (vector< double > , vector< double > , vector< double > *)
	Creates a look-up table for erosion potential, given depth over DB.

int	nCheckForSedimentInputEvent (void)
	Check to see if we have any sediment input events this timestep, if so then do the event(s)

int	nCalcExternalForcing (void)
	Calculate external forcings: change in still water level, tide level and deep water waves height, orientation and period.

int	nInitGridAndCalcStillWaterLevel (void)
	At the beginning of each timestep: clear vector coasts, profiles, and polygons, initialize the raster grid, and initialize some per-timestep accounting variables.

int	nLocateSeaAndCoasts (int &)
	First find all connected sea areas, then locate the vector coastline(s), then put these onto the raster grid.

int	nLocateFloodAndCoasts (void)
	First find all connected sea areas, then locate the vector coastline(s), then put these onto the raster grid.

int	nAssignLandformsForAllCoasts (void)
	Each timestep, classify coastal landforms and assign a coastal landform object to every point on every coastline. If, for a given cell, the coastal landform class has not changed then it inherits values from the previous timestep.

int	nAssignLandformsForAllCells (void)
	Each timestep, classify landforms for cells that are not on the coastline.

int	nDoAllPropagateWaves (void)
	Simulates wave propagation along all coastline-normal profiles, on all coasts.

int	nDoAllShorePlatFormErosion (void)
	Does platform erosion on all coastlines by first calculating platform erosion on coastline-normal profiles, then extrapolating this to cells between the profiles.

int	nDoAllWaveEnergyToCoastLandforms (void)
	Update accumulated wave energy in coastal landform objects.

int	nDoCliffCollapse (int const, CRWCliff *, double &, double &, double &, double &, double &)
	Simulates cliff collapse on a single cliff object, which happens when when a notch (incised into a condsolidated sediment layer) exceeds a critical depth. This updates the cliff object, the cell 'under' the cliff object, and the polygon which contains the cliff object.

int	nDoCliffCollapseDeposition (int const, CRWCliff const *, double const, double const, double const, double const)
	Redistributes the sand-sized and coarse-sized sediment from a cliff collapse onto the foreshore, as unconsolidated talus. The talus is added to the existing beach volume (i.e. to the unconsolidated sediment). The shoreline is iteratively advanced seaward until all this volume is accommodated under a Dean equilibrium profile. This equilibrium beach profile is h(y) = A * y^(2/3) where h(y) is the water depth at a distance y from the shoreline and A is a sediment-dependent scale parameter.

int	nUpdateGrid (void)
	Update all cells in the raster raster grid and do some per-timestep accounting.

void	FindAllSeaCells (void)
	Finds and flags all sea areas which have at least one cell at a grid edge (i.e. does not flag 'inland' seas)

int	FindAllInundatedCells (void)
	Finds and flags all sea areas which have at least one cell at a grid edge (i.e. does not flag 'inland' seas)

void	CellByCellFillSea (int const, int const)
	Cell-by-cell fills all sea cells starting from a given cell. The cell-by-cell fill (aka 'floodfill') code used here is adapted from an example by Lode Vandevenne (http://lodev.org/cgtutor/floodfill.html#Scanline_Floodfill_Algorithm_With_Stack)

void	FloodFillLand (int const, int const)
	Use the sealevel, wave set-up and run-up to evaluate flood hydraulically connected TODO 007 Not clear why we need this. We already have a cell-by-cell fill sea routine: every cell that isn't sea is land.

int	nTraceCoastLine (unsigned int const, int const, int const, vector< bool > , vector< CGeom2DIPoint > const )
	Traces a coastline (which is defined to be just above still water level) on the grid using the 'wall follower' rule for maze traversal (http://en.wikipedia.org/wiki/Maze_solving_algorithm#Wall_follower). The vector coastlines are then smoothed.

int	nTraceAllCoasts (int &)
	Locates all the potential coastline start/finish points on the edges of the raster grid, then traces vector coastline(s) from these start points.

int	nTraceFloodCoastLine (unsigned int const, int const, int const, vector< bool > , vector< CGeom2DIPoint > const )
	Traces a coastline (which is defined to be just above still water level) on the grid using the 'wall follower' rule for maze traversal (http://en.wikipedia.org/wiki/Maze_solving_algorithm#Wall_follower). The vector coastlines are then smoothed.

int	nTraceAllFloodCoasts (void)
	Locates all the potential coastline start points on the edges of the raster grid, then traces vector coastline(s) from these start points.

void	DoCoastCurvature (int const, int const)
	Calculates both detailed and smoothed curvature for every point on a coastline.

int	nCheckAllProfiles (void)
	Check all coastline-normal profiles and modify the profiles if they intersect, then mark valid profiles on the raster grid.

int	nCreateAllProfiles (void)
	Create coastline-normal profiles for all coastlines. The first profiles are created 'around' the most concave bits of coast. Also create 'special' profiles at the start and end of the coast, and put these onto the raster grid.

void	LocateAndCreateProfiles (int const, int &, int &, vector< bool > , vector< pair< int, double > > const )
	For a single coastline, locate the start points for all coastline-normal profiles (except the grid-edge profiles). Then create the profiles.

int	nCreateProfile (int const, int const, int const, int const, int &, bool const, CGeom2DIPoint const *)
	Creates a single coastline-normal profile (which may be an intervention profile)

int	nLocateAndCreateGridEdgeProfile (bool const, int const, int &, int &)
	Creates a 'special' profile at each end of a coastline, at the edge of the raster grid. This profile is not necessarily normal to the coastline since it goes along the grid's edge.

void	MarkProfilesOnGrid (int const, int &)
	For this coastline, marks all coastline-normal profiles (apart from the two 'special' ones at the start and end of the coast) onto the raster grid, i.e. rasterizes multi-line vector objects onto the raster grid. Note that this doesn't work if the vector has already been interpolated to fit on the grid i.e. if distances between vector points are just one cell apart.

void	CheckForIntersectingProfiles (void)
	Checks all coastline-normal profiles for intersection, and modifies those that intersect.

void	MergeProfilesAtFinalLineSegments (int const, CGeomProfile , CGeomProfile , int const, int const, double const, double const, double const, double const)
	Merges two profiles which intersect at their final (most seaward) line segments, seaward of their point of intersection.

void	TruncateOneProfileRetainOtherProfile (int const, CGeomProfile , CGeomProfile , double, double, int, int, bool const)
	Truncates one intersecting profile at the point of intersection, and retains the other profile.

int	nInsertPointIntoProfilesIfNeededThenUpdate (int const, CGeomProfile , double const, double const, int const, CGeomProfile , int const, bool const)
	Inserts an intersection point into the profile that is to be retained, if that point is not already present in the profile, then does the same for all co-incident profiles. Finally adds the numbers of the to-truncate profile (and all its coincident profiles) to the seaward line segments of the to-retain profile and all its coincident profiles.

void	TruncateProfileAndAppendNew (int const, CGeomProfile , int const, vector< CGeom2DPoint > const , vector< vector< pair< int, int > > > const *)
	Truncate a profile at the point of intersection, and do the same for all its co-incident profiles.

void	CreateRasterizedProfile (int const, CGeomProfile , vector< CGeom2DIPoint > , vector< bool > *, bool &, bool &, bool &, bool &, bool &, bool &)
	Given a pointer to a coastline-normal profile, returns an output vector of cells which are 'under' every line segment of the profile. If there is a problem with the profile (e.g. a rasterized cell is dry land or coast, or the profile has to be truncated) then we pass this back as an error code.

void	RasterizeCliffCollapseProfile (vector< CGeom2DPoint > const , vector< CGeom2DIPoint > ) const
	Given the start and end points of a cliff-collapse normal profile, returns an output vector of cells which are 'under' the vector line.

int	nCalcPotentialPlatformErosionOnProfile (int const, CGeomProfile *)
	Calculates potential (i.e. unconstrained by available sediment) erosional lowering of the shore platform for a single coastline-normal profile, due to wave action. This routine uses a behavioural rule to modify the original surface elevation profile geometry, in which erosion rate/slope = f(d/Db) based on Walkden & Hall (2005). Originally coded in Matlab by Andres Payo.

int	nCalcPotentialPlatformErosionBetweenProfiles (int const, CGeomProfile *, int const)
	Calculates potential platform erosion on cells to one side of a given coastline-normal profile, up to the next profile.

void	ConstructParallelProfile (int const, int const, int const, int const, int const, vector< CGeom2DIPoint > const, vector< CGeom2DIPoint > , vector< CGeom2DPoint > *)
	Constructs a parallel coastline-normal profile.

double	dCalcBeachProtectionFactor (int const, int const, double const)
	Calculates the (inverse) beach protection factor as in SCAPE: 0 is fully protected, 1 = no protection.

void	FillInBeachProtectionHoles (void)
	Fills in 'holes' in the beach protection i.e. orphan cells which get omitted because of rounding problems.

void	FillPotentialPlatformErosionHoles (void)
	Fills in 'holes' in the potential platform erosion i.e. orphan cells which get omitted because of rounding problems.

void	DoActualPlatformErosionOnCell (int const, int const)
	Calculates actual (constrained by available sediment) erosion of the consolidated shore platform on a single sea cell.

double	dLookUpErosionPotential (double const)
	The erosion potential lookup: it returns a value for erosion potential given a value of Depth Over DB.

int	nGetCoastNormalEndPoint (int const, int const, int const, CGeom2DPoint const , double const, CGeom2DPoint , CGeom2DIPoint *, bool const)
	Finds the end point of a coastline-normal line, given the start point on the vector coastline. All coordinates are in the external CRS.

int	nLandformToGrid (int const, int const)
	At the end of each timestep, this routine stores the attributes from a single coastal landform object in the grid cell 'under' the object, ready for the next timestep.

int	nCalcWavePropertiesOnProfile (int const, int const, CGeomProfile , vector< double > , vector< double > , vector< double > , vector< double > , vector< bool > )
	Calculates wave properties along a coastline-normal profile using either the COVE linear wave theory approach or the external CShore model.

int	nGetThisProfileElevationsForCShore (int const, CGeomProfile , int const, vector< double > , vector< double > , vector< double > )
	Get profile horizontal distance and bottom elevation vectors in CShore units.

int	nCreateCShoreInfile (int const, int const, int const, int const, int const, int const, int const, int const, int const, int const, int const, int const, int const, double const, double const, double const, double const, double const, double const, double const, double const, vector< double > const , vector< double > const , vector< double > const *)

int	nReadCShoreOutput (int const, string const , int const, int const, vector< double > const , vector< double > *)

void	InterpolateCShoreOutput (vector< double > const , int const, int const, vector< double > , vector< double > , vector< double > , vector< double > , vector< double > , vector< double > , vector< double > , vector< double > , vector< double > )

void	CalcCoastTangents (int const)
	Calculates tangents to a coastline: the tangent is assumed to be the orientation of energy/sediment flux along a coast. The tangent is specified as an angle (in degrees) measured clockwise from north. Based on a routine by Martin Hurst.

void	InterpolateWavePropertiesBetweenProfiles (int const, int const)
	Interpolates wave properties from profiles to the coastline points between two profiles. Do this by weighting the wave properties so that they change smoothly between the two profiles.

void	InterpolateWaveHeightToCoastPoints (int const)
	Linearly interpolates wave properties from profiles to the coastline cells between two profiles.

void	ModifyBreakingWavePropertiesWithinShadowZoneToCoastline (int const, int const)
	Modifies the wave breaking properties at coastline points of profiles within the shadow zone.

void	CalcD50AndFillWaveCalcHoles (void)
	Calculates an average d50 for each polygon. Also fills in 'holes' in active zone and wave calcs i.e. orphan cells which should have been included in the active zone but which have been omitted because of rounding problems.

int	nDoAllShadowZones (void)
	Finds wave shadow zones and modifies waves in and near them. Note that where up-coast and down-coast shadow zones overlap, the effects on wave values in the overlap area is an additive decrease in wave energy. Changes to wave energy in any down-drift increased-energy zones are also additive.

int	nFloodFillShadowZone (int const, CGeom2DIPoint const , CGeom2DIPoint const , CGeom2DIPoint const *)
	Cell-by-cell fills a shadow zone from the centroid.

void	DoShadowZoneAndDownDriftZone (int const, int const, int const, int const)
	Traverse the shadow zone, changing wave orientation and height, and the down-drift zone, changing only wave height. Do this by following the coast between the shadow boundary start point and end point, and following the downdrift boundary between the same points. At each step, trace a linking line, then move along this line and change wave properties.

void	ProcessDownDriftCell (int const, int const, int const, double const, int const)
	Process a single cell which is in the downdrift zone, changing its wave height.

void	ProcessShadowZoneCell (int const, int const, int const, CGeom2DIPoint const *, int const, int const, int const)
	Process a single cell which is in the shadow zone, changing its wave height and orientation.

int	nCreateAllPolygons (void)
	Create polygons, and mark the polygon boundaries on the raster grid.

void	RasterizePolygonJoiningLine (int const, CGeom2DIPoint const , CGeom2DIPoint const , int const)
	Puts a polygon 'joining line' (the line which is the seaward boundary of the polygon, if the polygon doesn't meet at a point) onto the raster grid.

void	MarkPolygonCells (void)
	Marks cells of the raster grid that are within each coastal polygon. The cell-by-cell fill (aka 'floodfill') code used here is adapted from an example by Lode Vandevenne (http://lodev.org/cgtutor/floodfill.html#Scanline_Floodfill_Algorithm_With_Stack)

int	nDoPolygonSharedBoundaries (void)
	For between-polygon potential sediment routing: find which are the adjacent polygons, and calc the length of the shared normal between this polygon and the adjacent polygons TODO 012 Will need to change this when length of coastline-normal profiles (and so polygon seaward length) is determined by depth of closure.

void	DoAllPotentialBeachErosion (void)
	Uses either the CERC equation or the Kamphuis (1990) equation to calculate potential (unconstrained) sediment movement between polygons.

int	nDoAllActualBeachErosionAndDeposition (void)
	Does between-polygon and within-polygon actual (supply-limited) redistribution of transported beach sediment.

int	nDoParallelProfileUnconsErosion (CGeomCoastPolygon , int const, int const, int const, int const, int const, int const, vector< CGeom2DIPoint > const , vector< double > const *, double &, double &, double &)
	This routine erodes unconsolidated beach sediment (either fine, sand, or coarse) on a parallel profile.

void	ErodeCellBeachSedimentSupplyLimited (int const, int const, int const, int const, double const, double &)
	Erodes the unconsolidated beach sediment on a single cell, for a single size class, and returns the depth-equivalents of sediment removed.

int	nDoUnconsErosionOnPolygon (int const, CGeomCoastPolygon *, int const, double const, double &)
	Erodes unconsolidated beach sediment of one texture class on the cells within a polygon. This is done by working down the coastline and constructing profiles which are parallel to the up-coast polygon boundary; then reversing direction and going up-coast, constructing profiles parallel to the down-coast boundary. Then iteratively fit a Dean equilibrium profile until the normal's share of the change in total depth of unconsolidated sediment is accommodated under the revised profile. For erosion, this reduces the beach volume.

int	nDoUnconsDepositionOnPolygon (int const, CGeomCoastPolygon *, int const, double, double &)
	Deposits unconsolidated beach sediment (sand or coarse) on the cells within a polygon. This is done by working down the coastline and constructing profiles which are parallel to the up-coast polygon boundary; then reversing direction and going up-coast, constructing profiles parallel to the down-coast boundary. Then iteratively fit a Dean equilibrium profile until the normal's share of the change in total depth of unconsolidated sediment is accommodated under the revised profile. For deposition, this adds to the beach volume.

void	CalcDepthOfClosure (void)
	Calculate the depth of closure.

int	nInterpolateAllDeepWaterWaveValues (void)
	If the user supplies multiple deep water wave height and angle values, this routine interplates these to all cells (including dry land cells)

int	nSetAllCoastpointDeepWaterWaveValues (void)
	Give every coast point a value for deep water wave height and direction TODO 005 This may not be realistic, maybe better to use end-of-profile value instead (how?)

int	nDoSedimentInputEvent (int const)
	Do a sediment input event.

void	AllPolygonsUpdateStoredUncons (int const)
	Before simulating beach erosion, update the per-polygon values of pre-existing unconsolidated sediment for all three size classes, to include unconsolidated sediment derived from platform erosion, cliff collapse, and sediment input events.

bool	bIsInterventionCell (int const, int const) const
	Returns true if the cell is an intervention.

bool	bSurroundedByDriftCells (int const, int const)
	Returns true if this cell has four drift cells surrounding it.

bool	bElevAboveDeanElev (int const, int const, double const, CRWCellLandform const *)
	Return true if the given elevation is higher than the Dean elevation (and other conditions are met), which means that we could have beach erosion.

int	nMarkBoundingBoxEdgeCells (void)
	Mark cells which are at the edge of a bounding box which represents the valid part of the grid, as defined by the basement layer. The valid part of the grid may be the whole grid, or only part of the whole grid. The bounding box may be an irregular shape (but may not have re-entrant edges): simple shapes are more likely to work correctly.

bool	bCheckRasterGISOutputFormat (void)
	Checks whether the selected raster GDAL driver supports file creation, 32-bit doubles, etc.

bool	bCheckVectorGISOutputFormat (void)
	Checks whether the selected vector OGR driver supports file creation etc.

bool	bSaveAllRasterGISFiles (void)
	The bSaveAllRasterGISFiles member function saves the raster GIS files using values from the RasterGrid array.

bool	bSaveAllVectorGISFiles (void)
	The bSaveAllvectorGISFiles member function saves the vector GIS files TODO 081 Choose more files to omit from "usual" vector output.

bool	bIsWithinValidGrid (int const, int const) const
	Checks whether the supplied point (an x-y pair, in the grid CRS) is within the raster grid, and is a valid cell (i.e. the basement DEM is not NODATA)

bool	bIsWithinValidGrid (CGeom2DIPoint const *) const
	Checks whether the supplied point (a reference to a CGeom2DIPoint, in the grid CRS) is within the raster grid, and is a valid cell (i.e. the basement DEM is not NODATA)

double	dGridCentroidXToExtCRSX (int const) const
	Given the integer X-axis ordinate of a cell in the raster grid CRS, returns the external CRS X-axis ordinate of the cell's centroid.

double	dGridCentroidYToExtCRSY (int const) const
	Given the integer Y-axis ordinate of a cell in the raster grid CRS, returns the external CRS Y-axis ordinate of the cell's centroid.

double	dGridXToExtCRSX (double const) const
	Given a real-valued X-axis ordinate in the raster grid CRS (i.e. not the centroid of a cell), returns the external CRS X-axis ordinate.

double	dGridYToExtCRSY (double const) const
	Given a real-valued Y-axis ordinate in the raster grid CRS (i.e. not the centroid of a cell), returns the external CRS Y-axis ordinate.

CGeom2DIPoint	PtiExtCRSToGridRound (CGeom2DPoint const *) const
	Transforms a pointer to a CGeom2DPoint in the external CRS to the equivalent CGeom2DIPoint in the raster grid CRS (both values rounded). The result may be outside the grid.

CGeom2DPoint	PtGridCentroidToExt (CGeom2DIPoint const *) const
	Transforms a pointer to a CGeom2DIPoint in the raster grid CRS (assumed to be the centroid of a cell) to the equivalent CGeom2DPoint in the external CRS.

double	dExtCRSXToGridX (double const) const
	Transforms an X-axis ordinate in the external CRS to the equivalent X-axis ordinate in the raster grid CRS (the result is not rounded, and so may not be integer, and may be outside the grid)

double	dExtCRSYToGridY (double const) const
	Transforms a Y-axis ordinate in the external CRS to the equivalent Y-axis ordinate in the raster grid CRS (the result is not rounded, and so may not be integer, and may be outside the grid)

void	KeepWithinValidGrid (int &, int &) const
	Constrains the supplied point (in the grid CRS) to be a valid cell within the raster grid.

void	KeepWithinValidGrid (int, int, int &, int &) const
	Given two points in the grid CRS (the points assumed not to be coincident), this routine modifies the value of the second point so that it is on a line joining the original two points and is a valid cell within the raster grid. However in some cases (e.g. if the first point is at the edge of the valid part of the raster grid) then the second cell will be coincident with the first cell, and the line joining them is thus of zero length. The calling routine has to be able to handle this.

void	KeepWithinValidGrid (CGeom2DIPoint const , CGeom2DIPoint ) const
	Constrains the second supplied point (both are CGeom2DIPoints, in the grid CRS) to be a valid cell within the raster grid.

CGeom2DIPoint	PtiFindClosestCoastPoint (int const, int const)
	Finds the closest point on any coastline to a given point.

int	nConvertMetresToNumCells (double const) const
	Given a length in m, this returns the rounded equivalent number of cells.

double	dGetInterpolatedValue (vector< double > const , vector< double > const , double, bool)

double	dGetInterpolatedValue (vector< int > const , vector< double > const , int, bool)

int	nFindIndex (vector< double > const *, double const)
	This is used by VdInterpolateCShoreProfileOutput, it returns the index of the value in pVdX which is less than or equal to the absolute difference between dValueIn and the pVdX value.

vector< double >	VdInterpolateCShoreProfileOutput (vector< double > const , vector< double > const , vector< double > const *)
	Returns a linearly interpolated vector of doubles, to make CShore profile output compatible with CME. The array pVdY has been output by CShore and so always has length CSHOREARRAYOUTSIZE, whereas all other arrays have sizes which depend on CME at runtime.

void	AnnounceLicence (void)
	Tells the user about the licence.

void	AnnounceReadBasementDEM (void) const
	Tells the user that we are now reading the DEM file.

void	AnnounceReadLGIS (void) const
	Tells the user that we are now reading the Landscape category GIS file.

void	AnnounceReadICGIS (void) const
	Tells the user that we are now reading the Intervention class GIS file.

void	AnnounceReadIHGIS (void) const
	Tells the user that we are now reading the Intervention height GIS file.

void	AnnounceReadInitialSuspSedGIS (void) const
	Tells the user that we are now reading the initial suspended sediment depth GIS file.

void	AnnounceReadInitialFineUnconsSedGIS (int const) const
	Tells the user that we are now reading the initial fine unconsolidated sediment depth GIS file.

void	AnnounceReadInitialSandUnconsSedGIS (int const) const
	Tells the user that we are now reading the initial sand unconsolidated sediment depth GIS file.

void	AnnounceReadInitialCoarseUnconsSedGIS (int const) const
	Tells the user that we are now reading the initial coarse unconsolidated sediment depth GIS file.

void	AnnounceReadInitialFineConsSedGIS (int const) const
	Tells the user that we are now reading the initial fine consolidated sediment depth GIS file.

void	AnnounceReadInitialSandConsSedGIS (int const) const
	Tells the user that we are now reading the initial sand consolidated sediment depth GIS file.

void	AnnounceReadInitialCoarseConsSedGIS (int const) const
	Tells the user that we are now reading the initial coarse consolidated sediment depth GIS file.

void	AnnounceReadDeepWaterWaveValuesGIS (void) const
	Tells the user that we are now reading the deep water wave values GIS file.

void	AnnounceReadSedimentEventInputValuesGIS (void) const
	Tells the user that we are now reading the sediment input events GIS file.

void	AnnounceReadFloodLocationGIS (void) const
	Tells the user that we are now reading the flood location GIS file.

void	AnnounceReadTideData (void) const
	Now reading tide data file.

void	StartClock (void)
	Starts the clock ticking.

bool	bFindExeDir (char const *)
	Finds the folder (directory) in which the CoastalME executable is located.

bool	bTimeToQuit (void)
	Checks to see if the simulation has gone on too long, amongst other things.

int	nDoSimulationTimeMultiplier (string const *)
	Given a string containing time units, this sets up the appropriate multiplier and display units for the simulation.

void	DoEndOfTimestepTotals (void)
	Update and print totals at the end of each timestep.

void	DoCPUClockReset (void)
	Resets the CPU clock timer to prevent it 'rolling over', as can happen during long runs. This is a particularly problem under Unix systems where the value returned by clock() is defined in microseconds (for compatibility with systems that have CPU clocks with much higher resolution) i.e. CLOCKS_PER_SEC is 1000000 rather than the more usual 1000. In this case, the value returned from clock() will wrap around after accumulating only 2147 seconds of CPU time (about 36 minutes).

void	CalcTime (double const)
	Calculates and displays time elapsed in terms of CPU time and real time, also calculates time per timestep in terms of both CPU time and real time.

void	AnnounceProgress (void)
	Displays information regarding the progress of the simulation.

string	strListRasterFiles (void) const
	Return a space-separated string containing the names of the raster GIS output files.

string	strListVectorFiles (void) const
	Return a space-separated string containing the names of the vector GIS output files.

string	strListTSFiles (void) const
	Return a space-separated string containing the names of the time series output files.

void	CalcProcessStats (void)
	This calculates and displays process statistics.

void	CalcSavitzkyGolayCoeffs (void)
	Calculates the Savitzky-Golay smoothing coefficients for a given size of smoothing window. Derived from a C original by Jean-Pierre Moreau (jpmor.nosp@m.eau@.nosp@m.wanad.nosp@m.oo.f.nosp@m.r, http://jean-pierre.moreau.pagesperso-orange.fr/index.html), to whom we are much indebted.

CGeomLine	LSmoothCoastSavitzkyGolay (CGeomLine *, int const, int const) const
	Does smoothing of a CGeomLine coastline vector (is in external CRS coordinates) using a Savitzky-Golay filter. Derived from a C original by Jean-Pierre Moreau (jpmor.nosp@m.eau@.nosp@m.wanad.nosp@m.oo.f.nosp@m.r, http://jean-pierre.moreau.pagesperso-orange.fr/index.html), to whom we are much indebted.

CGeomLine	LSmoothCoastRunningMean (CGeomLine *) const
	Does running-mean smoothing of a CGeomLine coastline vector (is in external CRS coordinates)

vector< double >	dVSmoothProfileSlope (vector< double > *) const
	Does running-mean smoothing of the slope of a coastline-normal profile.

unsigned long	ulConvertToTimestep (string const *) const
	For sediment input events, parses a string that may be relative (a number of hours or days after the start of the simulation), or absolute (a time/date in the format hh-mm-ss dd/mm/yyyy). Returns the timestep in which the sediment input event occurs.

void	WritePolygonInfoTable (int const)
	Writes to the log file a table showing polygon info.

void	WritePolygonPreExistingSedimentTable (int const)
	Writes to the log file a table showing per-polygon pre-existing unconsolidated sediment.

void	WritePolygonSedimentInputEventTable (int const)
	Writes to the log file a table showing per-polygon sediment input event totals.

void	WritePolygonShorePlatformErosion (int const)
	Writes to the log file a table showing per-polygon unconsolidated sand/coarse sediment derived from erosion of the consolidated shore platform.

void	WritePolygonCliffCollapseErosion (int const)
	Writes to the log file a table showing per-polygon per-polygon cliff collapse.

void	WritePolygonSedimentBeforeMovement (int const)
	Writes to the log file a table showing per-polygon totals of stored unconsolidated beach sediment prior to polygon-to-polygon movement.

void	WritePolygonPotentialErosion (int const)
	Writes to the log file a table showing per-polygon potential erosion of all size classes of unconsolidated beach sediment.

void	WritePolygonUnsortedSequence (int const, vector< vector< int > > &)
	Writes to the log file a table showing the unsorted sequence of polygon processing.

void	WritePolygonSortedSequence (int const, vector< vector< int > > &)
	Writes to the log file a table showing the sorted sequence of polygon processing, and any circularities.

void	WritePolygonEstimatedMovement (int const, vector< vector< int > > &)

void	WritePolygonActualMovement (int const, vector< vector< int > > const &)
	Writes to the log file a table showing per-polygon actual movement of unconsolidated beach sediment.

void	DoEndOfRunDeletes (void)
	Do end-of-run memory clearance.

Static Private Member Functions
static int	nUpdateIntervention (void)
	Check to see if we have a new intervention in place (not yet implemented)

static bool	bCheckForIntersection (CGeomProfile const, CGeomProfile const, int &, int &, double &, double &, double &, double &)
	Checks all line segments of a pair of coastline-normal profiles for intersection. If the lines intersect, returns true with the numbers of the line segments at which intersection occurs in nProfile1LineSegment and nProfile1LineSegment, the intersection point in dXIntersect and dYIntersect, and the 'average' seaward endpoint of the two intersecting profiles at dXAvgEnd and dYAvgEnd.

static void	CalcDeanProfile (vector< double > *, double const, double const, double const, bool const, int const, double const)
	Calculates a Dean equilibrium profile h(y) = A * y^(2/3) where h(y) is the distance below the highest point in the Dean profile at a distance y from the landward start of the profile.

static double	dSubtractProfiles (vector< double > const , vector< double > const , vector< bool > const *)
	Calculate the total elevation difference between every point in two elevation profiles (first profile - second profile)

static CGeom2DPoint	PtChooseEndPoint (int const, CGeom2DPoint const , CGeom2DPoint const , double const, double const, double const, double const)
	Choose which end point to use for the coastline-normal profile.

static double	dCalcWaveAngleToCoastNormal (double const, double const, int const)
	Calculates the angle between the wave direction and a normal to the coastline tangent. If wave direction has a component which is down-coast (i.e. in the direction with increasing coast point numbers), then the angle returned is +ve. If wave direction has a component which is up-coast (i.e. in the direction with decreasing coast point numbers), then the angle returned is -ve. If waves are in an off-shore direction, DBL_NODATA is returned.

static double	dCalcCurvature (int const, CGeom2DPoint const , CGeom2DPoint const , CGeom2DPoint const *)
	Calculates signed Menger curvature (https://en.wikipedia.org/wiki/Menger_curvature#Definition) from three points on a line. Returns +ve values for concave, -ve for convex, and zero if the points are co-linear. Curvature is multiplied by 1000 to give easier-to-read numbers.

static bool	bOnOrOffShoreAndUpOrDownCoast (double const, double const, int const, bool &)
	Determines whether the wave orientation at this point on a coast is onshore or offshore, and up-coast (i.e. along the coast in the direction of decreasing coastline point numbers) or down-coast (i.e. along the coast in the direction of increasing coastline point numbers)

static CGeom2DIPoint	PtiFollowWaveAngle (CGeom2DIPoint const *, double const, double &)
	Given a cell and a wave orientation, finds the 'upwave' cell.

static bool	bIsWithinPolygon (CGeom2DPoint const , vector< CGeom2DPoint > const )
	Determines whether a point is within a polygon: however if the point is exactly on the edge of the polygon, then the result is indeterminate. Modified from code at http://alienryderflex.com/polygon/, our thanks to Darel Rex Finley (Darel.nosp@m.Rex@.nosp@m.gmail.nosp@m..com)

static CGeom2DPoint	PtFindPointInPolygon (vector< CGeom2DPoint > const *, int const)
	Finds a point in a polygon: is guaranteed to succeed, as every strictly closed polygon has at least one triangle that is completely contained within the polygon. Derived from an algorithm at http://stackoverflow.com/questions/9797448/get-a-point-inside-the-polygon.

static double	dGetDistanceBetween (CGeom2DPoint const , CGeom2DPoint const )
	Returns the distance (in external CRS) between two points.

static double	dGetDistanceBetween (CGeom2DIPoint const , CGeom2DIPoint const )
	Returns the distance (in grid units) between two grid cell points.

static double	dTriangleAreax2 (CGeom2DPoint const , CGeom2DPoint const , CGeom2DPoint const *)
	Returns twice the signed area of a triangle.

static double	dKeepWithin360 (double const)
	Constrains the supplied angle to be within 0 and 360 degrees.

static CGeom2DPoint	PtGetPerpendicular (CGeom2DPoint const , CGeom2DPoint const , double const, int const)
	Returns a CGeom2DPoint which is the 'other' point of a two-point vector passing through PtStart, and which is perpendicular to the two-point vector from PtStart to PtNext.

static CGeom2DIPoint	PtiGetPerpendicular (CGeom2DIPoint const , CGeom2DIPoint const , double const, int const)
	Returns a CGeom2DIPoint (grid CRS) which is the 'other' point of a two-point vector passing through PtiStart, and which is perpendicular to the two-point vector from PtiStart to PtiNext.

static CGeom2DIPoint	PtiGetPerpendicular (int const, int const, int const, int const, double const, int const)
	Returns a CGeom2DIPoint (grid CRS) which is the 'other' point of a two-point vector passing through [nStartX][nStartY], and which is perpendicular to the two-point vector from [nStartX][nStartY] to [nNextX][nNextY].

static CGeom2DPoint	PtAverage (CGeom2DPoint const , CGeom2DPoint const )
	Returns a point (external CRS) which is the average of (i.e. is midway between) two other external CRS points.

static CGeom2DPoint	PtAverage (vector< CGeom2DPoint > *)
	Returns a point (external CRS) which is the average of a vector of external CRS points.

static CGeom2DIPoint	PtiWeightedAverage (CGeom2DIPoint const , CGeom2DIPoint const , double const)
	Returns an integer point (grid CRS) which is the weighted average of two other grid CRS integer points. The weight must be <= 1, if the weight is < 0.5 then the output point is closer to the first point, if the weight is > 0.5 then the output point is closer to the second point.

static CGeom2DIPoint	PtiPolygonCentroid (vector< CGeom2DIPoint > *)
	Returns an integer point (grid CRS) which is the centroid of a polygon, given by a vector of grid CRS points. From https://stackoverflow.com/questions/2792443/finding-the-centroid-of-a-polygon.

static double	dAngleSubtended (CGeom2DIPoint const , CGeom2DIPoint const , CGeom2DIPoint const *)
	Returns the signed angle BAC (in radians) subtended between three CGeom2DIPoints B A C. From http://stackoverflow.com/questions/3057448/angle-between-3-vertices.

static int	nGetOppositeDirection (int const)
	Returns the opposite direction.

static void	AnnounceStart (void)
	Tells the user that we have started the simulation.

static void	AnnounceAddLayers (void)
	Tells the user that we are now adding layers.

static void	AnnounceReadRasterFiles (void)
	Now reading raster GIS files.

static void	AnnounceReadVectorFiles (void)
	Now reading vector GIS files.

static void	AnnounceInitializing (void)
	Tells the user that we are now initializing.

static void	AnnounceReadSCAPEShapeFunctionFile (void)
	Now reading the SCAPE shape function file.

static void	AnnounceAllocateMemory (void)
	Tells the user that we are now allocating memory.

static void	AnnounceIsRunning (void)
	Tell the user that the simulation is now running.

static void	AnnounceSimEnd (void)
	Announce the end of the simulation.

static int	nDoTimeUnits (string const *)
	This finds time units in a string.

static double	dGetTimeMultiplier (string const *)
	Given a string containing time units, this returns the appropriate multiplier.

static bool	bParseDate (string const *, int &, int &, int &)
	Parses a date string into days, months, and years, and checks each of them.

static bool	bParseTime (string const *, int &, int &, int &)
	Parses a time string into hours, minutes, and seconds, and checks each of them.

static string	strGetBuild (void)
	Returns the date and time on which the program was compiled.

static string	strGetComputerName (void)
	Returns a string, hopefully giving the name of the computer on which the simulation is running.

static string	strDispTime (double const, bool const, bool const)
	strDispTime returns a string formatted as h:mm:ss, given a parameter in seconds, with rounding and fractions of a second if desired

static string	strDispSimTime (double const)
	strDispSimTime returns a string formatted as year Julian_day hour, given a parameter in hours

static string	strGetErrorText (int const)
	Returns an error message given an error code.

static void	CalcSavitzkyGolay (double[], int const, int const, int const, int const, int const)
	CalcSavitzkyGolay uses LULinearSolve and LUDecomp. It returns dFilterCoeffsArray[nWindowSize], a set of Savitzky-Golay filter coefficients in wrap-around order. nLeft is the number of leftward data points used, nRight is the number of rightward data points, making the total number of data points used = nLeft + nRight + 1. nDerivOrder is the order of the derivative desired (e.g. nDerivOrder = 0 for smoothed function), nSmoothPolyOrder is the order of the smoothing polynomial also equal to the highest conserved moment; usual values are nSmoothPolyOrder = 2 or nSmoothPolyOrder = 4. Derived from a C original by Jean-Pierre Moreau (jpmor.nosp@m.eau@.nosp@m.wanad.nosp@m.oo.f.nosp@m.r, http://jean-pierre.moreau.pagesperso-orange.fr/index.html), to whom we are much indebted.

static string	pstrChangeToBackslash (string const *)
	Changes all forward slashes in the input string to backslashes, leaving the original unchanged.

static string	pstrChangeToForwardSlash (string const *)
	Swaps all backslashes in the input string to forward slashes, leaving the original unchanged.

static string	strTrim (string const *)
	Trims whitespace from both sides of a string, does not change the original string.

static string	strTrimLeft (string const *)
	Trims whitespace from the left side of a string, does not change the original string.

static string	strTrimRight (string const *)
	Trims whitespace from the right side of a string, does not change the original string.

static string	strToLower (string const *)
	Returns the lower case version of an string, leaving the original unchanged.

static string	strRemoveSubstr (string , string const )
	Returns a string with a substring removed, and with whitespace trimmed.

static vector< string > *	VstrSplit (string const , char const, vector< string > )
	From http://stackoverflow.com/questions/236129/split-a-string-in-c They implement (approximately) Python's split() function. This first version puts the results into a pre-constructed string vector. It ignores empty items.

static vector< string >	VstrSplit (string const *, char const)
	From http://stackoverflow.com/questions/236129/split-a-string-in-c They implement (approximately) Python's split() function. This second version returns a new string vector (it calls the first version)

static void	AppendEnsureNoGap (vector< CGeom2DIPoint > , CGeom2DIPoint const )
	Appends a CGeom2DIPoint to a vector<CGeom2DIPoint>, making sure that the new end point touches the previous end point i.e. that there is no gap between the two points.

Private Attributes
bool	m_bHaveFineSediment
	Does this simulation consider fine-sized sediment?

bool	m_bHaveSandSediment
	Does this simulation consider sand-sized sediment?

bool	m_bHaveCoarseSediment
	Does this simulation consider coarse-sized sediment?

bool	m_bBasementElevSave
	Save basement raster DEMs?

bool	m_bSedimentTopSurfSave
	Save sediment top surface raster DEMs?

bool	m_bTopSurfSave
	Save fop surface (sediment and sea) raster DEMs?

bool	m_bSliceSave
	Save slices?

bool	m_bSeaDepthSave
	Save sea depth raster GIS files?

bool	m_bAvgSeaDepthSave
	Save average sea depth raster GIS files?

bool	m_bWaveHeightSave
	Save wave height raster GIS files?

bool	m_bAvgWaveHeightSave
	Save wave height raster GIS files?

bool	m_bWaveAngleSave
	Save wave angle raster GIS files?

bool	m_bAvgWaveAngleSave
	Save average wave angle raster GIS files?

bool	m_bWaveAngleAndHeightSave
	Save wave angle and wave height raster GIS files?

bool	m_bAvgWaveAngleAndHeightSave
	Save average wave angle and average wave height raster GIS files?

bool	m_bDeepWaterWaveAngleAndHeightSave
	Save deep water wave angle and wave height raster GIS files?

bool	m_bWaveEnergySinceCollapseSave
	Save wave energy since cliff collapse raster GIS files?

bool	m_bMeanWaveEnergySave
	Save mean wave energy raster GIS files?

bool	m_bBreakingWaveHeightSave
	Save breaking wave height raster GIS files?

bool	m_bBeachProtectionSave
	Save beach protection raster GIS files>

bool	m_bPotentialPlatformErosionSave
	Save potential shore platform erosion raster GIS files?

bool	m_bActualPlatformErosionSave
	Save actual (supply-limited) shore platform erosion raster GIS files?

bool	m_bTotalPotentialPlatformErosionSave
	Save total potential shore platform erosion raster GIS files?

bool	m_bTotalActualPlatformErosionSave
	Save total actual (supply-limited) shore platform erosion raster GIS files?

bool	m_bPotentialBeachErosionSave
	Save potential beach (unconsolidated sediment) erosion raster GIS files?

bool	m_bActualBeachErosionSave
	Save actual (supply-limited) beach (unconsolidated sediment) erosion raster GIS files?

bool	m_bTotalPotentialBeachErosionSave
	Save total potential beach (unconsolidated sediment) erosion raster GIS files?

bool	m_bTotalActualBeachErosionSave
	Save total actual (supply-limited) beach (unconsolidated sediment) erosion raster GIS files?

bool	m_bBeachDepositionSave
	Save beach (unconsolidated sediment) deposition raster GIS files?

bool	m_bTotalBeachDepositionSave
	Save total beach (unconsolidated sediment) deposition raster GIS files?

bool	m_bLandformSave
	Save coast landform raster GIS files?

bool	m_bLocalSlopeSave
	Save local slope raster GIS files?

bool	m_bInterventionClassSave
	Save intervention class raster GIS files?

bool	m_bInterventionHeightSave
	Save intervention height raster GIS files?

bool	m_bSuspSedSave
	Save suspended sediment raster GIS files?

bool	m_bAvgSuspSedSave
	Save average suspended sediment raster GIS files?

bool	m_bFineUnconsSedSave
	Save fine unconsolidated sediment raster GIS files?

bool	m_bSandUnconsSedSave
	Save sand unconsolidated sediment raster GIS files?

bool	m_bCoarseUnconsSedSave
	Save coarse unconsolidated sediment raster GIS files?

bool	m_bFineConsSedSave
	Save fine consolidated sediment raster GIS files?

bool	m_bSandConsSedSave
	Save sand consolidated sediment raster GIS files?

bool	m_bCoarseConsSedSave
	Save coarse consolidated sediment raster GIS files?

bool	m_bRasterCoastlineSave
	Save rasterized coastline GIS files?

bool	m_bRasterNormalProfileSave
	Save rasterized coastline-normal profiles GIS files?

bool	m_bActiveZoneSave
	Save active zone raster GIS files?

bool	m_bCliffCollapseSave
	Save cliff collapse raster GIS files?

bool	m_bTotCliffCollapseSave
	Save total cliff collapse raster GIS files?

bool	m_bCliffCollapseDepositionSave
	Save cliff collapse deposition raster GIS files?

bool	m_bTotCliffCollapseDepositionSave
	Save total cliff collapse deposition raster GIS files?

bool	m_bRasterPolygonSave
	Save raster polygon raster GIS files?

bool	m_bPotentialPlatformErosionMaskSave
	Save potential platform erosion mask raster GIS files?

bool	m_bSeaMaskSave
	Save sea mask raster GIS files?

bool	m_bBeachMaskSave
	Save beach mask raster GIS files?

bool	m_bShadowZoneCodesSave
	Save wave shadow zones raster GIS files?

bool	m_bDeepWaterWaveAngleSave
	Save deep water wave angle raster GIS files?

bool	m_bDeepWaterWaveHeightSave
	Save deep water wave height raster GIS files?

bool	m_bDeepWaterWavePeriodSave
	Save deep water wave period raster GIS files?

bool	m_bPolygonUnconsSedUpOrDownDriftSave
	Save polygon unconsolidated sediment up- or down-drift raster GIS files?

bool	m_bPolygonUnconsSedGainOrLossSave
	Save polygon unconsolidated sediment gain or loss raster GIS files?

bool	m_bSaveRegular
	Save GIS files at regular intervals?

bool	m_bCoastSave
	Save.

bool	m_bNormalsSave
	Save coastline-normal vector GIS files?

bool	m_bInvalidNormalsSave
	Save invalid coastline-normal vector GIS files?

bool	m_bCoastCurvatureSave
	Save coastline-curvature vector GIS files?

bool	m_bPolygonNodeSave
	Save polygon node vector GIS files?

bool	m_bPolygonBoundarySave
	Save polygon boundary vector GIS files?

bool	m_bCliffNotchSave
	Save cliff notch incision depth vector GIS files?

bool	m_bShadowBoundarySave
	Save wave shadow boundary vector GIS files?

bool	m_bShadowDowndriftBoundarySave
	Save wave shadow downdrift boundary vector GIS files?

bool	m_bSeaAreaTSSave
	Save the sea area time series file?

bool	m_bStillWaterLevelTSSave
	Save the still water level time series file?

bool	m_bActualPlatformErosionTSSave
	Save the actual (supply-limited) shore platform erosion time series file?

bool	m_bCliffCollapseErosionTSSave
	Save the cliff collapse erosion time series file?

bool	m_bCliffCollapseDepositionTSSave
	Save the cliff collapse deposition time series file?

bool	m_bCliffCollapseNetTSSave
	Save the cliff collapse net change time series file?

bool	m_bBeachErosionTSSave
	Save the beach (unconsolidated sediment) erosion time series file?

bool	m_bBeachDepositionTSSave
	Save the beach (unconsolidated sediment) deposition time series file?

bool	m_bBeachSedimentChangeNetTSSave
	Save the beach (unconsolidated sediment) net change time series file?

bool	m_bSuspSedTSSave
	Save the suspended sediment time series file?

bool	m_bFloodSetupSurgeTSSave
	Save the flood setup surge time series file? TODO 007 Does this work correctly?

bool	m_bFloodSetupSurgeRunupTSSave
	Save the flood setup surge runup time series file? TODO 007 Does this work correctly?

bool	m_bSaveGISThisIter
	Save GIS files this iteration?

bool	m_bOutputProfileData
	Output profile data?

bool	m_bOutputParallelProfileData
	Output parallel profile data?

bool	m_bOutputErosionPotentialData
	Output erosion potential data?

bool	m_bCSVPerTimestepResults
	Output per-timestep results in CSV format instead of fixed-width?

bool	m_bOmitSearchNorthEdge
	Omit the north edge of the grid from coast-end searches?

bool	m_bOmitSearchSouthEdge
	Omit the south edge of the grid from coast-end searches?

bool	m_bOmitSearchWestEdge
	Omit the west edge of the grid from coast-end searches?

bool	m_bOmitSearchEastEdge
	Omit the east edge of the grid from coast-end searches?

bool	m_bDoShorePlatformErosion
	Simulate shore platform erosion?

bool	m_bDoCliffCollapse
	Simulate cliff collapse?

bool	m_bDoBeachSedimentTransport
	Simulate unconsolidated sediment (beach) transport?

bool	m_bGDALCanCreate
	Is the selected GDAL output file format capable of writing files?

bool	m_bGDALCanWriteFloat
	Is the selected GDAL output file format capable of writing floating-point values to files?

bool	m_bGDALCanWriteInt32
	Is the selected GDAL output file format capable of writing 32-bit integers to files?

bool	m_bScaleRasterOutput
	Scale raster output?

bool	m_bWorldFile
	Write a GIS World file?

bool	m_bSingleDeepWaterWaveValues
	Do we have just a point source for (i.e. only a single measurement of) deep water wave values.

bool	m_bHaveWaveStationData
	Do we have wave station data?

bool	m_bSedimentInput
	Do we have sediment input events?

bool	m_bSedimentInputAtPoint
	Do we have sediment inputat a point?

bool	m_bSedimentInputAtCoast
	Do we have sediment input at the coast?

bool	m_bSedimentInputAlongLine
	Do we have sediment input along a line?

bool	m_bSedimentInputEventSave
	Save sediment inut data?

bool	m_bSedimentInputThisIter
	Do we have a sediment input event this iteration?

bool	m_bRiverineFlooding
	Are we doing flooding? TODO 007.

bool	m_bWaveSetupSave
	Are we saving the wave setup? TODO 007.

bool	m_bStormSurgeSave
	Are we saving the storm surge? TODO 007.

bool	m_bRunUpSave
	Are we saving runup? TODO 007.

bool	m_bSetupSurgeFloodMaskSave
	Are we saving the setup surge flood mask? TODO 007.

bool	m_bSetupSurgeRunupFloodMaskSave
	Are we saving the setup surge runup flood mask? TODO 007.

bool	m_bRasterWaveFloodLineSave
	Are we saving the raster wave flood line? TODO 007.

bool	m_bVectorWaveFloodLineSave
	Are we saving the vector wave flood line? TODO 007.

bool	m_bFloodLocation
	Are we saving the flood location? TODO 007.

bool	m_bFloodSWLSetupLine
	Are we saving the flood still water level setup line? TODO 007.

bool	m_bFloodSWLSetupSurgeLine
	Are we saving the flood still water level setup surge line? TODO 007.

bool	m_bFloodSWLSetupSurgeRunupLine
	Are we saving the flood still water level setup surge runup line? TODO 007.

bool	m_bGISSaveDigitsSequential
	Are the GIS save digits (which are part of each GIS file name) sequential, or are they the iteration number?

bool	m_bHaveConsolidatedSediment
	Does this simulation consider consolidated sediment, or is it an unconsolidated sediment only simulation?>

char **	m_papszGDALRasterOptions
	Options for GDAL when handling raster files.

char **	m_papszGDALVectorOptions
	Options for GDAL when handling vector files.

int	m_nXGridSize
	The size of the grid in the x direction.

int	m_nYGridSize
	The size of the grid in the y direction.

int	m_nLayers
	The number of sediment layers.

int	m_nCoastSmooth
	Which method to use for coast smoothing.

int	m_nCoastSmoothWindow
	The size of the window used for coast smoothing. Must be an odd number.

int	m_nSavGolCoastPoly
	The order of the coastline profile smoothing polynomial if Savitzky-Golay smoothing is used (usually 2 or 4, max is 6)

int	m_nProfileSmoothWindow
	The size of the window used for running-mean coast-normal profile smoothing (must be odd)

int	m_nCoastNormalSpacing
	Average spacing between coastline normals, measured in cells.

int	m_nCoastNormalInterventionSpacing
	Average spacing between coastline normals on interventions, measured in cells.

int	m_nCoastCurvatureInterval
	Coast curvature interval is a length, measured in coastline points.

int	m_nGISMaxSaveDigits
	The maximum number of digits in GIS filenames. These can be sequential, or the iteration number.

int	m_nGISSave
	The save number for GIS files (can be sequential, or the iteration number)

int	m_nUSave
	If user-defined GIS save intervals, the number of these.

int	m_nThisSave
	Used in calculations of GIS save intervals.

int	m_nCoastMax
	Maximum valid coast length when searching for coasts, actually is COAST_LENGTH_MAX * tMax(m_nXGridSize, m_nYGridSize)

int	m_nCoastMin
	Minimum valid coast legth when searching for coass, actualli is tMin(m_nXGridSize, m_nYGridSize)

int	m_nNumPolygonGlobal
	Number of global (all coasts) polygons.

int	m_nUnconsSedimentHandlingAtGridEdges
	How sediment which moves off an edge of the grid is handled. Possible values are GRID_EDGE_CLOSED, GRID_EDGE_OPEN, GRID_EDGE_RECIRCULATE.

int	m_nBeachErosionDepositionEquation
	Which beach erosion-deposition equation is used. Possible values are UNCONS_SEDIMENT_EQUATION_CERC and UNCONS_SEDIMENT_EQUATION_KAMPHUIS.

int	m_nGISMissingValue
	The value for integer missing values, as read from GIS input files.

int	m_nMissingValue
	Used by CoastalME for integer missing values.

int	m_nXMinBoundingBox
	The minimum x value of the bounding box.

int	m_nXMaxBoundingBox
	The maximum x value of the bounding box.

int	m_nYMinBoundingBox
	The minimum y value of the bounding box.

int	m_nYMaxBoundingBox
	The maximum y value of the bounding box.

int	m_nWavePropagationModel
	The wave propagation model used. Possible values are WAVE_MODEL_CSHORE and WAVE_MODEL_COVE.

int	m_nSimStartSec
	Start time of the simulation (seconds)

int	m_nSimStartMin
	Start time of the simulation (minutes)

int	m_nSimStartHour
	Start time of the simulation (hours)

int	m_nSimStartDay
	Start date of the simulation (day)

int	m_nSimStartMonth
	Start date of the simulation (month)

int	m_nSimStartYear
	Start date of the simulation (year)

int	m_nDeepWaterWaveDataNumTimeSteps
	The duration of data for deep water waves, expressed as a number of time steps.

int	m_nLogFileDetail
	The level of detail in the log file output. Can be LOG_FILE_LOW_DETAIL, LOG_FILE_MIDDLE_DETAIL, LOG_FILE_HIGH_DETAIL, or LOG_FILE_ALL.

int	m_nRunUpEquation
	The run-up equation used TODO 007.

int	m_nLevel
	TODO 007 Used in WAVESETUP + SURGE + RUNUP.

int	m_nCoastCurvatureMovingWindowSize

GDALDataType	m_GDALWriteIntDataType
	The data type used by GDAL for integer operations, can be GDT_Byte, GDT_Int16, GDT_UInt16, GDT_Int32, or GDT_UInt32.

GDALDataType	m_GDALWriteFloatDataType
	Thw data type used by GDAL for floating point operations, can be GDT_Byte, GDT_Int16, GDT_UInt16, GDT_Int32, GDT_UInt32, or GDT_Float32.

long	m_lGDALMaxCanWrite
	The maximum integer value which GDAL can write, can be UINT8_MAX, INT16_MAX, UINT16_MAX, INT32_MAX, or UINT32_MAX,.

long	m_lGDALMinCanWrite
	The minimum integer value which GDAL can write, can be zero, INT16_MIN, INT32_MIN.

unsigned long	m_ulIter
	The number of the current iteration (time step)

unsigned long	m_ulTotTimestep
	The target number of iterations.

unsigned long	m_ulRandSeed [NUMBER_OF_RNGS]
	A seed for each of the random number generators.

unsigned long	m_ulNumCells
	The number of cells in the grid.

unsigned long	m_ulThisIterNumSeaCells
	The number of grid cells which are marked as sea, for this iteration.

unsigned long	m_ulThisIterNumCoastCells
	The number of grid cells which are marked as coast, for this iteration.

unsigned long	m_ulThisIterNumPotentialPlatformErosionCells
	The number of grid cells on which potential platform erosion occurs, for this iteration.

unsigned long	m_ulThisIterNumActualPlatformErosionCells
	The number of grid cells on which actual platform erosion occurs, for this iteration.

unsigned long	m_ulThisIterNumPotentialBeachErosionCells
	The number of grid cells on which potential beach (unconsolidated sediment) erosion occurs, for this iteration.

unsigned long	m_ulThisIterNumActualBeachErosionCells
	The number of grid cells on which actual beach (unconsolidated sediment) erosion occurs, for this iteration.

unsigned long	m_ulThisIterNumBeachDepositionCells
	The number of grid cells on which beach (unconsolidated sediment) deposition occurs, for this iteration.

unsigned long	m_ulTotPotentialPlatformErosionOnProfiles
	The number of cells on which on-profile average potential shore platform erosion occurs.

unsigned long	m_ulTotPotentialPlatformErosionBetweenProfiles
	The number of cells on which between-profile average potential shore platform erosion occurs.

unsigned long	m_ulMissingValueBasementCells
	The number of basement cells marked with as missing value.

double	m_dDurationUnitsMult
	Multiplier for duration units, to convert to hours.

double	m_dNorthWestXExtCRS
	The north-west x coordinate, in the external coordinate reference system (CRS)

double	m_dNorthWestYExtCRS
	The north-west y coordinate, in the external coordinate reference system (CRS)

double	m_dSouthEastXExtCRS
	The south-east x coordinate, in the external coordinate reference system (CRS)

double	m_dSouthEastYExtCRS
	The south-east y coordinate, in the external coordinate reference system (CRS)

double	m_dExtCRSGridArea
	The area of the grid (in external CRS units)

double	m_dCellSide
	Length of a cell side (in external CRS units)

double	m_dCellArea
	Area of a cell (in external CRS units)

double	m_dCellDiagonal
	Length of a cell's diagonal (in external CRS units)

double	m_dInvCellSide
	Inverse of m_dCellSide.

double	m_dInvCellDiagonal
	Inverse of m_dCellDiagonal.

double	m_dSimDuration
	Duration of simulation, in hours.

double	m_dTimeStep
	The length of an iteration (a time step) in hours.

double	m_dSimElapsed
	Time simulated so far, in hours.

double	m_dRegularSaveTime
	The time of the next save, in hours from the start of the simulation, if we are saving regularly.

double	m_dRegularSaveInterval
	The interval between regular saves, in hours.

double	m_dUSaveTime [SAVEMAX]
	Save time, in hours from the start of the simukation, if we are not saving regularly.

double	m_dClkLast
	Last value returned by clock()

double	m_dCPUClock
	Total elapsed CPU time.

double	m_dGeoTransform [6]
	GDAL geotransformation info (see http://www.gdal.org/classGDALDataset.html)

double	m_dSeaWaterDensity
	Density of sea water in kg/m**3.

double	m_dInitialMeanSWL
	The start-of-simulation still water level (m)

double	m_dFinalMeanSWL
	The end-of-simulation still water (m), is same as m_dInitialMeanSWL unless SWL changes.

double	m_dDeltaSWLPerTimestep
	If long-term SWL changes, the increment per timestep.

double	m_dThisIterSWL
	The still water level for this timestep (this includes tidal changes and any long-term SWL change)

double	m_dThisIterMeanSWL
	The mean still water level for this timestep (does not include tidal changes, but includes any long-term SWL change)

double	m_dAccumulatedSeaLevelChange
	If long-term SWL changes, the total change so far since the start of simulation.

double	m_dMinSWL
	Minimum still water level.

double	m_dMaxSWL
	Maximum still water level.

double	m_dThisIterDiffTotWaterLevel
	TODO 007 Info needed.

double	m_dThisIterDiffWaveSetupWaterLevel
	TODO 007 Info needed.

double	m_dThisIterDiffWaveSetupSurgeWaterLevel
	TODO 007 Info needed.

double	m_dThisIterDiffWaveSetupSurgeRunupWaterLevel
	TODO 007 Info needed.

double	m_dBreakingWaveHeight
	The height of breaking waves (m)

double	m_dC_0
	Deep water wave speed (m/s)

double	m_dL_0
	Deep water wave length (m)

double	m_dWaveDepthRatioForWaveCalcs
	Start depth for wave calculations.

double	m_dBreakingWaveHeightDepthRatio
	Breaking wave height-to-depth ratio.

double	m_dAllCellsDeepWaterWaveHeight
	Deep water wave height (m) for all sea cells.

double	m_dAllCellsDeepWaterWaveAngle
	Deep water wave angle for all sea cells.

double	m_dAllCellsDeepWaterWavePeriod
	Deep water wave period for all sea cells.

double	m_dMaxUserInputWaveHeight
	Maximum deep water wave height.

double	m_dMaxUserInputWavePeriod
	Used to constrain depth of closure.

double	m_dR
	Coast platform resistance to erosion R, see Walkden & Hall, 2011.

double	m_dD50Fine
	The D50 for fine sediment.

double	m_dD50Sand
	The D50 for sand sediment.

double	m_dD50Coarse
	The D50 for coarse sediment.

double	m_dBeachSedimentDensity
	The density of unconsolidated beach sediment (kg/m**3)

double	m_dBeachSedimentPorosity
	The porosity of unconsolidated beach sediment (0 - 1)

double	m_dFineErodibility
	The relative erodibility (0- 1) of fine unconsolidated beach sediment.

double	m_dSandErodibility
	The relative erodibility (0- 1) of sand unconsolidated beach sediment.

double	m_dCoarseErodibility
	The relative erodibility (0- 1) of coarse unconsolidated beach sediment.

double	m_dFineErodibilityNormalized
	Relative erodibility of fine unconsolidated beach sediment, normalized.

double	m_dSandErodibilityNormalized
	Relative erodibility of sand unconsolidated beach sediment, normalized.

double	m_dCoarseErodibilityNormalized
	Relative erodibility of coarse unconsolidated beach sediment, normalized.

double	m_dKLS
	Transport parameter KLS in the CERC equation.

double	m_dKamphuis
	Transport parameter for the Kamphuis equation.

double	m_dG
	Gravitational acceleration (m**2/sec)

double	m_dInmersedToBulkVolumetric
	For beach erosion/deposition, conversion from immersed weight to bulk volumetric (sand and voids) transport rate (Leo Van Rijn) TODO 007 Need date of reference.

double	m_dDepthOfClosure
	Depth of closure (in m) TODO 007 can be calculated using Hallermeier, R.J. (1978) or Birkemeier (1985) TODO 045 This needs to be a user decision.

double	m_dCoastNormalSpacing
	Average spacing of the coastline-normal profiles, in m.

double	m_dCoastNormalInterventionSpacing
	Average spacing of the coastline-normal profiles on interventions, in m.

double	m_dCoastNormalLength
	Length of the coastline-normal profiles, in m.

double	m_dThisIterTotSeaDepth
	Total sea depth (m) for this iteration.

double	m_dThisIterPotentialPlatformErosion
	Total potential platform erosion (all size classes of consolidated sediment) for this iteration (depth in m)

double	m_dThisIterActualPlatformErosionFineCons
	Total actual platform erosion (fine consolidated sediment) for this iteration (depth in m)

double	m_dThisIterActualPlatformErosionSandCons
	Total actual platform erosion (sand consolidated sediment) for this iteration (depth in m)

double	m_dThisIterActualPlatformErosionCoarseCons
	Total actual platform erosion (coarse consolidated sediment) for this iteration (depth in m)

double	m_dThisIterPotentialBeachErosion
	Total potential beach erosion (all size classes of unconsolidated sediment) for this iteration (depth in m)

double	m_dThisIterBeachErosionFine
	Total actual beach erosion (fine unconsolidated sediment) for this iteration (depth in m)

double	m_dThisIterBeachErosionSand
	Total actual beach erosion (sand unconsolidated sediment) for this iteration (depth in m)

double	m_dThisIterBeachErosionCoarse
	Total actual beach erosion (coarse unconsolidated sediment) for this iteration (depth in m)

double	m_dThisIterBeachDepositionSand
	Total beach deposition (sand unconsolidated sediment) for this iteration (depth in m)

double	m_dThisIterBeachDepositionCoarse
	Total beach deposition (coarse unconsolidated sediment) for this iteration (depth in m)

double	m_dThisIterFineSedimentToSuspension
	Total fine unconsolidated sediment in suspension for this iteration (depth in m)

double	m_dThisIterPotentialSedLostBeachErosion
	Total unconsolidated sediment from beach erosion (all size classes) lost from the grid this iteration (depth in m)

double	m_dThisIterLeftGridUnconsFine
	Total fine unconsolidated sediment lost from the grid this iteration (depth in m)

double	m_dThisIterLeftGridUnconsSand
	Total sand unconsolidated sediment lost from the grid this iteration (depth in m)

double	m_dThisIterLeftGridUnconsCoarse
	Total coarse unconsolidated sediment lost from the grid this iteration (depth in m)

double	m_dThisIterCliffCollapseFineErodedDuringDeposition
	Total fine sediment eroded during Dean profile deposition of talus following cliff collapse (depth in m)

double	m_dThisIterCliffCollapseSandErodedDuringDeposition
	Total sand sediment eroded during Dean profile deposition of talus following cliff collapse (depth in m)

double	m_dThisIterCliffCollapseCoarseErodedDuringDeposition
	Total coarse sediment eroded during Dean profile deposition of talus following cliff collapse (depth in m)

double	m_dDepositionSandDiff
	Error term: if we are unable to deposit enough unconslidated sand on polygon(s), this is held over to be deposited the next iteration.

double	m_dDepositionCoarseDiff
	Error term: if we are unable to deposit enough unconslidated coarse on polygon(s), this is held over to be deposited the next iteration.

double	m_dDepthOverDBMax
	Maximum value of deoth over DB, is used in erosion potential look-up function.

double	m_dTotPotentialPlatformErosionOnProfiles
	Total potential platform erosion on profiles.

double	m_dTotPotentialPlatformErosionBetweenProfiles
	Total potential platform erosion between profiles.

double	m_dProfileMaxSlope
	Maximum slope on coastline-normal profiles.

double	m_dMaxBeachElevAboveSWL
	Maximum elevation of beach above SWL (m)

double	m_dCliffErosionResistance
	Resistance of cliff to notch erosion.

double	m_dNotchDepthAtCollapse
	Notch overhang (i.e. length of horizontal incision) to initiate collapse (m)

double	m_dNotchBaseBelowSWL
	Notch base below SWL (m)

double	m_dCliffDepositionA
	Scale parameter A for cliff deposition (m^(1/3)), may be zero for auto-calculation.

double	m_dCliffDepositionPlanviewWidth
	Planview width of cliff collapse talus (m)

double	m_dCliffTalusMinDepositionLength
	Planview length of cliff deposition talus (m)

double	m_dMinCliffTalusHeightFrac
	Minimum height of the landward end of cliff collapse talus, as a fraction of cliff elevation.

double	m_dThisIterCliffCollapseErosionFineUncons
	This-iteration total of fine unconsolidated sediment produced by cliff collapse (m^3)

double	m_dThisIterCliffCollapseErosionSandUncons
	This-iteration total of sand unconsolidated sediment produced by cliff collapse (m^3)

double	m_dThisIterCliffCollapseErosionCoarseUncons
	This-iteration total of coarse unconsolidated sediment produced by cliff collapse (m^3)

double	m_dThisIterCliffCollapseErosionFineCons
	This-iteration total of fine consolidated sediment produced by cliff collapse (m^3)

double	m_dThisIterCliffCollapseErosionSandCons
	This-iteration total of sand consolidated sediment produced by cliff collapse (m^3)

double	m_dThisIterCliffCollapseErosionCoarseCons
	This-iteration total of coarse consolidated sediment produced by cliff collapse (m^3)

double	m_dThisIterUnconsSandCliffDeposition
	This-iteration total of sand unconsolidated sediment deposited due to cliff collapse (m^3)

double	m_dThisIterUnconsCoarseCliffDeposition
	This-iteration total of coarse unconsolidated sediment deposited due to cliff collapse (m^3)

double	m_dCoastNormalRandSpacingFactor
	Random factor for spacing of along-coast normals.

double	m_dDeanProfileStartAboveSWL
	Berm height i.e. height above SWL of start of depositional Dean profile.

double	m_dGISMissingValue
	The value for floating-point missing values, as read from GIS input files.

double	m_dMissingValue
	Used by CoastalME for floating-point missing values.

double	m_dWaveDataWrapHours
	Number of hours after which deep water wave data wraps.

double	m_dThisIterTopElevMax
	This-iteration highest elevation of DEM.

double	m_dThisIterTopElevMin
	This-iteration lowest elevation of DEM.

double	m_dThisiterUnconsFineInput
	Depth (m) of fine unconsolidated sediment added, at this iteration.

double	m_dThisiterUnconsSandInput
	Depth (m) of sand unconsolidated sediment added, at this iteration.

double	m_dThisiterUnconsCoarseInput
	Depth (m) of coarse unconsolidated sediment added, at this iteration.

double	m_dStartIterSuspFineAllCells
	Depth (m) of fine suspended sediment at the start of the simulation, all cells (both inside and outside polygons)

double	m_dStartIterSuspFineInPolygons
	Depth (m) of fine suspended sediment at the start of the simulation (only cells in polygons)

double	m_dStartIterUnconsFineAllCells
	Depth (m) of fine unconsolidated sediment at the start of the simulation, all cells (both inside and outside polygons)

double	m_dStartIterUnconsSandAllCells
	Depth (m) of sand unconsolidated sediment at the start of the simulation, all cells (both inside and outside polygons)

double	m_dStartIterUnconsCoarseAllCells
	Depth (m) of coarse unconsolidated sediment at the start of the simulation, all cells (both inside and outside polygons)

double	m_dStartIterConsFineAllCells
	Depth (m) of fine consolidated sediment at the start of the simulation, all cells (both inside and outside polygons)

double	m_dStartIterConsSandAllCells
	Depth (m) of sand consolidated sediment at the start of the simulation, all cells (both inside and outside polygons)

double	m_dStartIterConsCoarseAllCells
	Depth (m) of coarse consolidated sediment at the start of the simulation, all cells (both inside and outside polygons)

double	m_dTotalFineUnconsInPolygons
	Total fine unconsolidated sediment in all polygons, before polygon-to-polygon movement (only cells in polygons)

double	m_dTotalSandUnconsInPolygons
	Total sand unconsolidated sediment in all polygons, before polygon-to-polygon movement (only cells in polygons)

double	m_dTotalCoarseUnconsInPolygons
	Total coarse unconsolidated sediment in all polygons, before polygon-to-polygon movement (only cells in polygons)

double	m_dTotalFineConsInPolygons
	Total fine consolidated sediment in all polygons, before polygon-to-polygon movement (only cells in polygons)

double	m_dTotalSandConsInPolygons
	Total sand consolidated sediment in all polygons, before polygon-to-polygon movement (only cells in polygons)

double	m_dTotalCoarseConsInPolygons
	Total coarse consolidated sediment in all polygons, before polygon-to-polygon movement (only cells in polygons)

double	m_dUnconsSandNotDepositedLastIter
	Depth of unconsolidated sand sediment that could not be deposited during the last iteration, carried forward to this iteration.

double	m_dUnconsCoarseNotDepositedLastIter
	Depth of unconsolidated coarse sediment that could not be deposited during the last iteration, carried forward to this iteration.

long double	m_ldGTotPotentialPlatformErosion
	All-simulation total of potential platform erosion (m), all size classes.

long double	m_ldGTotFineActualPlatformErosion
	All-simulation total of fine sediment actual platform erosion (m)

long double	m_ldGTotSandActualPlatformErosion
	All-simulation total of sand sediment actual platform erosion (m)

long double	m_ldGTotCoarseActualPlatformErosion
	All-simulation total of coarse sediment actual platform erosion (m)

long double	m_ldGTotPotentialSedLostBeachErosion
	All-simulation total of potential sediment lost via beach (unconsolidated) sediment movement (m), all size classes.

long double	m_ldGTotActualFineLostBeachErosion
	All-simulation total of fine sediment lost via beach (unconsolidated) sediment movement (m)

long double	m_ldGTotActualSandLostBeachErosion
	All-simulation total of sand sediment lost via beach (unconsolidated) sediment movement (m)

long double	m_ldGTotActualCoarseLostBeachErosion
	All-simulation total of coarse sediment lost via beach (unconsolidated) sediment movement (m)

long double	m_ldGTotSandSedLostCliffCollapse
	All-simulation total of sand sediment lost via cliff collapse (m)

long double	m_ldGTotCoarseSedLostCliffCollapse
	All-simulation total of coarse sediment lost via cliff collapse (m)

long double	m_ldGTotCliffCollapseFine
	All-simulation total of fine sediment from cliff collapse (m)

long double	m_ldGTotCliffCollapseSand
	All-simulation total of sand sediment from cliff collapse (m)

long double	m_ldGTotCliffCollapseCoarse
	All-simulation total of coarse sediment from cliff collapse (m)

long double	m_ldGTotCliffTalusFineToSuspension
	All-simulation total of fine sediment moved to suspension, due to cliff collapse (m)

long double	m_ldGTotCliffTalusSandDeposition
	All-simulation total of sand sediment deposited as talus following cliff collapse (m)

long double	m_ldGTotCliffTalusCoarseDeposition
	All-simulation total of coarse sediment deposited as talus following cliff collapse (m)

long double	m_ldGTotCliffCollapseFineErodedDuringDeposition
	All-simulation total of fine sediment eroded during talus deposition following cliff collapse (m)

long double	m_ldGTotCliffCollapseSandErodedDuringDeposition
	All-simulation total of sand sediment eroded during talus deposition following cliff collapse (m)

long double	m_ldGTotCliffCollapseCoarseErodedDuringDeposition
	All-simulation total of coarse sediment eroded during talus deposition following cliff collapse (m)

long double	m_ldGTotPotentialBeachErosion
	All-simulation total of potential beach erosion (m), all size classes.

long double	m_ldGTotActualFineBeachErosion
	All-simulation total of fine sediment eroded during beach (unconsolidated sediment) movement (m)

long double	m_ldGTotActualSandBeachErosion
	All-simulation total of sand sediment eroded during beach (unconsolidated sediment) movement (m)

long double	m_ldGTotActualCoarseBeachErosion
	All-simulation total of coarse sediment eroded during beach (unconsolidated sediment) movement (m)

long double	m_ldGTotSandBeachDeposition
	All-simulation total of sand sediment deposited during beach (unconsolidated sediment) movement (m)

long double	m_ldGTotCoarseBeachDeposition
	All-simulation total of coarse sediment deposited during beach (unconsolidated sediment) movement (m)

long double	m_ldGTotSuspendedSediment
	All-simulation total of suspended sediment (m)

long double	m_ldGTotSandDepositionDiff
	All-simulation total of shortfall in unconsolidated sand sediment deposition (m, not currently used)

long double	m_ldGTotCoarseDepositionDiff
	All-simulation total of shortfall in unconsolidated coarse sediment deposition (m, not currently used)

long double	m_ldGTotFineSedimentInput
	All-simulation total of fine sediment input (m)

long double	m_ldGTotSandSedimentInput
	All-simulation total of sand sediment input (m)

long double	m_ldGTotCoarseSedimentInput
	All-simulation total of coarse sediment input (m)

string	m_strCMEDir
	The CME folder.

string	m_strCMEIni
	Folder for the CME .ini file.

string	m_strMailAddress
	An email addresx to which to send end-of-simulation messages.

string	m_strDataPathName
	Folder in which the CME data file is found.

string	m_strRasterGISOutFormat
	Base name for CME raster GIS output files.

string	m_strVectorGISOutFormat
	Base name for CME vector GIS output files.

string	m_strInitialBasementDEMFile
	Name of initial basement DEM file.

string	m_strInitialLandformFile
	Name of initial landform file.

string	m_strInterventionClassFile
	Name of intervention class file.

string	m_strInterventionHeightFile
	Name of intervention height file.

string	m_strInitialSuspSedimentFile
	Name of initial suspended sediment file.

string	m_strSCAPEShapeFunctionFile
	Name of SCAPE shape function file.

string	m_strTideDataFile
	Name of tide data file.

string	m_strLogFile
	Name of output log file.

string	m_strOutPath
	Path for all output files.

string	m_strOutFile
	Name of main output file.

string	m_strGDALBasementDEMDriverCode
	GDAL code for the basement DEM raster file type.

string	m_strGDALBasementDEMDriverDesc
	GDAL description of the basement DEM raster file type.

string	m_strGDALBasementDEMProjection
	GDAL projection string for the basement DEM raster file.

string	m_strGDALBasementDEMDataType
	GDAL data type for the basement DEM raster file.

string	m_strGDALLDriverCode
	GDAL code for the for the initial landform class raster file.

string	m_strGDALLDriverDesc
	GDAL description of the initial landform class raster file.

string	m_strGDALLProjection
	GDAL projection string for the initial landform class raster file.

string	m_strGDALLDataType
	GDAL data type for the initial landform class raster file.

string	m_strGDALICDriverCode
	GDAL code for the initial intervention class raster file.

string	m_strGDALICDriverDesc
	GDAL description of the initial intervention class raster file.

string	m_strGDALICProjection
	GDAL projection string for the initial intervention class raster file.

string	m_strGDALICDataType
	GDAL data type of the initial intervention class raster file.

string	m_strGDALIHDriverCode
	GDAL code for the initial intervention height raster file.

string	m_strGDALIHDriverDesc
	GDAL description for the initial intervention height raster file.

string	m_strGDALIHProjection
	GDAL projection string for the initial intervention height raster file.

string	m_strGDALIHDataType
	GDAL data type for the initial intervention height raster file.

string	m_strGDALIWDriverCode
	GDAL code for the initial water depth raster file.

string	m_strGDALIWDriverDesc
	GDAL description for the initial water depth raster file.

string	m_strGDALIWProjection
	GDAL projection string for the initial water depth raster file.

string	m_strGDALIWDataType
	GDAL data type for the initial water depth raster file.

string	m_strGDALISSDriverCode
	GDAL code for the initial suspended sediment raster file.

string	m_strGDALISSDriverDesc
	GDAL description for the initial suspended sediment raster file.

string	m_strGDALISSProjection
	GDAL projection string for the initial suspended sediment raster file.

string	m_strGDALISSDataType
	GDAL data type for the initial suspended sediment raster file.

string	m_strOGRDWWVDriverCode
	GDAL code for the deep water wave stations vector file.

string	m_strOGRDWWVDriverDesc

string	m_strOGRDWWVGeometry
	GDAL geometry for the deep water wave stations vector file.

string	m_strOGRDWWVDataType
	GDAL data type for the deep water wave stations vector file.

string	m_strOGRSedInputDriverCode
	GDAL code for the sediment input event locations vector file.

string	m_strOGRSedInputDriverDesc

string	m_strOGRSedInputGeometry
	GDAL geometry for the sediment input event locations vector file.

string	m_strOGRSedInputDataType
	GDAL data type for the sediment input event locations vector file.

string	m_strOGRFloodDriverCode
	GDAL code for the flood input locations point or vector file.

string	m_strOGRFloodDriverDesc

string	m_strOGRFloodGeometry
	GDAL geometry for the flood input locations point or vector file.

string	m_strOGRFloodDataType
	GDAL data type for the flood input locations point or vector file.

string	m_strGDALRasterOutputDriverLongname
	GDAL raster output driver long name.

string	m_strGDALRasterOutputDriverExtension
	GDAL raster output driver file extension.

string	m_strOGRVectorOutputExtension
	GDAL-OGR vector output drive file extension.

string	m_strRunName
	The name of this simulation.

string	m_strDurationUnits
	The duration units for this simulation.

string	m_strDeepWaterWaveStationsShapefile
	The name of the deep water wave stations shape file.

string	m_strDeepWaterWavesInputFile
	The name of the deep water wave stations time series file.

string	m_strSedimentInputEventShapefile
	The name of the sediment input events shape file.

string	m_strSedimentInputEventFile
	The name of the sediment input events time series file.

string	m_strFloodLocationShapefile
	The name of the flood loction events shape file.

time_t	m_tSysStartTime
	System start-simulation time.

time_t	m_tSysEndTime
	System finish-simulation time.

ofstream	OutStream
	The main output file stream.

ofstream	SeaAreaTSStream
	Sea area time series file output stream.

ofstream	StillWaterLevelTSStream
	SWL time series file output stream.

ofstream	PlatformErosionTSStream
	Shore platform erosion time series file output stream.

ofstream	CliffCollapseErosionTSStream
	Cliff collapse erosion time series file output stream.

ofstream	CliffCollapseDepositionTSStream
	Cliff collapse deposition time series file output stream.

ofstream	CliffCollapseNetChangeTSStream
	Cliff collapse net change (erosion - deposition) time series file output stream.

ofstream	BeachErosionTSStream
	Beach sediment erosion time series file output stream.

ofstream	BeachDepositionTSStream
	Beach sediment deposition time series file output stream.

ofstream	BeachSedimentNetChangeTSStream
	Beach sediment net change (erosion - deposition) time series file output stream.

ofstream	FineSedSuspensionTSStream
	Fine sediment in suspension time series file output stream.

ofstream	FloodSetupSurgeTSStream
	Flood setup surge time series file output stream.

ofstream	FloodSetupSurgeRunupTSStream
	Flood setup surge runup time series file output stream.

vector< bool >	m_bConsChangedThisIter
	One element per layer: has the consolidated sediment of this layer been changed during this iteration?

vector< bool >	m_bUnconsChangedThisIter
	One element per layer: has the consolidated sediment of this layer been changed during this iteration?

vector< int >	m_VnProfileToSave
	The numbers of the profiles which are to be saved.

vector< int >	m_VnDeepWaterWaveStationID
	ID for deep water wave station, this corresponds with the ID in the wave time series file.

vector< int >	m_VnSedimentInputLocationID
	ID for sediment input location, this corresponds with the ID in the sediment input time series file.

vector< int >	m_VnFloodLocationID
	ID for flood location.

vector< int >	m_VnSavGolIndexCoast
	Savitzky-Golay shift index for the coastline vector(s)

vector< unsigned long >	m_VulProfileTimestep
	Timesteps at which to save profiles.

vector< unsigned long >	m_VlDeepWaterWaveValuesAtTimestep
	Calculate deep water wave values at these timesteps.

vector< double >	m_VdSliceElev
	Elevations for raster slice output.

vector< double >	m_VdErosionPotential
	For erosion potential lookup.

vector< double >	m_VdDepthOverDB
	For erosion potential lookup.

vector< double >	m_VdSavGolFCRWCoast
	Savitzky-Golay filter coefficients for the coastline vector(s)

vector< double >	m_VdSavGolFCGeomProfile
	Savitzky-Golay filter coefficients for the profile vectors.

vector< double >	m_VdTideData
	Tide data: one record per timestep, is the change (m) from still water level for that timestep.

vector< double >	m_VdDeepWaterWaveStationX
	X coordinate (grid CRS) for deep water wave station.

vector< double >	m_VdDeepWaterWaveStationY
	Y coordinate (grid CRS) for deep water wave station.

vector< double >	m_VdThisIterDeepWaterWaveStationHeight
	This-iteration wave height at deep water wave station.

vector< double >	m_VdThisIterDeepWaterWaveStationAngle
	This-iteration wave orientation at deep water wave station.

vector< double >	m_VdThisIterDeepWaterWaveStationPeriod
	This-iteration wave period at deep water wave station.

vector< double >	m_VdTSDeepWaterWaveStationHeight
	Time series of wave heights at deep water wave station.

vector< double >	m_VdTSDeepWaterWaveStationAngle
	Time series of wave orientation at deep water wave station.

vector< double >	m_VdTSDeepWaterWaveStationPeriod
	Time series of wave period at deep water wave station.

vector< double >	m_VdSedimentInputLocationX
	X coordinate (grid CRS) for sediment input event.

vector< double >	m_VdSedimentInputLocationY
	X coordinate (grid CRS) for sediment input event.

vector< double >	m_VdFloodLocationX
	X coordinate (grid CRS) for total water level flooding.

vector< double >	m_VdFloodLocationY
	X coordinate (grid CRS) for total water level flooding.

vector< string >	m_VstrInitialFineUnconsSedimentFile
	The name of the initial fine-sized unconsolidated sediment GIS file.

vector< string >	m_VstrInitialSandUnconsSedimentFile
	The name of the initial sand-sized unconsolidated sediment GIS file.

vector< string >	m_VstrInitialCoarseUnconsSedimentFile
	The name of the initial coarse-sized unconsolidated sediment GIS file.

vector< string >	m_VstrInitialFineConsSedimentFile
	The name of the initial fine-sized consolidated sediment GIS file.

vector< string >	m_VstrInitialSandConsSedimentFile
	The name of the initial sand-sized consolidated sediment GIS file.

vector< string >	m_VstrInitialCoarseConsSedimentFile
	The name of the initial coarse-sized consolidated sediment GIS file.

vector< string >	m_VstrGDALIUFDriverCode
	GDAL driver code for the initial unconsolidated fine sediment GIS data.

vector< string >	m_VstrGDALIUFDriverDesc
	GDAL driver description for the initial unconsolidated fine sediment GIS data.

vector< string >	m_VstrGDALIUFProjection
	GDAL projection for the initial unconsolidated fine sediment GIS data.

vector< string >	m_VstrGDALIUFDataType
	GDAL data type for the initial unconsolidated fine sediment GIS data.

vector< string >	m_VstrGDALIUSDriverCode
	GDAL driver code for the initial unconsolidated sand sediment GIS data.

vector< string >	m_VstrGDALIUSDriverDesc
	GDAL driver description for the initial unconsolidated sand sediment GIS data.

vector< string >	m_VstrGDALIUSProjection
	GDAL projection for the initial unconsolidated sand sediment GIS data.

vector< string >	m_VstrGDALIUSDataType
	GDAL data type for the initial unconsolidated sand sediment GIS data.

vector< string >	m_VstrGDALIUCDriverCode
	GDAL driver code for the initial unconsolidated coarse sediment GIS data.

vector< string >	m_VstrGDALIUCDriverDesc
	GDAL driver description for the initial unconsolidated coarse sediment GIS data.

vector< string >	m_VstrGDALIUCProjection
	GDAL projection for the initial unconsolidated coarse sediment GIS data.

vector< string >	m_VstrGDALIUCDataType
	GDAL data type for the initial unconsolidated coarse sediment GIS data.

vector< string >	m_VstrGDALICFDriverCode
	GDAL driver code for the initial consolidated fine sediment GIS data.

vector< string >	m_VstrGDALICFDriverDesc
	GDAL driver description for the initial consolidated fine sediment GIS data.

vector< string >	m_VstrGDALICFProjection
	GDAL projection for the initial consolidated fine sediment GIS data.

vector< string >	m_VstrGDALICFDataType
	GDAL data type for the initial consolidated fine sediment GIS data.

vector< string >	m_VstrGDALICSDriverCode
	GDAL driver code for the initial consolidated sand sediment GIS data.

vector< string >	m_VstrGDALICSDriverDesc
	GDAL driver description for the initial consolidated sand sediment GIS data.

vector< string >	m_VstrGDALICSProjection
	GDAL dprojection for the initial consolidated sand sediment GIS data.

vector< string >	m_VstrGDALICSDataType
	GDAL data type for the initial consolidated sand sediment GIS data.

vector< string >	m_VstrGDALICCDriverCode
	GDAL driver code for the initial consolidated coarse sediment GIS data.

vector< string >	m_VstrGDALICCDriverDesc
	GDAL driver decription for the initial consolidated coarse sediment GIS data.

vector< string >	m_VstrGDALICCProjection
	GDAL projection for the initial consolidated coarse sediment GIS data.

vector< string >	m_VstrGDALICCDataType
	GDAL data type for the initial consolidated coarse sediment GIS data.

CGeomRasterGrid *	m_pRasterGrid
	Pointer to the raster grid object.

vector< CRWCoast >	m_VCoast
	The coastline objects.

vector< CRWCoast >	m_VFloodWaveSetupSurge
	TODO 007 Info needed.

vector< CRWCoast >	m_VFloodWaveSetupSurgeRunup
	TODO 007 Info needed.

vector< CGeomCoastPolygon * >	m_pVCoastPolygon
	Pointers to coast polygon objects, in down-coast sequence TODO 044 Will need to use global polygon ID here to support multiple coastlines.

vector< CGeom2DIPoint >	m_VEdgeCell
	Edge cells.

vector< int >	m_VEdgeCellEdge
	The grid edge that each edge cell belongs to.

vector< int >	m_VCellFloodLocation
	The location to compute the total water level for flooding.

vector< CSedInputEvent * >	m_pVSedInputEvent
	Sediment input events.

default_random_engine	m_Rand [NUMBER_OF_RNGS]
	The c++11 random number generators.

normal_distribution< double >	m_dGetFromUnitNormalDist {0.0, 1.0}
	c++11 unit normal distribution (mean = 0, stdev = 1)

Detailed Description

This class runs CoastalME simulations.

TODO 001 This is a more detailed description of the CSimulation class

Author: David Favis-Mortlock; Andres Payo

Date: 2025

Copyright: GNU General Public License

Definition at line 68 of file simulation.h.

Constructor & Destructor Documentation

◆ CSimulation()

CSimulation::CSimulation ( void )

The CSimulation constructor.

Definition at line 68 of file simulation.cpp.

◆ ~CSimulation()

staticprivate

Announce the end of the simulation.

Definition at line 1445 of file utils.cpp.

Referenced by nDoSimulation().

◆ AnnounceStart()

void CSimulation::AnnounceStart ( void )

staticprivate

Tells the user that we have started the simulation.

Definition at line 197 of file utils.cpp.

Referenced by nDoSimulation().

◆ AppendEnsureNoGap()

void CSimulation::AppendEnsureNoGap	(	vector< CGeom2DIPoint > *	pVPtiPoints,
		CGeom2DIPoint const *	pPti )

staticprivate

Appends a CGeom2DIPoint to a vector<CGeom2DIPoint>, making sure that the new end point touches the previous end point i.e. that there is no gap between the two points.

Definition at line 2500 of file utils.cpp.

Referenced by nLocateAndCreateGridEdgeProfile().

◆ AppendPolygon()

void CSimulation::AppendPolygon ( CGeomCoastPolygon * pPolygon )

Appends a pointer to a coast polygon to the coast polygon vector.

Appends a pointer to a coast polygon, to the down-coast coast polygon vector.

Definition at line 2956 of file utils.cpp.

◆ bCheckForIntersection()

bool CSimulation::bCheckForIntersection	(	CGeomProfile * const	pVProfile1,
		CGeomProfile * const	pVProfile2,
		int &	nProfile1LineSegment,
		int &	nProfile2LineSegment,
		double &	dXIntersect,
		double &	dYIntersect,
		double &	dXAvgEnd,
		double &	dYAvgEnd )

staticprivate

Checks all line segments of a pair of coastline-normal profiles for intersection. If the lines intersect, returns true with the numbers of the line segments at which intersection occurs in nProfile1LineSegment and nProfile1LineSegment, the intersection point in dXIntersect and dYIntersect, and the 'average' seaward endpoint of the two intersecting profiles at dXAvgEnd and dYAvgEnd.

Definition at line 1336 of file create_profiles.cpp.

Referenced by CheckForIntersectingProfiles().

◆ bCheckRasterGISOutputFormat()

bool CSimulation::bCheckRasterGISOutputFormat ( void )

private

Checks whether the selected raster GDAL driver supports file creation, 32-bit doubles, etc.

Definition at line 716 of file gis_utils.cpp.

Referenced by nDoSimulation().

◆ bCheckVectorGISOutputFormat()

bool CSimulation::bCheckVectorGISOutputFormat ( void )

private

Checks whether the selected vector OGR driver supports file creation etc.

Definition at line 873 of file gis_utils.cpp.

Referenced by nDoSimulation().

◆ bCreateErosionPotentialLookUp()

bool CSimulation::bCreateErosionPotentialLookUp	(	vector< double > *	VdDepthOverDBIn,
		vector< double > *	VdErosionPotentialIn,
		vector< double > *	VdErosionPotentialFirstDerivIn )

private

Creates a look-up table for erosion potential, given depth over DB.

Definition at line 1041 of file do_shore_platform_erosion.cpp.

Referenced by nReadShapeFunctionFile().

◆ bElevAboveDeanElev()

bool CSimulation::bElevAboveDeanElev	(	int const	nX,
		int const	nY,
		double const	dElevDiff,
		CRWCellLandform const *	pLandform )

private

Return true if the given elevation is higher than the Dean elevation (and other conditions are met), which means that we could have beach erosion.

Definition at line 1860 of file do_beach_within_polygon.cpp.

Referenced by nDoUnconsDepositionOnPolygon().

◆ bFindExeDir()

bool CSimulation::bFindExeDir ( char const * pcArg )

private

Finds the folder (directory) in which the CoastalME executable is located.

Definition at line 229 of file utils.cpp.

Referenced by nDoSimulation().

◆ bIsInterventionCell()

bool CSimulation::bIsInterventionCell	(	int const	nX,
		int const	nY ) const

private

Returns true if the cell is an intervention.

Definition at line 2928 of file utils.cpp.

Referenced by GetRasterOutputMinMax(), LSmoothCoastRunningMean(), LSmoothCoastSavitzkyGolay(), nAssignLandformsForAllCoasts(), nDoCliffCollapseDeposition(), nDoParallelProfileUnconsErosion(), nDoUnconsDepositionOnPolygon(), nDoUnconsErosionOnPolygon(), nTraceCoastLine(), and nTraceFloodCoastLine().

◆ bIsWithinPolygon()

bool CSimulation::bIsWithinPolygon	(	CGeom2DPoint const *	pPtStart,
		vector< CGeom2DPoint > const *	pPtPoints )

staticprivate

Determines whether a point is within a polygon: however if the point is exactly on the edge of the polygon, then the result is indeterminate. Modified from code at http://alienryderflex.com/polygon/, our thanks to Darel Rex Finley (Darel.nosp@m.Rex@.nosp@m.gmail.nosp@m..com)

Definition at line 988 of file create_polygons.cpp.

Referenced by PtFindPointInPolygon().

◆ bIsWithinValidGrid() [1/2]

bool CSimulation::bIsWithinValidGrid ( CGeom2DIPoint const * Pti ) const

private

Checks whether the supplied point (a reference to a CGeom2DIPoint, in the grid CRS) is within the raster grid, and is a valid cell (i.e. the basement DEM is not NODATA)

Definition at line 198 of file gis_utils.cpp.

◆ bIsWithinValidGrid() [2/2]

bool CSimulation::bIsWithinValidGrid	(	int const	nX,
		int const	nY ) const

private

Checks whether the supplied point (an x-y pair, in the grid CRS) is within the raster grid, and is a valid cell (i.e. the basement DEM is not NODATA)

Definition at line 181 of file gis_utils.cpp.

Referenced by bIsWithinValidGrid(), bSurroundedByDriftCells(), CalcD50AndFillWaveCalcHoles(), ConstructParallelProfile(), CreateRasterizedProfile(), DoShadowZoneAndDownDriftZone(), FillInBeachProtectionHoles(), FillPotentialPlatformErosionHoles(), LSmoothCoastSavitzkyGolay(), nDoAllShadowZones(), nDoParallelProfileUnconsErosion(), nDoSedimentInputEvent(), nDoUnconsDepositionOnPolygon(), nDoUnconsErosionOnPolygon(), nFloodFillShadowZone(), nGetCoastNormalEndPoint(), nTraceCoastLine(), nTraceFloodCoastLine(), RasterizeCliffCollapseProfile(), and RasterizePolygonJoiningLine().

◆ bOnOrOffShoreAndUpOrDownCoast()

bool CSimulation::bOnOrOffShoreAndUpOrDownCoast	(	double const	dCoastAngle,
		double const	dWaveAngle,
		int const	nSeaHand,
		bool &	bDownCoast )

staticprivate

Determines whether the wave orientation at this point on a coast is onshore or offshore, and up-coast (i.e. along the coast in the direction of decreasing coastline point numbers) or down-coast (i.e. along the coast in the direction of increasing coastline point numbers)

Definition at line 52 of file calc_shadow_zones.cpp.

Referenced by nDoAllShadowZones().

◆ bOpenLogFile()

bool CSimulation::bOpenLogFile ( void )

private

Opens the log file.

Definition at line 384 of file utils.cpp.

Referenced by nDoSimulation().

◆ bParseDate()

bool CSimulation::bParseDate	(	string const *	strDate,
		int &	nDay,
		int &	nMonth,
		int &	nYear )

staticprivate

Parses a date string into days, months, and years, and checks each of them.

Definition at line 2666 of file utils.cpp.

Referenced by bReadRunDataFile(), nReadWaveStationInputFile(), and ulConvertToTimestep().

◆ bParseTime()

bool CSimulation::bParseTime	(	string const *	strTime,
		int &	nHour,
		int &	nMin,
		int &	nSec )

private

Calculates the Savitzky-Golay smoothing coefficients for a given size of smoothing window. Derived from a C original by Jean-Pierre Moreau (jpmor.nosp@m.eau@.nosp@m.wanad.nosp@m.oo.f.nosp@m.r, http://jean-pierre.moreau.pagesperso-orange.fr/index.html), to whom we are much indebted.

Definition at line 54 of file smooth_line.cpp.

Referenced by nDoSimulation().

◆ CalcTime()

void CSimulation::CalcTime ( double const dRunLength )

private

Calculates and displays time elapsed in terms of CPU time and real time, also calculates time per timestep in terms of both CPU time and real time.

Definition at line 1453 of file utils.cpp.

◆ CellByCellFillSea()

void CSimulation::CellByCellFillSea	(	int const	nXStart,
		int const	nYStart )

private

Cell-by-cell fills all sea cells starting from a given cell. The cell-by-cell fill (aka 'floodfill') code used here is adapted from an example by Lode Vandevenne (http://lodev.org/cgtutor/floodfill.html#Scanline_Floodfill_Algorithm_With_Stack)

Definition at line 109 of file locate_coast.cpp.

Referenced by FindAllSeaCells().

◆ CheckForIntersectingProfiles()

void CSimulation::CheckForIntersectingProfiles ( void )

private

Checks all coastline-normal profiles for intersection, and modifies those that intersect.

Definition at line 1006 of file create_profiles.cpp.

Referenced by nCheckAllProfiles().

◆ ConstructParallelProfile()

void CSimulation::ConstructParallelProfile	(	int const	nProfileStartX,
		int const	nProfileStartY,
		int const	nParCoastX,
		int const	nParCoastY,
		int const	nProfSize,
		vector< CGeom2DIPoint > * const	pPtViGridProfile,
		vector< CGeom2DIPoint > *	pPtiVGridParProfile,
		vector< CGeom2DPoint > *	pPtVExtCRSParProfile )

private

Constructs a parallel coastline-normal profile.

Definition at line 1288 of file do_shore_platform_erosion.cpp.

Referenced by nCalcPotentialPlatformErosionBetweenProfiles().

◆ CreateRasterizedProfile()

void CSimulation::CreateRasterizedProfile	(	int const	nCoast,
		CGeomProfile *	pProfile,
		vector< CGeom2DIPoint > *	pVIPointsOut,
		vector< bool > *	pbVShared,
		bool &	bTooShort,
		bool &	bTruncated,
		bool &	bHitCoast,
		bool &	bHitLand,
		bool &	bHitIntervention,
		bool &	bHitAnotherProfile )

private

Given a pointer to a coastline-normal profile, returns an output vector of cells which are 'under' every line segment of the profile. If there is a problem with the profile (e.g. a rasterized cell is dry land or coast, or the profile has to be truncated) then we pass this back as an error code.

Definition at line 1526 of file create_profiles.cpp.

Referenced by MarkProfilesOnGrid().

◆ dAngleSubtended()

double CSimulation::dAngleSubtended	(	CGeom2DIPoint const *	pPtiA,
		CGeom2DIPoint const *	pPtiB,
		CGeom2DIPoint const *	pPtiC )

staticprivate

Returns the signed angle BAC (in radians) subtended between three CGeom2DIPoints B A C. From http://stackoverflow.com/questions/3057448/angle-between-3-vertices.

Definition at line 700 of file gis_utils.cpp.

Referenced by ProcessShadowZoneCell().

◆ dCalcBeachProtectionFactor()

double CSimulation::dCalcBeachProtectionFactor	(	int const	nX,
		int const	nY,
		double const	dBreakingWaveHeight )

private

Calculates the (inverse) beach protection factor as in SCAPE: 0 is fully protected, 1 = no protection.

Definition at line 1107 of file do_shore_platform_erosion.cpp.

Referenced by nCalcPotentialPlatformErosionBetweenProfiles(), and nCalcPotentialPlatformErosionOnProfile().

◆ dCalcCurvature()

double CSimulation::dCalcCurvature	(	int const	nHandedness,
		CGeom2DPoint const *	pPtBefore,
		CGeom2DPoint const *	pPtThis,
		CGeom2DPoint const *	pPtAfter )

staticprivate

Calculates signed Menger curvature (https://en.wikipedia.org/wiki/Menger_curvature#Definition) from three points on a line. Returns +ve values for concave, -ve for convex, and zero if the points are co-linear. Curvature is multiplied by 1000 to give easier-to-read numbers.

Definition at line 160 of file calc_curvature.cpp.

Referenced by DoCoastCurvature().

◆ dCalcWaveAngleToCoastNormal()

double CSimulation::dCalcWaveAngleToCoastNormal	(	double const	dCoastAngle,
		double const	dWaveAngle,
		int const	nSeaHand )

staticprivate

Calculates the angle between the wave direction and a normal to the coastline tangent. If wave direction has a component which is down-coast (i.e. in the direction with increasing coast point numbers), then the angle returned is +ve. If wave direction has a component which is up-coast (i.e. in the direction with decreasing coast point numbers), then the angle returned is -ve. If waves are in an off-shore direction, DBL_NODATA is returned.

Definition at line 633 of file calc_waves.cpp.

Referenced by nCalcWavePropertiesOnProfile().

◆ dExtCRSXToGridX()

double CSimulation::dExtCRSXToGridX ( double const dExtCRSX ) const

private

Transforms an X-axis ordinate in the external CRS to the equivalent X-axis ordinate in the raster grid CRS (the result is not rounded, and so may not be integer, and may be outside the grid)

Definition at line 121 of file gis_utils.cpp.

Referenced by DoShadowZoneAndDownDriftZone(), nGetCoastNormalEndPoint(), nReadVectorGISFile(), and RasterizeCliffCollapseProfile().

◆ dExtCRSYToGridY()

double CSimulation::dExtCRSYToGridY ( double const dExtCRSY ) const

private

Transforms a Y-axis ordinate in the external CRS to the equivalent Y-axis ordinate in the raster grid CRS (the result is not rounded, and so may not be integer, and may be outside the grid)

Definition at line 130 of file gis_utils.cpp.

Referenced by DoShadowZoneAndDownDriftZone(), nGetCoastNormalEndPoint(), nReadVectorGISFile(), and RasterizeCliffCollapseProfile().

◆ dGetD50Coarse()

double CSimulation::dGetD50Coarse ( void ) const

Returns the global d50 value for coarse sediment.

Returns D50 for coarse sediment.

Definition at line 591 of file simulation.cpp.

◆ dGetD50Fine()

double CSimulation::dGetD50Fine ( void ) const

Returns the global d50 value for fine sediment.

Returns D50 for fine sediment.

Definition at line 575 of file simulation.cpp.

◆ dGetD50Sand()

double CSimulation::dGetD50Sand ( void ) const

Returns the global d50 value for sand sediment.

Returns D50 for sand sediment.

Definition at line 583 of file simulation.cpp.

◆ dGetDistanceBetween() [1/2]

double CSimulation::dGetDistanceBetween	(	CGeom2DIPoint const *	Pti1,
		CGeom2DIPoint const *	Pti2 )

staticprivate

Returns the distance (in grid units) between two grid cell points.

Definition at line 162 of file gis_utils.cpp.

◆ dGetDistanceBetween() [2/2]

double CSimulation::dGetDistanceBetween	(	CGeom2DPoint const *	Pt1,
		CGeom2DPoint const *	Pt2 )

staticprivate

Returns the distance (in external CRS) between two points.

Definition at line 151 of file gis_utils.cpp.

Referenced by dCalcCurvature(), nCalcPotentialPlatformErosionBetweenProfiles(), nDoAllShadowZones(), nDoPolygonSharedBoundaries(), nDoUnconsDepositionOnPolygon(), and nDoUnconsErosionOnPolygon().

◆ dGetInterpolatedValue() [1/2]

double CSimulation::dGetInterpolatedValue	(	vector< double > const *	pVdXdata,
		vector< double > const *	pVdYdata,
		double	dX,
		bool	bExtrapolate )

private

From https://cplusplus.com/forum/general/216928/ Returns interpolated value at x from parallel arrays (VdXdata, VdYdata). Assumes that VdXdata has at least two elements, is sorted and is strictly monotonically increasing. The boolean argument extrapolate determines behaviour beyond ends of array (if needed). For this version, both lots of data are doubles

Definition at line 40 of file interpolate.cpp.

Referenced by dLookUpErosionPotential(), InterpolateWaveHeightToCoastPoints(), and WriteLookUpData().

◆ dGetInterpolatedValue() [2/2]

double CSimulation::dGetInterpolatedValue	(	vector< int > const *	pVnXdata,
		vector< double > const *	pVdYdata,
		int	nX,
		bool	bExtrapolate )

private

From https://cplusplus.com/forum/general/216928/ Returns interpolated value at x from parallel arrays (VdXdata, VdYdata). Assumes that VdXdata has at least two elements, is sorted and is strictly monotonically increasing. The boolean argument extrapolate determines behaviour beyond ends of array (if needed). For this version, one lot of data is integer and the other is double

Definition at line 80 of file interpolate.cpp.

◆ dGetMissingValue()

double CSimulation::dGetMissingValue ( void ) const

Returns the NODATA value.

Returns the double Missing Value code.

Definition at line 519 of file simulation.cpp.

◆ dGetThisIterSWL()

double CSimulation::dGetThisIterSWL ( void ) const

Returns this timestep's still water level.

Returns the still water level (SWL)

Definition at line 527 of file simulation.cpp.

double CSimulation::dSubtractProfiles	(	vector< double > const *	pdVFirstProfile,
		vector< double > const *	pdVSecondProfile,
		vector< bool > const *	pbVIsValid )

staticprivate

Calculate the total elevation difference between every point in two elevation profiles (first profile - second profile)

Definition at line 2579 of file utils.cpp.

Referenced by nDoCliffCollapseDeposition(), and nDoUnconsErosionOnPolygon().

◆ dTriangleAreax2()

double CSimulation::dTriangleAreax2	(	CGeom2DPoint const *	pPtA,
		CGeom2DPoint const *	pPtB,
		CGeom2DPoint const *	pPtC )

staticprivate

Returns twice the signed area of a triangle.

Definition at line 173 of file gis_utils.cpp.

Referenced by dCalcCurvature().

◆ dVSmoothProfileSlope()

vector< double > CSimulation::dVSmoothProfileSlope ( vector< double > * pdVSlope ) const

private

Does running-mean smoothing of the slope of a coastline-normal profile.

Definition at line 355 of file smooth_line.cpp.

Referenced by nCalcPotentialPlatformErosionBetweenProfiles(), and nCalcPotentialPlatformErosionOnProfile().

◆ ErodeCellBeachSedimentSupplyLimited()

void CSimulation::ErodeCellBeachSedimentSupplyLimited	(	int const	nX,
		int const	nY,
		int const	nThisLayer,
		int const	nTexture,
		double const	dMaxToErode,
		double &	dRemoved )

private

Erodes the unconsolidated beach sediment on a single cell, for a single size class, and returns the depth-equivalents of sediment removed.

Definition at line 688 of file do_beach_within_polygon.cpp.

Referenced by nDoParallelProfileUnconsErosion(), and nDoUnconsDepositionOnPolygon().

◆ FillInBeachProtectionHoles()

void CSimulation::FillInBeachProtectionHoles ( void )

private

Initialize GDAL with performance optimizations.

Definition at line 66 of file gis_raster.cpp.

Referenced by nReadRasterBasementDEM().

◆ InterpolateCShoreOutput()

void CSimulation::InterpolateCShoreOutput	(	vector< double > const *	,
		int const	,
		int const	,
		vector< double > *	,
		vector< double > *	,
		vector< double > *	,
		vector< double > *	,
		vector< double > *	,
		vector< double > *	,
		vector< double > *	,
		vector< double > *	,
		vector< double > *	)

private

Referenced by nCalcWavePropertiesOnProfile().

◆ InterpolateWaveHeightToCoastPoints()

void CSimulation::InterpolateWaveHeightToCoastPoints ( int const nCoast )

private

Linearly interpolates wave properties from profiles to the coastline cells between two profiles.

Definition at line 2134 of file calc_waves.cpp.

Referenced by nDoAllPropagateWaves().

◆ InterpolateWavePropertiesBetweenProfiles()

void CSimulation::InterpolateWavePropertiesBetweenProfiles	(	int const	nCoast,
		int const	nCount )

private

Interpolates wave properties from profiles to the coastline points between two profiles. Do this by weighting the wave properties so that they change smoothly between the two profiles.

Definition at line 1956 of file calc_waves.cpp.

Referenced by nDoAllPropagateWaves().

◆ KeepWithinValidGrid() [1/3]

void CSimulation::KeepWithinValidGrid	(	CGeom2DIPoint const *	Pti0,
		CGeom2DIPoint *	Pti1 ) const

private

Constrains the second supplied point (both are CGeom2DIPoints, in the grid CRS) to be a valid cell within the raster grid.

Definition at line 221 of file gis_utils.cpp.

◆ KeepWithinValidGrid() [2/3]

void CSimulation::KeepWithinValidGrid	(	int &	nX,
		int &	nY ) const

private

Constrains the supplied point (in the grid CRS) to be a valid cell within the raster grid.

Definition at line 209 of file gis_utils.cpp.

Referenced by KeepWithinValidGrid(), LSmoothCoastSavitzkyGolay(), nDoParallelProfileUnconsErosion(), nDoUnconsDepositionOnPolygon(), nDoUnconsErosionOnPolygon(), nGetCoastNormalEndPoint(), RasterizeCliffCollapseProfile(), and RasterizePolygonJoiningLine().

◆ KeepWithinValidGrid() [3/3]

void CSimulation::KeepWithinValidGrid	(	int	nX0,
		int	nY0,
		int &	nX1,
		int &	nY1 ) const

private

Given two points in the grid CRS (the points assumed not to be coincident), this routine modifies the value of the second point so that it is on a line joining the original two points and is a valid cell within the raster grid. However in some cases (e.g. if the first point is at the edge of the valid part of the raster grid) then the second cell will be coincident with the first cell, and the line joining them is thus of zero length. The calling routine has to be able to handle this.

Definition at line 229 of file gis_utils.cpp.

◆ LocateAndCreateProfiles()

void CSimulation::LocateAndCreateProfiles	(	int const	nCoast,
		int &	nProfile,
		int &	nProfileGlobalID,
		vector< bool > *	pbVCoastPointDone,
		vector< pair< int, double > > const *	prVCurvature )

private

For a single coastline, locate the start points for all coastline-normal profiles (except the grid-edge profiles). Then create the profiles.

Definition at line 284 of file create_profiles.cpp.

Referenced by nCreateAllProfiles().

◆ LSmoothCoastRunningMean()

CGeomLine CSimulation::LSmoothCoastRunningMean ( CGeomLine * pLineIn ) const

private

Does running-mean smoothing of a CGeomLine coastline vector (is in external CRS coordinates)

Definition at line 222 of file smooth_line.cpp.

Referenced by nTraceCoastLine().

◆ LSmoothCoastSavitzkyGolay()

CGeomLine CSimulation::LSmoothCoastSavitzkyGolay	(	CGeomLine *	pLineIn,
		int const	nStartEdge,
		int const	nEndEdge ) const

private

Does smoothing of a CGeomLine coastline vector (is in external CRS coordinates) using a Savitzky-Golay filter. Derived from a C original by Jean-Pierre Moreau (jpmor.nosp@m.eau@.nosp@m.wanad.nosp@m.oo.f.nosp@m.r, http://jean-pierre.moreau.pagesperso-orange.fr/index.html), to whom we are much indebted.

Definition at line 87 of file smooth_line.cpp.

Referenced by nTraceCoastLine().

◆ MarkPolygonCells()

void CSimulation::MarkPolygonCells ( void )

private

Marks cells of the raster grid that are within each coastal polygon. The cell-by-cell fill (aka 'floodfill') code used here is adapted from an example by Lode Vandevenne (http://lodev.org/cgtutor/floodfill.html#Scanline_Floodfill_Algorithm_With_Stack)

Definition at line 359 of file create_polygons.cpp.

Referenced by nDoSimulation().

◆ MarkProfilesOnGrid()

void CSimulation::MarkProfilesOnGrid	(	int const	nCoast,
		int &	nValidProfiles )

private

For this coastline, marks all coastline-normal profiles (apart from the two 'special' ones at the start and end of the coast) onto the raster grid, i.e. rasterizes multi-line vector objects onto the raster grid. Note that this doesn't work if the vector has already been interpolated to fit on the grid i.e. if distances between vector points are just one cell apart.

Definition at line 1409 of file create_profiles.cpp.

Referenced by nCheckAllProfiles().

◆ MergeProfilesAtFinalLineSegments()

void CSimulation::MergeProfilesAtFinalLineSegments	(	int const	nCoast,
		CGeomProfile *	pFirstProfile,
		CGeomProfile *	pSecondProfile,
		int const	nFirstProfileLineSegments,
		int const	nSecondProfileLineSegments,
		double const	dIntersectX,
		double const	dIntersectY,
		double const	dAvgEndX,
		double const	dAvgEndY )

private

Merges two profiles which intersect at their final (most seaward) line segments, seaward of their point of intersection.

Definition at line 1748 of file create_profiles.cpp.

Referenced by CheckForIntersectingProfiles().

◆ ModifyBreakingWavePropertiesWithinShadowZoneToCoastline()

void CSimulation::ModifyBreakingWavePropertiesWithinShadowZoneToCoastline	(	int const	nCoast,
		int const	nProfile )

private

Modifies the wave breaking properties at coastline points of profiles within the shadow zone.

Definition at line 1876 of file calc_waves.cpp.

Referenced by nDoAllPropagateWaves().

◆ nAssignLandformsForAllCells()

int CSimulation::nAssignLandformsForAllCells ( void )

private

Each timestep, classify landforms for cells that are not on the coastline.

Definition at line 369 of file assign_landforms.cpp.

Referenced by nDoSimulation().

◆ nAssignLandformsForAllCoasts()

int CSimulation::nAssignLandformsForAllCoasts ( void )

private

Each timestep, classify coastal landforms and assign a coastal landform object to every point on every coastline. If, for a given cell, the coastal landform class has not changed then it inherits values from the previous timestep.

Definition at line 45 of file assign_landforms.cpp.

Referenced by nDoSimulation().

◆ nCalcExternalForcing()

int CSimulation::nCalcExternalForcing ( void )

private

Calculate external forcings: change in still water level, tide level and deep water waves height, orientation and period.

Definition at line 35 of file calc_external_forcing.cpp.

Referenced by nDoSimulation().

◆ nCalcPotentialPlatformErosionBetweenProfiles()

int CSimulation::nCalcPotentialPlatformErosionBetweenProfiles	(	int const	nCoast,
		CGeomProfile *	pProfile,
		int const	nDirection )

private

Calculates potential platform erosion on cells to one side of a given coastline-normal profile, up to the next profile.

Definition at line 411 of file do_shore_platform_erosion.cpp.

Referenced by nDoAllShorePlatFormErosion().

◆ nCalcPotentialPlatformErosionOnProfile()

int CSimulation::nCalcPotentialPlatformErosionOnProfile	(	int const	nCoast,
		CGeomProfile *	pProfile )

private

Calculates potential (i.e. unconstrained by available sediment) erosional lowering of the shore platform for a single coastline-normal profile, due to wave action. This routine uses a behavioural rule to modify the original surface elevation profile geometry, in which erosion rate/slope = f(d/Db) based on Walkden & Hall (2005). Originally coded in Matlab by Andres Payo.

Definition at line 176 of file do_shore_platform_erosion.cpp.

Referenced by nDoAllShorePlatFormErosion().

◆ nCalcWavePropertiesOnProfile()

int CSimulation::nCalcWavePropertiesOnProfile	(	int const	nCoast,
		int const	nCoastSize,
		CGeomProfile *	pProfile,
		vector< double > *	pVdX,
		vector< double > *	pVdY,
		vector< double > *	pVdHeightX,
		vector< double > *	pVdHeightY,
		vector< bool > *	pVbBreaking )

private

Referenced by nCalcWavePropertiesOnProfile().

◆ nCreateProfile()

int CSimulation::nCreateProfile	(	int const	nCoast,
		int const	nCoastSize,
		int const	nProfileStartPoint,
		int const	nProfile,
		int &	pnProfileGlobalID,
		bool const	bIntervention,
		CGeom2DIPoint const *	pPtiStart )

private

Simulates cliff collapse on a single cliff object, which happens when when a notch (incised into a condsolidated sediment layer) exceeds a critical depth. This updates the cliff object, the cell 'under' the cliff object, and the polygon which contains the cliff object.

Definition at line 254 of file do_cliff_collapse.cpp.

Referenced by nDoAllWaveEnergyToCoastLandforms().

◆ nDoCliffCollapseDeposition()

int CSimulation::nDoCliffCollapseDeposition	(	int const	nCoast,
		CRWCliff const *	pCliff,
		double const	dSandFromCollapse,
		double const	dCoarseFromCollapse,
		double const	dPreCollapseCliffElev,
		double const	dPostCollapseCliffElev )

private

Redistributes the sand-sized and coarse-sized sediment from a cliff collapse onto the foreshore, as unconsolidated talus. The talus is added to the existing beach volume (i.e. to the unconsolidated sediment). The shoreline is iteratively advanced seaward until all this volume is accommodated under a Dean equilibrium profile. This equilibrium beach profile is h(y) = A * y^(2/3) where h(y) is the water depth at a distance y from the shoreline and A is a sediment-dependent scale parameter.

Definition at line 526 of file do_cliff_collapse.cpp.

Referenced by nDoAllWaveEnergyToCoastLandforms().

◆ nDoParallelProfileUnconsErosion()

int CSimulation::nDoParallelProfileUnconsErosion	(	CGeomCoastPolygon *	pPolygon,
		int const	nCoastPoint,
		int const	nCoastX,
		int const	nCoastY,
		int const	nTexture,
		int const	nInlandOffset,
		int const	nParProfLen,
		vector< CGeom2DIPoint > const *	pVPtiParProfile,
		vector< double > const *	pVdParProfileDeanElev,
		double &	dStillToErodeOnProfile,
		double &	dStillToErodeOnPolygon,
		double &	dTotEroded )

private

Deposits unconsolidated beach sediment (sand or coarse) on the cells within a polygon. This is done by working down the coastline and constructing profiles which are parallel to the up-coast polygon boundary; then reversing direction and going up-coast, constructing profiles parallel to the down-coast boundary. Then iteratively fit a Dean equilibrium profile until the normal's share of the change in total depth of unconsolidated sediment is accommodated under the revised profile. For deposition, this adds to the beach volume.

Definition at line 762 of file do_beach_within_polygon.cpp.

Referenced by nDoAllActualBeachErosionAndDeposition().

◆ nDoUnconsErosionOnPolygon()

int CSimulation::nDoUnconsErosionOnPolygon	(	int const	nCoast,
		CGeomCoastPolygon *	pPolygon,
		int const	nTexture,
		double const	dErosionTargetOnPolygon,
		double &	dEroded )

private

Erodes unconsolidated beach sediment of one texture class on the cells within a polygon. This is done by working down the coastline and constructing profiles which are parallel to the up-coast polygon boundary; then reversing direction and going up-coast, constructing profiles parallel to the down-coast boundary. Then iteratively fit a Dean equilibrium profile until the normal's share of the change in total depth of unconsolidated sediment is accommodated under the revised profile. For erosion, this reduces the beach volume.

Definition at line 45 of file do_beach_within_polygon.cpp.

Referenced by nDoAllActualBeachErosionAndDeposition().

◆ nFindIndex()

int CSimulation::nFindIndex	(	vector< double > const *	pVdX,
		double const	dValueIn )

private

This is used by VdInterpolateCShoreProfileOutput, it returns the index of the value in pVdX which is less than or equal to the absolute difference between dValueIn and the pVdX value.

Definition at line 120 of file interpolate.cpp.

Referenced by VdInterpolateCShoreProfileOutput().

◆ nFloodFillShadowZone()

int CSimulation::nFloodFillShadowZone	(	int const	nZone,
		CGeom2DIPoint const *	pPtiCentroid,
		CGeom2DIPoint const *	pPtiShadowBoundaryStart,
		CGeom2DIPoint const *	pPtiShadowBoundaryEnd )

private

Cell-by-cell fills a shadow zone from the centroid.

Definition at line 699 of file calc_shadow_zones.cpp.

Referenced by nDoAllShadowZones().

◆ nGetCoastNormalEndPoint()

int CSimulation::nGetCoastNormalEndPoint	(	int const	nCoast,
		int const	nStartCoastPoint,
		int const	nCoastSize,
		CGeom2DPoint const *	pPtStart,
		double const	dLineLength,
		CGeom2DPoint *	pPtEnd,
		CGeom2DIPoint *	pPtiEnd,
		bool const	bIntervention )

private

Finds the end point of a coastline-normal line, given the start point on the vector coastline. All coordinates are in the external CRS.

Definition at line 724 of file create_profiles.cpp.

Referenced by nCreateProfile(), and nDoCliffCollapseDeposition().

◆ nGetCoastPolygonSize()

int CSimulation::nGetCoastPolygonSize ( void ) const

Returns the size of the coast polygon vector.

Definition at line 2939 of file utils.cpp.

Referenced by CRWCoast::nGetNumPolygons(), and WritePolygonInfoTable().

◆ nGetGridXMax()

int CSimulation::nGetGridXMax ( void ) const

Returns the cell size.

Returns X grid max.

Returns the size of the grid in the X direction

Definition at line 559 of file simulation.cpp.

◆ nGetGridYMax()

int CSimulation::nGetGridYMax ( void ) const

Returns the size of the grid in the Y direction.

Returns Y grid max.

Definition at line 567 of file simulation.cpp.

◆ nGetOppositeDirection()

int CSimulation::nGetOppositeDirection ( int const nDirection )

staticprivate

Returns the opposite direction.

Definition at line 1775 of file gis_utils.cpp.

Referenced by nTraceAllCoasts(), and nTraceAllFloodCoasts().

◆ nGetThisProfileElevationsForCShore()

int CSimulation::nGetThisProfileElevationsForCShore	(	int const	nCoast,
		CGeomProfile *	pProfile,
		int const	nProfSize,
		vector< double > *	VdDistXY,
		vector< double > *	VdVZ,
		vector< double > *	VdFricF )

private

Get profile horizontal distance and bottom elevation vectors in CShore units.

Definition at line 1546 of file calc_waves.cpp.

Referenced by nCalcWavePropertiesOnProfile().

◆ nHandleCommandLineParams()

int CSimulation::nHandleCommandLineParams	(	int	nArg,
		char const *	pcArgv[] )

private

Handles command-line parameters.

Definition at line 101 of file utils.cpp.

Referenced by nDoSimulation().

◆ nInitGridAndCalcStillWaterLevel()

int CSimulation::nInitGridAndCalcStillWaterLevel ( void )

private

At the beginning of each timestep: clear vector coasts, profiles, and polygons, initialize the raster grid, and initialize some per-timestep accounting variables.

Definition at line 53 of file init_grid.cpp.

Referenced by nDoSimulation().

◆ nInsertPointIntoProfilesIfNeededThenUpdate()

int CSimulation::nInsertPointIntoProfilesIfNeededThenUpdate	(	int const	nCoast,
		CGeomProfile *	pProfileToRetain,
		double const	dIntersectX,
		double const	dIntersectY,
		int const	nProfileToRetainIntersectLineSeg,
		CGeomProfile *	pProfileToTruncate,
		int const	nProfileToTruncateIntersectLineSeg,
		bool const	bAlreadyPresent )

private

Inserts an intersection point into the profile that is to be retained, if that point is not already present in the profile, then does the same for all co-incident profiles. Finally adds the numbers of the to-truncate profile (and all its coincident profiles) to the seaward line segments of the to-retain profile and all its coincident profiles.

Definition at line 1972 of file create_profiles.cpp.

Referenced by TruncateOneProfileRetainOtherProfile().

◆ nInterpolateAllDeepWaterWaveValues()

int CSimulation::nInterpolateAllDeepWaterWaveValues ( void )

private

If the user supplies multiple deep water wave height and angle values, this routine interplates these to all cells (including dry land cells)

Definition at line 2396 of file gis_raster.cpp.

Referenced by nInitGridAndCalcStillWaterLevel().

◆ nInterpolateWavesToPolygonCells()

int CSimulation::nInterpolateWavesToPolygonCells	(	vector< double > const *	pVdX,
		vector< double > const *	pVdY,
		vector< double > const *	pVdHeightX,
		vector< double > const *	pVdHeightY )

private

Interpolates wave properties from all profiles to all within-polygon sea cells, using GDALGridCreate(), the library version of external utility gdal_grid.

Definition at line 2007 of file gis_raster.cpp.

Referenced by nDoAllPropagateWaves().

◆ nLandformToGrid()

int CSimulation::nLandformToGrid	(	int const	nCoast,
		int const	nPoint )

private

At the end of each timestep, this routine stores the attributes from a single coastal landform object in the grid cell 'under' the object, ready for the next timestep.

Definition at line 290 of file assign_landforms.cpp.

Referenced by nUpdateGrid().

◆ nLocateAndCreateGridEdgeProfile()

int CSimulation::nLocateAndCreateGridEdgeProfile	(	bool const	bCoastStart,
		int const	nCoast,
		int &	nProfile,
		int &	nProfileGlobalID )

private

Creates a 'special' profile at each end of a coastline, at the edge of the raster grid. This profile is not necessarily normal to the coastline since it goes along the grid's edge.

Definition at line 532 of file create_profiles.cpp.

Referenced by nCreateAllProfiles().

◆ nLocateFloodAndCoasts()

int CSimulation::nLocateFloodAndCoasts ( void )

private

First find all connected sea areas, then locate the vector coastline(s), then put these onto the raster grid.

Definition at line 1088 of file locate_coast.cpp.

Referenced by nDoSimulation().

◆ nLocateSeaAndCoasts()

int CSimulation::nLocateSeaAndCoasts ( int & nValidCoast )

private

First find all connected sea areas, then locate the vector coastline(s), then put these onto the raster grid.

Definition at line 56 of file locate_coast.cpp.

Referenced by nDoSimulation().

◆ nMarkBoundingBoxEdgeCells()

int CSimulation::nMarkBoundingBoxEdgeCells ( void )

private

Mark cells which are at the edge of a bounding box which represents the valid part of the grid, as defined by the basement layer. The valid part of the grid may be the whole grid, or only part of the whole grid. The bounding box may be an irregular shape (but may not have re-entrant edges): simple shapes are more likely to work correctly.

Definition at line 276 of file gis_raster.cpp.

Referenced by nDoSimulation().

◆ nReadCShoreOutput()

int CSimulation::nReadCShoreOutput	(	int const	,
		string const *	,
		int const	,
		int const	,
		vector< double > const *	,
		vector< double > *	)

private

Referenced by nCalcWavePropertiesOnProfile().

◆ nReadRasterBasementDEM()

int CSimulation::nReadRasterBasementDEM ( void )

private

Reads a raster DEM of basement elevation data to the Cell array.

Definition at line 94 of file gis_raster.cpp.

Referenced by nDoSimulation().

◆ nReadRasterGISFile()

int CSimulation::nReadRasterGISFile	(	int const	nDataItem,
		int const	nLayer )

private

Locates all the potential coastline start points on the edges of the raster grid, then traces vector coastline(s) from these start points.

Definition at line 236 of file do_surge_flood.cpp.

Referenced by nLocateFloodAndCoasts().

◆ nTraceCoastLine()

int CSimulation::nTraceCoastLine	(	unsigned int const	nTraceFromStartCellIndex,
		int const	nStartSearchDirection,
		int const	nHandedness,
		vector< bool > *	pVbTraced,
		vector< CGeom2DIPoint > const *	pV2DIPossibleStartCell )

private

Traces a coastline (which is defined to be just above still water level) on the grid using the 'wall follower' rule for maze traversal (http://en.wikipedia.org/wiki/Maze_solving_algorithm#Wall_follower). The vector coastlines are then smoothed.

Definition at line 427 of file locate_coast.cpp.

Referenced by nTraceAllCoasts().

◆ nTraceFloodCoastLine()

int CSimulation::nTraceFloodCoastLine	(	unsigned int const	nTraceFromStartCellIndex,
		int const	nStartSearchDirection,
		int const	nHandedness,
		vector< bool > *	pVbTraced,
		vector< CGeom2DIPoint > const *	pV2DIPossibleStartCell )

private

Traces a coastline (which is defined to be just above still water level) on the grid using the 'wall follower' rule for maze traversal (http://en.wikipedia.org/wiki/Maze_solving_algorithm#Wall_follower). The vector coastlines are then smoothed.

Definition at line 338 of file do_surge_flood.cpp.

Referenced by nTraceAllFloodCoasts().

◆ nUpdateGrid()

int CSimulation::nUpdateGrid ( void )

private

Update all cells in the raster raster grid and do some per-timestep accounting.

Definition at line 41 of file update_grid.cpp.

Referenced by nDoSimulation().

◆ nUpdateIntervention()

int CSimulation::nUpdateIntervention ( void )

staticprivate

Check to see if we have a new intervention in place (not yet implemented)

Definition at line 30 of file do_intervention.cpp.

Referenced by nDoSimulation().

◆ nWriteEndRunDetails()

int CSimulation::nWriteEndRunDetails ( void )

private

Writes end-of-run information to Out, Log and time-series files.

Definition at line 1465 of file write_output.cpp.

Referenced by nDoSimulation().

◆ pGetPolygon()

CGeomCoastPolygon * CSimulation::pGetPolygon ( int const nPoly ) const

Returns a pointer to a coast polygon, in down-coast sequence.

Definition at line 2947 of file utils.cpp.

Referenced by CRWCoast::pGetPolygon(), WritePolygonCliffCollapseErosion(), WritePolygonInfoTable(), WritePolygonPotentialErosion(), WritePolygonPreExistingSedimentTable(), WritePolygonSedimentBeforeMovement(), WritePolygonSedimentInputEventTable(), and WritePolygonShorePlatformErosion().

◆ ProcessDownDriftCell()

void CSimulation::ProcessDownDriftCell	(	int const	nX,
		int const	nY,
		int const	nTraversed,
		double const	dTotalToTraverse,
		int const	nZone )

private

Process a single cell which is in the downdrift zone, changing its wave height.

Definition at line 1258 of file calc_shadow_zones.cpp.

Referenced by DoShadowZoneAndDownDriftZone().

◆ ProcessShadowZoneCell()

void CSimulation::ProcessShadowZoneCell	(	int const	nX,
		int const	nY,
		int const	nShadowZoneCoastToCapeSeaHand,
		CGeom2DIPoint const *	pPtiCoast,
		int const	nShadowEndX,
		int const	nShadowEndY,
		int const	nZone )

private

Process a single cell which is in the shadow zone, changing its wave height and orientation.

Definition at line 1315 of file calc_shadow_zones.cpp.

Referenced by DoShadowZoneAndDownDriftZone().

◆ pstrChangeToBackslash()

string CSimulation::pstrChangeToBackslash ( string const * strIn )

staticprivate

Changes all forward slashes in the input string to backslashes, leaving the original unchanged.

Definition at line 2319 of file utils.cpp.

Referenced by bReadRunDataFile(), and nHandleCommandLineParams().

◆ pstrChangeToForwardSlash()

string CSimulation::pstrChangeToForwardSlash ( string const * strIn )

staticprivate

Swaps all backslashes in the input string to forward slashes, leaving the original unchanged.

Definition at line 2329 of file utils.cpp.

Referenced by AnnounceReadBasementDEM(), AnnounceReadDeepWaterWaveValuesGIS(), AnnounceReadFloodLocationGIS(), AnnounceReadICGIS(), AnnounceReadIHGIS(), AnnounceReadInitialCoarseConsSedGIS(), AnnounceReadInitialCoarseUnconsSedGIS(), AnnounceReadInitialFineConsSedGIS(), AnnounceReadInitialFineUnconsSedGIS(), AnnounceReadInitialSandConsSedGIS(), AnnounceReadInitialSandUnconsSedGIS(), AnnounceReadInitialSuspSedGIS(), AnnounceReadLGIS(), AnnounceReadSedimentEventInputValuesGIS(), AnnounceReadTideData(), and WriteStartRunDetails().

◆ PtAverage() [1/2]

CGeom2DPoint CSimulation::PtAverage	(	CGeom2DPoint const *	pPt1,
		CGeom2DPoint const *	pPt2 )

staticprivate

Returns a point (external CRS) which is the average of (i.e. is midway between) two other external CRS points.

Definition at line 413 of file gis_utils.cpp.

Referenced by nCreateAllPolygons(), nGetCoastNormalEndPoint(), and PtFindPointInPolygon().

◆ PtAverage() [2/2]

CGeom2DPoint CSimulation::PtAverage ( vector< CGeom2DPoint > * pVIn )

staticprivate

Returns a point (external CRS) which is the average of a vector of external CRS points.

Definition at line 460 of file gis_utils.cpp.

◆ PtChooseEndPoint()

CGeom2DPoint CSimulation::PtChooseEndPoint	(	int const	nHand,
		CGeom2DPoint const *	PtBefore,
		CGeom2DPoint const *	PtAfter,
		double const	dXEnd1,
		double const	dYEnd1,
		double const	dXEnd2,
		double const	dYEnd2 )

staticprivate

Choose which end point to use for the coastline-normal profile.

Definition at line 851 of file create_profiles.cpp.

Referenced by nGetCoastNormalEndPoint().

◆ PtFindPointInPolygon()

CGeom2DPoint CSimulation::PtFindPointInPolygon	(	vector< CGeom2DPoint > const *	pPtPoints,
		int const	nStartPoint )

staticprivate

Finds a point in a polygon: is guaranteed to succeed, as every strictly closed polygon has at least one triangle that is completely contained within the polygon. Derived from an algorithm at http://stackoverflow.com/questions/9797448/get-a-point-inside-the-polygon.

Definition at line 1022 of file create_polygons.cpp.

◆ PtGetPerpendicular()

CGeom2DPoint CSimulation::PtGetPerpendicular	(	CGeom2DPoint const *	PtStart,
		CGeom2DPoint const *	PtNext,
		double const	dDesiredLength,
		int const	nHandedness )

staticprivate

Returns a CGeom2DPoint which is the 'other' point of a two-point vector passing through PtStart, and which is perpendicular to the two-point vector from PtStart to PtNext.

Definition at line 586 of file gis_utils.cpp.

◆ PtGridCentroidToExt()

CGeom2DPoint CSimulation::PtGridCentroidToExt ( CGeom2DIPoint const * pPtiIn ) const

private

Transforms a pointer to a CGeom2DIPoint in the raster grid CRS (assumed to be the centroid of a cell) to the equivalent CGeom2DPoint in the external CRS.

Definition at line 91 of file gis_utils.cpp.

Referenced by nDoUnconsErosionOnPolygon().

◆ PtiExtCRSToGridRound()

CGeom2DIPoint CSimulation::PtiExtCRSToGridRound ( CGeom2DPoint const * pPtIn ) const

private

Transforms a pointer to a CGeom2DPoint in the external CRS to the equivalent CGeom2DIPoint in the raster grid CRS (both values rounded). The result may be outside the grid.

Definition at line 139 of file gis_utils.cpp.

Referenced by CreateRasterizedProfile(), LSmoothCoastRunningMean(), LSmoothCoastSavitzkyGolay(), nCheckAllProfiles(), and nCreateAllPolygons().

◆ PtiFindClosestCoastPoint()

CGeom2DIPoint CSimulation::PtiFindClosestCoastPoint	(	int const	nX,
		int const	nY )

private

Finds the closest point on any coastline to a given point.

Definition at line 1834 of file gis_utils.cpp.

Referenced by nDoSedimentInputEvent().

◆ PtiFollowWaveAngle()

CGeom2DIPoint CSimulation::PtiFollowWaveAngle	(	CGeom2DIPoint const *	pPtiLast,
		double const	dWaveAngleIn,
		double &	dCorrection )

staticprivate

Given a cell and a wave orientation, finds the 'upwave' cell.

Definition at line 77 of file calc_shadow_zones.cpp.

Referenced by nDoAllShadowZones().

◆ PtiGetPerpendicular() [1/2]

CGeom2DIPoint CSimulation::PtiGetPerpendicular	(	CGeom2DIPoint const *	PtiStart,
		CGeom2DIPoint const *	PtiNext,
		double const	dDesiredLength,
		int const	nHandedness )

staticprivate

Returns a CGeom2DIPoint (grid CRS) which is the 'other' point of a two-point vector passing through PtiStart, and which is perpendicular to the two-point vector from PtiStart to PtiNext.

Definition at line 624 of file gis_utils.cpp.

Referenced by DoShadowZoneAndDownDriftZone(), and nDoSedimentInputEvent().

◆ PtiGetPerpendicular() [2/2]

CGeom2DIPoint CSimulation::PtiGetPerpendicular	(	int const	nStartX,
		int const	nStartY,
		int const	nNextX,
		int const	nNextY,
		double const	dDesiredLength,
		int const	nHandedness )

staticprivate

Returns a CGeom2DIPoint (grid CRS) which is the 'other' point of a two-point vector passing through [nStartX][nStartY], and which is perpendicular to the two-point vector from [nStartX][nStartY] to [nNextX][nNextY].

Definition at line 662 of file gis_utils.cpp.

◆ PtiPolygonCentroid()

CGeom2DIPoint CSimulation::PtiPolygonCentroid ( vector< CGeom2DIPoint > * pVIn )

staticprivate

Returns an integer point (grid CRS) which is the centroid of a polygon, given by a vector of grid CRS points. From https://stackoverflow.com/questions/2792443/finding-the-centroid-of-a-polygon.

Definition at line 509 of file gis_utils.cpp.

Referenced by nDoAllShadowZones().

◆ PtiWeightedAverage()

CGeom2DIPoint CSimulation::PtiWeightedAverage	(	CGeom2DIPoint const *	pPti1,
		CGeom2DIPoint const *	pPti2,
		double const	dWeight )

staticprivate

Returns an integer point (grid CRS) which is the weighted average of two other grid CRS integer points. The weight must be <= 1, if the weight is < 0.5 then the output point is closer to the first point, if the weight is > 0.5 then the output point is closer to the second point.

Definition at line 443 of file gis_utils.cpp.

Referenced by nFloodFillShadowZone().

◆ RasterizeCliffCollapseProfile()

void CSimulation::RasterizeCliffCollapseProfile	(	vector< CGeom2DPoint > const *	pVPointsIn,
		vector< CGeom2DIPoint > *	pVIPointsOut ) const

private

Given the start and end points of a cliff-collapse normal profile, returns an output vector of cells which are 'under' the vector line.

Definition at line 1148 of file do_cliff_collapse.cpp.

Referenced by nDoCliffCollapseDeposition().

◆ RasterizePolygonJoiningLine()

void CSimulation::RasterizePolygonJoiningLine	(	int const	nCoast,
		CGeom2DIPoint const *	pPt1,
		CGeom2DIPoint const *	pPt2,
		int const	nPoly )

private

For sediment input events, parses a string that may be relative (a number of hours or days after the start of the simulation), or absolute (a time/date in the format hh-mm-ss dd/mm/yyyy). Returns the timestep in which the sediment input event occurs.

Definition at line 2788 of file utils.cpp.

Referenced by nReadSedimentInputEventFile().

◆ VdInterpolateCShoreProfileOutput()

vector< double > CSimulation::VdInterpolateCShoreProfileOutput	(	vector< double > const *	pVdX,
		vector< double > const *	pVdY,
		vector< double > const *	pVdXNew )

private

Returns a linearly interpolated vector of doubles, to make CShore profile output compatible with CME. The array pVdY has been output by CShore and so always has length CSHOREARRAYOUTSIZE, whereas all other arrays have sizes which depend on CME at runtime.

Definition at line 142 of file interpolate.cpp.

◆ VstrSplit() [1/2]

vector< string > CSimulation::VstrSplit	(	string const *	s,
		char const	delim )

staticprivate

From http://stackoverflow.com/questions/236129/split-a-string-in-c They implement (approximately) Python's split() function. This second version returns a new string vector (it calls the first version)

Definition at line 2457 of file utils.cpp.

◆ VstrSplit() [2/2]

vector< string > * CSimulation::VstrSplit	(	string const *	s,
		char const	delim,
		vector< string > *	elems )

staticprivate

From http://stackoverflow.com/questions/236129/split-a-string-in-c They implement (approximately) Python's split() function. This first version puts the results into a pre-constructed string vector. It ignores empty items.

Definition at line 2440 of file utils.cpp.

Referenced by bParseDate(), bParseTime(), bReadRunDataFile(), nReadSedimentInputEventFile(), nReadShapeFunctionFile(), nReadWaveStationInputFile(), ulConvertToTimestep(), and VstrSplit().

◆ WriteLookUpData()

void CSimulation::WriteLookUpData ( void )

private

Output the erosion potential look-up values, for checking purposes.

Definition at line 1288 of file write_output.cpp.

Referenced by nDoSimulation().

◆ WritePolygonActualMovement()

void CSimulation::WritePolygonActualMovement	(	int const	nCoast,
		vector< vector< int > > const &	pnVVPolyAndAdjacent )

private

Writes to the log file a table showing per-polygon actual movement of unconsolidated beach sediment.

Definition at line 2156 of file write_output.cpp.

Referenced by nDoAllActualBeachErosionAndDeposition().

◆ WritePolygonCliffCollapseErosion()

void CSimulation::WritePolygonCliffCollapseErosion ( int const nCoast )

private

Writes to the log file a table showing per-polygon per-polygon cliff collapse.

Definition at line 1848 of file write_output.cpp.

Referenced by nDoSimulation().

◆ WritePolygonEstimatedMovement()

void CSimulation::WritePolygonEstimatedMovement	(	int const	,
		vector< vector< int > > &	)

Referenced by nDoSimulation().

◆ WritePolygonSortedSequence()

void CSimulation::WritePolygonSortedSequence	(	int const	nCoast,
		vector< vector< int > > &	pnVVPolyAndAdjacent )

private

Writes to the log file a table showing the sorted sequence of polygon processing, and any circularities.

Definition at line 2084 of file write_output.cpp.

Referenced by nDoAllActualBeachErosionAndDeposition().

◆ WritePolygonUnsortedSequence()

void CSimulation::WritePolygonUnsortedSequence	(	int const	nCoast,
		vector< vector< int > > &	pnVVPolyAndAdjacent )

private

Writes to the log file a table showing the unsorted sequence of polygon processing.

Definition at line 2024 of file write_output.cpp.

Referenced by nDoAllActualBeachErosionAndDeposition().

◆ WriteStartRunDetails()

void CSimulation::WriteStartRunDetails ( void )

private

GDAL data type for the initial water depth raster file.

Definition at line 1200 of file simulation.h.

◆ m_strGDALIWDriverCode

string CSimulation::m_strGDALIWDriverCode

private

GDAL code for the initial water depth raster file.

Definition at line 1191 of file simulation.h.

◆ m_strGDALIWDriverDesc

string CSimulation::m_strGDALIWDriverDesc

private

GDAL description for the initial water depth raster file.

Definition at line 1194 of file simulation.h.

string CSimulation::m_strOGRDWWVDriverDesc

private

Definition at line 1218 of file simulation.h.

Referenced by nReadVectorGISFile(), and WriteStartRunDetails().

◆ m_strOGRDWWVGeometry

string CSimulation::m_strOGRDWWVGeometry

private

GDAL geometry for the deep water wave stations vector file.

Definition at line 1221 of file simulation.h.

Referenced by nReadVectorGISFile(), and WriteStartRunDetails().

◆ m_strOGRFloodDataType

string CSimulation::m_strOGRFloodDataType

private

GDAL data type for the flood input locations point or vector file.

Definition at line 1248 of file simulation.h.

Referenced by nReadVectorGISFile(), and WriteStartRunDetails().

◆ m_strOGRFloodDriverCode

string CSimulation::m_strOGRFloodDriverCode

private

GDAL code for the flood input locations point or vector file.

Definition at line 1239 of file simulation.h.

Referenced by nReadVectorGISFile(), and WriteStartRunDetails().

private

Name of tide data file.

Definition at line 1131 of file simulation.h.

Referenced by AnnounceReadTideData(), bReadRunDataFile(), nDoSimulation(), nReadTideDataFile(), and WriteStartRunDetails().

◆ m_strVectorGISOutFormat

string CSimulation::m_strVectorGISOutFormat

unsigned long CSimulation::m_ulTotTimestep

private

The target number of iterations.

Definition at line 569 of file simulation.h.

Referenced by bTimeToQuit(), CalcTime(), and CSimulation().

ofstream CSimulation::StillWaterLevelTSStream

private

SWL time series file output stream.

Definition at line 1293 of file simulation.h.

Referenced by bSetUpTSFiles(), bWriteTSFiles(), and ~CSimulation().

The documentation for this class was generated from the following files:

Public Member Functions

Data Fields

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CSimulation()

◆ ~CSimulation()

Member Function Documentation

◆ AllPolygonsUpdateStoredUncons()

◆ AnnounceAddLayers()

◆ AnnounceAllocateMemory()

◆ AnnounceInitializing()

◆ AnnounceIsRunning()

◆ AnnounceLicence()

◆ AnnounceProgress()

◆ AnnounceReadBasementDEM()

◆ AnnounceReadDeepWaterWaveValuesGIS()

◆ AnnounceReadFloodLocationGIS()

◆ AnnounceReadICGIS()

◆ AnnounceReadIHGIS()

◆ AnnounceReadInitialCoarseConsSedGIS()

◆ AnnounceReadInitialCoarseUnconsSedGIS()

◆ AnnounceReadInitialFineConsSedGIS()

◆ AnnounceReadInitialFineUnconsSedGIS()

◆ AnnounceReadInitialSandConsSedGIS()

◆ AnnounceReadInitialSandUnconsSedGIS()

◆ AnnounceReadInitialSuspSedGIS()

◆ AnnounceReadLGIS()

◆ AnnounceReadRasterFiles()

◆ AnnounceReadSCAPEShapeFunctionFile()

◆ AnnounceReadSedimentEventInputValuesGIS()

◆ AnnounceReadTideData()

◆ AnnounceReadVectorFiles()

◆ AnnounceSimEnd()

◆ AnnounceStart()

◆ AppendEnsureNoGap()

◆ AppendPolygon()

◆ bCheckForIntersection()

◆ bCheckRasterGISOutputFormat()

◆ bCheckVectorGISOutputFormat()

◆ bCreateErosionPotentialLookUp()

◆ bElevAboveDeanElev()

◆ bFindExeDir()

◆ bIsInterventionCell()

◆ bIsWithinPolygon()

◆ bIsWithinValidGrid() [1/2]

◆ bIsWithinValidGrid() [2/2]

◆ bOnOrOffShoreAndUpOrDownCoast()

◆ bOpenLogFile()

◆ bParseDate()

◆ bParseTime()

◆ bReadIniFile()

◆ bReadRunDataFile()

◆ bSaveAllRasterGISFiles()

◆ bSaveAllVectorGISFiles()

◆ bSetUpTSFiles()

◆ bSurroundedByDriftCells()

◆ bTimeToQuit()

◆ bWriteParProfileData()

◆ bWritePerTimestepResults()

◆ bWritePerTimestepResultsCSV()

◆ bWritePerTimestepResultsFixedWidth()

◆ bWriteProfileData()

◆ bWriteRasterGISFile()

◆ bWriteTSFiles()

◆ bWriteVectorGISFile()

◆ CalcCoastTangents()

◆ CalcD50AndFillWaveCalcHoles()

◆ CalcDeanProfile()

◆ CalcDepthOfClosure()

◆ CalcProcessStats()

◆ CalcSavitzkyGolay()

◆ CalcSavitzkyGolayCoeffs()

◆ CalcTime()

◆ CellByCellFillSea()

◆ CheckForIntersectingProfiles()

◆ ConstructParallelProfile()

◆ CreateRasterizedProfile()