d2/d93/simulation_8cpp_source.html

/* ==============================================================================================================================

   This file is part of CoastalME, the Coastal Modelling Environment.


   CoastalME is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.


   This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.


   You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

==============================================================================================================================*/

#include <assert.h>


#include <cstdio>

#include <unistd.h>

#include <stdio.h>


#include <climits>


#include <ios>

using std::fixed;


#include <iostream>

using std::cerr;

using std::cin;

using std::endl;

using std::ios;


#include <iomanip>

using std::setprecision;


#include <cfloat>


#include <string>

using std::to_string;


#include <filesystem> // C++17 and later, needed for missing output directory creation

using std::filesystem::is_directory;

using std::filesystem::exists;

using std::filesystem::create_directories;


#include <gdal.h>


#include "cme.h"

#include "simulation.h"

#include "raster_grid.h"

#include "coast.h"


//===============================================================================================================================

//===============================================================================================================================


CSimulation::CSimulation(void)

{

   // Initialization

   m_bHaveFineSediment = false;

   m_bHaveSandSediment = false;

   m_bHaveCoarseSediment = false;

   m_bBasementElevSave = false;

   m_bSedIncTalusTopSurfSave = false;

   m_bTopSurfIncSeaSave = false;

   m_bTalusSave = false;

   m_bSliceSave = false;

   m_bSeaDepthSave = false;

   m_bAvgSeaDepthSave = false;

   m_bWaveHeightSave = false;

   m_bAvgWaveHeightSave = false;

   m_bWaveAngleSave = false;

   m_bAvgWaveAngleSave = false;

   m_bWaveAngleAndHeightSave = false;

   m_bAvgWaveAngleAndHeightSave = false;

   m_bDeepWaterWaveAngleAndHeightSave = false;

   m_bBeachProtectionSave = false;

   m_bWaveEnergySinceCollapseSave = false;

   m_bMeanWaveEnergySave = false;

   m_bBreakingWaveHeightSave = false;

   m_bPotentialPlatformErosionSave = false;

   m_bActualPlatformErosionSave = false;

   m_bTotalPotentialPlatformErosionSave = false;

   m_bTotalActualPlatformErosionSave = false;

   m_bPotentialBeachErosionSave = false;

   m_bActualBeachErosionSave = false;

   m_bTotalPotentialBeachErosionSave = false;

   m_bTotalActualBeachErosionSave = false;

   m_bBeachDepositionSave = false;

   m_bTotalBeachDepositionSave = false;

   m_bLandformSave = false;

   m_bSlopeConsSedSave = false;

   m_bSlopeSaveForCliffToe = false;

   m_bInterventionClassSave = false;

   m_bInterventionHeightSave = false;

   m_bSuspSedSave = false;

   m_bAvgSuspSedSave = false;

   m_bFineUnconsSedSave = false;

   m_bSandUnconsSedSave = false;

   m_bCoarseUnconsSedSave = false;

   m_bFineConsSedSave = false;

   m_bSandConsSedSave = false;

   m_bCoarseConsSedSave = false;

   m_bRasterCoastlineSave = false;

   m_bRasterNormalProfileSave = false;

   m_bActiveZoneSave = false;

   m_bCliffCollapseSave = false;

   m_bTotCliffCollapseSave = false;

   m_bCliffCollapseDepositionSave = false;

   m_bTotCliffCollapseDepositionSave = false;

   m_bCliffNotchAllSave = false;

   m_bCliffCollapseTimestepSave = false;

   m_bRasterPolygonSave = false;

   m_bPotentialPlatformErosionMaskSave = false;

   m_bSeaMaskSave = false;

   m_bBeachMaskSave = false;

   m_bShadowZoneCodesSave = false;

   m_bSaveRegular = false;

   m_bCoastSave = false;

   m_bCliffEdgeSave = false;

   m_bNormalsSave = false;

   m_bInvalidNormalsSave = false;

   m_bCoastCurvatureSave = false;

   m_bPolygonNodeSave = false;

   m_bPolygonBoundarySave = false;

   m_bCliffNotchSave = false;

   m_bShadowBoundarySave = false;

   m_bShadowDowndriftBoundarySave = false;

   m_bDeepWaterWaveAngleSave = false;

   m_bDeepWaterWaveHeightSave = false;

   m_bDeepWaterWavePeriodSave = false;

   m_bPolygonUnconsSedUpOrDownDriftSave = false;

   m_bPolygonUnconsSedGainOrLossSave = false;

   m_bCliffToeSave = false;

   m_bSeaAreaTSSave = false;

   m_bSWLTSSave = false;

   m_bActualPlatformErosionTSSave = false;

   m_bSuspSedTSSave = false;

   m_bFloodSetupSurgeTSSave = false;

   m_bFloodSetupSurgeRunupTSSave = false;

   m_bCliffCollapseDepositionTSSave = false;

   m_bCliffCollapseErosionTSSave = false;

   m_bCliffCollapseNetTSSave = false;

   m_bBeachErosionTSSave = false;

   m_bBeachDepositionTSSave = false;

   m_bBeachSedimentChangeNetTSSave = false;

   m_bCliffNotchElevTSSave = false;

   m_bSaveGISThisIter = false;

   m_bOutputConsolidatedProfileData = false;

   m_bOutputParallelProfileData = false;

   m_bOutputErosionPotentialData = false;

   m_bOmitSearchNorthEdge = false;

   m_bOmitSearchSouthEdge = false;

   m_bOmitSearchWestEdge = false;

   m_bOmitSearchEastEdge = false;

   m_bDoShorePlatformErosion = false;

   m_bDoCliffCollapse = false;

   m_bDoBeachSedimentTransport = false;

   m_bGDALCanWriteFloat = false;

   m_bGDALCanWriteInt32 = false;

   m_bScaleRasterOutput = false;

   m_bWorldFile = false;

   m_bSingleDeepWaterWaveValues = false;

   m_bHaveWaveStationData = false;

   m_bSedimentInput = false;

   m_bSedimentInputAtPoint = false;

   m_bSedimentInputAtCoast = false;

   m_bSedimentInputAlongLine = false;

   m_bSedimentInputThisIter = false;

   m_bSedimentInputEventSave = false;

   m_bWaveSetupSave = false;

   m_bStormSurgeSave = false;

   m_bRiverineFlooding = false;

   m_bRunUpSave = false;

   m_bSetupSurgeFloodMaskSave = false;

   m_bSetupSurgeRunupFloodMaskSave = false;

   m_bRasterWaveFloodLineSave = false;

   m_bVectorWaveFloodLineSave = false;

   m_bFloodLocationSave = false;

   m_bFloodSWLSetupLineSave = false;

   m_bFloodSWLSetupSurgeLine = false;

   m_bFloodSWLSetupSurgeRunupLineSave = false;

   m_bGISSaveDigitsSequential = false;

   m_bHaveConsolidatedSediment = false;

   m_bGDALOptimisations = false;

   m_bCliffToeLocate = false;

   m_bHighestSWLSoFar = false;

   m_bLowestSWLSoFar = false;


   m_bGDALCanCreate = true;

   m_bCSVPerTimestepResults = true; // Default to CSV output format

   m_bYamlInputFormat = false;      // Default to .dat format


   m_papszGDALRasterOptions = NULL;

   m_papszGDALVectorOptions = NULL;


   m_nLayers = 0;

   m_nCoastSmooth = 0;

   m_nCoastSmoothingWindowSize = 0;

   m_nSavGolCoastPoly = 0;

   m_nCliffEdgeSmooth = 0;

   m_nCliffEdgeSmoothWindow = 0;

   m_nSavGolCliffEdgePoly = 0;

   m_nProfileSmoothWindow = 0;

   m_nCoastNormalSpacing = 0;

   m_nCoastNormalInterventionSpacing = 0;

   m_nCoastCurvatureInterval = 0;

   m_nGISMaxSaveDigits = 0;

   m_nGISSave = 0;

   m_nUSave = 0;

   m_nThisSave = 0;

   m_nXGridSize = 0;

   m_nYGridSize = 0;

   m_nCoastMax = 0;

   m_nCoastMin = 0;

   m_nNumThisIterCliffCollapse = 0;

   m_nNumTotCliffCollapse = 0;

   m_nUnconsSedimentHandlingAtGridEdges = 0;

   m_nBeachErosionDepositionEquation = 0;

   m_nWavePropagationModel = 0;

   m_nSimStartSec = 0;

   m_nSimStartMin = 0;

   m_nSimStartHour = 0;

   m_nSimStartDay = 0;

   m_nSimStartMonth = 0;

   m_nSimStartYear = 0;

   m_nDeepWaterWaveDataNumTimeSteps = 0;

   m_nLogFileDetail = 0;

   m_nRunUpEquation = 0;

   m_nLevel = 0;


   // TODO 011 May wish to make this a user-supplied value

   m_nGISMissingValue = INT_NODATA;

   m_nMissingValue = INT_NODATA;


   m_nXMinBoundingBox = INT_MAX;

   m_nXMaxBoundingBox = INT_MIN;

   m_nYMinBoundingBox = INT_MAX;

   m_nYMaxBoundingBox = INT_MIN;


   // cppcheck-suppress useInitializationList

   m_GDALWriteIntDataType = GDT_Unknown;

   // cppcheck-suppress useInitializationList

   m_GDALWriteFloatDataType = GDT_Unknown;


   m_lGDALMaxCanWrite = 0;

   m_lGDALMinCanWrite = 0;


   m_ulIter = 0;

   m_ulTotTimestep = 0;

   m_ulThisIterNumPotentialBeachErosionCells = 0;

   m_ulThisIterNumActualBeachErosionCells = 0;

   m_ulThisIterNumBeachDepositionCells = 0;

   m_ulTotPotentialPlatformErosionOnProfiles = 0;

   m_ulTotPotentialPlatformErosionBetweenProfiles = 0;

   m_ulMissingValueBasementCells = 0;

   m_ulNumCells = 0;

   m_ulThisIterNumSeaCells = 0;

   m_ulThisIterNumCoastCells = 0;

   m_ulThisIterNumPotentialPlatformErosionCells = 0;

   m_ulThisIterNumActualPlatformErosionCells = 0;


   m_ulMissingValue = UNSIGNED_LONG_NODATA;


   for (int i = 0; i < NUMBER_OF_RNGS; i++)

      m_ulRandSeed[i] = 0;


   for (int i = 0; i < SAVEMAX; i++)

      m_dUSaveTime[i] = 0;


   m_dDurationUnitsMult = 0;

   m_dNorthWestXExtCRS = 0;

   m_dNorthWestYExtCRS = 0;

   m_dSouthEastXExtCRS = 0;

   m_dSouthEastYExtCRS = 0;

   m_dExtCRSGridArea = 0;

   m_dCellSide = 0;

   m_dCellDiagonal = 0;

   m_dInvCellSide = 0;

   m_dInvCellDiagonal = 0;

   m_dCellArea = 0;

   m_dSimDuration = 0;

   m_dTimeStep = 0;

   m_dSimElapsed = 0;

   m_dRegularSaveTime = 0;

   m_dRegularSaveInterval = 0;

   m_dClkLast = 0;

   m_dCPUClock = 0;

   m_dSeaWaterDensity = 0;

   m_dThisIterSWL = 0;

   m_dThisIterMeanSWL = 0;

   m_dInitialMeanSWL = 0;

   m_dFinalMeanSWL = 0;

   m_dDeltaSWLPerTimestep = 0;

   m_dBreakingWaveHeight = 0;

   m_dC_0 = 0;

   m_dL_0 = 0;

   m_dWaveDepthRatioForWaveCalcs = 0;

   m_dAllCellsDeepWaterWaveHeight = 0;

   m_dAllCellsDeepWaterWaveAngle = 0;

   m_dAllCellsDeepWaterWavePeriod = 0;

   m_dMaxUserInputWaveHeight = 0;

   m_dMaxUserInputWavePeriod = 0;

   m_dR = 0;

   m_dD50Fine = 0;

   m_dD50Sand = 0;

   m_dD50Coarse = 0;

   m_dBeachSedimentDensity = 0;

   m_dBeachSedimentPorosity = 0;

   m_dFineErodibility = 0;

   m_dSandErodibility = 0;

   m_dCoarseErodibility = 0;

   m_dFineErodibilityNormalized = 0;

   m_dSandErodibilityNormalized = 0;

   m_dCoarseErodibilityNormalized = 0;

   m_dKLS = 0;

   m_dKamphuis = 0;

   m_dG = 0;

   m_dInmersedToBulkVolumetric = 0;

   m_dDepthOfClosure = 0;

   m_dCoastNormalSpacing = 0;

   m_dCoastNormalInterventionSpacing = 0;

   m_dCoastNormalLength = 0;

   m_dThisIterTotSeaDepth = 0;

   m_dThisIterPotentialSedLostBeachErosion = 0;

   m_dThisIterLeftGridUnconsFine = 0;        // TODO067

   m_dThisIterLeftGridUnconsSand = 0;

   m_dThisIterLeftGridUnconsCoarse = 0;

   m_dThisIterPotentialPlatformErosion = 0;

   m_dThisIterActualPlatformErosionFineCons = 0;

   m_dThisIterActualPlatformErosionSandCons = 0;

   m_dThisIterActualPlatformErosionCoarseCons = 0;

   m_dThisIterPotentialBeachErosion = 0;

   m_dThisIterBeachErosionFine = 0;

   m_dThisIterBeachErosionSand = 0;

   m_dThisIterBeachErosionCoarse = 0;

   m_dThisIterBeachDepositionSand = 0;

   m_dThisIterBeachDepositionCoarse = 0;

   m_dThisIterFineSedimentToSuspension = 0;

   m_dDepositionSandDiff = 0;

   m_dDepositionCoarseDiff = 0;

   m_dDepthOverDBMax = 0;

   m_dTotPotentialPlatformErosionOnProfiles = 0;

   m_dTotPotentialPlatformErosionBetweenProfiles = 0;

   m_dProfileMaxSlope = 0;

   m_dMaxBeachElevAboveSWL = 0;

   m_dCliffErosionResistance = 0;

   m_dNotchIncisionAtCollapse = 0;

   m_dThisIterNewNotchApexElev = 0;

   m_dNotchApexAboveMHW = 0;

   m_dCliffDepositionA = 0;

   m_dCliffDepositionPlanviewWidth = 0;

   m_dCliffTalusMinDepositionLength = 0;

   m_dMinCliffTalusHeightFrac = 0;

   m_dThisIterCliffCollapseErosionFineUncons = 0;

   m_dThisIterCliffCollapseErosionSandUncons = 0;

   m_dThisIterCliffCollapseErosionCoarseUncons = 0;

   m_dThisIterCliffCollapseErosionFineCons = 0;

   m_dThisIterCliffCollapseErosionSandCons = 0;

   m_dThisIterCliffCollapseErosionCoarseCons = 0;

   m_dThisIterUnconsSandCliffDeposition = 0;

   m_dThisIterUnconsCoarseCliffDeposition = 0;

   m_dThisIterCliffCollapseFineErodedDuringDeposition = 0;

   m_dThisIterCliffCollapseSandErodedDuringDeposition = 0;

   m_dThisIterCliffCollapseCoarseErodedDuringDeposition = 0;

   m_dCoastNormalRandSpacingFactor = 0;

   m_dDeanProfileStartAboveSWL = 0;

   m_dAccumulatedSeaLevelChange = 0;

   m_dBreakingWaveHeightDepthRatio = 0;

   m_dWaveDataWrapHours = 0;

   m_dThisIterTopElevMax = 0;

   m_dThisIterTopElevMin = 0;

   m_dThisiterUnconsFineInput = 0;

   m_dThisiterUnconsSandInput = 0;

   m_dThisiterUnconsCoarseInput = 0;

   m_dStartIterSuspFineAllCells = 0;

   m_dStartIterSuspFineInPolygons = 0;

   m_dStartIterUnconsFineAllCells = 0;

   m_dStartIterUnconsSandAllCells = 0;

   m_dStartIterUnconsCoarseAllCells = 0;

   m_dStartIterConsFineAllCells = 0;

   m_dStartIterConsSandAllCells = 0;

   m_dStartIterConsCoarseAllCells = 0;

   m_dThisIterDiffTotWaterLevel = 0;         // Used in surge stuff TODO 007 Finish surge and runup stuff

   m_dThisIterDiffWaveSetupWaterLevel = 0;

   m_dThisIterDiffWaveSetupSurgeWaterLevel = 0;

   m_dThisIterDiffWaveSetupSurgeRunupWaterLevel = 0;

   m_dTotalFineUnconsInPolygons = 0;

   m_dTotalSandUnconsInPolygons = 0;

   m_dTotalCoarseUnconsInPolygons = 0;

   m_dUnconsSandNotDepositedLastIter = 0;

   m_dUnconsCoarseNotDepositedLastIter = 0;

   m_dTotalFineConsInPolygons = 0;

   m_dTotalSandConsInPolygons = 0;

   m_dTotalCoarseConsInPolygons = 0;

   m_dSlopeThresholdForCliffToe = 0;

   m_dThisIterMHWElev = 0;


   m_dMinSWLSoFar = DBL_MAX;

   m_dMaxSWLSoFar = DBL_MIN;


   for (int i = 0; i < 6; i++)

      m_dGeoTransform[i] = 0;


   // TODO 011 May wish to make this a user-supplied value

   m_dGISMissingValue = DBL_NODATA;

   m_dMissingValue = DBL_NODATA;


   m_ldGTotPotentialPlatformErosion = 0;

   m_ldGTotFineActualPlatformErosion = 0;

   m_ldGTotSandActualPlatformErosion = 0;

   m_ldGTotCoarseActualPlatformErosion = 0;

   m_ldGTotPotentialSedLostBeachErosion = 0;

   m_ldGTotActualFineLostBeachErosion = 0;

   m_ldGTotActualSandLostBeachErosion = 0;

   m_ldGTotActualCoarseLostBeachErosion = 0;

   m_ldGTotSandSedLostCliffCollapse = 0;

   m_ldGTotCoarseSedLostCliffCollapse = 0;

   m_ldGTotCliffCollapseFine = 0;

   m_ldGTotCliffCollapseSand = 0;

   m_ldGTotCliffCollapseCoarse = 0;

   m_ldGTotCliffTalusFineToSuspension = 0;

   m_ldGTotCliffTalusSandDeposition = 0;

   m_ldGTotCliffTalusCoarseDeposition = 0;

   m_ldGTotCliffCollapseFineErodedDuringDeposition = 0;

   m_ldGTotCliffCollapseSandErodedDuringDeposition = 0;

   m_ldGTotCliffCollapseCoarseErodedDuringDeposition = 0;

   m_ldGTotPotentialBeachErosion = 0;

   m_ldGTotActualFineBeachErosion = 0;

   m_ldGTotActualSandBeachErosion = 0;

   m_ldGTotActualCoarseBeachErosion = 0;

   m_ldGTotSandBeachDeposition = 0;

   m_ldGTotCoarseBeachDeposition = 0;

   m_ldGTotSuspendedSediment = 0;

   m_ldGTotSandDepositionDiff = 0;

   m_ldGTotCoarseDepositionDiff = 0;

   m_ldGTotFineSedimentInput = 0;

   m_ldGTotSandSedimentInput = 0;

   m_ldGTotCoarseSedimentInput = 0;


   m_tSysStartTime = 0;

   m_tSysEndTime = 0;


   m_pRasterGrid = NULL;

}


//===============================================================================================================================

//===============================================================================================================================


CSimulation::~CSimulation(void)

{

   // Close output files if open

   if (LogStream && LogStream.is_open())

   {

      LogStream.flush();

      LogStream.close();

   }


   if (OutStream && OutStream.is_open())

   {

      OutStream.flush();

      OutStream.close();

   }


   if (SeaAreaTSStream && SeaAreaTSStream.is_open())

   {

      SeaAreaTSStream.flush();

      SeaAreaTSStream.close();

   }


   if (SWLTSStream && SWLTSStream.is_open())

   {

      SWLTSStream.flush();

      SWLTSStream.close();

   }


   if (PlatformErosionTSStream && PlatformErosionTSStream.is_open())

   {

      PlatformErosionTSStream.flush();

      PlatformErosionTSStream.close();

   }


   if (CliffCollapseErosionTSStream && CliffCollapseErosionTSStream.is_open())

   {

      CliffCollapseErosionTSStream.flush();

      CliffCollapseErosionTSStream.close();

   }


   if (CliffCollapseDepositionTSStream && CliffCollapseDepositionTSStream.is_open())

   {

      CliffCollapseDepositionTSStream.flush();

      CliffCollapseDepositionTSStream.close();

   }


   if (CliffCollapseNetChangeTSStream && CliffCollapseNetChangeTSStream.is_open())

   {

      CliffCollapseNetChangeTSStream.flush();

      CliffCollapseNetChangeTSStream.close();

   }


   if (FineSedSuspensionTSStream && FineSedSuspensionTSStream.is_open())

   {

      FineSedSuspensionTSStream.flush();

      FineSedSuspensionTSStream.close();

   }


   if (FloodSetupSurgeTSStream && FloodSetupSurgeTSStream.is_open())

   {

      FloodSetupSurgeTSStream.flush();

      FloodSetupSurgeTSStream.close();

   }


   if (FloodSetupSurgeRunupTSStream && FloodSetupSurgeRunupTSStream.is_open())

   {

      FloodSetupSurgeRunupTSStream.flush();

      FloodSetupSurgeRunupTSStream.close();

   }


   if (CliffNotchElevTSStream && CliffNotchElevTSStream.is_open())

   {

      CliffNotchElevTSStream.flush();

      CliffNotchElevTSStream.close();

   }


   if (m_pRasterGrid)

      delete m_pRasterGrid;

}


//===============================================================================================================================

//===============================================================================================================================


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

{

   // ================================================== initialisation section ================================================

   // Hello, World!

   AnnounceStart();


   // Start the clock ticking

   StartClock();


   // Deal with command-line parameters

   int nRet = nHandleCommandLineParams(nArg, pcArgv);


   if (nRet != RTN_OK)

      return (nRet);


   // Find out the folder in which the CoastalME executable sits, in order to open the .ini file (they are assumed to be in the same folder)

   if (! bFindExeDir(pcArgv[0]))

      return (RTN_ERR_CMEDIR);


   // OK, we are off, tell the user about the licence and the start time

   AnnounceLicence();


   // Read the .ini file and get the name of the run-data file, and path for output etc.

   if (! bReadIniFile())

      return (RTN_ERR_INI);


   // Check if output dir exists

   if ((! is_directory(m_strOutPath.c_str())) || (! exists(m_strOutPath.c_str())))

   {

      // Output dir does not exist

      bool bCreateDir = false;


      if ((isatty(fileno(stdout))) && (isatty(fileno(stderr))))

      {

         // Running with stdout and stderr as a tty, so ask the user if they wish to create it

         char ch;

         cerr << endl

              << "Output folder '" << m_strOutPath << "' does not exist. Create it? (Y/N) ";

         cerr.flush();

         cin.get(ch);


         if ((ch == 'y') || (ch == 'Y'))

            bCreateDir = true;

      }

      else

      {

         // Running with stdout or stderr not a tty, so create output dir rather than abort

         bCreateDir = true;

      }


      if (bCreateDir)

      {

         // Yes, so create the directory

         create_directories(m_strOutPath.c_str());

         cerr << m_strOutPath << " created" << endl << endl;

      }

      else

         // Nope, just end the run

         return RTN_USER_ABORT;

   }


   // We have the name of the run-data input file, so read it

   if (! bReadRunDataFile())

      return RTN_ERR_RUNDATA;


   // Check raster GIS output format

   if (! bCheckRasterGISOutputFormat())

      return (RTN_ERR_RASTER_GIS_OUT_FORMAT);


   // Check vector GIS output format

   if (! bCheckVectorGISOutputFormat())

      return (RTN_ERR_VECTOR_GIS_OUT_FORMAT);


   // Open log file

   if (! bOpenLogFile())

      return (RTN_ERR_LOGFILE);


   // Set up the time series output files

   if (! bSetUpTSFiles())

      return (RTN_ERR_TSFILE);


   // Initialize the random number generators

   for (int n = 0; n < NUMBER_OF_RNGS; n++)

      m_Rand[n].seed(m_ulRandSeed[n]);


   // If we are doing Savitzky-Golay smoothing of the vector coastline(s), calculate the filter coefficients

   if (m_nCoastSmooth == SMOOTH_SAVITZKY_GOLAY)

      CalcSavitzkyGolayCoeffs();


   // Create the raster grid object

   m_pRasterGrid = new CGeomRasterGrid(this);


   // Read in the basement layer (must have this file), create the raster grid, then read in the basement DEM data to the array

   AnnounceReadBasementDEM();

   nRet = nReadRasterBasementDEM();


   if (nRet != RTN_OK)

      return nRet;


   // Are we simulating cliff collapse?

   if (m_bDoCliffCollapse)

   {

      // We are: now that we have a value for m_dCellSide, we can check some more input parameters. Talus must be more than one cell wide, and since the number of cells must be odd, three cells is the minimum width

      int const nTmp = nConvertMetresToNumCells(m_dCliffDepositionPlanviewWidth);

      if (nTmp < 3)

      {

         string const strErr = ERR + "cliff deposition must have a planview width of at least three cells. The current setting of " + to_string(m_dCliffDepositionPlanviewWidth) + " m gives a planview width of " + to_string(nTmp) + " cells. Please edit " + m_strDataPathName;

         cerr << strErr << endl;

         LogStream << strErr << endl;

         OutStream << strErr << endl;

         return RTN_ERR_RUNDATA;

      }

   }


   // Do some more initialisation

   // cppcheck-suppress truncLongCastAssignment

   m_ulNumCells = m_nXGridSize * m_nYGridSize;


   // Mark edge cells, as defined by the basement layer

   nRet = nMarkBoundingBoxEdgeCells();

   if (nRet != RTN_OK)

      return nRet;


   //    // DEBUG CODE =================================================================================================================

   // for (int n = 0; n < m_VEdgeCell.size(); n++)

   // {

   // LogStream << "[" << m_VEdgeCell[n].nGetX() << "][" << m_VEdgeCell[n].nGetY() << "] = {" << dGridCentroidXToExtCRSX(m_VEdgeCell[n].nGetX()) << ", " << dGridCentroidYToExtCRSY(m_VEdgeCell[n].nGetY()) << "} " << m_VEdgeCellEdge[n] << endl;

   // }

   //    // DEBUG CODE =================================================================================================================


   // If we are using the default cell spacing, then now that we know the size of the raster cells, we can set the size of profile spacing in m

   if (bFPIsEqual(m_dCoastNormalSpacing, 0.0, TOLERANCE))

      m_dCoastNormalSpacing = DEFAULT_PROFILE_SPACING * m_dCellSide;

   else

   {

      // The user specified a profile spacing, is this too small?

      m_nCoastNormalSpacing = nRound(m_dCoastNormalSpacing / m_dCellSide);


      if (m_nCoastNormalSpacing < DEFAULT_PROFILE_SPACING)

      {

         cerr << ERR << "profile spacing was specified as " << m_dCoastNormalSpacing << " m, which is " << m_nCoastNormalSpacing << " cells. Polygon creation works poorly if profile spacing is less than " << DEFAULT_PROFILE_SPACING << " cells, i.e. " << DEFAULT_PROFILE_SPACING * m_dCellSide << " m" << endl;


         LogStream << ERR << "profile spacing was specified as " << m_dCoastNormalSpacing << " m, which is " << m_nCoastNormalSpacing << " cells. Polygon creation works poorly if profile spacing is less than " << DEFAULT_PROFILE_SPACING << " cells, i.e. " << DEFAULT_PROFILE_SPACING * m_dCellSide << " m" << endl;


         return RTN_ERR_PROFILE_SPACING;

      }

   }


   // Set the profile spacing on interventions

   m_dCoastNormalInterventionSpacing = m_dCoastNormalSpacing * INTERVENTION_PROFILE_SPACING_FACTOR;

   m_nCoastNormalInterventionSpacing = nRound(m_dCoastNormalInterventionSpacing / m_dCellSide);


   // We have at least one filename for the first layer, so add the correct number of layers. Note the the number of layers does not change during the simulation: however layers can decrease in thickness until they have zero thickness

   AnnounceAddLayers();


   for (int nX = 0; nX < m_nXGridSize; nX++)

      for (int nY = 0; nY < m_nYGridSize; nY++)

         m_pRasterGrid->m_Cell[nX][nY].AppendLayers(m_nLayers);


   // Tell the user what is happening then read in the layer files

   AnnounceReadRasterFiles();


   for (int nLayer = 0; nLayer < m_nLayers; nLayer++)

   {

      if (! m_VstrInitialFineUnconsSedimentFile[nLayer].empty())

      {

         // Read in the initial fine unconsolidated sediment depth file(s)

         AnnounceReadInitialFineUnconsSedGIS(nLayer);

         nRet = nReadRasterGISFile(FINE_UNCONS_RASTER, nLayer);

         if (nRet != RTN_OK)

            return (nRet);

      }


      if (! m_VstrInitialSandUnconsSedimentFile[nLayer].empty())

      {

         // Read in the initial sand unconsolidated sediment depth file

         AnnounceReadInitialSandUnconsSedGIS(nLayer);

         nRet = nReadRasterGISFile(SAND_UNCONS_RASTER, nLayer);

         if (nRet != RTN_OK)

            return (nRet);

      }


      if (! m_VstrInitialCoarseUnconsSedimentFile[nLayer].empty())

      {

         // Read in the initial coarse unconsolidated sediment depth file

         AnnounceReadInitialCoarseUnconsSedGIS(nLayer);

         nRet = nReadRasterGISFile(COARSE_UNCONS_RASTER, nLayer);

         if (nRet != RTN_OK)

            return (nRet);

      }


      if (! m_VstrInitialFineConsSedimentFile[nLayer].empty())

      {

         // Read in the initial fine consolidated sediment depth file

         AnnounceReadInitialFineConsSedGIS(nLayer);

         nRet = nReadRasterGISFile(FINE_CONS_RASTER, nLayer);

         if (nRet != RTN_OK)

            return (nRet);

      }


      if (! m_VstrInitialSandConsSedimentFile[nLayer].empty())

      {

         // Read in the initial sand consolidated sediment depth file

         AnnounceReadInitialSandConsSedGIS(nLayer);

         nRet = nReadRasterGISFile(SAND_CONS_RASTER, nLayer);

         if (nRet != RTN_OK)

            return (nRet);

      }


      if (! m_VstrInitialCoarseConsSedimentFile[nLayer].empty())

      {

         // Read in the initial coarse consolidated sediment depth file

         AnnounceReadInitialCoarseConsSedGIS(nLayer);

         nRet = nReadRasterGISFile(COARSE_CONS_RASTER, nLayer);

         if (nRet != RTN_OK)

            return (nRet);

      }

   }


   if (! m_strInitialSuspSedimentFile.empty())

   {

      // Read in the initial suspended sediment depth file

      AnnounceReadInitialSuspSedGIS();

      nRet = nReadRasterGISFile(SUSP_SED_RASTER, 0);

      if (nRet != RTN_OK)

         return (nRet);

   }


   // Maybe read in the landform class data, otherwise calculate this during the first timestep using identification rules

   if (! m_strInitialLandformFile.empty())

   {

      AnnounceReadLGIS();

      nRet = nReadRasterGISFile(LANDFORM_RASTER, 0);

      if (nRet != RTN_OK)

         return (nRet);

   }


   // Maybe read in intervention data

   if (! m_strInterventionClassFile.empty())

   {

      AnnounceReadICGIS();

      nRet = nReadRasterGISFile(INTERVENTION_CLASS_RASTER, 0);

      if (nRet != RTN_OK)

         return (nRet);


      AnnounceReadIHGIS();

      nRet = nReadRasterGISFile(INTERVENTION_HEIGHT_RASTER, 0);

      if (nRet != RTN_OK)

         return (nRet);

   }


   // Maybe read in the tide data

   if (! m_strTideDataFile.empty())

   {

      AnnounceReadTideData();

      nRet = nReadTideDataFile();

      if (nRet != RTN_OK)

         return (nRet);

   }


   // Read in the erosion potential shape function data

   AnnounceReadSCAPEShapeFunctionFile();

   nRet = nReadShapeFunctionFile();

   if (nRet != RTN_OK)

      return (nRet);


   // Do we want to output the erosion potential look-up values, for checking purposes?

   if (m_bOutputErosionPotentialData)

      WriteLookUpData();


   // OK, now read in the vector files (if any)

   if (m_bHaveWaveStationData || m_bSedimentInput)

      AnnounceReadVectorFiles();


   // Maybe read in deep water wave station data

   if (m_bHaveWaveStationData)

   {

      // We are reading deep water wave height, orientation and period from a file of vector points and file time series

      AnnounceReadDeepWaterWaveValuesGIS();


      // Read in vector points

      nRet = nReadVectorGISFile(DEEP_WATER_WAVE_STATIONS_VEC);

      if (nRet != RTN_OK)

         return (nRet);


      int const nWaveStations = static_cast<int>(m_VnDeepWaterWaveStationID.size());


      if (nWaveStations == 1)

         m_bSingleDeepWaterWaveValues = true;


      // Read in time series values, and initialise the vector which stores each timestep's deep water wave height, orientation and period

      nRet = nReadWaveStationInputFile(nWaveStations);

      if (nRet != RTN_OK)

         return (nRet);

   }


   // Maybe read in sediment input event data

   if (m_bSedimentInput)

   {

      // We are reading sediment input event data

      AnnounceReadSedimentEventInputValuesGIS();


      // Read in vector points for sediment input events

      nRet = nReadVectorGISFile(SEDIMENT_INPUT_EVENT_LOCATION_VEC);

      if (nRet != RTN_OK)

         return (nRet);


      // Read in the time series values for sediment input events

      nRet = nReadSedimentInputEventFile();

      if (nRet != RTN_OK)

         return (nRet);

   }


   // Maybe read in flood input location

   if (m_bFloodLocationSave)

   {

      // We are reading sediment input event data

      AnnounceReadFloodLocationGIS();


      // Read in vector points for sediment input events

      nRet = nReadVectorGISFile(FLOOD_LOCATION_VEC);

      if (nRet != RTN_OK)

         return (nRet);

   }


   // Open the main output

   OutStream.open(m_strOutFile.c_str(), ios::out | ios::trunc);


   if (!OutStream)

   {

      // Error, cannot open Out file

      cerr << ERR << "cannot open " << m_strOutFile << " for output" << endl;

      return (RTN_ERR_OUTFILE);

   }


   // Write beginning-of-run information to Out and Log files

   WriteStartRunDetails();


   // Final stage of initialization

   AnnounceFinalInitialization();


   // Misc initialisation calcs

   m_nCoastMax = COAST_LENGTH_MAX * tMax(m_nXGridSize, m_nYGridSize);                           // Arbitrary but probably OK

   // m_nCoastMin = tMin(m_nXGridSize, m_nYGridSize);

   m_nCoastMin = nRound(COAST_LENGTH_MIN_X_PROF_SPACE * m_dCoastNormalSpacing / m_dCellSide);   // Arbitrary but probably OK

   m_nCoastCurvatureInterval = tMax(nRound(m_dCoastNormalSpacing / (m_dCellSide * 2)), 2);      // Arbitrary but probably OK


   // For beach erosion/deposition, conversion from immersed weight to bulk volumetric (sand and voids) transport rate (Leo Van Rijn) TODO 007 need full reference

   m_dInmersedToBulkVolumetric = 1 / ((m_dBeachSedimentDensity - m_dSeaWaterDensity) * (1 - m_dBeachSedimentPorosity) * m_dG);


   m_bConsChangedThisIter.resize(m_nLayers, false);

   m_bUnconsChangedThisIter.resize(m_nLayers, false);


   // Normalize sediment erodibility values, so that none are > 1

   double const dTmp = m_dFineErodibility + m_dSandErodibility + m_dCoarseErodibility;

   m_dFineErodibilityNormalized = m_dFineErodibility / dTmp;

   m_dSandErodibilityNormalized = m_dSandErodibility / dTmp;

   m_dCoarseErodibilityNormalized = m_dCoarseErodibility / dTmp;


   // Intialise SWL

   m_dThisIterSWL = m_dInitialMeanSWL;


   // If SWL changes during the simulation, calculate the per-timestep increment (could be -ve)

   if (! bFPIsEqual(m_dFinalMeanSWL, m_dInitialMeanSWL, TOLERANCE))

   {

      m_dDeltaSWLPerTimestep = (m_dTimeStep * (m_dFinalMeanSWL - m_dInitialMeanSWL)) / m_dSimDuration;

      m_dAccumulatedSeaLevelChange -= m_dDeltaSWLPerTimestep;

   }


   // ===================================================== The main loop ======================================================

   // Tell the user what is happening

   AnnounceIsRunning();


   while (true)

   {

      // Check that we haven't gone on too long: if not then update timestep number etc.

      if (bTimeToQuit())

         break;


      // Tell the user how the simulation is progressing

      AnnounceProgress();


      if (m_nLogFileDetail >= LOG_FILE_MIDDLE_DETAIL)

         LogStream << "TIMESTEP " << m_ulIter << " " << string(154, '=') << endl;


      LogStream << fixed << setprecision(3);


      // Check to see if there is a new intervention in place: if so, update it on the RasterGrid array

      nRet = nUpdateIntervention();

      if (nRet != RTN_OK)

         return nRet;


      // Calculate changes due to external forcing (change in still water level, tide level and deep water waves height, orientation and period)

      nRet = nCalcExternalForcing();

      if (nRet != RTN_OK)

         return nRet;


      // Do per-timestep initialisation: set up the grid cells ready for this timestep, also initialise per-timestep totals. Note that in the first timestep, all cells (including hinterland cells) are given the deep water wave values

      nRet = nInitGridAndCalcStillWaterLevel();

      if (nRet != RTN_OK)

         return nRet;


      // Next find out which cells are inundated and locate the coastline(s). This also gives to all sea cells, wave values which are the same as the deep water values. For shallow water sea cells, these wave values will be changed later, in nDoAllPropagateWaves()

      nRet = nLocateSeaAndCoasts();

      if (nRet != RTN_OK)

         return nRet;


      // Tell the user how the simulation is progressing

      AnnounceProgress();


      // Locate estuaries TODO someday...


      if (m_bHaveConsolidatedSediment && m_bDoCliffCollapse && m_bCliffToeLocate)

      {

         // Locate and trace cliff toe

         nRet = nLocateCliffToe();

         if (nRet != RTN_OK)

            return nRet;

      }


      // For all cells, use classification rules to assign sea and hinterland landform categories

      nRet = nAssignLandformsForAllCells();

      if (nRet != RTN_OK)

         return nRet;


      // For every coastline, use classification rules to assign landform categories

      nRet = nAssignLandformsForAllCoasts();

      if (nRet != RTN_OK)

         return nRet;


      // Create all coastline-normal profiles, in coastline-concave-curvature sequence

      nRet = nCreateAllProfiles();

      if (nRet != RTN_OK)

         return nRet;


      // Check the coastline-normal profiles for intersection, modify the profiles if they intersect, then mark valid profiles on the raster grid

      nRet = nCheckAndMarkAllProfiles();

      if (nRet != RTN_OK)

         return nRet;


      if (m_VCoast.size() > 1)

      {

         // We have multiple coastlines

         nRet = nDoMultipleCoastlines();

         if (nRet != RTN_OK)

         return nRet;

      }


      // Tell the user how the simulation is progressing

      AnnounceProgress();


      // Create the coast polygons

      nRet = nCreateAllPolygons();

      if (nRet != RTN_OK)

         return nRet;


      // Mark cells of the raster grid that are within each polygon, and do some polygon initialisation

      MarkPolygonCells();


      // // DEBUG CODE ================

      // m_nGISSave++;

      // if (! bWriteVectorGISFile(VECTOR_PLOT_COAST, &VECTOR_PLOT_COAST_TITLE))

      //    return false;

      // if (! bWriteVectorGISFile(VECTOR_PLOT_NORMALS, &VECTOR_PLOT_NORMALS_TITLE))

      //    return false;

      // if (! bWriteVectorGISFile(VECTOR_PLOT_INVALID_NORMALS, &VECTOR_PLOT_INVALID_NORMALS_TITLE))

      //    return false;

      // if (! bWriteRasterGISFile(RASTER_PLOT_NORMAL_PROFILE, &RASTER_PLOT_NORMAL_PROFILE_TITLE))

      //    return false;

      // if (! bWriteRasterGISFile(RASTER_PLOT_COAST, &RASTER_PLOT_COAST_TITLE))

      //    return false;

      // if (! bWriteRasterGISFile(RASTER_PLOT_POLYGON, &RASTER_PLOT_POLYGON_TITLE))

      //    return false;

      // if (! bWriteVectorGISFile(VECTOR_PLOT_POLYGON_BOUNDARY, &VECTOR_PLOT_POLYGON_BOUNDARY_TITLE))

      //    return false;

      // // DEBUG CODE ================


      // Calculate the length of the shared normal between each polygon and the adjacent polygon(s)

      nRet = nDoPolygonSharedBoundaries();

      if (nRet != RTN_OK)

         return nRet;


      // Tell the user how the simulation is progressing

      AnnounceProgress();


      // // DEBUG CODE =========================================================================================================

      // nNODATA = 0;

      // nPoly0 = 0;

      // nPoly24 = 0;

      // for (int nX = 0; nX < m_nXGridSize; nX++)

      // {

      // for (int nY = 0; nY < m_nYGridSize; nY++)

      // {

      // int nTmp = m_pRasterGrid->m_Cell[nX][nY].nGetPolygonID();

      // if (nTmp == INT_NODATA)

      // nNODATA++;

      //

      // if (nTmp == 0)

      // nPoly0++;

      //

      // if (nTmp == 24)

      // nPoly24++;

      // }

      // }

      // LogStream << "After marking polygon cells, N cells with NODATA polygon ID = " << nNODATA << endl;

      // // LogStream << "After marking polygon cells, N cells with zero polygon ID = " << nPoly0 << endl;

      // LogStream << "After marking polygon cells, N cells with 24 polygon ID = " << nPoly24 << endl;

      // // DEBUG CODE =========================================================================================================

      // PropagateWind();


      // Give every coast point a value for deep water wave height and direction

      nRet = nSetAllCoastpointDeepWaterWaveValues();

      if (nRet != RTN_OK)

         return nRet;


      // // DEBUG CODE ===============

      // for (int nCoast = 0; nCoast < static_cast<int>(m_VCoast.size()); nCoast++)

      // {

      // LogStream << "====================" << endl;

      //

      // for (int nProfile = 0; nProfile < m_VCoast[nCoast].nGetNumProfiles(); nProfile++)

      // {

      // CGeomProfile* pProfile = m_VCoast[nCoast].pGetProfile(nProfile);

      // int nCell = pProfile->nGetNumCellsInProfile();

      // LogStream << "Profile " << pProfile->nGetProfileID() << " nGetNumCellsInProfile() = " << nCell << endl;

      // }

      //

      // LogStream << endl;

      //

      // for (int nProfile = 0; nProfile < m_VCoast[nCoast].nGetNumProfiles(); nProfile++)

      // {

      // CGeomProfile* pProfile = m_VCoast[nCoast].pGetProfileWithDownCoastSeq(nProfile);

      // int nCell = pProfile->nGetNumCellsInProfile();

      // LogStream << "Profile " << pProfile->nGetProfileID() << " nGetNumCellsInProfile() = " << nCell << endl;

      // }

      //

      // LogStream << "====================" << endl;

      // }

      // // DEBUG CODE =====================


      // Change the wave properties in all shallow water sea cells: propagate waves and define the active zone, also locate wave shadow zones

      nRet = nDoAllPropagateWaves();

      if (nRet != RTN_OK)

         return nRet;


      // Output polygon share table and pre-existing sediment table to log file

      if (m_nLogFileDetail >= LOG_FILE_MIDDLE_DETAIL)

      {

         WritePolygonInfoTable();

         WritePolygonPreExistingSedimentTable();

      }


      // Tell the user how the simulation is progressing

      AnnounceProgress();


      //       // DEBUG CODE ===========================================================================================================

      // string strOutFile = m_strOutPath;

      // strOutFile += "sea_wave_height_CHECKPOINT_";

      // strOutFile += to_string(m_ulIter);

      // strOutFile += ".tif";

      //

      // GDALDriver* pDriver = GetGDALDriverManager()->GetDriverByName("gtiff");

      // GDALDataset* pDataSet = pDriver->Create(strOutFile.c_str(), m_nXGridSize, m_nYGridSize, 1, GDT_Float64, m_papszGDALRasterOptions);

      // pDataSet->SetProjection(m_strGDALBasementDEMProjection.c_str());

      // pDataSet->SetGeoTransform(m_dGeoTransform);

      //

      // int nn = 0;

      // double* pdRaster = new double[m_nXGridSize * m_nYGridSize];

      // for (int nY = 0; nY < m_nYGridSize; nY++)

      // {

      // for (int nX = 0; nX < m_nXGridSize; nX++)

      // {

      // pdRaster[nn++] = m_pRasterGrid->m_Cell[nX][nY].dGetWaveHeight();

      // }

      // }

      //

      // GDALRasterBand* pBand = pDataSet->GetRasterBand(1);

      // pBand->SetNoDataValue(m_dMissingValue);

      // int nRet = pBand->RasterIO(GF_Write, 0, 0, m_nXGridSize, m_nYGridSize, pdRaster, m_nXGridSize, m_nYGridSize, GDT_Float64, 0, 0, NULL);

      //

      // if (nRet == CE_Failure)

      // return RTN_ERR_GRIDCREATE;

      //

      // GDALClose(pDataSet);

      // delete[] pdRaster;

      //       // DEBUG CODE ===========================================================================================================

      //

      //       // DEBUG CODE ===========================================================================================================

      // strOutFile = m_strOutPath;

      // strOutFile += "sea_wave_angle_CHECKPOINT_";

      // strOutFile += to_string(m_ulIter);

      // strOutFile += ".tif";

      //

      // pDriver = GetGDALDriverManager()->GetDriverByName("gtiff");

      // pDataSet = pDriver->Create(strOutFile.c_str(), m_nXGridSize, m_nYGridSize, 1, GDT_Float64, m_papszGDALRasterOptions);

      // pDataSet->SetProjection(m_strGDALBasementDEMProjection.c_str());

      // pDataSet->SetGeoTransform(m_dGeoTransform);

      //

      // nn = 0;

      // pdRaster = new double[m_nXGridSize * m_nYGridSize];

      // for (int nY = 0; nY < m_nYGridSize; nY++)

      // {

      // for (int nX = 0; nX < m_nXGridSize; nX++)

      // {

      // pdRaster[nn++] = m_pRasterGrid->m_Cell[nX][nY].dGetWaveAngle();

      // }

      // }

      //

      // pBand = pDataSet->GetRasterBand(1);

      // pBand->SetNoDataValue(m_dMissingValue);

      // nRet = pBand->RasterIO(GF_Write, 0, 0, m_nXGridSize, m_nYGridSize, pdRaster, m_nXGridSize, m_nYGridSize, GDT_Float64, 0, 0, NULL);

      //

      // if (nRet == CE_Failure)

      // return RTN_ERR_GRIDCREATE;

      //

      // GDALClose(pDataSet);

      // delete[] pdRaster;

      //       // DEBUG CODE ===========================================================================================================


      // Save the not-deposited values, to be shown in the logfile after we've finished beach sediment movement

      m_dUnconsSandNotDepositedLastIter = m_dDepositionSandDiff;

      m_dUnconsCoarseNotDepositedLastIter = m_dDepositionCoarseDiff;


      if (m_nLogFileDetail >= LOG_FILE_MIDDLE_DETAIL)

         if (m_dDepositionSandDiff > MASS_BALANCE_TOLERANCE)

         {

            LogStream << m_ulIter << ": AT ITERATION START m_dDepositionSandDiff = " << m_dDepositionSandDiff * m_dCellArea << " m_dUnconsSandNotDepositedLastIter = " << m_dUnconsSandNotDepositedLastIter << endl;

            LogStream << m_ulIter << ": AT ITERATION START m_dDepositionCoarseDiff = " << m_dDepositionCoarseDiff * m_dCellArea << " m_dUnconsCoarseNotDepositedLastIter = " << m_dUnconsCoarseNotDepositedLastIter << endl;

         }


      if (m_bDoShorePlatformErosion)

      {

         // Calculate elevation change on the consolidated sediment which comprises the coastal platform

         nRet = nDoAllShorePlatFormErosion();

         if (nRet != RTN_OK)

            return nRet;

      }


      // Output shore platform erosion table to log file

      if (m_nLogFileDetail >= LOG_FILE_MIDDLE_DETAIL)

         WritePolygonShorePlatformErosion();


      // Are we considering cliff collapse?

      if (m_bHaveConsolidatedSediment && m_bDoCliffCollapse)

      {

         // Distribute wave energy to coast landforms (currently, this is only relevant to cliffs), maybe incise cliff notches, maybe do cliff collapses

         nRet = nDoAllWaveEnergyToCoastLandforms();

         if (nRet != RTN_OK)

            return nRet;


         // Output cliff collapse table to log file

         if (m_nLogFileDetail >= LOG_FILE_MIDDLE_DETAIL)

            WritePolygonCliffCollapseErosion();


         // Move some cliff collapse talus to unconsolidated sediment

         nRet = nMoveCliffTalusToUnconsolidated();

         if (nRet != RTN_OK)

            return nRet;

      }


      // Tell the user how the simulation is progressing

      AnnounceProgress();


      if (m_bDoBeachSedimentTransport)

      {

         // Next simulate beach erosion and deposition i.e. simulate alongshore transport of unconsolidated sediment (longshore drift) between polygons. First calculate potential sediment movement between polygons

         DoAllPotentialBeachErosion();


         // Do within-sediment redistribution of unconsolidated sediment, constraining potential sediment movement to give actual (i.e. supply-limited) sediment movement to/from each polygon in three size classes

         nRet = nDoAllActualBeachErosionAndDeposition();

         if (nRet != RTN_OK)

            return nRet;

      }


      // If we have sediment input events, then check to see whether this is time for an event to occur. If it is, then do it

      if (m_bSedimentInput)

      {

         nRet = nCheckForSedimentInputEvent();

         if (nRet != RTN_OK)

            return nRet;


         // If we have had at least one sediment input event this iteration, then output the sediment event per polygon table to the log file

         if (m_bSedimentInputThisIter && (m_nLogFileDetail >= LOG_FILE_MIDDLE_DETAIL))

            WritePolygonSedimentInputEventTable();

      }


      //       // Add the fine sediment that was eroded this timestep (from the shore platform, from cliff collapse, from erosion of existing fine sediment during cliff collapse talus deposition, and from beach erosion; minus the fine sediment from beach erosion that went off-grid) to the suspended sediment load

      // double dFineThisIter = m_dThisIterActualPlatformErosionFineCons + m_dThisIterCliffCollapseErosionFineUncons + m_dThisIterCliffCollapseErosionFineCons + m_dThisIterCliffCollapseFineErodedDuringDeposition + m_dThisIterBeachErosionFine - m_dThisIterLeftGridUnconsFine;

      //

      // m_dThisIterFineSedimentToSuspension += dFineThisIter;


      // Tell the user how the simulation is progressing

      AnnounceProgress();


      //       // DEBUG CODE ===========================================================================================================

      // string strOutFile = m_strOutPath;

      // strOutFile += "sea_wave_height_CHECKPOINT_";

      // strOutFile += to_string(m_ulIter);

      // strOutFile += ".tif";

      //

      // GDALDriver* pDriver = GetGDALDriverManager()->GetDriverByName("gtiff");

      // GDALDataset* pDataSet = pDriver->Create(strOutFile.c_str(), m_nXGridSize, m_nYGridSize, 1, GDT_Float64, m_papszGDALRasterOptions);

      // pDataSet->SetProjection(m_strGDALBasementDEMProjection.c_str());

      // pDataSet->SetGeoTransform(m_dGeoTransform);

      //

      // int nn = 0;

      // double* pdRaster = new double[m_nXGridSize * m_nYGridSize];

      // for (int nY = 0; nY < m_nYGridSize; nY++)

      // {

      // for (int nX = 0; nX < m_nXGridSize; nX++)

      // {

      // pdRaster[nn++] = m_pRasterGrid->m_Cell[nX][nY].dGetWaveHeight();

      // }

      // }

      //

      // GDALRasterBand* pBand = pDataSet->GetRasterBand(1);

      // pBand->SetNoDataValue(m_dMissingValue);

      // int nRet = pBand->RasterIO(GF_Write, 0, 0, m_nXGridSize, m_nYGridSize, pdRaster, m_nXGridSize, m_nYGridSize, GDT_Float64, 0, 0, NULL);

      //

      // if (nRet == CE_Failure)

      // return RTN_ERR_GRIDCREATE;

      //

      // GDALClose(pDataSet);

      // delete[] pdRaster;

      //       // DEBUG CODE ===========================================================================================================

      //

      //       // DEBUG CODE ===========================================================================================================

      // strOutFile = m_strOutPath;

      // strOutFile += "sea_wave_angle_CHECKPOINT_";

      // strOutFile += to_string(m_ulIter);

      // strOutFile += ".tif";

      //

      // pDriver = GetGDALDriverManager()->GetDriverByName("gtiff");

      // pDataSet = pDriver->Create(strOutFile.c_str(), m_nXGridSize, m_nYGridSize, 1, GDT_Float64, m_papszGDALRasterOptions);

      // pDataSet->SetProjection(m_strGDALBasementDEMProjection.c_str());

      // pDataSet->SetGeoTransform(m_dGeoTransform);

      //

      // nn = 0;

      // pdRaster = new double[m_nXGridSize * m_nYGridSize];

      // for (int nY = 0; nY < m_nYGridSize; nY++)

      // {

      // for (int nX = 0; nX < m_nXGridSize; nX++)

      // {

      // pdRaster[nn++] = m_pRasterGrid->m_Cell[nX][nY].dGetWaveAngle();

      // }

      // }

      //

      // pBand = pDataSet->GetRasterBand(1);

      // pBand->SetNoDataValue(m_dMissingValue);

      // nRet = pBand->RasterIO(GF_Write, 0, 0, m_nXGridSize, m_nYGridSize, pdRaster, m_nXGridSize, m_nYGridSize, GDT_Float64, 0, 0, NULL);

      //

      // if (nRet == CE_Failure)

      // return RTN_ERR_GRIDCREATE;

      //

      // GDALClose(pDataSet);

      // delete[] pdRaster;

      //       // DEBUG CODE ===========================================================================================================


      // Do some end-of-timestep updates to the raster grid, also update per-timestep and running totals

      nRet = nUpdateGrid();

      if (nRet != RTN_OK)

         return nRet;


      // Make water level inundation on grid

      if (m_bFloodSWLSetupSurgeLine || m_bSetupSurgeFloodMaskSave)

      {

         m_nLevel = 0;


         nRet = nLocateFloodAndCoasts();

         if (nRet != RTN_OK)

            return nRet;

      }


      if (m_bFloodSWLSetupSurgeRunupLineSave || m_bSetupSurgeRunupFloodMaskSave)

      {

         // TODO 007 Finish surge and runup stuff

         m_nLevel = 1;


         nRet = nLocateFloodAndCoasts();

         if (nRet != RTN_OK)

            return nRet;

      }


      // Now save results, first the raster and vector GIS files if required

      m_bSaveGISThisIter = false;


      if ((m_bSaveRegular && (m_dSimElapsed >= m_dRegularSaveTime) && (m_dSimElapsed < m_dSimDuration)) || (! m_bSaveRegular && (m_dSimElapsed >= m_dUSaveTime[m_nThisSave])))

      {

         m_bSaveGISThisIter = true;


         // Save the values from the RasterGrid array into raster GIS files

         if (! bSaveAllRasterGISFiles())

            return (RTN_ERR_RASTER_FILE_WRITE);


         // Tell the user how the simulation is progressing

         AnnounceProgress();


         // Save the vector GIS files

         if (! bSaveAllVectorGISFiles())

            return (RTN_ERR_VECTOR_FILE_WRITE);


         // Tell the user how the simulation is progressing

         AnnounceProgress();

      }


      // Output per-timestep results to the .out file

      if (! bWritePerTimestepResults())

         return (RTN_ERR_TEXT_FILE_WRITE);


      // Now output time series CSV stuff

      if (! bWriteTSFiles())

         return (RTN_ERR_TIMESERIES_FILE_WRITE);


      // Tell the user how the simulation is progressing

      AnnounceProgress();


      // Update grand totals

      DoEndOfTimestepTotals();


   } // ================================================ End of main loop ======================================================


   // =================================================== post-loop tidying =====================================================

   // Tell the user what is happening

   AnnounceSimEnd();


   // Write end-of-run information to Out, Log and time-series files

   nRet = nWriteEndRunDetails();

   if (nRet != RTN_OK)

      return (nRet);


   // Do end-of-run memory clearance

   DoEndOfRunDeletes();

   return RTN_OK;

}


CGeomRasterGrid
Geometry cass used to represent the raster grid of cell objects.
Definition raster_grid.h:29

CSimulation::m_dThisIterPotentialBeachErosion
double m_dThisIterPotentialBeachErosion
Total potential beach erosion (all size classes of unconsolidated sediment) for this iteration (depth...
Definition simulation.h:861

CSimulation::m_dCliffDepositionPlanviewWidth
double m_dCliffDepositionPlanviewWidth
Planview width of cliff collapse talus (m)
Definition simulation.h:939

CSimulation::m_bCliffCollapseSave
bool m_bCliffCollapseSave
Save cliff collapse raster GIS files?
Definition simulation.h:216

CSimulation::m_nLogFileDetail
int m_nLogFileDetail
The level of detail in the log file output. Can be LOG_FILE_LOW_DETAIL, LOG_FILE_MIDDLE_DETAIL,...
Definition simulation.h:588

CSimulation::m_bAvgSeaDepthSave
bool m_bAvgSeaDepthSave
Save average sea depth raster GIS files?
Definition simulation.h:105

CSimulation::m_bCliffToeLocate
bool m_bCliffToeLocate
Cliff to location?
Definition simulation.h:462

CSimulation::m_VstrInitialSandConsSedimentFile
vector< string > m_VstrInitialSandConsSedimentFile
The name of the initial sand-sized consolidated sediment GIS file.
Definition simulation.h:1480

CSimulation::m_dAllCellsDeepWaterWaveHeight
double m_dAllCellsDeepWaterWaveHeight
Deep water wave height (m) for all sea cells.
Definition simulation.h:768

CSimulation::m_bDeepWaterWaveAngleSave
bool m_bDeepWaterWaveAngleSave
Save deep water wave angle raster GIS files?
Definition simulation.h:243

CSimulation::m_nGISMaxSaveDigits
int m_nGISMaxSaveDigits
The maximum number of digits in GIS filenames. These can be sequential, or the iteration number.
Definition simulation.h:516

CSimulation::m_nYMinBoundingBox
int m_nYMinBoundingBox
The minimum y value of the bounding box.
Definition simulation.h:558

CSimulation::AnnounceReadSCAPEShapeFunctionFile
static void AnnounceReadSCAPEShapeFunctionFile(void)
Now reading the SCAPE shape function file.
Definition utils.cpp:734

CSimulation::CalcSavitzkyGolayCoeffs
void CalcSavitzkyGolayCoeffs(void)
Calculates the Savitzky-Golay smoothing coefficients for a given size of smoothing window....
Definition smooth_line.cpp:48

CSimulation::m_strInitialSuspSedimentFile
string m_strInitialSuspSedimentFile
Name of initial suspended sediment file.
Definition simulation.h:1180

CSimulation::m_bSlopeConsSedSave
bool m_bSlopeConsSedSave
Save slope of consolidated sediment raster GIS files?
Definition simulation.h:174

CSimulation::WritePolygonShorePlatformErosion
void WritePolygonShorePlatformErosion(void)
Writes to the log file a table showing per-polygon unconsolidated sand/coarse sediment derived from e...
Definition write_output.cpp:1775

CSimulation::m_nNumTotCliffCollapse
int m_nNumTotCliffCollapse
The total number of cells with cliff collapse since the start of the simulation.
Definition simulation.h:537

CSimulation::bCheckRasterGISOutputFormat
bool bCheckRasterGISOutputFormat(void)
Checks whether the selected raster GDAL driver supports file creation, 32-bit doubles,...
Definition gis_utils.cpp:711

CSimulation::AnnounceIsRunning
static void AnnounceIsRunning(void)
Tell the user that the simulation is now running.
Definition utils.cpp:751

CSimulation::m_bFineUnconsSedSave
bool m_bFineUnconsSedSave
Save fine unconsolidated sediment raster GIS files?
Definition simulation.h:189

CSimulation::m_bHaveConsolidatedSediment
bool m_bHaveConsolidatedSediment
Does this simulation consider consolidated sediment, or is it an unconsolidated sediment only simulat...
Definition simulation.h:456

CSimulation::m_bFloodSWLSetupSurgeLine
bool m_bFloodSWLSetupSurgeLine
Are we saving the flood still water level setup surge line? TODO 007 Finish surge and runup stuff.
Definition simulation.h:441

CSimulation::m_tSysEndTime
time_t m_tSysEndTime
System finish-simulation time.
Definition simulation.h:1339

CSimulation::m_dTotalCoarseUnconsInPolygons
double m_dTotalCoarseUnconsInPolygons
Total coarse unconsolidated sediment in all polygons, before polygon-to-polygon movement (only cells ...
Definition simulation.h:1032

CSimulation::m_bSedimentInputAtPoint
bool m_bSedimentInputAtPoint
Do we have sediment inputat a point?
Definition simulation.h:396

CSimulation::m_dG
double m_dG
Gravitational acceleration (m**2/sec)
Definition simulation.h:825

CSimulation::m_VstrInitialCoarseUnconsSedimentFile
vector< string > m_VstrInitialCoarseUnconsSedimentFile
The name of the initial coarse-sized unconsolidated sediment GIS file.
Definition simulation.h:1474

CSimulation::AnnounceReadDeepWaterWaveValuesGIS
void AnnounceReadDeepWaterWaveValuesGIS(void) const
Tells the user that we are now reading the deep water wave values GIS file.
Definition utils.cpp:586

CSimulation::m_dThisIterSWL
double m_dThisIterSWL
The still water level for this timestep (this includes tidal changes and any long-term SWL change)
Definition simulation.h:726

CSimulation::m_nBeachErosionDepositionEquation
int m_nBeachErosionDepositionEquation
Which beach erosion-deposition equation is used. Possible values are UNCONS_SEDIMENT_EQUATION_CERC an...
Definition simulation.h:543

CSimulation::CliffCollapseNetChangeTSStream
ofstream CliffCollapseNetChangeTSStream
Cliff collapse net change (erosion - deposition) time series file output stream.
Definition simulation.h:1360

CSimulation::m_bCoastSave
bool m_bCoastSave
Save coastline as vector GIS file?
Definition simulation.h:261

CSimulation::m_bBeachDepositionTSSave
bool m_bBeachDepositionTSSave
Save the beach (unconsolidated sediment) deposition time series file?
Definition simulation.h:315

CSimulation::bWritePerTimestepResults
bool bWritePerTimestepResults(void)
Write the results for this timestep to the .out file.
Definition write_output.cpp:667

CSimulation::m_pRasterGrid
CGeomRasterGrid * m_pRasterGrid
Pointer to the raster grid object.
Definition simulation.h:1558

CSimulation::nMoveCliffTalusToUnconsolidated
int nMoveCliffTalusToUnconsolidated(void)
Move talus from previous cliff collapse to unconsolidated sediment.
Definition do_cliff_collapse.cpp:744

CSimulation::AnnounceReadInitialSandConsSedGIS
void AnnounceReadInitialSandConsSedGIS(int const) const
Tells the user that we are now reading the initial sand consolidated sediment depth GIS file.
Definition utils.cpp:696

CSimulation::m_nXGridSize
int m_nXGridSize
The size of the grid in the x direction.
Definition simulation.h:477

CSimulation::nAssignLandformsForAllCoasts
int nAssignLandformsForAllCoasts(void)
Each timestep, classify coastal landforms and assign a coastal landform object to every point on ever...
Definition assign_landforms.cpp:40

CSimulation::AnnounceReadInitialSandUnconsSedGIS
void AnnounceReadInitialSandUnconsSedGIS(int const) const
Tells the user that we are now reading the initial sand unconsolidated sediment depth GIS file.
Definition utils.cpp:657

CSimulation::m_dL_0
double m_dL_0
Deep water wave length (m)
Definition simulation.h:759

CSimulation::m_dWaveDataWrapHours
double m_dWaveDataWrapHours
Number of hours after which deep water wave data wraps.
Definition simulation.h:984

CSimulation::m_dMaxUserInputWavePeriod
double m_dMaxUserInputWavePeriod
Used to constrain depth of closure.
Definition simulation.h:780

CSimulation::WritePolygonInfoTable
void WritePolygonInfoTable(void)
Writes to the log file a table showing polygon info for all coasts.
Definition write_output.cpp:1643

CSimulation::m_bFloodSetupSurgeRunupTSSave
bool m_bFloodSetupSurgeRunupTSSave
Save the flood setup surge runup time series file? TODO 007 Finish surge and runup stuff.
Definition simulation.h:327

CSimulation::m_bTopSurfIncSeaSave
bool m_bTopSurfIncSeaSave
Save top surface (sediment, talus, and sea) raster DEMs?
Definition simulation.h:87

CSimulation::bSetUpTSFiles
bool bSetUpTSFiles(void)
This member function intialises the time series files.
Definition utils.cpp:1215

CSimulation::LogStream
ofstream LogStream
Definition simulation.h:1893

CSimulation::nWriteEndRunDetails
int nWriteEndRunDetails(void)
Writes end-of-run information to Out, Log and time-series files.
Definition write_output.cpp:1422

CSimulation::AnnounceReadInitialFineUnconsSedGIS
void AnnounceReadInitialFineUnconsSedGIS(int const) const
Tells the user that we are now reading the initial fine unconsolidated sediment depth GIS file.
Definition utils.cpp:644

CSimulation::m_dThisIterBeachErosionCoarse
double m_dThisIterBeachErosionCoarse
Total actual beach erosion (coarse unconsolidated sediment) for this iteration (depth in m)
Definition simulation.h:870

CSimulation::m_nGISMissingValue
int m_nGISMissingValue
The value for integer missing values, as read from GIS input files.
Definition simulation.h:546

CSimulation::m_papszGDALVectorOptions
char ** m_papszGDALVectorOptions
Options for GDAL when handling vector files.
Definition simulation.h:474

CSimulation::m_bSedIncTalusTopSurfSave
bool m_bSedIncTalusTopSurfSave
Save sediment (inc talus) top surface raster DEMs?
Definition simulation.h:84

CSimulation::m_dStartIterUnconsCoarseAllCells
double m_dStartIterUnconsCoarseAllCells
Depth (m) of coarse unconsolidated sediment at the start of the simulation, all cells (both inside an...
Definition simulation.h:1014

CSimulation::nReadRasterGISFile
int nReadRasterGISFile(int const, int const)
Reads raster GIS datafiles into the RasterGrid array.
Definition gis_raster.cpp:568

CSimulation::m_VCoast
vector< CRWCoast > m_VCoast
The coastline objects.
Definition simulation.h:1561

CSimulation::m_dCoastNormalLength
double m_dCoastNormalLength
Length of the coastline-normal profiles, in m.
Definition simulation.h:840

CSimulation::nLocateFloodAndCoasts
int nLocateFloodAndCoasts(void)
First find all connected sea areas, then locate the vector coastline(s), then put these onto the rast...
Definition locate_coast.cpp:1574

CSimulation::m_bSaveGISThisIter
bool m_bSaveGISThisIter
Save GIS files this iteration?
Definition simulation.h:333

CSimulation::m_ldGTotCliffCollapseCoarseErodedDuringDeposition
long double m_ldGTotCliffCollapseCoarseErodedDuringDeposition
All-simulation total of coarse sediment eroded during talus deposition following cliff collapse (m)
Definition simulation.h:1111

CSimulation::m_dGISMissingValue
double m_dGISMissingValue
The value for floating-point missing values, as read from GIS input files.
Definition simulation.h:978

CSimulation::m_dUnconsCoarseNotDepositedLastIter
double m_dUnconsCoarseNotDepositedLastIter
Depth of unconsolidated coarse sediment that could not be deposited during the last iteration,...
Definition simulation.h:1047

CSimulation::m_dCPUClock
double m_dCPUClock
Total elapsed CPU time.
Definition simulation.h:708

CSimulation::bSaveAllVectorGISFiles
bool bSaveAllVectorGISFiles(void)
The bSaveAllvectorGISFiles member function saves the vector GIS files TODO 081 Choose more files to o...
Definition gis_utils.cpp:1323

CSimulation::m_bSingleDeepWaterWaveValues
bool m_bSingleDeepWaterWaveValues
Do we have just a point source for (i.e. only a single measurement of) deep water wave values.
Definition simulation.h:387

CSimulation::nDoMultipleCoastlines
int nDoMultipleCoastlines(void)
Checks all profiles on all coasts for intersections between profiles belonging to different coasts.
Definition multiple_coastlines.cpp:42

CSimulation::m_nThisSave
int m_nThisSave
Used in calculations of GIS save intervals.
Definition simulation.h:525

CSimulation::m_lGDALMaxCanWrite
long m_lGDALMaxCanWrite
The maximum integer value which GDAL can write, can be UINT8_MAX, INT16_MAX, UINT16_MAX,...
Definition simulation.h:603

CSimulation::m_bAvgWaveAngleAndHeightSave
bool m_bAvgWaveAngleAndHeightSave
Save average wave angle and average wave height raster GIS files?
Definition simulation.h:123

CSimulation::m_dSouthEastXExtCRS
double m_dSouthEastXExtCRS
The south-east x coordinate, in the external coordinate reference system (CRS)
Definition simulation.h:663

CSimulation::m_nMissingValue
int m_nMissingValue
Used by CoastalME for integer missing values.
Definition simulation.h:549

CSimulation::m_bAvgWaveAngleSave
bool m_bAvgWaveAngleSave
Save average wave angle raster GIS files?
Definition simulation.h:117

CSimulation::m_ldGTotActualCoarseBeachErosion
long double m_ldGTotActualCoarseBeachErosion
All-simulation total of coarse sediment eroded during beach (unconsolidated sediment) movement (m)
Definition simulation.h:1123

CSimulation::nCalcExternalForcing
int nCalcExternalForcing(void)
Calculate external forcings: change in still water level, tide level and deep water waves height,...
Definition calc_external_forcing.cpp:29

CSimulation::nReadWaveStationInputFile
int nReadWaveStationInputFile(int const)
Definition read_input.cpp:3539

CSimulation::m_bCliffEdgeSave
bool m_bCliffEdgeSave
Save cliff edge vector GIS files?
Definition simulation.h:264

CSimulation::m_dFineErodibilityNormalized
double m_dFineErodibilityNormalized
Relative erodibility of fine unconsolidated beach sediment, normalized.
Definition simulation.h:810

CSimulation::m_dThisIterCliffCollapseFineErodedDuringDeposition
double m_dThisIterCliffCollapseFineErodedDuringDeposition
Total fine sediment eroded during Dean profile deposition of talus following cliff collapse (depth in...
Definition simulation.h:894

CSimulation::m_bInvalidNormalsSave
bool m_bInvalidNormalsSave
Save invalid coastline-normal vector GIS files?
Definition simulation.h:270

CSimulation::m_bShadowBoundarySave
bool m_bShadowBoundarySave
Save wave shadow boundary vector GIS files?
Definition simulation.h:288

CSimulation::m_dThisIterDiffWaveSetupSurgeWaterLevel
double m_dThisIterDiffWaveSetupSurgeWaterLevel
TODO 007 Finish surge and runup stuff.
Definition simulation.h:747

CSimulation::nReadSedimentInputEventFile
int nReadSedimentInputEventFile(void)
Reads the sediment input event file.
Definition read_input.cpp:3872

CSimulation::m_dThisIterActualPlatformErosionCoarseCons
double m_dThisIterActualPlatformErosionCoarseCons
Total actual platform erosion (coarse consolidated sediment) for this iteration (depth in m)
Definition simulation.h:858

CSimulation::m_nNumThisIterCliffCollapse
int m_nNumThisIterCliffCollapse
The number of cells with cliff collapse this iteration.
Definition simulation.h:534

CSimulation::m_bActualBeachErosionSave
bool m_bActualBeachErosionSave
Save actual (supply-limited) beach (unconsolidated sediment) erosion raster GIS files?
Definition simulation.h:156

CSimulation::nDoAllShorePlatFormErosion
int nDoAllShorePlatFormErosion(void)
Does platform erosion on all coastlines by first calculating platform erosion on coastline-normal pro...
Definition do_shore_platform_erosion.cpp:44

CSimulation::m_nYGridSize
int m_nYGridSize
The size of the grid in the y direction.
Definition simulation.h:480

CSimulation::nLocateCliffToe
int nLocateCliffToe(void)
Definition locate_cliff_toe.cpp:54

CSimulation::m_dThisIterTopElevMin
double m_dThisIterTopElevMin
This-iteration lowest elevation of DEM.
Definition simulation.h:990

CSimulation::m_bRunUpSave
bool m_bRunUpSave
Are we saving runup? TODO 007 Finish surge and runup stuff.
Definition simulation.h:420

CSimulation::m_GDALWriteIntDataType
GDALDataType m_GDALWriteIntDataType
The data type used by GDAL for integer operations, can be GDT_Byte, GDT_Int16, GDT_UInt16,...
Definition simulation.h:597

CSimulation::m_ldGTotCliffTalusFineToSuspension
long double m_ldGTotCliffTalusFineToSuspension
All-simulation total of fine sediment moved to suspension, due to cliff collapse (m)
Definition simulation.h:1096

CSimulation::m_bYamlInputFormat
bool m_bYamlInputFormat
Use YAML format for input datafile instead of .dat format?
Definition simulation.h:348

CSimulation::m_bCliffCollapseDepositionSave
bool m_bCliffCollapseDepositionSave
Save cliff collapse deposition raster GIS files?
Definition simulation.h:222

CSimulation::m_bTotalActualPlatformErosionSave
bool m_bTotalActualPlatformErosionSave
Save total actual (supply-limited) shore platform erosion raster GIS files?
Definition simulation.h:150

CSimulation::m_bPolygonUnconsSedUpOrDownDriftSave
bool m_bPolygonUnconsSedUpOrDownDriftSave
Save polygon unconsolidated sediment up- or down-drift raster GIS files?
Definition simulation.h:252

CSimulation::m_dCoarseErodibility
double m_dCoarseErodibility
The relative erodibility (0-1) of coarse unconsolidated beach sediment.
Definition simulation.h:807

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

CSimulation::m_dMaxSWLSoFar
double m_dMaxSWLSoFar
Maximum still water level (m)
Definition simulation.h:738

CSimulation::m_dCliffTalusMinDepositionLength
double m_dCliffTalusMinDepositionLength
Planview length of cliff deposition talus (m)
Definition simulation.h:942

CSimulation::m_VstrInitialFineConsSedimentFile
vector< string > m_VstrInitialFineConsSedimentFile
The name of the initial fine-sized consolidated sediment GIS file.
Definition simulation.h:1477

CSimulation::m_dMissingValue
double m_dMissingValue
Used by CoastalME for floating-point missing values.
Definition simulation.h:981

CSimulation::m_dNotchIncisionAtCollapse
double m_dNotchIncisionAtCollapse
Notch overhang (i.e. length of horizontal incision at the apex elevation) to initiate collapse (m)
Definition simulation.h:927

CSimulation::m_nUnconsSedimentHandlingAtGridEdges
int m_nUnconsSedimentHandlingAtGridEdges
How sediment which moves off an edge of the grid is handled. Possible values are GRID_EDGE_CLOSED,...
Definition simulation.h:540

CSimulation::m_dSandErodibility
double m_dSandErodibility
The relative erodibility (0-1) of sand unconsolidated beach sediment.
Definition simulation.h:804

CSimulation::m_bBasementElevSave
bool m_bBasementElevSave
Save basement raster DEMs?
Definition simulation.h:81

CSimulation::m_dInvCellDiagonal
double m_dInvCellDiagonal
Inverse of m_dCellDiagonal.
Definition simulation.h:684

CSimulation::m_nSimStartHour
int m_nSimStartHour
Start time of the simulation (hours)
Definition simulation.h:573

CSimulation::m_dCoarseErodibilityNormalized
double m_dCoarseErodibilityNormalized
Relative erodibility of coarse unconsolidated beach sediment, normalized.
Definition simulation.h:816

CSimulation::m_bCoarseUnconsSedSave
bool m_bCoarseUnconsSedSave
Save coarse unconsolidated sediment raster GIS files?
Definition simulation.h:195

CSimulation::m_bSuspSedTSSave
bool m_bSuspSedTSSave
Save the suspended sediment time series file?
Definition simulation.h:321

CSimulation::m_bCliffCollapseNetTSSave
bool m_bCliffCollapseNetTSSave
Save the cliff collapse net change time series file?
Definition simulation.h:309

CSimulation::m_dStartIterSuspFineInPolygons
double m_dStartIterSuspFineInPolygons
Depth (m) of fine suspended sediment at the start of the simulation (only cells in polygons)
Definition simulation.h:1005

CSimulation::m_bPotentialPlatformErosionMaskSave
bool m_bPotentialPlatformErosionMaskSave
Save potential platform erosion mask raster GIS files?
Definition simulation.h:231

CSimulation::m_ulThisIterNumCoastCells
unsigned long m_ulThisIterNumCoastCells
The number of grid cells which are marked as coast, for this iteration.
Definition simulation.h:624

CSimulation::AnnounceSimEnd
static void AnnounceSimEnd(void)
Announce the end of the simulation.
Definition utils.cpp:1549

CSimulation::m_ulNumCells
unsigned long m_ulNumCells
The number of cells in the grid.
Definition simulation.h:618

CSimulation::m_dTotPotentialPlatformErosionBetweenProfiles
double m_dTotPotentialPlatformErosionBetweenProfiles
Total potential platform erosion between profiles.
Definition simulation.h:915

CSimulation::AnnounceReadICGIS
void AnnounceReadICGIS(void) const
Tells the user that we are now reading the Intervention class GIS file.
Definition utils.cpp:556

CSimulation::m_bFloodLocationSave
bool m_bFloodLocationSave
Are we saving the flood location? TODO 007 Finish surge and runup stuff.
Definition simulation.h:435

CSimulation::nCheckForSedimentInputEvent
int nCheckForSedimentInputEvent(void)
Check to see if we have any sediment input events this timestep, if so then do the event(s)
Definition do_sediment_input_event.cpp:40

CSimulation::m_dWaveDepthRatioForWaveCalcs
double m_dWaveDepthRatioForWaveCalcs
Start depth for wave calculations.
Definition simulation.h:762

CSimulation::m_bWaveHeightSave
bool m_bWaveHeightSave
Save wave height raster GIS files?
Definition simulation.h:108

CSimulation::WriteStartRunDetails
void WriteStartRunDetails(void)
Writes beginning-of-run information to Out and Log files.
Definition write_output.cpp:59

CSimulation::m_dThisIterCliffCollapseErosionCoarseUncons
double m_dThisIterCliffCollapseErosionCoarseUncons
This-iteration total of coarse unconsolidated sediment produced by cliff collapse (m^3)
Definition simulation.h:954

CSimulation::m_bGDALCanCreate
bool m_bGDALCanCreate
Is the selected GDAL output file format capable of writing files?
Definition simulation.h:372

CSimulation::m_bLandformSave
bool m_bLandformSave
Save coast landform raster GIS files?
Definition simulation.h:171

CSimulation::CliffCollapseDepositionTSStream
ofstream CliffCollapseDepositionTSStream
Cliff collapse deposition time series file output stream.
Definition simulation.h:1357

CSimulation::m_ldGTotCoarseBeachDeposition
long double m_ldGTotCoarseBeachDeposition
All-simulation total of coarse sediment deposited during beach (unconsolidated sediment) movement (m)
Definition simulation.h:1129

CSimulation::m_dDepositionCoarseDiff
double m_dDepositionCoarseDiff
Error term: if we are unable to deposit enough unconslidated coarse on polygon(s),...
Definition simulation.h:906

CSimulation::m_bTotalBeachDepositionSave
bool m_bTotalBeachDepositionSave
Save total beach (unconsolidated sediment) deposition raster GIS files?
Definition simulation.h:168

CSimulation::m_nCoastMax
int m_nCoastMax
Maximum valid coast length when searching for coasts.
Definition simulation.h:528

CSimulation::m_dBeachSedimentPorosity
double m_dBeachSedimentPorosity
The porosity of unconsolidated beach sediment (0-1)
Definition simulation.h:798

CSimulation::AnnounceFinalInitialization
static void AnnounceFinalInitialization(void)
Tells the user that we are now initializing.
Definition utils.cpp:742

CSimulation::m_nSimStartSec
int m_nSimStartSec
Start time of the simulation (seconds)
Definition simulation.h:567

CSimulation::m_nSimStartDay
int m_nSimStartDay
Start date of the simulation (day)
Definition simulation.h:576

CSimulation::m_bGDALOptimisations
bool m_bGDALOptimisations
GDAL optimisations enabled?
Definition simulation.h:459

CSimulation::m_ulThisIterNumActualPlatformErosionCells
unsigned long m_ulThisIterNumActualPlatformErosionCells
The number of grid cells on which actual platform erosion occurs, for this iteration.
Definition simulation.h:630

CSimulation::m_bSandUnconsSedSave
bool m_bSandUnconsSedSave
Save sand unconsolidated sediment raster GIS files?
Definition simulation.h:192

CSimulation::m_bActualPlatformErosionTSSave
bool m_bActualPlatformErosionTSSave
Save the actual (supply-limited) shore platform erosion time series file?
Definition simulation.h:300

CSimulation::m_nCoastNormalSpacing
int m_nCoastNormalSpacing
Average spacing between coastline normals, measured in cells.
Definition simulation.h:507

CSimulation::m_nXMaxBoundingBox
int m_nXMaxBoundingBox
The maximum x value of the bounding box.
Definition simulation.h:555

CSimulation::m_ldGTotPotentialSedLostBeachErosion
long double m_ldGTotPotentialSedLostBeachErosion
All-simulation total of potential sediment lost via beach (unconsolidated) sediment movement (m),...
Definition simulation.h:1069

CSimulation::m_dThisIterCliffCollapseErosionFineUncons
double m_dThisIterCliffCollapseErosionFineUncons
This-iteration total of fine unconsolidated sediment produced by cliff collapse (m^3)
Definition simulation.h:948

CSimulation::m_bTotCliffCollapseSave
bool m_bTotCliffCollapseSave
Save total cliff collapse raster GIS files?
Definition simulation.h:219

CSimulation::nReadShapeFunctionFile
int nReadShapeFunctionFile(void)
Definition read_input.cpp:3428

CSimulation::AnnounceAddLayers
static void AnnounceAddLayers(void)
Tells the user that we are now adding layers.
Definition utils.cpp:516

CSimulation::m_ulMissingValue
unsigned long m_ulMissingValue
Used by CoastalME for unsigned long integer missing values.
Definition simulation.h:651

CSimulation::nDoAllActualBeachErosionAndDeposition
int nDoAllActualBeachErosionAndDeposition(void)
Does between-polygon and within-polygon actual (supply-limited) redistribution of transported beach s...
Definition do_beach_sediment_movement.cpp:222

CSimulation::m_bDoShorePlatformErosion
bool m_bDoShorePlatformErosion
Simulate shore platform erosion?
Definition simulation.h:363

CSimulation::m_bLowestSWLSoFar
bool m_bLowestSWLSoFar
Do we have the lowest SWL so far?
Definition simulation.h:468

CSimulation::m_bSliceSave
bool m_bSliceSave
Save slices?
Definition simulation.h:99

CSimulation::m_bRasterPolygonSave
bool m_bRasterPolygonSave
Save raster polygon raster GIS files?
Definition simulation.h:228

CSimulation::m_dInitialMeanSWL
double m_dInitialMeanSWL
The start-of-simulation still water level (m)
Definition simulation.h:717

CSimulation::m_bBeachDepositionSave
bool m_bBeachDepositionSave
Save beach (unconsolidated sediment) deposition raster GIS files?
Definition simulation.h:165

CSimulation::m_dThisIterNewNotchApexElev
double m_dThisIterNewNotchApexElev
Elevation (m) of the apex of any cliff notches created during this iteration.
Definition simulation.h:930

CSimulation::m_dNorthWestYExtCRS
double m_dNorthWestYExtCRS
The north-west y coordinate, in the external coordinate reference system (CRS)
Definition simulation.h:660

CSimulation::m_bSaveRegular
bool m_bSaveRegular
Save GIS files at regular intervals?
Definition simulation.h:258

CSimulation::m_nLayers
int m_nLayers
The number of sediment layers.
Definition simulation.h:483

CSimulation::bFindExeDir
bool bFindExeDir(char const *)
Finds the folder (directory) in which the CoastalME executable is located.
Definition utils.cpp:316

CSimulation::m_dStartIterConsCoarseAllCells
double m_dStartIterConsCoarseAllCells
Depth (m) of coarse consolidated sediment at the start of the simulation, all cells (both inside and ...
Definition simulation.h:1023

CSimulation::m_dStartIterConsSandAllCells
double m_dStartIterConsSandAllCells
Depth (m) of sand consolidated sediment at the start of the simulation, all cells (both inside and ou...
Definition simulation.h:1020

CSimulation::m_nCoastSmoothingWindowSize
int m_nCoastSmoothingWindowSize
The size of the window used for coast smoothing. Must be an odd number.
Definition simulation.h:489

CSimulation::m_bSedimentInputAlongLine
bool m_bSedimentInputAlongLine
Do we have sediment input along a line?
Definition simulation.h:402

CSimulation::m_bSedimentInput
bool m_bSedimentInput
Do we have sediment input events?
Definition simulation.h:393

CSimulation::m_bFloodSWLSetupSurgeRunupLineSave
bool m_bFloodSWLSetupSurgeRunupLineSave
Are we saving the flood still water level setup surge runup line? TODO 007 Finish surge and runup stu...
Definition simulation.h:450

CSimulation::m_ulThisIterNumBeachDepositionCells
unsigned long m_ulThisIterNumBeachDepositionCells
The number of grid cells on which beach (unconsolidated sediment) deposition occurs,...
Definition simulation.h:639

CSimulation::m_dInmersedToBulkVolumetric
double m_dInmersedToBulkVolumetric
For beach erosion/deposition, conversion from immersed weight to bulk volumetric (sand and voids) tra...
Definition simulation.h:828

CSimulation::m_bNormalsSave
bool m_bNormalsSave
Save coastline-normal vector GIS files?
Definition simulation.h:267

CSimulation::m_bAvgWaveHeightSave
bool m_bAvgWaveHeightSave
Save wave height raster GIS files?
Definition simulation.h:111

CSimulation::CSimulation
CSimulation(void)
The CSimulation constructor.
Definition simulation.cpp:60

CSimulation::m_dDepositionSandDiff
double m_dDepositionSandDiff
Error term: if we are unable to deposit enough unconslidated sand on polygon(s), this is held over to...
Definition simulation.h:903

CSimulation::m_bHaveSandSediment
bool m_bHaveSandSediment
Does this simulation consider sand-sized sediment?
Definition simulation.h:75

CSimulation::m_ulMissingValueBasementCells
unsigned long m_ulMissingValueBasementCells
The number of basement cells marked with as missing value.
Definition simulation.h:648

CSimulation::m_dThisiterUnconsCoarseInput
double m_dThisiterUnconsCoarseInput
Depth (m) of coarse unconsolidated sediment added, at this iteration.
Definition simulation.h:999

CSimulation::nReadVectorGISFile
int nReadVectorGISFile(int const)
Reads vector GIS datafiles using GDAL/OGR.
Definition gis_vector.cpp:46

CSimulation::bReadRunDataFile
bool bReadRunDataFile(void)
Reads the run details input file and does some initialization.
Definition read_input.cpp:247

CSimulation::m_nUSave
int m_nUSave
If user-defined GIS save intervals, the number of these.
Definition simulation.h:522

CSimulation::m_dThisIterPotentialPlatformErosion
double m_dThisIterPotentialPlatformErosion
Total potential platform erosion (all size classes of consolidated sediment) for this iteration (dept...
Definition simulation.h:849

CSimulation::bWriteTSFiles
bool bWriteTSFiles(void)
Write the results for this timestep to the time series CSV files.
Definition write_output.cpp:1091

CSimulation::m_dDeanProfileStartAboveSWL
double m_dDeanProfileStartAboveSWL
Berm height i.e. height above SWL of start of depositional Dean profile.
Definition simulation.h:975

CSimulation::m_nSavGolCoastPoly
int m_nSavGolCoastPoly
The order of the coastline profile smoothing polynomial if Savitzky-Golay smoothing is used (usually ...
Definition simulation.h:492

CSimulation::m_bSeaDepthSave
bool m_bSeaDepthSave
Save sea depth raster GIS files?
Definition simulation.h:102

CSimulation::m_bWaveAngleAndHeightSave
bool m_bWaveAngleAndHeightSave
Save wave angle and wave height raster GIS files?
Definition simulation.h:120

CSimulation::m_nRunUpEquation
int m_nRunUpEquation
The run-up equation used TODO 007 Finish surge and runup stuff.
Definition simulation.h:591

CSimulation::m_ldGTotCliffCollapseFine
long double m_ldGTotCliffCollapseFine
All-simulation total of fine sediment from cliff collapse (m)
Definition simulation.h:1087

CSimulation::m_bWorldFile
bool m_bWorldFile
Write a GIS World file?
Definition simulation.h:384

CSimulation::m_ldGTotCliffTalusCoarseDeposition
long double m_ldGTotCliffTalusCoarseDeposition
All-simulation total of coarse sediment deposited as talus following cliff collapse (m)
Definition simulation.h:1102

CSimulation::AnnounceReadSedimentEventInputValuesGIS
void AnnounceReadSedimentEventInputValuesGIS(void) const
Tells the user that we are now reading the sediment input events GIS file.
Definition utils.cpp:601

CSimulation::m_dDepthOverDBMax
double m_dDepthOverDBMax
Maximum value of deoth over DB, is used in erosion potential look-up function.
Definition simulation.h:909

CSimulation::m_ldGTotCliffCollapseCoarse
long double m_ldGTotCliffCollapseCoarse
All-simulation total of coarse sediment from cliff collapse (m)
Definition simulation.h:1093

CSimulation::m_nCoastNormalInterventionSpacing
int m_nCoastNormalInterventionSpacing
Average spacing between coastline normals on interventions, measured in cells.
Definition simulation.h:510

CSimulation::m_dFineErodibility
double m_dFineErodibility
The relative erodibility (0-1) of fine unconsolidated beach sediment.
Definition simulation.h:801

CSimulation::m_dThisiterUnconsFineInput
double m_dThisiterUnconsFineInput
Depth (m) of fine unconsolidated sediment added, at this iteration.
Definition simulation.h:993

CSimulation::m_tSysStartTime
time_t m_tSysStartTime
System start-simulation time.
Definition simulation.h:1336

CSimulation::m_dBreakingWaveHeightDepthRatio
double m_dBreakingWaveHeightDepthRatio
Breaking wave height-to-depth ratio.
Definition simulation.h:765

CSimulation::AnnounceReadFloodLocationGIS
void AnnounceReadFloodLocationGIS(void) const
Tells the user that we are now reading the flood location GIS file.
Definition utils.cpp:616

CSimulation::m_dCoastNormalSpacing
double m_dCoastNormalSpacing
Average spacing of the coastline-normal profiles, in m.
Definition simulation.h:834

CSimulation::bCheckVectorGISOutputFormat
bool bCheckVectorGISOutputFormat(void)
Checks whether the selected vector GDAL/OGR driver supports file creation etc.
Definition gis_utils.cpp:868

CSimulation::m_bHaveWaveStationData
bool m_bHaveWaveStationData
Do we have wave station data?
Definition simulation.h:390

CSimulation::m_dSeaWaterDensity
double m_dSeaWaterDensity
Density of sea water in kg/m**3.
Definition simulation.h:714

CSimulation::nDoSimulation
int nDoSimulation(int, char const *[])
Runs the simulation.
Definition simulation.cpp:535

CSimulation::StartClock
void StartClock(void)
Starts the clock ticking.
Definition utils.cpp:292

CSimulation::m_ldGTotSuspendedSediment
long double m_ldGTotSuspendedSediment
All-simulation total of suspended sediment (m)
Definition simulation.h:1132

CSimulation::m_bSlopeSaveForCliffToe
bool m_bSlopeSaveForCliffToe
Save slope raster grids (used for cliff toe location)?
Definition simulation.h:93

CSimulation::m_nSavGolCliffEdgePoly
int m_nSavGolCliffEdgePoly
The order of the cliff edge smoothing polynomial if Savitzky-Golay smoothing is used (usually 2 or 4,...
Definition simulation.h:501

CSimulation::nCreateAllPolygons
int nCreateAllPolygons(void)
Create polygons, and mark the polygon boundaries on the raster grid.
Definition create_polygons.cpp:37

CSimulation::m_dSandErodibilityNormalized
double m_dSandErodibilityNormalized
Relative erodibility of sand unconsolidated beach sediment, normalized.
Definition simulation.h:813

CSimulation::m_dR
double m_dR
Coast platform resistance to erosion R, see Walkden & Hall, 2011.
Definition simulation.h:783

CSimulation::WritePolygonSedimentInputEventTable
void WritePolygonSedimentInputEventTable(void)
Writes to the log file a table showing per-polygon sediment input event totals for all coasts.
Definition write_output.cpp:1734

CSimulation::m_bCliffCollapseTimestepSave
bool m_bCliffCollapseTimestepSave
Are we saving the timestep at which each cliff occurred?
Definition simulation.h:447

CSimulation::m_bRasterNormalProfileSave
bool m_bRasterNormalProfileSave
Save rasterized coastline-normal profiles GIS files?
Definition simulation.h:210

CSimulation::m_bActiveZoneSave
bool m_bActiveZoneSave
Save active zone raster GIS files?
Definition simulation.h:213

CSimulation::AnnounceReadInitialSuspSedGIS
void AnnounceReadInitialSuspSedGIS(void) const
Tells the user that we are now reading the initial suspended sediment depth GIS file.
Definition utils.cpp:631

CSimulation::DoEndOfRunDeletes
void DoEndOfRunDeletes(void)
Do end-of-run memory clearance.
Definition utils.cpp:3078

CSimulation::m_VstrInitialSandUnconsSedimentFile
vector< string > m_VstrInitialSandUnconsSedimentFile
The name of the initial sand-sized unconsolidated sediment GIS file.
Definition simulation.h:1471

CSimulation::m_dThisIterActualPlatformErosionSandCons
double m_dThisIterActualPlatformErosionSandCons
Total actual platform erosion (sand consolidated sediment) for this iteration (depth in m)
Definition simulation.h:855

CSimulation::m_bOmitSearchWestEdge
bool m_bOmitSearchWestEdge
Omit the west edge of the grid from coast-end searches?
Definition simulation.h:357

CSimulation::m_bSedimentInputAtCoast
bool m_bSedimentInputAtCoast
Do we have sediment input at the coast?
Definition simulation.h:399

CSimulation::AnnounceReadRasterFiles
static void AnnounceReadRasterFiles(void)
Now reading raster GIS files.
Definition utils.cpp:525

CSimulation::m_nCliffEdgeSmooth
int m_nCliffEdgeSmooth
Which method to use for cliff edge smoothing.
Definition simulation.h:495

CSimulation::m_dCliffErosionResistance
double m_dCliffErosionResistance
Resistance of cliff to notch erosion.
Definition simulation.h:924

CSimulation::m_dThisIterBeachDepositionCoarse
double m_dThisIterBeachDepositionCoarse
Total beach deposition (coarse unconsolidated sediment) for this iteration (depth in m)
Definition simulation.h:876

CSimulation::m_dD50Sand
double m_dD50Sand
The D50 for sand sediment.
Definition simulation.h:789

CSimulation::WritePolygonPreExistingSedimentTable
void WritePolygonPreExistingSedimentTable(void)
Writes to the log file a table showing per-polygon pre-existing unconsolidated sediment for all coast...
Definition write_output.cpp:1668

CSimulation::m_ldGTotCliffTalusSandDeposition
long double m_ldGTotCliffTalusSandDeposition
All-simulation total of sand sediment deposited as talus following cliff collapse (m)
Definition simulation.h:1099

CSimulation::m_dCellDiagonal
double m_dCellDiagonal
Length of a cell's diagonal (in external CRS units)
Definition simulation.h:678

CSimulation::m_bDeepWaterWaveHeightSave
bool m_bDeepWaterWaveHeightSave
Save deep water wave height raster GIS files?
Definition simulation.h:246

CSimulation::m_dSlopeThresholdForCliffToe
double m_dSlopeThresholdForCliffToe
Slope limit for cliff toe detection.
Definition simulation.h:1053

CSimulation::m_bMeanWaveEnergySave
bool m_bMeanWaveEnergySave
Save mean wave energy raster GIS files?
Definition simulation.h:132

CSimulation::m_bCliffToeSave
bool m_bCliffToeSave
Save cliff toe raster grids?
Definition simulation.h:96

CSimulation::m_dKLS
double m_dKLS
Transport parameter KLS in the CERC equation.
Definition simulation.h:819

CSimulation::m_dInvCellSide
double m_dInvCellSide
Inverse of m_dCellSide.
Definition simulation.h:681

CSimulation::m_nWavePropagationModel
int m_nWavePropagationModel
The wave propagation model used. Possible values are WAVE_MODEL_CSHORE and WAVE_MODEL_COVE.
Definition simulation.h:564

CSimulation::m_ldGTotCliffCollapseSandErodedDuringDeposition
long double m_ldGTotCliffCollapseSandErodedDuringDeposition
All-simulation total of sand sediment eroded during talus deposition following cliff collapse (m)
Definition simulation.h:1108

CSimulation::m_dAllCellsDeepWaterWaveAngle
double m_dAllCellsDeepWaterWaveAngle
Deep water wave angle for all sea cells.
Definition simulation.h:771

CSimulation::m_dSimElapsed
double m_dSimElapsed
Time simulated so far, in hours.
Definition simulation.h:693

CSimulation::m_bCoastCurvatureSave
bool m_bCoastCurvatureSave
Save coastline-curvature vector GIS files?
Definition simulation.h:273

CSimulation::m_dMinSWLSoFar
double m_dMinSWLSoFar
Minimum still water level (m)
Definition simulation.h:735

CSimulation::m_nCliffEdgeSmoothWindow
int m_nCliffEdgeSmoothWindow
The size of the window used for cliff edge smoothing. Must be an odd number.
Definition simulation.h:498

CSimulation::m_nDeepWaterWaveDataNumTimeSteps
int m_nDeepWaterWaveDataNumTimeSteps
The duration of data for deep water waves, expressed as a number of timesteps.
Definition simulation.h:585

CSimulation::AnnounceReadBasementDEM
void AnnounceReadBasementDEM(void) const
Tells the user that we are now reading the DEM file.
Definition utils.cpp:495

CSimulation::nConvertMetresToNumCells
int nConvertMetresToNumCells(double const) const
Given a length in m, this returns the rounded equivalent number of cells.
Definition gis_utils.cpp:1933

CSimulation::m_ldGTotCoarseSedimentInput
long double m_ldGTotCoarseSedimentInput
All-simulation total of coarse sediment input (m)
Definition simulation.h:1147

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

CSimulation::m_dThisIterUnconsCoarseCliffDeposition
double m_dThisIterUnconsCoarseCliffDeposition
This-iteration total of coarse unconsolidated sediment deposited due to cliff collapse (m^3)
Definition simulation.h:969

CSimulation::m_bGDALCanWriteInt32
bool m_bGDALCanWriteInt32
Is the selected GDAL output file format capable of writing 32-bit integers to files?
Definition simulation.h:378

CSimulation::m_bRasterWaveFloodLineSave
bool m_bRasterWaveFloodLineSave
Are we saving the raster wave flood line? TODO 007 Finish surge and runup stuff.
Definition simulation.h:429

CSimulation::m_bSWLTSSave
bool m_bSWLTSSave
Save the SWL (still water level) time series file?
Definition simulation.h:297

CSimulation::m_bBreakingWaveHeightSave
bool m_bBreakingWaveHeightSave
Save breaking wave height raster GIS files?
Definition simulation.h:135

CSimulation::m_dThisIterTotSeaDepth
double m_dThisIterTotSeaDepth
Total sea depth (m) for this iteration.
Definition simulation.h:846

CSimulation::m_dTotPotentialPlatformErosionOnProfiles
double m_dTotPotentialPlatformErosionOnProfiles
Total potential platform erosion on profiles.
Definition simulation.h:912

CSimulation::m_nCoastMin
int m_nCoastMin
Minimum valid coast length when searching for coasts.
Definition simulation.h:531

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

CSimulation::m_bPolygonNodeSave
bool m_bPolygonNodeSave
Save polygon node vector GIS files?
Definition simulation.h:276

CSimulation::m_bOmitSearchNorthEdge
bool m_bOmitSearchNorthEdge
Omit the north edge of the grid from coast-end searches?
Definition simulation.h:351

CSimulation::m_ldGTotCoarseActualPlatformErosion
long double m_ldGTotCoarseActualPlatformErosion
All-simulation total of coarse sediment actual platform erosion (m)
Definition simulation.h:1066

CSimulation::m_ldGTotFineActualPlatformErosion
long double m_ldGTotFineActualPlatformErosion
All-simulation total of fine sediment actual platform erosion (m)
Definition simulation.h:1060

CSimulation::m_dThisIterUnconsSandCliffDeposition
double m_dThisIterUnconsSandCliffDeposition
This-iteration total of sand unconsolidated sediment deposited due to cliff collapse (m^3)
Definition simulation.h:966

CSimulation::m_VnDeepWaterWaveStationID
vector< int > m_VnDeepWaterWaveStationID
ID for deep water wave station, this corresponds with the ID in the wave time series file.
Definition simulation.h:1393

CSimulation::m_ldGTotSandSedimentInput
long double m_ldGTotSandSedimentInput
All-simulation total of sand sediment input (m)
Definition simulation.h:1144

CSimulation::m_bFloodSetupSurgeTSSave
bool m_bFloodSetupSurgeTSSave
Save the flood setup surge time series file? TODO 007 Finish surge and runup stuff.
Definition simulation.h:324

CSimulation::m_bTotalPotentialPlatformErosionSave
bool m_bTotalPotentialPlatformErosionSave
Save total potential shore platform erosion raster GIS files?
Definition simulation.h:147

CSimulation::m_bSetupSurgeFloodMaskSave
bool m_bSetupSurgeFloodMaskSave
Are we saving the setup surge flood mask? TODO 007 Finish surge and runup stuff.
Definition simulation.h:423

CSimulation::m_bWaveEnergySinceCollapseSave
bool m_bWaveEnergySinceCollapseSave
Save wave energy since cliff collapse raster GIS files?
Definition simulation.h:129

CSimulation::m_dNorthWestXExtCRS
double m_dNorthWestXExtCRS
The north-west x coordinate, in the external coordinate reference system (CRS)
Definition simulation.h:657

CSimulation::m_dD50Coarse
double m_dD50Coarse
The D50 for coarse sediment.
Definition simulation.h:792

CSimulation::AnnounceStart
static void AnnounceStart(void)
Tells the user that we have started the simulation.
Definition utils.cpp:272

CSimulation::nUpdateIntervention
static int nUpdateIntervention(void)
Check to see if we have a new intervention in place (not yet implemented)
Definition do_intervention.cpp:26

CSimulation::m_nCoastCurvatureInterval
int m_nCoastCurvatureInterval
Coast curvature interval is a length, measured in coastline points.
Definition simulation.h:513

CSimulation::SWLTSStream
ofstream SWLTSStream
SWL time series file output stream.
Definition simulation.h:1348

CSimulation::CliffCollapseErosionTSStream
ofstream CliffCollapseErosionTSStream
Cliff collapse erosion time series file output stream.
Definition simulation.h:1354

CSimulation::m_dThisIterPotentialSedLostBeachErosion
double m_dThisIterPotentialSedLostBeachErosion
Total unconsolidated sediment from beach erosion (all size classes) lost from the grid this iteration...
Definition simulation.h:882

CSimulation::m_bHighestSWLSoFar
bool m_bHighestSWLSoFar
Do we have the highest SWL so far?
Definition simulation.h:465

CSimulation::m_dSouthEastYExtCRS
double m_dSouthEastYExtCRS
The south-east y coordinate, in the external coordinate reference system (CRS)
Definition simulation.h:666

CSimulation::m_bPotentialBeachErosionSave
bool m_bPotentialBeachErosionSave
Save potential beach (unconsolidated sediment) erosion raster GIS files?
Definition simulation.h:153

CSimulation::m_ldGTotCliffCollapseFineErodedDuringDeposition
long double m_ldGTotCliffCollapseFineErodedDuringDeposition
All-simulation total of fine sediment eroded during talus deposition following cliff collapse (m)
Definition simulation.h:1105

CSimulation::~CSimulation
~CSimulation(void)
The CSimulation destructor.
Definition simulation.cpp:453

CSimulation::m_ldGTotCoarseDepositionDiff
long double m_ldGTotCoarseDepositionDiff
All-simulation total of shortfall in unconsolidated coarse sediment deposition (m,...
Definition simulation.h:1138

CSimulation::nSetAllCoastpointDeepWaterWaveValues
int nSetAllCoastpointDeepWaterWaveValues(void)
Give every coast point a value for deep water wave height and direction TODO 005 This may not be real...
Definition calc_waves.cpp:52

CSimulation::m_dStartIterConsFineAllCells
double m_dStartIterConsFineAllCells
Depth (m) of fine consolidated sediment at the start of the simulation, all cells (both inside and ou...
Definition simulation.h:1017

CSimulation::m_ldGTotActualCoarseLostBeachErosion
long double m_ldGTotActualCoarseLostBeachErosion
All-simulation total of coarse sediment lost via beach (unconsolidated) sediment movement (m)
Definition simulation.h:1078

CSimulation::m_bGISSaveDigitsSequential
bool m_bGISSaveDigitsSequential
Are the GIS save digits (which are part of each GIS file name) sequential, or are they the iteration ...
Definition simulation.h:453

CSimulation::nUpdateGrid
int nUpdateGrid(void)
Update all cells in the raster raster grid and do some per-timestep accounting.
Definition update_grid.cpp:34

CSimulation::m_nSimStartMonth
int m_nSimStartMonth
Start date of the simulation (month)
Definition simulation.h:579

CSimulation::nAssignLandformsForAllCells
int nAssignLandformsForAllCells(void)
Each timestep, classify landforms for cells that are not on the coastline.
Definition assign_landforms.cpp:386

CSimulation::m_bSuspSedSave
bool m_bSuspSedSave
Save suspended sediment raster GIS files?
Definition simulation.h:183

CSimulation::m_dMinCliffTalusHeightFrac
double m_dMinCliffTalusHeightFrac
Minimum height of the landward end of cliff collapse talus, as a fraction of cliff elevation.
Definition simulation.h:945

CSimulation::m_dThisIterBeachErosionSand
double m_dThisIterBeachErosionSand
Total actual beach erosion (sand unconsolidated sediment) for this iteration (depth in m)
Definition simulation.h:867

CSimulation::m_dAccumulatedSeaLevelChange
double m_dAccumulatedSeaLevelChange
If long-term SWL changes, the total change (m) so far since the start of simulation.
Definition simulation.h:732

CSimulation::m_bPolygonBoundarySave
bool m_bPolygonBoundarySave
Save polygon boundary vector GIS files?
Definition simulation.h:279

CSimulation::m_bStormSurgeSave
bool m_bStormSurgeSave
Are we saving the storm surge? TODO 007 Finish surge and runup stuff.
Definition simulation.h:417

CSimulation::m_VstrInitialFineUnconsSedimentFile
vector< string > m_VstrInitialFineUnconsSedimentFile
The name of the initial fine-sized unconsolidated sediment GIS file.
Definition simulation.h:1468

CSimulation::m_bActualPlatformErosionSave
bool m_bActualPlatformErosionSave
Save actual (supply-limited) shore platform erosion raster GIS files?
Definition simulation.h:144

CSimulation::m_dThisIterFineSedimentToSuspension
double m_dThisIterFineSedimentToSuspension
Total fine unconsolidated sediment in suspension for this iteration (depth in m)
Definition simulation.h:879

CSimulation::nDoAllWaveEnergyToCoastLandforms
int nDoAllWaveEnergyToCoastLandforms(void)
Definition do_cliff_collapse.cpp:39

CSimulation::m_dThisIterBeachErosionFine
double m_dThisIterBeachErosionFine
Total actual beach erosion (fine unconsolidated sediment) for this iteration (depth in m)
Definition simulation.h:864

CSimulation::m_dNotchApexAboveMHW
double m_dNotchApexAboveMHW
Distance of notch base below SWL (m)
Definition simulation.h:933

CSimulation::DoAllPotentialBeachErosion
void DoAllPotentialBeachErosion(void)
Uses either the CERC equation or the Kamphuis (1990) equation to calculate potential (unconstrained) ...
Definition do_beach_potential_erosion.cpp:50

CSimulation::m_dThisIterCliffCollapseSandErodedDuringDeposition
double m_dThisIterCliffCollapseSandErodedDuringDeposition
Total sand sediment eroded during Dean profile deposition of talus following cliff collapse (depth in...
Definition simulation.h:897

CSimulation::m_nSimStartMin
int m_nSimStartMin
Start time of the simulation (minutes)
Definition simulation.h:570

CSimulation::bSaveAllRasterGISFiles
bool bSaveAllRasterGISFiles(void)
The bSaveAllRasterGISFiles member function saves the raster GIS files using values from the RasterGri...
Definition gis_utils.cpp:923

CSimulation::m_ulThisIterNumActualBeachErosionCells
unsigned long m_ulThisIterNumActualBeachErosionCells
The number of grid cells on which actual beach (unconsolidated sediment) erosion occurs,...
Definition simulation.h:636

CSimulation::bReadIniFile
bool bReadIniFile(void)
The bReadIniFile member function reads the initialisation file.
Definition read_input.cpp:63

CSimulation::m_bHaveFineSediment
bool m_bHaveFineSediment
Does this simulation consider fine-sized sediment?
Definition simulation.h:72

CSimulation::m_dCliffDepositionA
double m_dCliffDepositionA
Scale parameter A for cliff deposition (m^(1/3)), may be zero for auto-calculation.
Definition simulation.h:936

CSimulation::m_strDataPathName
string m_strDataPathName
Folder in which the CME data file is found.
Definition simulation.h:1159

CSimulation::m_strOutPath
string m_strOutPath
Path for all output files.
Definition simulation.h:1192

CSimulation::m_bBeachErosionTSSave
bool m_bBeachErosionTSSave
Save the beach (unconsolidated sediment) erosion time series file?
Definition simulation.h:312

CSimulation::m_nYMaxBoundingBox
int m_nYMaxBoundingBox
The maximum y value of the bounding box.
Definition simulation.h:561

CSimulation::m_strTideDataFile
string m_strTideDataFile
Name of tide data file.
Definition simulation.h:1186

CSimulation::m_bUnconsChangedThisIter
vector< bool > m_bUnconsChangedThisIter
One element per layer: has the consolidated sediment of this layer been changed during this iteration...
Definition simulation.h:1387

CSimulation::m_bTotalPotentialBeachErosionSave
bool m_bTotalPotentialBeachErosionSave
Save total potential beach (unconsolidated sediment) erosion raster GIS files?
Definition simulation.h:159

CSimulation::m_ulThisIterNumPotentialPlatformErosionCells
unsigned long m_ulThisIterNumPotentialPlatformErosionCells
The number of grid cells on which potential platform erosion occurs, for this iteration.
Definition simulation.h:627

CSimulation::m_dStartIterUnconsSandAllCells
double m_dStartIterUnconsSandAllCells
Depth (m) of sand unconsolidated sediment at the start of the simulation, all cells (both inside and ...
Definition simulation.h:1011

CSimulation::m_ldGTotActualSandLostBeachErosion
long double m_ldGTotActualSandLostBeachErosion
All-simulation total of sand sediment lost via beach (unconsolidated) sediment movement (m)
Definition simulation.h:1075

CSimulation::m_dDeltaSWLPerTimestep
double m_dDeltaSWLPerTimestep
If long-term SWL changes, the increment per timestep.
Definition simulation.h:723

CSimulation::m_nGISSave
int m_nGISSave
The save number for GIS files (can be sequential, or the iteration number)
Definition simulation.h:519

CSimulation::m_strInterventionClassFile
string m_strInterventionClassFile
Name of intervention class file.
Definition simulation.h:1174

CSimulation::m_Rand
default_random_engine m_Rand[NUMBER_OF_RNGS]
The c++11 random number generators.
Definition simulation.h:1591

CSimulation::m_ldGTotActualFineLostBeachErosion
long double m_ldGTotActualFineLostBeachErosion
All-simulation total of fine sediment lost via beach (unconsolidated) sediment movement (m)
Definition simulation.h:1072

CSimulation::m_bSeaMaskSave
bool m_bSeaMaskSave
Save sea mask raster GIS files?
Definition simulation.h:234

CSimulation::m_dThisIterCliffCollapseErosionFineCons
double m_dThisIterCliffCollapseErosionFineCons
This-iteration total of fine consolidated sediment produced by cliff collapse (m^3)
Definition simulation.h:957

CSimulation::m_bInterventionClassSave
bool m_bInterventionClassSave
Save intervention class raster GIS files?
Definition simulation.h:177

CSimulation::m_ldGTotCoarseSedLostCliffCollapse
long double m_ldGTotCoarseSedLostCliffCollapse
All-simulation total of coarse sediment lost via cliff collapse (m)
Definition simulation.h:1084

CSimulation::m_dCoastNormalInterventionSpacing
double m_dCoastNormalInterventionSpacing
Average spacing of the coastline-normal profiles on interventions, in m.
Definition simulation.h:837

CSimulation::m_ldGTotSandActualPlatformErosion
long double m_ldGTotSandActualPlatformErosion
All-simulation total of sand sediment actual platform erosion (m)
Definition simulation.h:1063

CSimulation::m_nSimStartYear
int m_nSimStartYear
Start date of the simulation (year)
Definition simulation.h:582

CSimulation::m_bTotalActualBeachErosionSave
bool m_bTotalActualBeachErosionSave
Save total actual (supply-limited) beach (unconsolidated sediment) erosion raster GIS files?
Definition simulation.h:162

CSimulation::m_bRasterCoastlineSave
bool m_bRasterCoastlineSave
Save rasterized coastline GIS files?
Definition simulation.h:207

CSimulation::m_ldGTotSandSedLostCliffCollapse
long double m_ldGTotSandSedLostCliffCollapse
All-simulation total of sand sediment lost via cliff collapse (m)
Definition simulation.h:1081

CSimulation::m_dUnconsSandNotDepositedLastIter
double m_dUnconsSandNotDepositedLastIter
Depth of unconsolidated sand sediment that could not be deposited during the last iteration,...
Definition simulation.h:1044

CSimulation::m_dThisIterDiffWaveSetupWaterLevel
double m_dThisIterDiffWaveSetupWaterLevel
TODO 007 Finish surge and runup stuff.
Definition simulation.h:744

CSimulation::m_bInterventionHeightSave
bool m_bInterventionHeightSave
Save intervention height raster GIS files?
Definition simulation.h:180

CSimulation::m_dTotalCoarseConsInPolygons
double m_dTotalCoarseConsInPolygons
Total coarse consolidated sediment in all polygons, before polygon-to-polygon movement (only cells in...
Definition simulation.h:1041

CSimulation::SeaAreaTSStream
ofstream SeaAreaTSStream
Sea area time series file output stream.
Definition simulation.h:1345

CSimulation::m_ulThisIterNumSeaCells
unsigned long m_ulThisIterNumSeaCells
The number of grid cells which are marked as sea, for this iteration.
Definition simulation.h:621

CSimulation::AnnounceReadIHGIS
void AnnounceReadIHGIS(void) const
Tells the user that we are now reading the Intervention height GIS file.
Definition utils.cpp:571

CSimulation::m_dTotalSandUnconsInPolygons
double m_dTotalSandUnconsInPolygons
Total sand unconsolidated sediment in all polygons, before polygon-to-polygon movement (only cells in...
Definition simulation.h:1029

CSimulation::AnnounceReadInitialCoarseConsSedGIS
void AnnounceReadInitialCoarseConsSedGIS(int const) const
Tells the user that we are now reading the initial coarse consolidated sediment depth GIS file.
Definition utils.cpp:709

CSimulation::m_bRiverineFlooding
bool m_bRiverineFlooding
Are we doing riverine flooding?
Definition simulation.h:411

CSimulation::m_lGDALMinCanWrite
long m_lGDALMinCanWrite
The minimum integer value which GDAL can write, can be zero, INT16_MIN, INT32_MIN.
Definition simulation.h:606

CSimulation::nCreateAllProfiles
int nCreateAllProfiles(void)
Create coastline-normal profiles for all coastlines. The first profiles are created 'around' the most...
Definition create_profiles.cpp:62

CSimulation::m_dStartIterUnconsFineAllCells
double m_dStartIterUnconsFineAllCells
Depth (m) of fine unconsolidated sediment at the start of the simulation, all cells (both inside and ...
Definition simulation.h:1008

CSimulation::m_bSandConsSedSave
bool m_bSandConsSedSave
Save sand consolidated sediment raster GIS files?
Definition simulation.h:201

CSimulation::m_bSedimentInputEventSave
bool m_bSedimentInputEventSave
Save sediment inut data?
Definition simulation.h:405

CSimulation::m_dThisIterMHWElev
double m_dThisIterMHWElev
This iteration's Mean High Water (MHW) elevation, calculated using a moving time window....
Definition simulation.h:1050

CSimulation::m_bHaveCoarseSediment
bool m_bHaveCoarseSediment
Does this simulation consider coarse-sized sediment?
Definition simulation.h:78

CSimulation::m_dRegularSaveInterval
double m_dRegularSaveInterval
The interval between regular saves, in hours.
Definition simulation.h:699

CSimulation::m_ldGTotActualFineBeachErosion
long double m_ldGTotActualFineBeachErosion
All-simulation total of fine sediment eroded during beach (unconsolidated sediment) movement (m)
Definition simulation.h:1117

CSimulation::nLocateSeaAndCoasts
int nLocateSeaAndCoasts(void)
First find all connected sea areas, then locate the vector coastline(s), then put these onto the rast...
Definition locate_coast.cpp:47

CSimulation::m_bPolygonUnconsSedGainOrLossSave
bool m_bPolygonUnconsSedGainOrLossSave
Save polygon unconsolidated sediment gain or loss raster GIS files?
Definition simulation.h:255

CSimulation::MarkPolygonCells
void MarkPolygonCells(void)
Marks cells of the raster grid that are within each coastal polygon. The cell-by-cell fill (aka 'floo...
Definition create_polygons.cpp:330

CSimulation::m_dTimeStep
double m_dTimeStep
The length of an iteration (a timestep) in hours.
Definition simulation.h:690

CSimulation::m_ulTotPotentialPlatformErosionOnProfiles
unsigned long m_ulTotPotentialPlatformErosionOnProfiles
The number of cells on which on-profile average potential shore platform erosion occurs.
Definition simulation.h:642

CSimulation::m_bCliffCollapseDepositionTSSave
bool m_bCliffCollapseDepositionTSSave
Save the cliff collapse deposition time series file?
Definition simulation.h:306

CSimulation::m_nXMinBoundingBox
int m_nXMinBoundingBox
The minimum x value of the bounding box.
Definition simulation.h:552

CSimulation::PlatformErosionTSStream
ofstream PlatformErosionTSStream
Shore platform erosion time series file output stream.
Definition simulation.h:1351

CSimulation::DoEndOfTimestepTotals
void DoEndOfTimestepTotals(void)
Update and print totals at the end of each timestep.
Definition write_output.cpp:2242

CSimulation::m_dCellArea
double m_dCellArea
Area of a cell (in external CRS units)
Definition simulation.h:675

CSimulation::m_bDeepWaterWaveAngleAndHeightSave
bool m_bDeepWaterWaveAngleAndHeightSave
Save deep water wave angle and wave height raster GIS files?
Definition simulation.h:126

CSimulation::m_ulTotPotentialPlatformErosionBetweenProfiles
unsigned long m_ulTotPotentialPlatformErosionBetweenProfiles
The number of cells on which between-profile average potential shore platform erosion occurs.
Definition simulation.h:645

CSimulation::m_dCoastNormalRandSpacingFactor
double m_dCoastNormalRandSpacingFactor
Random factor for spacing of along-coast normals.
Definition simulation.h:972

CSimulation::m_dMaxUserInputWaveHeight
double m_dMaxUserInputWaveHeight
Maximum deep water wave height.
Definition simulation.h:777

CSimulation::m_bOutputConsolidatedProfileData
bool m_bOutputConsolidatedProfileData
Output profile data?
Definition simulation.h:336

CSimulation::AnnounceReadInitialFineConsSedGIS
void AnnounceReadInitialFineConsSedGIS(int const) const
Tells the user that we are now reading the initial fine consolidated sediment depth GIS file.
Definition utils.cpp:683

CSimulation::m_bBeachProtectionSave
bool m_bBeachProtectionSave
Save beach protection raster GIS files>
Definition simulation.h:138

CSimulation::CliffNotchElevTSStream
ofstream CliffNotchElevTSStream
Cliff notch elevation time series file output stream.
Definition simulation.h:1381

CSimulation::m_bDoBeachSedimentTransport
bool m_bDoBeachSedimentTransport
Simulate unconsolidated sediment (beach) transport?
Definition simulation.h:369

CSimulation::m_ulThisIterNumPotentialBeachErosionCells
unsigned long m_ulThisIterNumPotentialBeachErosionCells
The number of grid cells on which potential beach (unconsolidated sediment) erosion occurs,...
Definition simulation.h:633

CSimulation::m_bFineConsSedSave
bool m_bFineConsSedSave
Save fine consolidated sediment raster GIS files?
Definition simulation.h:198

CSimulation::m_bShadowDowndriftBoundarySave
bool m_bShadowDowndriftBoundarySave
Save wave shadow downdrift boundary vector GIS files?
Definition simulation.h:291

CSimulation::m_bCliffNotchElevTSSave
bool m_bCliffNotchElevTSSave
Save the cliff notch elevation time series file?
Definition simulation.h:330

CSimulation::m_nCoastSmooth
int m_nCoastSmooth
Which method to use for coast smoothing.
Definition simulation.h:486

CSimulation::m_bDeepWaterWavePeriodSave
bool m_bDeepWaterWavePeriodSave
Save deep water wave period raster GIS files?
Definition simulation.h:249

CSimulation::m_strInitialLandformFile
string m_strInitialLandformFile
Name of initial landform file.
Definition simulation.h:1171

CSimulation::m_dC_0
double m_dC_0
Deep water wave speed (m/s)
Definition simulation.h:756

CSimulation::m_dThisIterCliffCollapseErosionSandCons
double m_dThisIterCliffCollapseErosionSandCons
This-iteration total of sand consolidated sediment produced by cliff collapse (m^3)
Definition simulation.h:960

CSimulation::m_bBeachSedimentChangeNetTSSave
bool m_bBeachSedimentChangeNetTSSave
Save the beach (unconsolidated sediment) net change time series file?
Definition simulation.h:318

CSimulation::m_dThisIterBeachDepositionSand
double m_dThisIterBeachDepositionSand
Total beach deposition (sand unconsolidated sediment) for this iteration (depth in m)
Definition simulation.h:873

CSimulation::nReadTideDataFile
int nReadTideDataFile(void)
Reads the tide time series data.
Definition read_input.cpp:3375

CSimulation::m_bCoarseConsSedSave
bool m_bCoarseConsSedSave
Save coarse consolidated sediment raster GIS files?
Definition simulation.h:204

CSimulation::m_bSeaAreaTSSave
bool m_bSeaAreaTSSave
Save the sea area time series file?
Definition simulation.h:294

CSimulation::m_bScaleRasterOutput
bool m_bScaleRasterOutput
Scale raster output?
Definition simulation.h:381

CSimulation::WriteLookUpData
void WriteLookUpData(void)
Output the erosion potential look-up values, for checking purposes.
Definition write_output.cpp:1245

CSimulation::m_dThisIterLeftGridUnconsCoarse
double m_dThisIterLeftGridUnconsCoarse
Total coarse unconsolidated sediment lost from the grid this iteration (depth in m)
Definition simulation.h:891

CSimulation::m_dThisIterCliffCollapseErosionSandUncons
double m_dThisIterCliffCollapseErosionSandUncons
This-iteration total of sand unconsolidated sediment produced by cliff collapse (m^3)
Definition simulation.h:951

CSimulation::m_dD50Fine
double m_dD50Fine
The D50 for fine sediment.
Definition simulation.h:786

CSimulation::m_ulRandSeed
unsigned long m_ulRandSeed[NUMBER_OF_RNGS]
A seed for each of the random number generators.
Definition simulation.h:615

CSimulation::m_bOmitSearchSouthEdge
bool m_bOmitSearchSouthEdge
Omit the south edge of the grid from coast-end searches?
Definition simulation.h:354

CSimulation::m_bBeachMaskSave
bool m_bBeachMaskSave
Save beach mask raster GIS files?
Definition simulation.h:237

CSimulation::bOpenLogFile
bool bOpenLogFile(void)
Opens the log file.
Definition utils.cpp:471

CSimulation::m_dTotalSandConsInPolygons
double m_dTotalSandConsInPolygons
Total sand consolidated sediment in all polygons, before polygon-to-polygon movement (only cells in p...
Definition simulation.h:1038

CSimulation::m_ulIter
unsigned long m_ulIter
The number of the current iteration (time step)
Definition simulation.h:609

CSimulation::AnnounceLicence
void AnnounceLicence(void)
Tells the user about the licence.
Definition utils.cpp:355

CSimulation::m_bAvgSuspSedSave
bool m_bAvgSuspSedSave
Save average suspended sediment raster GIS files?
Definition simulation.h:186

CSimulation::m_dBeachSedimentDensity
double m_dBeachSedimentDensity
The density of unconsolidated beach sediment (kg/m**3)
Definition simulation.h:795

CSimulation::m_VstrInitialCoarseConsSedimentFile
vector< string > m_VstrInitialCoarseConsSedimentFile
The name of the initial coarse-sized consolidated sediment GIS file.
Definition simulation.h:1483

CSimulation::nReadRasterBasementDEM
int nReadRasterBasementDEM(void)
Reads a raster DEM of basement elevation data to the Cell array.
Definition gis_raster.cpp:122

CSimulation::m_dSimDuration
double m_dSimDuration
Duration of simulation, in hours.
Definition simulation.h:687

CSimulation::m_dTotalFineUnconsInPolygons
double m_dTotalFineUnconsInPolygons
Total fine unconsolidated sediment in all polygons, before polygon-to-polygon movement (only cells in...
Definition simulation.h:1026

CSimulation::m_ldGTotSandDepositionDiff
long double m_ldGTotSandDepositionDiff
All-simulation total of shortfall in unconsolidated sand sediment deposition (m, not currently used)
Definition simulation.h:1135

CSimulation::m_bTalusSave
bool m_bTalusSave
Save talus depth?
Definition simulation.h:90

CSimulation::m_bCSVPerTimestepResults
bool m_bCSVPerTimestepResults
Output per-timestep results in CSV format instead of fixed-width?
Definition simulation.h:345

CSimulation::m_bCliffNotchAllSave
bool m_bCliffNotchAllSave
Are we saving all cliff notches?
Definition simulation.h:444

CSimulation::FloodSetupSurgeTSStream
ofstream FloodSetupSurgeTSStream
Flood setup surge time series file output stream.
Definition simulation.h:1375

CSimulation::bTimeToQuit
bool bTimeToQuit(void)
Checks to see if the simulation has gone on too long, amongst other things.
Definition utils.cpp:1446

CSimulation::m_dTotalFineConsInPolygons
double m_dTotalFineConsInPolygons
Total fine consolidated sediment in all polygons, before polygon-to-polygon movement (only cells in p...
Definition simulation.h:1035

CSimulation::m_dThisiterUnconsSandInput
double m_dThisiterUnconsSandInput
Depth (m) of sand unconsolidated sediment added, at this iteration.
Definition simulation.h:996

CSimulation::m_dExtCRSGridArea
double m_dExtCRSGridArea
The area of the grid (in external CRS units)
Definition simulation.h:669

CSimulation::nDoAllPropagateWaves
int nDoAllPropagateWaves(void)
Simulates wave propagation along all coastline-normal profiles, on all coasts.
Definition calc_waves.cpp:299

CSimulation::m_dThisIterDiffWaveSetupSurgeRunupWaterLevel
double m_dThisIterDiffWaveSetupSurgeRunupWaterLevel
TODO 007 Finish surge and runup stuff.
Definition simulation.h:750

CSimulation::m_dCellSide
double m_dCellSide
Length of a cell side (in external CRS units)
Definition simulation.h:672

CSimulation::m_dMaxBeachElevAboveSWL
double m_dMaxBeachElevAboveSWL
Maximum elevation of beach above SWL (m)
Definition simulation.h:921

CSimulation::m_ldGTotActualSandBeachErosion
long double m_ldGTotActualSandBeachErosion
All-simulation total of sand sediment eroded during beach (unconsolidated sediment) movement (m)
Definition simulation.h:1120

CSimulation::m_dBreakingWaveHeight
double m_dBreakingWaveHeight
The height of breaking waves (m)
Definition simulation.h:753

CSimulation::AnnounceProgress
void AnnounceProgress(void)
Displays information regarding the progress of the simulation.
Definition utils.cpp:1761

CSimulation::m_bTotCliffCollapseDepositionSave
bool m_bTotCliffCollapseDepositionSave
Save total cliff collapse deposition raster GIS files?
Definition simulation.h:225

CSimulation::m_dAllCellsDeepWaterWavePeriod
double m_dAllCellsDeepWaterWavePeriod
Deep water wave period for all sea cells.
Definition simulation.h:774

CSimulation::m_dThisIterCliffCollapseCoarseErodedDuringDeposition
double m_dThisIterCliffCollapseCoarseErodedDuringDeposition
Total coarse sediment eroded during Dean profile deposition of talus following cliff collapse (depth ...
Definition simulation.h:900

CSimulation::nMarkBoundingBoxEdgeCells
int nMarkBoundingBoxEdgeCells(void)
Definition gis_raster.cpp:327

CSimulation::m_ldGTotSandBeachDeposition
long double m_ldGTotSandBeachDeposition
All-simulation total of sand sediment deposited during beach (unconsolidated sediment) movement (m)
Definition simulation.h:1126

CSimulation::m_dUSaveTime
double m_dUSaveTime[SAVEMAX]
Save time, in hours from the start of the simukation, if we are not saving regularly.
Definition simulation.h:702

CSimulation::WritePolygonCliffCollapseErosion
void WritePolygonCliffCollapseErosion(void)
Writes to the log file a table showing per-polygon per-polygon cliff collapse for all coasts.
Definition write_output.cpp:1811

CSimulation::AnnounceReadLGIS
void AnnounceReadLGIS(void) const
Tells the user that we are now reading the Landscape category GIS file.
Definition utils.cpp:541

CSimulation::m_dThisIterTopElevMax
double m_dThisIterTopElevMax
This-iteration highest elevation of DEM.
Definition simulation.h:987

CSimulation::m_dThisIterActualPlatformErosionFineCons
double m_dThisIterActualPlatformErosionFineCons
Total actual platform erosion (fine consolidated sediment) for this iteration (depth in m)
Definition simulation.h:852

CSimulation::m_ldGTotPotentialBeachErosion
long double m_ldGTotPotentialBeachErosion
All-simulation total of potential beach erosion (m), all size classes.
Definition simulation.h:1114

CSimulation::m_dProfileMaxSlope
double m_dProfileMaxSlope
Maximum slope on coastline-normal profiles.
Definition simulation.h:918

CSimulation::m_nProfileSmoothWindow
int m_nProfileSmoothWindow
The size of the window used for running-mean coast-normal profile smoothing (must be odd)
Definition simulation.h:504

CSimulation::m_bDoCliffCollapse
bool m_bDoCliffCollapse
Simulate cliff collapse?
Definition simulation.h:366

CSimulation::AnnounceReadVectorFiles
static void AnnounceReadVectorFiles(void)
Now reading vector GIS files.
Definition utils.cpp:533

CSimulation::m_dThisIterCliffCollapseErosionCoarseCons
double m_dThisIterCliffCollapseErosionCoarseCons
This-iteration total of coarse consolidated sediment produced by cliff collapse (m^3)
Definition simulation.h:963

CSimulation::m_dThisIterLeftGridUnconsSand
double m_dThisIterLeftGridUnconsSand
Total sand unconsolidated sediment lost from the grid this iteration (depth in m)
Definition simulation.h:888

CSimulation::m_dDepthOfClosure
double m_dDepthOfClosure
Depth of closure (in m) TODO 007 can be calculated using Hallermeier, R.J. (1978) or Birkemeier (1985...
Definition simulation.h:831

CSimulation::nInitGridAndCalcStillWaterLevel
int nInitGridAndCalcStillWaterLevel(void)
At the beginning of each timestep: clear vector coasts, profiles, and polygons, initialise the raster...
Definition init_grid.cpp:41

CSimulation::m_dStartIterSuspFineAllCells
double m_dStartIterSuspFineAllCells
Depth (m) of fine suspended sediment at the start of the simulation, all cells (both inside and outsi...
Definition simulation.h:1002

CSimulation::m_strOutFile
string m_strOutFile
Name of main output file.
Definition simulation.h:1195

CSimulation::m_bSetupSurgeRunupFloodMaskSave
bool m_bSetupSurgeRunupFloodMaskSave
Are we saving the setup surge runup flood mask? TODO 007 Finish surge and runup stuff.
Definition simulation.h:426

CSimulation::m_dThisIterDiffTotWaterLevel
double m_dThisIterDiffTotWaterLevel
TODO 007 Finish surge and runup stuff.
Definition simulation.h:741

CSimulation::m_bConsChangedThisIter
vector< bool > m_bConsChangedThisIter
One element per layer: has the consolidated sediment of this layer been changed during this iteration...
Definition simulation.h:1384

CSimulation::FineSedSuspensionTSStream
ofstream FineSedSuspensionTSStream
Fine sediment in suspension time series file output stream.
Definition simulation.h:1372

CSimulation::FloodSetupSurgeRunupTSStream
ofstream FloodSetupSurgeRunupTSStream
Flood setup surge runup time series file output stream.
Definition simulation.h:1378

CSimulation::m_bWaveSetupSave
bool m_bWaveSetupSave
Are we saving the wave setup? TODO 007 Finish surge and runup stuff.
Definition simulation.h:414

CSimulation::nDoPolygonSharedBoundaries
int nDoPolygonSharedBoundaries(void)
For between-polygon potential sediment routing: find which are the adjacent polygons,...
Definition create_polygons.cpp:642

CSimulation::AnnounceReadTideData
void AnnounceReadTideData(void) const
Now reading tide data file.
Definition utils.cpp:722

CSimulation::m_bFloodSWLSetupLineSave
bool m_bFloodSWLSetupLineSave
Are we saving the flood still water level setup line? TODO 007 Finish surge and runup stuff.
Definition simulation.h:438

CSimulation::m_dClkLast
double m_dClkLast
Last value returned by clock()
Definition simulation.h:705

CSimulation::m_bShadowZoneCodesSave
bool m_bShadowZoneCodesSave
Save wave shadow zones raster GIS files?
Definition simulation.h:240

CSimulation::m_ldGTotFineSedimentInput
long double m_ldGTotFineSedimentInput
All-simulation total of fine sediment input (m)
Definition simulation.h:1141

CSimulation::m_dThisIterMeanSWL
double m_dThisIterMeanSWL
The mean still water level for this timestep (does not include tidal changes, but includes any long-t...
Definition simulation.h:729

CSimulation::nCheckAndMarkAllProfiles
int nCheckAndMarkAllProfiles(void)
Check all coastline-normal profiles and modify the profiles if they intersect, then mark valid profil...
Definition create_profiles.cpp:1196

CSimulation::m_bCliffCollapseErosionTSSave
bool m_bCliffCollapseErosionTSSave
Save the cliff collapse erosion time series file?
Definition simulation.h:303

CSimulation::m_bPotentialPlatformErosionSave
bool m_bPotentialPlatformErosionSave
Save potential shore platform erosion raster GIS files?
Definition simulation.h:141

CSimulation::m_ldGTotPotentialPlatformErosion
long double m_ldGTotPotentialPlatformErosion
All-simulation total of potential platform erosion (m), all size classes.
Definition simulation.h:1057

CSimulation::m_GDALWriteFloatDataType
GDALDataType m_GDALWriteFloatDataType
Thw data type used by GDAL for floating point operations, can be GDT_Byte, GDT_Int16,...
Definition simulation.h:600

CSimulation::m_bGDALCanWriteFloat
bool m_bGDALCanWriteFloat
Is the selected GDAL output file format capable of writing floating-point values to files?
Definition simulation.h:375

CSimulation::AnnounceReadInitialCoarseUnconsSedGIS
void AnnounceReadInitialCoarseUnconsSedGIS(int const) const
Tells the user that we are now reading the initial coarse unconsolidated sediment depth GIS file.
Definition utils.cpp:670

CSimulation::nHandleCommandLineParams
int nHandleCommandLineParams(int, char const *[])
Handles command-line parameters.
Definition utils.cpp:168

CSimulation::m_ldGTotCliffCollapseSand
long double m_ldGTotCliffCollapseSand
All-simulation total of sand sediment from cliff collapse (m)
Definition simulation.h:1090

CSimulation::m_papszGDALRasterOptions
char ** m_papszGDALRasterOptions
Options for GDAL when handling raster files.
Definition simulation.h:471

CSimulation::OutStream
ofstream OutStream
The main output file stream.
Definition simulation.h:1342

CSimulation::m_dDurationUnitsMult
double m_dDurationUnitsMult
Multiplier for duration units, to convert to hours.
Definition simulation.h:654

CSimulation::m_ulTotTimestep
unsigned long m_ulTotTimestep
The target number of iterations.
Definition simulation.h:612

CSimulation::m_bOutputParallelProfileData
bool m_bOutputParallelProfileData
Output parallel profile data?
Definition simulation.h:339

CSimulation::m_dKamphuis
double m_dKamphuis
Transport parameter for the Kamphuis equation.
Definition simulation.h:822

CSimulation::m_bOutputErosionPotentialData
bool m_bOutputErosionPotentialData
Output erosion potential data?
Definition simulation.h:342

CSimulation::m_nLevel
int m_nLevel
TODO 007 Used in WAVESETUP + SURGE + RUNUP Finish surge and runup stuff.
Definition simulation.h:594

CSimulation::m_bSedimentInputThisIter
bool m_bSedimentInputThisIter
Do we have a sediment input event this iteration?
Definition simulation.h:408

CSimulation::m_bCliffNotchSave
bool m_bCliffNotchSave
Save cliff notch incision depth vector GIS files?
Definition simulation.h:282

CSimulation::m_bVectorWaveFloodLineSave
bool m_bVectorWaveFloodLineSave
Are we saving the vector wave flood line? TODO 007 Finish surge and runup stuff.
Definition simulation.h:432

CSimulation::m_bWaveAngleSave
bool m_bWaveAngleSave
Save wave angle raster GIS files?
Definition simulation.h:114

CSimulation::m_bOmitSearchEastEdge
bool m_bOmitSearchEastEdge
Omit the east edge of the grid from coast-end searches?
Definition simulation.h:360

CSimulation::m_dThisIterLeftGridUnconsFine
double m_dThisIterLeftGridUnconsFine
Total fine unconsolidated sediment lost from the grid this iteration (depth in m)
Definition simulation.h:885

cme.h
This file contains global definitions for CoastalME.

INT_NODATA
int const INT_NODATA
Definition cme.h:380

TOLERANCE
double const TOLERANCE
Definition cme.h:725

UNSIGNED_LONG_NODATA
unsigned long const UNSIGNED_LONG_NODATA
Definition cme.h:705

SAND_CONS_RASTER
int const SAND_CONS_RASTER
Definition cme.h:450

INTERVENTION_PROFILE_SPACING_FACTOR
double const INTERVENTION_PROFILE_SPACING_FACTOR
Definition cme.h:733

SEDIMENT_INPUT_EVENT_LOCATION_VEC
int const SEDIMENT_INPUT_EVENT_LOCATION_VEC
Definition cme.h:477

ERR
string const ERR
Definition cme.h:805

RTN_ERR_LOGFILE
int const RTN_ERR_LOGFILE
Definition cme.h:595

DEFAULT_PROFILE_SPACING
int const DEFAULT_PROFILE_SPACING
Definition cme.h:387

RTN_ERR_RASTER_GIS_OUT_FORMAT
int const RTN_ERR_RASTER_GIS_OUT_FORMAT
Definition cme.h:602

RTN_ERR_RASTER_FILE_WRITE
int const RTN_ERR_RASTER_FILE_WRITE
Definition cme.h:605

LOG_FILE_MIDDLE_DETAIL
int const LOG_FILE_MIDDLE_DETAIL
Definition cme.h:393

bFPIsEqual
bool bFPIsEqual(const T d1, const T d2, const T dEpsilon)
Definition cme.h:1213

FLOOD_LOCATION_VEC
int const FLOOD_LOCATION_VEC
Definition cme.h:482

DEEP_WATER_WAVE_STATIONS_VEC
int const DEEP_WATER_WAVE_STATIONS_VEC
Definition cme.h:474

RTN_ERR_RUNDATA
int const RTN_ERR_RUNDATA
Definition cme.h:592

MASS_BALANCE_TOLERANCE
double const MASS_BALANCE_TOLERANCE
Definition cme.h:727

tMax
T tMax(T a, T b)
Definition cme.h:1162

SAVEMAX
int const SAVEMAX
Definition cme.h:368

NUMBER_OF_RNGS
int const NUMBER_OF_RNGS
Definition cme.h:367

RTN_ERR_PROFILE_SPACING
int const RTN_ERR_PROFILE_SPACING
Definition cme.h:609

RTN_ERR_TSFILE
int const RTN_ERR_TSFILE
Definition cme.h:597

INTERVENTION_CLASS_RASTER
int const INTERVENTION_CLASS_RASTER
Definition cme.h:457

RTN_ERR_VECTOR_GIS_OUT_FORMAT
int const RTN_ERR_VECTOR_GIS_OUT_FORMAT
Definition cme.h:603

RTN_USER_ABORT
int const RTN_USER_ABORT
Definition cme.h:588

SMOOTH_SAVITZKY_GOLAY
int const SMOOTH_SAVITZKY_GOLAY
Definition cme.h:677

COAST_LENGTH_MIN_X_PROF_SPACE
int const COAST_LENGTH_MIN_X_PROF_SPACE
Definition cme.h:373

RTN_ERR_CMEDIR
int const RTN_ERR_CMEDIR
Definition cme.h:591

RTN_ERR_INI
int const RTN_ERR_INI
Definition cme.h:590

RTN_OK
int const RTN_OK
Definition cme.h:585

RTN_ERR_TEXT_FILE_WRITE
int const RTN_ERR_TEXT_FILE_WRITE
Definition cme.h:604

RTN_ERR_VECTOR_FILE_WRITE
int const RTN_ERR_VECTOR_FILE_WRITE
Definition cme.h:606

SAND_UNCONS_RASTER
int const SAND_UNCONS_RASTER
Definition cme.h:453

FINE_UNCONS_RASTER
int const FINE_UNCONS_RASTER
Definition cme.h:452

COARSE_UNCONS_RASTER
int const COARSE_UNCONS_RASTER
Definition cme.h:454

DBL_NODATA
double const DBL_NODATA
Definition cme.h:736

RTN_ERR_OUTFILE
int const RTN_ERR_OUTFILE
Definition cme.h:596

SUSP_SED_RASTER
int const SUSP_SED_RASTER
Definition cme.h:455

FINE_CONS_RASTER
int const FINE_CONS_RASTER
Definition cme.h:449

COARSE_CONS_RASTER
int const COARSE_CONS_RASTER
Definition cme.h:451

COAST_LENGTH_MAX
int const COAST_LENGTH_MAX
Definition cme.h:372

LANDFORM_RASTER
int const LANDFORM_RASTER
Definition cme.h:456

INTERVENTION_HEIGHT_RASTER
int const INTERVENTION_HEIGHT_RASTER
Definition cme.h:458

RTN_ERR_TIMESERIES_FILE_WRITE
int const RTN_ERR_TIMESERIES_FILE_WRITE
Definition cme.h:607

coast.h
Contains CRWCoast definitions.

raster_grid.h
Contains CGeomRasterGrid definitions.

simulation.h
Contains CSimulation definitions.

nRound
int nRound(double const d)
Correctly rounds doubles, returns an int.
Definition utils_global.cpp:47