dd/d6a/simulation_8h_source.html

#ifndef SIMULATION_H

#define SIMULATION_H

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

   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 <vector>

using std::vector;


#include <ctime>

using std::localtime;

using std::time;

using std::time_t;


#include <fstream>

using std::ofstream;


#include <string>

using std::string;


#include <utility>

using std::pair;


#include <stack>

using std::stack;


#include <random>

using std::default_random_engine;

using std::normal_distribution;


#include <gdal.h>

using ::GDALDataType;


#include "yaml_parser.h"

#include "configuration.h"

#include "2d_point.h"

#include "2di_point.h"

#include "line.h"

#include "cme.h"

#include "line.h"


class CGeomRasterGrid; // Forward declarations

class CRWCoast;

class CGeomProfile;

class CGeomCoastPolygon;

class CRWCliff;

class CRWSedInputEvent;

class CRWCellLandform;


class CSimulation

{

 private:

   bool m_bHaveFineSediment;


   bool m_bHaveSandSediment;


   bool m_bHaveCoarseSediment;


   bool m_bBasementElevSave;


   bool m_bSedIncTalusTopSurfSave;


   bool m_bTopSurfIncSeaSave;


   bool m_bTalusSave;


   bool m_bSlopeSaveForCliffToe;


   bool m_bCliffToeSave;


   bool m_bSliceSave;


   bool m_bSeaDepthSave;


   bool m_bAvgSeaDepthSave;


   bool m_bWaveHeightSave;


   bool m_bAvgWaveHeightSave;


   bool m_bWaveAngleSave;


   bool m_bAvgWaveAngleSave;


   bool m_bWaveAngleAndHeightSave;


   bool m_bAvgWaveAngleAndHeightSave;


   bool m_bDeepWaterWaveAngleAndHeightSave;


   bool m_bWaveEnergySinceCollapseSave;


   bool m_bMeanWaveEnergySave;


   bool m_bBreakingWaveHeightSave;


   bool m_bBeachProtectionSave;


   bool m_bPotentialPlatformErosionSave;


   bool m_bActualPlatformErosionSave;


   bool m_bTotalPotentialPlatformErosionSave;


   bool m_bTotalActualPlatformErosionSave;


   bool m_bPotentialBeachErosionSave;


   bool m_bActualBeachErosionSave;


   bool m_bTotalPotentialBeachErosionSave;


   bool m_bTotalActualBeachErosionSave;


   bool m_bBeachDepositionSave;


   bool m_bTotalBeachDepositionSave;


   bool m_bLandformSave;


   bool m_bSlopeConsSedSave;


   bool m_bInterventionClassSave;


   bool m_bInterventionHeightSave;


   bool m_bSuspSedSave;


   bool m_bAvgSuspSedSave;


   bool m_bFineUnconsSedSave;


   bool m_bSandUnconsSedSave;


   bool m_bCoarseUnconsSedSave;


   bool m_bFineConsSedSave;


   bool m_bSandConsSedSave;


   bool m_bCoarseConsSedSave;


   bool m_bRasterCoastlineSave;


   bool m_bRasterNormalProfileSave;


   bool m_bActiveZoneSave;


   bool m_bCliffCollapseSave;


   bool m_bTotCliffCollapseSave;


   bool m_bCliffCollapseDepositionSave;


   bool m_bTotCliffCollapseDepositionSave;


   bool m_bRasterPolygonSave;


   bool m_bPotentialPlatformErosionMaskSave;


   bool m_bSeaMaskSave;


   bool m_bBeachMaskSave;


   bool m_bShadowZoneCodesSave;


   bool m_bDeepWaterWaveAngleSave;


   bool m_bDeepWaterWaveHeightSave;


   bool m_bDeepWaterWavePeriodSave;


   bool m_bPolygonUnconsSedUpOrDownDriftSave;


   bool m_bPolygonUnconsSedGainOrLossSave;


   bool m_bSaveRegular;


   bool m_bCoastSave;


   bool m_bCliffEdgeSave;


   bool m_bNormalsSave;


   bool m_bInvalidNormalsSave;


   bool m_bCoastCurvatureSave;


   bool m_bPolygonNodeSave;


   bool m_bPolygonBoundarySave;


   bool m_bCliffNotchSave;


   bool m_bWaveTransectPointsSave;


   bool m_bShadowBoundarySave;


   bool m_bShadowDowndriftBoundarySave;


   bool m_bSeaAreaTSSave;


   bool m_bSWLTSSave;


   bool m_bActualPlatformErosionTSSave;


   bool m_bCliffCollapseErosionTSSave;


   bool m_bCliffCollapseDepositionTSSave;


   bool m_bCliffCollapseNetTSSave;


   bool m_bBeachErosionTSSave;


   bool m_bBeachDepositionTSSave;


   bool m_bBeachSedimentChangeNetTSSave;


   bool m_bSuspSedTSSave;


   bool m_bFloodSetupSurgeTSSave;


   bool m_bFloodSetupSurgeRunupTSSave;


   bool m_bCliffNotchElevTSSave;


   bool m_bSaveGISThisIter;


   bool m_bOutputConsolidatedProfileData;


   bool m_bOutputParallelProfileData;


   bool m_bOutputErosionPotentialData;


   bool m_bCSVPerTimestepResults;


   bool m_bYamlInputFormat;


   bool m_bOmitSearchNorthEdge;


   bool m_bOmitSearchSouthEdge;


   bool m_bOmitSearchWestEdge;


   bool m_bOmitSearchEastEdge;


   bool m_bDoShorePlatformErosion;


   bool m_bDoCliffCollapse;


   bool m_bDoBeachSedimentTransport;


   bool m_bGDALCanCreate;


   bool m_bGDALCanWriteFloat;


   bool m_bGDALCanWriteInt32;


   bool m_bScaleRasterOutput;


   bool m_bWorldFile;


   bool m_bSingleDeepWaterWaveValues;


   bool m_bHaveWaveStationData;


   bool m_bSedimentInput;


   bool m_bSedimentInputAtPoint;


   bool m_bSedimentInputAtCoast;


   bool m_bSedimentInputAlongLine;


   bool m_bSedimentInputEventSave;


   bool m_bSedimentInputThisIter;


   bool m_bRiverineFlooding;


   bool m_bWaveSetupSave;


   bool m_bStormSurgeSave;


   bool m_bRunUpSave;


   bool m_bSetupSurgeFloodMaskSave;


   bool m_bSetupSurgeRunupFloodMaskSave;


   bool m_bRasterWaveFloodLineSave;


   bool m_bVectorWaveFloodLineSave;


   bool m_bFloodLocationSave;


   bool m_bFloodSWLSetupLineSave;


   bool m_bFloodSWLSetupSurgeLine;


   bool m_bCliffNotchAllSave;


   bool m_bCliffCollapseTimestepSave;


   bool m_bFloodSWLSetupSurgeRunupLineSave;


   bool m_bGISSaveDigitsSequential;


   bool m_bHaveConsolidatedSediment;


   bool m_bGDALOptimisations;


   bool m_bCliffToeLocate;


   bool m_bHighestSWLSoFar;


   bool m_bLowestSWLSoFar;


   char **m_papszGDALRasterOptions;


   char **m_papszGDALVectorOptions;


   int m_nXGridSize;


   int m_nYGridSize;


   int m_nLayers;


   int m_nCoastSmooth;


   int m_nCoastSmoothingWindowSize;


   int m_nSavGolCoastPoly;


   int m_nCliffEdgeSmooth;


   int m_nCliffEdgeSmoothWindow;


   int m_nSavGolCliffEdgePoly;


   int m_nProfileSmoothWindow;


   int m_nCoastNormalSpacing;


   int m_nCoastNormalInterventionSpacing;


   int m_nCoastCurvatureInterval;


   int m_nGISMaxSaveDigits;


   int m_nGISSave;


   int m_nUSave;


   int m_nThisSave;


   int m_nCoastMax;


   int m_nCoastMin;


   int m_nNumThisIterCliffCollapse;


   int m_nNumTotCliffCollapse;


   int m_nUnconsSedimentHandlingAtGridEdges;


   int m_nBeachErosionDepositionEquation;


   int m_nGISMissingValue;


   int m_nMissingValue;


   int m_nXMinBoundingBox;


   int m_nXMaxBoundingBox;


   int m_nYMinBoundingBox;


   int m_nYMaxBoundingBox;


   int m_nWavePropagationModel;


   int m_nSimStartSec;


   int m_nSimStartMin;


   int m_nSimStartHour;


   int m_nSimStartDay;


   int m_nSimStartMonth;


   int m_nSimStartYear;


   int m_nDeepWaterWaveDataNumTimeSteps;


   int m_nLogFileDetail;


   int m_nRunUpEquation;


   int m_nLevel;


   GDALDataType m_GDALWriteIntDataType;


   GDALDataType m_GDALWriteFloatDataType;


   long m_lGDALMaxCanWrite;


   long m_lGDALMinCanWrite;


   unsigned long m_ulIter;


   unsigned long m_ulTotTimestep;


   unsigned long m_ulRandSeed[NUMBER_OF_RNGS];


   unsigned long m_ulNumCells;


   unsigned long m_ulThisIterNumSeaCells;


   unsigned long m_ulThisIterNumCoastCells;


   unsigned long m_ulThisIterNumPotentialPlatformErosionCells;


   unsigned long m_ulThisIterNumActualPlatformErosionCells;


   unsigned long m_ulThisIterNumPotentialBeachErosionCells;


   unsigned long m_ulThisIterNumActualBeachErosionCells;


   unsigned long m_ulThisIterNumBeachDepositionCells;


   unsigned long m_ulTotPotentialPlatformErosionOnProfiles;


   unsigned long m_ulTotPotentialPlatformErosionBetweenProfiles;


   unsigned long m_ulMissingValueBasementCells;


   unsigned long m_ulMissingValue;


   double m_dDurationUnitsMult;


   double m_dNorthWestXExtCRS;


   double m_dNorthWestYExtCRS;


   double m_dSouthEastXExtCRS;


   double m_dSouthEastYExtCRS;


   double m_dExtCRSGridArea;


   double m_dCellSide;


   double m_dCellArea;


   double m_dCellDiagonal;


   double m_dInvCellSide;


   double m_dInvCellDiagonal;


   double m_dSimDuration;


   double m_dTimeStep;


   double m_dSimElapsed;


   double m_dRegularSaveTime;


   double m_dRegularSaveInterval;


   double m_dUSaveTime[SAVEMAX];


   double m_dClkLast;


   double m_dCPUClock;


   double m_dGeoTransform[6];


   double m_dSeaWaterDensity;


   double m_dInitialMeanSWL;


   double m_dFinalMeanSWL;


   double m_dDeltaSWLPerTimestep;


   double m_dThisIterSWL;


   double m_dThisIterMeanSWL;


   double m_dAccumulatedSeaLevelChange;


   double m_dMinSWLSoFar;


   double m_dMaxSWLSoFar;


   double m_dThisIterDiffTotWaterLevel;


   double m_dThisIterDiffWaveSetupWaterLevel;


   double m_dThisIterDiffWaveSetupSurgeWaterLevel;


   double m_dThisIterDiffWaveSetupSurgeRunupWaterLevel;


   double m_dBreakingWaveHeight;


   double m_dC_0;


   double m_dL_0;


   double m_dWaveDepthRatioForWaveCalcs;


   double m_dBreakingWaveHeightDepthRatio;


   double m_dAllCellsDeepWaterWaveHeight;


   double m_dAllCellsDeepWaterWaveAngle;


   double m_dAllCellsDeepWaterWavePeriod;


   double m_dMaxUserInputWaveHeight;


   double m_dMaxUserInputWavePeriod;


   double m_dR;


   double m_dD50Fine;


   double m_dD50Sand;


   double m_dD50Coarse;


   double m_dBeachSedimentDensity;


   double m_dBeachSedimentPorosity;


   double m_dFineErodibility;


   double m_dSandErodibility;


   double m_dCoarseErodibility;


   double m_dFineErodibilityNormalized;


   double m_dSandErodibilityNormalized;


   double m_dCoarseErodibilityNormalized;


   double m_dKLS;


   double m_dKamphuis;


   double m_dG;


   double m_dInmersedToBulkVolumetric;


   double m_dDepthOfClosure;


   double m_dCoastNormalSpacing;


   double m_dCoastNormalInterventionSpacing;


   double m_dCoastNormalLength;


   double m_dSyntheticTransectSpacing;


   double m_dThisIterTotSeaDepth;


   double m_dThisIterPotentialPlatformErosion;


   double m_dThisIterActualPlatformErosionFineCons;


   double m_dThisIterActualPlatformErosionSandCons;


   double m_dThisIterActualPlatformErosionCoarseCons;


   double m_dThisIterPotentialBeachErosion;


   double m_dThisIterBeachErosionFine;


   double m_dThisIterBeachErosionSand;


   double m_dThisIterBeachErosionCoarse;


   double m_dThisIterBeachDepositionSand;


   double m_dThisIterBeachDepositionCoarse;


   double m_dThisIterFineSedimentToSuspension;


   double m_dThisIterPotentialSedLostBeachErosion;


   double m_dThisIterLeftGridUnconsFine;


   double m_dThisIterLeftGridUnconsSand;


   double m_dThisIterLeftGridUnconsCoarse;


   double m_dThisIterCliffCollapseFineErodedDuringDeposition;


   double m_dThisIterCliffCollapseSandErodedDuringDeposition;


   double m_dThisIterCliffCollapseCoarseErodedDuringDeposition;


   double m_dDepositionSandDiff;


   double m_dDepositionCoarseDiff;


   double m_dDepthOverDBMax;


   double m_dTotPotentialPlatformErosionOnProfiles;


   double m_dTotPotentialPlatformErosionBetweenProfiles;


   double m_dProfileMaxSlope;


   double m_dMaxBeachElevAboveSWL;


   double m_dCliffErosionResistance;


   double m_dNotchIncisionAtCollapse;


   double m_dThisIterNewNotchApexElev;


   double m_dNotchApexAboveMHW;


   double m_dCliffDepositionA;


   double m_dCliffDepositionPlanviewWidth;


   double m_dCliffTalusMinDepositionLength;


   double m_dMinCliffTalusHeightFrac;


   double m_dThisIterCliffCollapseErosionFineUncons;


   double m_dThisIterCliffCollapseErosionSandUncons;


   double m_dThisIterCliffCollapseErosionCoarseUncons;


   double m_dThisIterCliffCollapseErosionFineCons;


   double m_dThisIterCliffCollapseErosionSandCons;


   double m_dThisIterCliffCollapseErosionCoarseCons;


   double m_dThisIterUnconsSandCliffDeposition;


   double m_dThisIterUnconsCoarseCliffDeposition;


   double m_dCoastNormalRandSpacingFactor;


   double m_dDeanProfileStartAboveSWL;


   double m_dGISMissingValue;


   double m_dMissingValue;


   double m_dWaveDataWrapHours;


   double m_dThisIterTopElevMax;


   double m_dThisIterTopElevMin;


   double m_dThisiterUnconsFineInput;


   double m_dThisiterUnconsSandInput;


   double m_dThisiterUnconsCoarseInput;


   double m_dStartIterSuspFineAllCells;


   double m_dStartIterSuspFineInPolygons;


   double m_dStartIterUnconsFineAllCells;


   double m_dStartIterUnconsSandAllCells;


   double m_dStartIterUnconsCoarseAllCells;


   double m_dStartIterConsFineAllCells;


   double m_dStartIterConsSandAllCells;


   double m_dStartIterConsCoarseAllCells;


   double m_dTotalFineUnconsInPolygons;


   double m_dTotalSandUnconsInPolygons;


   double m_dTotalCoarseUnconsInPolygons;


   double m_dTotalFineConsInPolygons;


   double m_dTotalSandConsInPolygons;


   double m_dTotalCoarseConsInPolygons;


   double m_dUnconsSandNotDepositedLastIter;


   double m_dUnconsCoarseNotDepositedLastIter;


   double m_dThisIterMHWElev;


   double m_dSlopeThresholdForCliffToe;


   // These grand totals are all long doubles. The aim is to minimize rounding errors when many very small numbers are added to a single much larger number, see e.g. http://www.ddj.com/cpp/184403224

   long double m_ldGTotPotentialPlatformErosion;


   long double m_ldGTotFineActualPlatformErosion;


   long double m_ldGTotSandActualPlatformErosion;


   long double m_ldGTotCoarseActualPlatformErosion;


   long double m_ldGTotPotentialSedLostBeachErosion;


   long double m_ldGTotActualFineLostBeachErosion;


   long double m_ldGTotActualSandLostBeachErosion;


   long double m_ldGTotActualCoarseLostBeachErosion;


   long double m_ldGTotSandSedLostCliffCollapse;


   long double m_ldGTotCoarseSedLostCliffCollapse;


   long double m_ldGTotCliffCollapseFine;


   long double m_ldGTotCliffCollapseSand;


   long double m_ldGTotCliffCollapseCoarse;


   long double m_ldGTotCliffTalusFineToSuspension;


   long double m_ldGTotCliffTalusSandDeposition;


   long double m_ldGTotCliffTalusCoarseDeposition;


   long double m_ldGTotCliffCollapseFineErodedDuringDeposition;


   long double m_ldGTotCliffCollapseSandErodedDuringDeposition;


   long double m_ldGTotCliffCollapseCoarseErodedDuringDeposition;


   long double m_ldGTotPotentialBeachErosion;


   long double m_ldGTotActualFineBeachErosion;


   long double m_ldGTotActualSandBeachErosion;


   long double m_ldGTotActualCoarseBeachErosion;


   long double m_ldGTotSandBeachDeposition;


   long double m_ldGTotCoarseBeachDeposition;


   long double m_ldGTotSuspendedSediment;


   long double m_ldGTotSandDepositionDiff;


   long double m_ldGTotCoarseDepositionDiff;


   long double m_ldGTotFineSedimentInput;


   long double m_ldGTotSandSedimentInput;


   long double m_ldGTotCoarseSedimentInput;


   string m_strCMEDir;


   string m_strCMEIni;


   string m_strMailAddress;


   string m_strDataPathName;


   string m_strRasterGISOutFormat;


   string m_strVectorGISOutFormat;


   string m_strInitialBasementDEMFile;


   string m_strInitialLandformFile;


   string m_strInterventionClassFile;


   string m_strInterventionHeightFile;


   string m_strInitialSuspSedimentFile;


   string m_strSCAPEShapeFunctionFile;


   string m_strTideDataFile;


   string m_strLogFile;


   string m_strOutPath;


   string m_strOutFile;


   string m_strGDALBasementDEMDriverCode;


   string m_strGDALBasementDEMDriverDesc;


   string m_strGDALBasementDEMProjection;


   string m_strGDALBasementDEMDataType;


   string m_strGDALLDriverCode;


   string m_strGDALLDriverDesc;


   string m_strGDALLProjection;


   string m_strGDALLDataType;


   string m_strGDALICDriverCode;


   string m_strGDALICDriverDesc;


   string m_strGDALICProjection;


   string m_strGDALICDataType;


   string m_strGDALIHDriverCode;


   string m_strGDALIHDriverDesc;


   string m_strGDALIHProjection;


   string m_strGDALIHDataType;


   string m_strGDALIWDriverCode;


   string m_strGDALIWDriverDesc;


   string m_strGDALIWProjection;


   string m_strGDALIWDataType;


   string m_strGDALISSDriverCode;


   string m_strGDALISSDriverDesc;


   string m_strGDALISSProjection;


   string m_strGDALISSDataType;


   string m_strOGRDWWVDriverCode;


   // GDAL description for the deep water wave stations vector file

   string m_strOGRDWWVDriverDesc;


   string m_strOGRDWWVGeometry;


   string m_strOGRDWWVDataType;


   string m_strOGRSedInputDriverCode;


   // GDAL description for the sediment input event locations vector file

   string m_strOGRSedInputDriverDesc;


   string m_strOGRSedInputGeometry;


   string m_strOGRSedInputDataType;


   string m_strOGRFloodDriverCode;


   // GDAL description for the flood input locations point or vector file

   string m_strOGRFloodDriverDesc;


   string m_strOGRFloodGeometry;


   string m_strOGRFloodDataType;


   string m_strGDALRasterOutputDriverLongname;


   string m_strGDALRasterOutputDriverExtension;


   string m_strOGRVectorOutputExtension;


   string m_strRunName;


   string m_strDurationUnits;


   string m_strDeepWaterWaveStationsShapefile;


   string m_strDeepWaterWavesInputFile;


   string m_strSedimentInputEventShapefile;


   string m_strSedimentInputEventFile;


   string m_strFloodLocationShapefile;


   time_t m_tSysStartTime;


   time_t m_tSysEndTime;


   ofstream OutStream;


   ofstream SeaAreaTSStream;


   ofstream SWLTSStream;


   ofstream PlatformErosionTSStream;


   ofstream CliffCollapseErosionTSStream;


   ofstream CliffCollapseDepositionTSStream;


   ofstream CliffCollapseNetChangeTSStream;


   ofstream BeachErosionTSStream;


   ofstream BeachDepositionTSStream;


   ofstream BeachSedimentNetChangeTSStream;


   ofstream FineSedSuspensionTSStream;


   ofstream FloodSetupSurgeTSStream;


   ofstream FloodSetupSurgeRunupTSStream;


   ofstream CliffNotchElevTSStream;


   vector<bool> m_bConsChangedThisIter;


   vector<bool> m_bUnconsChangedThisIter;


   vector<int> m_VnProfileToSave;


   vector<int> m_VnDeepWaterWaveStationID;


   vector<int> m_VnSedimentInputLocationID;


   vector<int> m_VnFloodLocationID;


   vector<int> m_VnSavGolIndexCoast;


   vector<unsigned long> m_VulProfileTimestep;


   vector<unsigned long> m_VlDeepWaterWaveValuesAtTimestep;


   vector<double> m_VdSliceElev;


   vector<double> m_VdErosionPotential;


   vector<double> m_VdDepthOverDB;


   vector<double> m_VdSavGolFCRWCoast;


   vector<double> m_VdSavGolFCGeomProfile;


   vector<double> m_VdTideData;


   vector<double> m_VdDeepWaterWaveStationX;


   vector<double> m_VdDeepWaterWaveStationY;


   vector<double> m_VdThisIterDeepWaterWaveStationHeight;


   vector<double> m_VdThisIterDeepWaterWaveStationAngle;


   vector<double> m_VdThisIterDeepWaterWaveStationPeriod;


   vector<double> m_VdTSDeepWaterWaveStationHeight;


   vector<double> m_VdTSDeepWaterWaveStationAngle;


   vector<double> m_VdTSDeepWaterWaveStationPeriod;


   vector<TransectWaveData> m_VAllTransectsWithSynthetic;


   vector<double> m_VdSedimentInputLocationX;


   vector<double> m_VdSedimentInputLocationY;


   vector<double> m_VdFloodLocationX;


   vector<double> m_VdFloodLocationY;


   vector<string> m_VstrInitialFineUnconsSedimentFile;


   vector<string> m_VstrInitialSandUnconsSedimentFile;


   vector<string> m_VstrInitialCoarseUnconsSedimentFile;


   vector<string> m_VstrInitialFineConsSedimentFile;


   vector<string> m_VstrInitialSandConsSedimentFile;


   vector<string> m_VstrInitialCoarseConsSedimentFile;


   vector<string> m_VstrGDALIUFDriverCode;


   vector<string> m_VstrGDALIUFDriverDesc;


   vector<string> m_VstrGDALIUFProjection;


   vector<string> m_VstrGDALIUFDataType;


   vector<string> m_VstrGDALIUSDriverCode;


   vector<string> m_VstrGDALIUSDriverDesc;


   vector<string> m_VstrGDALIUSProjection;


   vector<string> m_VstrGDALIUSDataType;


   vector<string> m_VstrGDALIUCDriverCode;


   vector<string> m_VstrGDALIUCDriverDesc;


   vector<string> m_VstrGDALIUCProjection;


   vector<string> m_VstrGDALIUCDataType;


   vector<string> m_VstrGDALICFDriverCode;


   vector<string> m_VstrGDALICFDriverDesc;


   vector<string> m_VstrGDALICFProjection;


   vector<string> m_VstrGDALICFDataType;


   vector<string> m_VstrGDALICSDriverCode;


   vector<string> m_VstrGDALICSDriverDesc;


   vector<string> m_VstrGDALICSProjection;


   vector<string> m_VstrGDALICSDataType;


   vector<string> m_VstrGDALICCDriverCode;


   vector<string> m_VstrGDALICCDriverDesc;


   vector<string> m_VstrGDALICCProjection;


   vector<string> m_VstrGDALICCDataType;


   CGeomRasterGrid* m_pRasterGrid;


   vector<CRWCoast> m_VCoast;


   vector<CGeomLine> m_VHighestSWLCoastLine;


   vector<CGeomLine> m_VLowestSWLCoastLine;


   vector<CGeomLine> m_VCliffToe;


   vector<CRWCoast> m_VFloodWaveSetupSurge;


   vector<CRWCoast> m_VFloodWaveSetupSurgeRunup;


   vector<CGeom2DIPoint> m_VEdgeCell;


   vector<int> m_VEdgeCellEdge;


   vector<int> m_VCellFloodLocation;


   vector<CRWSedInputEvent*> m_pVSedInputEvent;


   default_random_engine m_Rand[NUMBER_OF_RNGS];


   normal_distribution<double> m_dGetFromUnitNormalDist{0.0, 1.0};


 private:

   // Input and output routines

   int nHandleCommandLineParams(int, char const*[]);

   bool bReadIniFile(void);

   bool bReadRunDataFile(void);

   bool bReadYamlFile(void);

   bool bDetectFileFormat(string const& strFileName, bool& bIsYaml);

   bool bConfigureFromDatFile(CConfiguration& config);

   bool bConfigureFromYamlFile(CConfiguration& config);

   bool bApplyConfiguration(CConfiguration const& config);

   bool bOpenLogFile(void);

   bool bSetUpTSFiles(void);

   void WriteStartRunDetails(void);

   bool bWritePerTimestepResults(void);

   bool bWritePerTimestepResultsFixedWidth(void);

   bool bWritePerTimestepResultsCSV(void);

   bool bWriteTSFiles(void);

   int nWriteEndRunDetails(void);

   int nReadShapeFunctionFile(void);

   int nReadWaveStationInputFile(int const);

   int nReadSedimentInputEventFile(void);

   int nReadTideDataFile(void);

   int nSaveProfile(int const, CGeomProfile const*, int const, vector<double> const*, vector<double> const*, vector<double> const*, vector<double> const*, vector<double> const*, vector<double> const*, vector<double> const*, vector<CGeom2DIPoint>*const, vector<double> const*) const;

   bool bWriteProfileData(int const, CGeomProfile const*, int const, vector<double> const*, vector<double> const*, vector<double> const*, vector<double> const*, vector<double> const*, vector<double> const*, vector<double> const*, vector<CGeom2DIPoint>*const, vector<double> const*) const;

   int nSaveParProfile(int const, CGeomProfile const*, int const, int const, int const, vector<double> const*, vector<double> const*, vector<double> const*, vector<double> const*, vector<double> const*, vector<double> const*, vector<double> const*, vector<CGeom2DIPoint>*const, vector<double> const*) const;

   bool bWriteParProfileData(int const, int const, int const, int const, int const, vector<double> const*, vector<double> const*, vector<double> const*, vector<double> const*, vector<double> const*, vector<double> const*, vector<double> const*, vector<CGeom2DIPoint>*const, vector<double> const*) const;

   void WriteLookUpData(void);


   // GIS input and output stuff

   void InitializeGDALPerformance(void);

   int nReadRasterBasementDEM(void);

   int nReadRasterGISFile(int const, int const);

   int nReadVectorGISFile(int const);

   bool bWriteRasterGISFile(int const, string const*, int const = 0, double const = 0);

   bool bWriteVectorGISFile(int const, string const*);

   void GetRasterOutputMinMax(int const, double&, double&, int const, double const);

   void SetRasterFileCreationDefaults(void);

   int nInterpolateWavesToPolygonCells(vector<TransectWaveData> const*, vector<double> const*, vector<double> const*, vector<double> const*, vector<double> const*);


   // Initialization

   bool bCreateErosionPotentialLookUp(vector<double>*, vector<double>*, vector<double>*);

   void CalcMHWElevation(int const);


   // Top-level simulation routines

   static int nUpdateIntervention(void);

   int nCheckForSedimentInputEvent(void);

   int nCalcExternalForcing(void);

   int nInitGridAndCalcStillWaterLevel(void);

   int nLocateSeaAndCoasts(void);

   int nLocateFloodAndCoasts(void);

   int nAssignLandformsForAllCoasts(void);

   int nAssignLandformsForAllCells(void);

   int nDoAllPropagateWaves(void);

   void GenerateSyntheticTransects(vector<TransectWaveData> const*, vector<TransectWaveData>*);

   int nDoAllShorePlatFormErosion(void);

   int nDoAllWaveEnergyToCoastLandforms(void);

   int nDoCliffCollapse(int const, CRWCliff *, double&, double&, double&, int&, double&, double&);

   void DoCliffCollapseTalusDeposition(int const, CRWCliff const*, double const, double const, int const);

   int nMoveCliffTalusToUnconsolidated(void);

   int nUpdateGrid(void);


   // For cliff toe location

   int nLocateCliffToe(void);

   void nCalcSlopeAtAllCells(void);

   void nLocateCliffCell(void);

   void nTraceSeawardCliffEdge(void);

   void nValidateCliffToeEdges(void);

   CGeomLine nValidateCliffToeDirection(CGeomLine& CliffEdge, bool bReverse);

   void nRemoveSmallCliffIslands(int const);


   // Lower-level simulation routines

   void FindAllSeaCells(void);

   int FindAllInundatedCells(void);

   void CellByCellFillSea(int const, int const);

   void FloodFillLand(int const, int const);

   int nTraceCoastLine(unsigned int const, int const, int const, vector<bool>*, vector<CGeom2DIPoint> const*);

   int nTraceAllCoasts(void);

   int nTraceFloodCoastLine(unsigned int const, int const, int const, vector<bool>*, vector<CGeom2DIPoint> const*);

   int nTraceAllFloodCoasts(void);

   void DoCoastCurvature(int const, int const);

   int nCheckAndMarkAllProfiles(void);

   int nCreateAllProfiles(void);

   void LocateAndCreateProfiles(int const, int&, vector<bool>*, vector<pair<int, double>> const*);

   int nCreateProfile(int const, int const, int const, int const, bool const, CGeom2DIPoint const*);

   int nLocateAndCreateGridEdgeProfile(bool const, int const, int&);

   void MarkProfilesOnGrid(int const, int&);

   void CheckForIntersectingProfiles(void);

   static bool bCheckForIntersection(CGeomProfile* const, CGeomProfile* const, int&, int&, double&, double&, double&, double&);

   void MergeProfilesAtFinalLineSegments(int const, CGeomProfile*, CGeomProfile*, int const, int const, double const, double const, double const, double const);

   void TruncateOneProfileRetainOtherProfile(int const, CGeomProfile*, CGeomProfile*, double, double, int, int, bool const);

   int nInsertPointIntoProfilesIfNeededThenUpdate(int const, CGeomProfile*, double const, double const, int const, CGeomProfile*, int const, bool const);

   void TruncateProfileAndAppendNew(int const, CGeomProfile*, int const, vector<CGeom2DPoint> const*, vector<vector<pair<int, int>>> const*);

   void CreateRasterizedProfile(int const, CGeomProfile*, vector<CGeom2DIPoint>*, vector<bool>*, bool&, bool&, bool&, bool&, bool&, bool&);

   static void CalcDeanProfile(vector<double>*, double const, double const, double const, bool const, int const, double const);

   static double dSubtractProfiles(vector<double> const*, vector<double> const*, vector<bool> const*);

   int nCalcPotentialPlatformErosionOnProfile(int const, CGeomProfile*);

   int nCalcPotentialPlatformErosionBetweenProfiles(int const, CGeomProfile*, int const);

   void ConstructParallelProfile(int const, int const, int const, int const, int const, vector<CGeom2DIPoint>* const, vector<CGeom2DIPoint>*, vector<CGeom2DPoint> *);

   double dCalcBeachProtectionFactor(int const, int const, double const);

   void FillInBeachProtectionHolesAndRemoveLegacyCliffs(void);

   void FillPotentialPlatformErosionHoles(void);

   void DoActualPlatformErosionOnCell(int const, int const);

   double dLookUpErosionPotential(double const);

   static CGeom2DPoint PtChooseEndPoint(int const, CGeom2DPoint const*, CGeom2DPoint const*, double const, double const, double const, double const);

   int nGetCoastNormalEndPoint(int const, int const, int const, CGeom2DPoint const*, double const, CGeom2DPoint *, CGeom2DIPoint *, bool const);

   int nLandformToGrid(int const, int const);

   int nCalcWavePropertiesOnProfile(int const, int const, CGeomProfile*, vector<double>*, vector<double>*, vector<double>*, vector<double>*, vector<bool>*);

   int nGetThisProfileElevationsForCShore(int const, CGeomProfile*, int const, vector<double>*, vector<double>*, vector<double>*);

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

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

   /*   static */ void InterpolateCShoreOutput(vector<double> const*, int const, int const, vector<double>*, vector<double>*, vector<double>*, vector<double>*, vector<double>*, vector<double>*, vector<double>*, vector<double>*, vector<double>*);

   static double dCalcWaveAngleToCoastNormal(double const, double const, int const);

   void CalcCoastTangents(int const);

   void InterpolateWavePropertiesBetweenProfiles(int const, int const);

   void InterpolateWaveHeightToCoastPoints(int const);

   // void InterpolateWavePropertiesToCells(int const, int const, int const);

   void ModifyBreakingWavePropertiesWithinShadowZoneToCoastline(int const, int const);

   static double dCalcCurvature(int const, CGeom2DPoint const*, CGeom2DPoint const*, CGeom2DPoint const*);

   void CalcD50AndFillWaveCalcHoles(void);

   int nDoAllShadowZones(void);

   static bool bOnOrOffShoreAndUpOrDownCoast(double const, double const, int const, bool&);

   static CGeom2DIPoint PtiFollowWaveAngle(CGeom2DIPoint const*, double const, double&);

   // int nFindAllShadowZones(void);

   int nCellByCellFillShadowZone(int const, int const, CGeom2DIPoint const*, CGeom2DIPoint const*, CGeom2DIPoint const*);

   void DoShadowZoneAndDownDriftZone(int const, int const, int const, int const);

   void ProcessDownDriftCell(int const, int const, int const, double const, int const);

   void ProcessShadowZoneCell(int const, int const, int const, CGeom2DIPoint const*, int const, int const, int const);

   int nCreateAllPolygons(void);

   void RasterizePolygonJoiningLine(int const, CGeom2DIPoint const*, CGeom2DIPoint const*, int const);

   // static bool bIsWithinPolygon(CGeom2DPoint const*, vector<CGeom2DPoint> const*);

   // static CGeom2DPoint PtFindPointInPolygon(vector<CGeom2DPoint> const*, int const);

   void MarkPolygonCells(void);

   int nDoPolygonSharedBoundaries(void);

   void DoAllPotentialBeachErosion(void);

   int nDoAllActualBeachErosionAndDeposition(void);

   int nDoParallelProfileUnconsErosion(CGeomCoastPolygon *, int const, int const, int const, int const, int const, int const, vector<CGeom2DIPoint> const*, vector<double> const*, double&, double&, double&);

   void ErodeCellBeachSedimentSupplyLimited(int const, int const, int const, int const, double const, double&);

   int nDoUnconsErosionOnPolygon(int const, CGeomCoastPolygon *, int const, double const, double&);

   int nDoUnconsDepositionOnPolygon(int const, CGeomCoastPolygon *, int const, double, double&);

   void CalcDepthOfClosure(void);

   int nInterpolateAllDeepWaterWaveValues(void);

   int nSetAllCoastpointDeepWaterWaveValues(void);

   int nDoSedimentInputEvent(int const);

   void AllPolygonsUpdateStoredUncons(int const);

   bool bIsInterventionCell(int const, int const) const;

   bool bSurroundedByDriftCells(int const, int const);

   bool bElevAboveDeanElev(int const, int const, double const, CRWCellLandform const*);

   // void CreatePolygonIndexIDSeq(int const);

   int nDoMultipleCoastlines(void);

   int nTruncateProfilesDifferentCoasts(int const, int const, int const, int const, int const, int const);

   int nTruncateProfileHitDifferentCoast(int const, int const, int const, int const);

   int nTruncateProfileMultiLineDifferentCoasts(CGeomProfile*, double const, double const);

   bool bIncreaseCliffNotchIncision(int const, int const, int const, CRWCliff*, double const);

   bool bCreateNotchInland(int const, int const, int const, int const, double const, double const);


   // GIS utility routines

   int nMarkBoundingBoxEdgeCells(void);

   bool bCheckRasterGISOutputFormat(void);

   bool bCheckVectorGISOutputFormat(void);

   bool bSaveAllRasterGISFiles(void);

   bool bSaveAllVectorGISFiles(void);

   bool bIsWithinValidGrid(int const, int const) const;

   bool bIsWithinValidGrid(CGeom2DIPoint const*) const;

   double dGridCentroidXToExtCRSX(int const) const;

   double dGridCentroidYToExtCRSY(int const) const;

   double dGridXToExtCRSX(double const) const;

   double dGridYToExtCRSY(double const) const;

   // double dExtCRSXToGridCentroidX(double const) const;

   // double dExtCRSYToGridCentroidY(double const) const;

   CGeom2DIPoint PtiExtCRSToGridRound(CGeom2DPoint const*) const;

   CGeom2DPoint PtGridCentroidToExt(CGeom2DIPoint const*) const;

   double dExtCRSXToGridX(double const) const;

   double dExtCRSYToGridY(double const) const;

   static double dGetDistanceBetween(CGeom2DPoint const*, CGeom2DPoint const*);

   static double dGetDistanceBetween(CGeom2DIPoint const*, CGeom2DIPoint const*);

   static double dGetDistanceBetween(double const, double const, double const, double const);

   static double dTriangleAreax2(CGeom2DPoint const*, CGeom2DPoint const*, CGeom2DPoint const*);

   void KeepWithinValidGrid(int&, int&) const;

   void KeepWithinValidGrid(int, int, int&, int&) const;

   void KeepWithinValidGrid(CGeom2DIPoint const*, CGeom2DIPoint *) const;

   static double dKeepWithin360(double const);

   // vector<CGeom2DPoint> VGetPerpendicular(CGeom2DPoint const*, CGeom2DPoint

   // const*, double const, int const);

   // static CGeom2DPoint PtGetPerpendicular(CGeom2DPoint const*, CGeom2DPoint const*, double const, int const);

   static CGeom2DIPoint PtiGetPerpendicular(CGeom2DIPoint const*, CGeom2DIPoint const*, double const, int const);

   static CGeom2DIPoint PtiGetPerpendicular(int const, int const, int const, int const, double const, int const);

   static CGeom2DPoint PtAverage(CGeom2DPoint const*, CGeom2DPoint const*);

   static CGeom2DPoint PtAverage(vector<CGeom2DPoint>*);

   // static CGeom2DIPoint PtiAverage(CGeom2DIPoint const*, CGeom2DIPoint const*);

   // static CGeom2DIPoint PtiAverage(vector<CGeom2DIPoint>*);

   static CGeom2DIPoint PtiWeightedAverage(CGeom2DIPoint const*, CGeom2DIPoint const*, double const);

   static CGeom2DIPoint PtiPolygonCentroid(vector<CGeom2DIPoint>*);

   static double dAngleSubtended(CGeom2DIPoint const*, CGeom2DIPoint const*, CGeom2DIPoint const*);

   static int nGetOppositeDirection(int const);

   // static void GetSlopeAndInterceptFromPoints(CGeom2DIPoint const*,

   // CGeom2DIPoint const*, double&, double&);

   CGeom2DIPoint PtiFindClosestCoastPoint(int const, int const, int&);

   int nFindClosestCoastPoint(int const, int const, int&);

   int nConvertMetresToNumCells(double const) const;

   bool bIsAdjacentEdgeCell(CGeom2DIPoint const*, CGeom2DIPoint const*);

   void FindClosestPointOnStraightLine(double const, double const, double const, double const, double const, double const, double&, double&);


   // Interpolation routines

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

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

   int nFindIndex(vector<double> const*, double const);

   vector<double> VdInterpolateCShoreProfileOutput(vector<double> const*, vector<double> const*, vector<double> const*);


   // Utility routines

   static void AnnounceStart(void);

   void AnnounceLicence(void);

   void AnnounceReadBasementDEM(void) const;

   static void AnnounceAddLayers(void);

   static void AnnounceReadRasterFiles(void);

   static void AnnounceReadVectorFiles(void);

   void AnnounceReadLGIS(void) const;

   void AnnounceReadICGIS(void) const;

   void AnnounceReadIHGIS(void) const;

   static void AnnounceFinalInitialization(void);

   void AnnounceReadInitialSuspSedGIS(void) const;

   void AnnounceReadInitialFineUnconsSedGIS(int const) const;

   void AnnounceReadInitialSandUnconsSedGIS(int const) const;

   void AnnounceReadInitialCoarseUnconsSedGIS(int const) const;

   void AnnounceReadInitialFineConsSedGIS(int const) const;

   void AnnounceReadInitialSandConsSedGIS(int const) const;

   void AnnounceReadInitialCoarseConsSedGIS(int const) const;

   void AnnounceReadDeepWaterWaveValuesGIS(void) const;

   void AnnounceReadSedimentEventInputValuesGIS(void) const;

   void AnnounceReadFloodLocationGIS(void) const;

   void AnnounceReadTideData(void) const;

   static void AnnounceReadSCAPEShapeFunctionFile(void);

   static void AnnounceAllocateMemory(void);

   static void AnnounceIsRunning(void);

   static void AnnounceSimEnd(void);

   void StartClock(void);

   bool bFindExeDir(char const*);

   bool bTimeToQuit(void);

   static int nDoTimeUnits(string const*);

   int nDoSimulationTimeMultiplier(string const*);

   static double dGetTimeMultiplier(string const*);

   static bool bParseDate(string const*, int&, int&, int&);

   static bool bParseTime(string const*, int&, int&, int&);

   void DoEndOfTimestepTotals(void);

   static string strGetBuild(void);

   static string strGetComputerName(void);

   void DoCPUClockReset(void);

   // void CalcTime(double const);

   static string strDispTime(double const, bool const, bool const);

   static string strDispSimTime(double const);

   void AnnounceProgress(void);

   static string strGetErrorText(int const);

   string strListRasterFiles(void) const;

   string strListVectorFiles(void) const;

   string strListTSFiles(void) const;

   void CalcProcessStats(void);

   void CalcSavitzkyGolayCoeffs(void);

   CGeomLine LSmoothCoastSavitzkyGolay(CGeomLine *, int const, int const) const;

   CGeomLine LSmoothCoastRunningMean(CGeomLine *) const;

   vector<double> dVSmoothProfileSlope(vector<double>*) const;

   // vector<double> dVCalCGeomProfileSlope(vector<CGeom2DPoint>*, vector<double>*);         // TODO 007 Why was this removed? vector<double>

   // dVSmoothProfileSavitzkyGolay(vector<double>*, vector<double>*);         //

   // TODO 007 was this removed? vector<double>

   // dVSmoothProfileRunningMean(vector<double>*);                            //

   // TODO 007 was this removed?

   static void CalcSavitzkyGolay(double[], int const, int const, int const, int const, int const);

   static string pstrChangeToBackslash(string const*);

   static string pstrChangeToForwardSlash(string const*);

   static string strTrim(string const*);

   static string strTrimLeft(string const*);

   static string strTrimRight(string const*);

   static string strToLower(string const*);

   // static string strToUpper(string const*);

   static string strRemoveSubstr(string*, string const*);

   static vector<string>* VstrSplit(string const*, char const, vector<string>*);

   static vector<string> VstrSplit(string const*, char const);

   // static double dCrossProduct(double const, double const, double const,

   // double const, double const, double const); static double

   // dGetMean(vector<double> const*); static double dGetStdDev(vector<double>

   // const*);

   static void AppendEnsureNoGap(vector<CGeom2DIPoint>*, CGeom2DIPoint const*);

   // static bool bIsNumeric(string const*);

   unsigned long ulConvertToTimestep(string const*) const;

   void WritePolygonInfoTable(void);

   void WritePolygonPreExistingSedimentTable(void);

   void WritePolygonSedimentInputEventTable(void);

   void WritePolygonShorePlatformErosion(void);

   void WritePolygonCliffCollapseErosion(void);

   void WritePolygonSedimentBeforeMovement(void);

   void WritePolygonPotentialErosion(void);

   // void WritePolygonUnconsErosion(int const);

   void WritePolygonUnsortedSequence(vector<vector<vector<int>>>&);

   void WritePolygonSortedSequence(vector<vector<vector<int>>>&);

   void WritePolygonActualMovement(vector<vector<vector<int>>>&);

   void DoEndOfRunDeletes(void);


 protected:

 public:

   ofstream LogStream;


   CSimulation(void);

   ~CSimulation(void);


   double dGetMissingValue(void) const;


   double dGetThisIterSWL(void) const;


   double dGetThisIterTotWaterLevel(void) const;


   // //! Returns the vertical tolerance for beach cells to be included in smoothing

   // double dGetMaxBeachElevAboveSWL(void) const;


   // double dGetCellSide(void) const;


   int nGetGridXMax(void) const;


   int nGetGridYMax(void) const;


   double dGetD50Fine(void) const;


   double dGetD50Sand(void) const;


   double dGetD50Coarse(void) const;


   int nDoSimulation(int, char const*[]);


   void DoSimulationEnd(int const);

};


#endif // SIMULATION_H

2d_point.h
Contains CGeom2DPoint definitions.

2di_point.h
Contains CGeom2DIPoint definitions.

CConfiguration
Unified configuration class for CoastalME simulation parameters.
Definition configuration.h:45

CGeom2DIPoint
Geometry class used to represent 2D point objects with integer coordinates.
Definition 2di_point.h:25

CGeom2DPoint
Geometry class used to represent 2D point objects with floating-point coordinates.
Definition 2d_point.h:25

CGeomCoastPolygon
Geometry class used for coast polygon objects.
Definition coast_polygon.h:30

CGeomLine
Geometry class used to represent 2D vector line objects.
Definition line.h:28

CGeomProfile
Geometry class used to represent coast profile objects.
Definition profile.h:33

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

CRWCellLandform
Real-world class used to represent the landform of a cell.
Definition cell_landform.h:25

CRWCliff
Real-world class used to represent the 'cliff' category of coastal landform object.
Definition cliff.h:28

CRWCoast
Real-world class used to represent coastline objects.
Definition coast.h:39

CRWSedInputEvent
Class used to represent a sediment input event.
Definition sediment_input_event.h:25

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::CalcDepthOfClosure
void CalcDepthOfClosure(void)
Calculate the depth of closure.
Definition utils.cpp:2760

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_strGDALISSDriverCode
string m_strGDALISSDriverCode
GDAL code for the initial suspended sediment raster file.
Definition simulation.h:1258

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::bReadYamlFile
bool bReadYamlFile(void)
Reads YAML configuration file.
Definition read_input.cpp:4121

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

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::m_dSyntheticTransectSpacing
double m_dSyntheticTransectSpacing
Approximate minimum spacing (m) between wave transects (real and synthetic) for wave interpolation de...
Definition simulation.h:843

CSimulation::m_strGDALISSProjection
string m_strGDALISSProjection
GDAL projection string for the initial suspended sediment raster file.
Definition simulation.h:1264

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::FindAllSeaCells
void FindAllSeaCells(void)
Finds and flags all sea areas which have at least one cell at a grid edge (i.e. does not flag 'inland...
Definition locate_coast.cpp:99

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_VdTSDeepWaterWaveStationPeriod
vector< double > m_VdTSDeepWaterWaveStationPeriod
Time series of wave period at deep water wave station.
Definition simulation.h:1450

CSimulation::CalcSavitzkyGolay
static void CalcSavitzkyGolay(double[], int const, int const, int const, int const, int const)
CalcSavitzkyGolay uses LULinearSolve and LUDecomp. It returns dFilterCoeffsArray[nWindowSize],...
Definition smooth_line.cpp:393

CSimulation::m_strOGRVectorOutputExtension
string m_strOGRVectorOutputExtension
GDAL-OGR vector output drive file extension.
Definition simulation.h:1312

CSimulation::LSmoothCoastRunningMean
CGeomLine LSmoothCoastRunningMean(CGeomLine *) const
Does running-mean smoothing of a CGeomLine coastline vector (is in external CRS coordinates)
Definition smooth_line.cpp:216

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::InterpolateCShoreOutput
void InterpolateCShoreOutput(vector< double > const *, int const, int const, vector< double > *, vector< double > *, vector< double > *, vector< double > *, vector< double > *, vector< double > *, vector< double > *, vector< double > *, vector< double > *)

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

CSimulation::DoCPUClockReset
void DoCPUClockReset(void)
Resets the CPU clock timer to prevent it 'rolling over', as can happen during long runs....
Definition utils.cpp:1499

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

CSimulation::m_strSedimentInputEventFile
string m_strSedimentInputEventFile
The name of the sediment input events time series file.
Definition simulation.h:1330

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::GetRasterOutputMinMax
void GetRasterOutputMinMax(int const, double &, double &, int const, double const)
Finds the max and min values in order to scale raster output if we cannot write doubles.
Definition gis_utils.cpp:1470

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_strCMEIni
string m_strCMEIni
Folder for the CME .ini file.
Definition simulation.h:1153

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_strGDALICDataType
string m_strGDALICDataType
GDAL data type of the initial intervention class raster file.
Definition simulation.h:1231

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::strRemoveSubstr
static string strRemoveSubstr(string *, string const *)
Returns a string with a substring removed, and with whitespace trimmed.
Definition utils.cpp:2559

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

CSimulation::m_VstrGDALICCDataType
vector< string > m_VstrGDALICCDataType
GDAL data type for the initial consolidated coarse sediment GIS data.
Definition simulation.h:1555

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

CSimulation::nCalcWavePropertiesOnProfile
int nCalcWavePropertiesOnProfile(int const, int const, CGeomProfile *, vector< double > *, vector< double > *, vector< double > *, vector< double > *, vector< bool > *)
Calculates wave properties along a coastline-normal profile using either the COVE linear wave theory ...
Definition calc_waves.cpp:806

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

CSimulation::dGetThisIterTotWaterLevel
double dGetThisIterTotWaterLevel(void) const
Returns this timestep's total water level TODO 007 Finish surge and runup stuff.
Definition utils.cpp:104

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::strListRasterFiles
string strListRasterFiles(void) const
Return a space-separated string containing the names of the raster GIS output files.
Definition utils.cpp:759

CSimulation::m_VdDeepWaterWaveStationY
vector< double > m_VdDeepWaterWaveStationY
Y coordinate (grid CRS) for deep water wave station.
Definition simulation.h:1432

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::LocateAndCreateProfiles
void LocateAndCreateProfiles(int const, int &, vector< bool > *, vector< pair< int, double > > const *)
For a single coastline, locate the start points for all coastline-normal profiles (except the grid-ed...
Definition create_profiles.cpp:265

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::nGetOppositeDirection
static int nGetOppositeDirection(int const)
Returns the opposite direction.
Definition gis_utils.cpp:1804

CSimulation::strListVectorFiles
string strListVectorFiles(void) const
Return a space-separated string containing the names of the vector GIS output files.
Definition utils.cpp:1019

CSimulation::PtiExtCRSToGridRound
CGeom2DIPoint PtiExtCRSToGridRound(CGeom2DPoint const *) const
Transforms a pointer to a CGeom2DPoint in the external CRS to the equivalent CGeom2DIPoint in the ras...
Definition gis_utils.cpp:131

CSimulation::m_VstrGDALICFDataType
vector< string > m_VstrGDALICFDataType
GDAL data type for the initial consolidated fine sediment GIS data.
Definition simulation.h:1531

CSimulation::m_VCellFloodLocation
vector< int > m_VCellFloodLocation
The location to compute the total water level for flooding.
Definition simulation.h:1585

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_VstrGDALICCDriverCode
vector< string > m_VstrGDALICCDriverCode
GDAL driver code for the initial consolidated coarse sediment GIS data.
Definition simulation.h:1546

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_VFloodWaveSetupSurgeRunup
vector< CRWCoast > m_VFloodWaveSetupSurgeRunup
TODO 007 Finish surge and runup stuff.
Definition simulation.h:1576

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::pstrChangeToForwardSlash
static string pstrChangeToForwardSlash(string const *)
Swaps all backslashes in the input string to forward slashes, leaving the original unchanged.
Definition utils.cpp:2469

CSimulation::m_VstrGDALIUFDataType
vector< string > m_VstrGDALIUFDataType
GDAL data type for the initial unconsolidated fine sediment GIS data.
Definition simulation.h:1495

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::nTraceCoastLine
int nTraceCoastLine(unsigned int const, int const, int const, vector< bool > *, vector< CGeom2DIPoint > const *)
Traces a coastline (which is defined to be just above still water level) on the grid using the 'wall ...
Definition locate_coast.cpp:949

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_strOGRSedInputDataType
string m_strOGRSedInputDataType
GDAL data type for the sediment input event locations vector file.
Definition simulation.h:1291

CSimulation::DoSimulationEnd
void DoSimulationEnd(int const)
Carries out end-of-simulation tidying (error messages etc.)
Definition utils.cpp:2344

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::m_strRunName
string m_strRunName
The name of this simulation.
Definition simulation.h:1315

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::strGetComputerName
static string strGetComputerName(void)
Returns a string, hopefully giving the name of the computer on which the simulation is running.
Definition utils.cpp:1474

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::strDispSimTime
static string strDispSimTime(double const)
strDispSimTime returns a string formatted as year Julian_day hour, given a parameter in hours
Definition utils.cpp:1633

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

CSimulation::nTraceAllFloodCoasts
int nTraceAllFloodCoasts(void)
Locates all the potential coastline start points on the edges of the raster grid, then traces vector ...
Definition do_surge_flood.cpp:217

CSimulation::FloodFillLand
void FloodFillLand(int const, int const)
Use the sealevel, wave set-up and run-up to evaluate flood hydraulically connected TODO 007 Finish su...
Definition do_surge_flood.cpp:45

CSimulation::bConfigureFromYamlFile
bool bConfigureFromYamlFile(CConfiguration &config)
Configures simulation from YAML file.
Definition read_input.cpp:4137

CSimulation::MarkProfilesOnGrid
void MarkProfilesOnGrid(int const, int &)
For this coastline, marks all coastline-normal profiles (apart from the two 'special' ones at the sta...
Definition create_profiles.cpp:1379

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

CSimulation::m_VAllTransectsWithSynthetic
vector< TransectWaveData > m_VAllTransectsWithSynthetic
Storage for wave transect points (real and synthetic) for debug output.
Definition simulation.h:1453

CSimulation::m_strSCAPEShapeFunctionFile
string m_strSCAPEShapeFunctionFile
Name of SCAPE shape function file.
Definition simulation.h:1183

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::bWriteVectorGISFile
bool bWriteVectorGISFile(int const, string const *)
Writes vector GIS files using GDAL/OGR.
Definition gis_vector.cpp:400

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::nCalcSlopeAtAllCells
void nCalcSlopeAtAllCells(void)
Definition locate_cliff_toe.cpp:68

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::PtChooseEndPoint
static CGeom2DPoint PtChooseEndPoint(int const, CGeom2DPoint const *, CGeom2DPoint const *, double const, double const, double const, double const)
Choose which end point to use for the coastline-normal profile.
Definition create_profiles.cpp:849

CSimulation::nDoSimulationTimeMultiplier
int nDoSimulationTimeMultiplier(string const *)
Given a string containing time units, this sets up the appropriate multiplier and display units for t...
Definition utils.cpp:411

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

CSimulation::m_VnSedimentInputLocationID
vector< int > m_VnSedimentInputLocationID
ID for sediment input location, this corresponds with the ID in the sediment input time series file.
Definition simulation.h:1396

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::FindClosestPointOnStraightLine
void FindClosestPointOnStraightLine(double const, double const, double const, double const, double const, double const, double &, double &)
For the straight line between two points A and B, and given another point C, this finds the closest p...
Definition gis_utils.cpp:1941

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::m_VdErosionPotential
vector< double > m_VdErosionPotential
For erosion potential lookup.
Definition simulation.h:1414

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::InitializeGDALPerformance
void InitializeGDALPerformance(void)
Initialize GDAL with performance optimizations.
Definition gis_raster.cpp:72

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

CSimulation::m_VstrGDALIUFProjection
vector< string > m_VstrGDALIUFProjection
GDAL projection for the initial unconsolidated fine sediment GIS data.
Definition simulation.h:1492

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

CSimulation::m_bWaveTransectPointsSave
bool m_bWaveTransectPointsSave
Save wave transect points vector GIS files?
Definition simulation.h:285

CSimulation::ConstructParallelProfile
void ConstructParallelProfile(int const, int const, int const, int const, int const, vector< CGeom2DIPoint > *const, vector< CGeom2DIPoint > *, vector< CGeom2DPoint > *)
Constructs a parallel coastline-normal profile.
Definition do_shore_platform_erosion.cpp:1318

CSimulation::m_dGetFromUnitNormalDist
normal_distribution< double > m_dGetFromUnitNormalDist
c++11 unit normal distribution (mean = 0, stdev = 1)
Definition simulation.h:1594

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::ErodeCellBeachSedimentSupplyLimited
void ErodeCellBeachSedimentSupplyLimited(int const, int const, int const, int const, double const, double &)
Erodes the unconsolidated beach sediment on a single cell, for a single size class,...
Definition do_beach_within_polygon.cpp:679

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::nSaveParProfile
int nSaveParProfile(int const, CGeomProfile const *, int const, int const, int const, vector< double > const *, vector< double > const *, vector< double > const *, vector< double > const *, vector< double > const *, vector< double > const *, vector< double > const *, vector< CGeom2DIPoint > *const, vector< double > const *) const
Save a coastline-normal parallel profile.
Definition write_output.cpp:1346

CSimulation::m_strSedimentInputEventShapefile
string m_strSedimentInputEventShapefile
The name of the sediment input events shape file.
Definition simulation.h:1327

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

CSimulation::strTrimLeft
static string strTrimLeft(string const *)
Trims whitespace from the left side of a string, does not change the original string.
Definition utils.cpp:2479

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::PtiGetPerpendicular
static CGeom2DIPoint PtiGetPerpendicular(CGeom2DIPoint const *, CGeom2DIPoint const *, double const, int const)
Returns a CGeom2DIPoint (grid CRS) which is the 'other' point of a two-point vector passing through P...
Definition gis_utils.cpp:619

CSimulation::m_strVectorGISOutFormat
string m_strVectorGISOutFormat
Vector GIS output format.
Definition simulation.h:1165

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

CSimulation::m_VstrGDALICFDriverCode
vector< string > m_VstrGDALICFDriverCode
GDAL driver code for the initial consolidated fine sediment GIS data.
Definition simulation.h:1522

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::dGetDistanceBetween
static double dGetDistanceBetween(CGeom2DPoint const *, CGeom2DPoint const *)
Returns the distance (in external CRS) between two points.
Definition gis_utils.cpp:143

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::CreateRasterizedProfile
void CreateRasterizedProfile(int const, CGeomProfile *, vector< CGeom2DIPoint > *, vector< bool > *, bool &, bool &, bool &, bool &, bool &, bool &)
Given a pointer to a coastline-normal profile, returns an output vector of cells which are 'under' ev...
Definition create_profiles.cpp:1493

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::nDoAllShadowZones
int nDoAllShadowZones(void)
Finds wave shadow zones and modifies waves in and near them. Note that where up-coast and down-coast ...
Definition calc_shadow_zones.cpp:138

CSimulation::PtAverage
static CGeom2DPoint PtAverage(CGeom2DPoint const *, CGeom2DPoint const *)
Returns a point (external CRS) which is the average of (i.e. is midway between) two other external CR...
Definition gis_utils.cpp:409

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_strGDALLDriverCode
string m_strGDALLDriverCode
GDAL code for the for the initial landform class raster file.
Definition simulation.h:1210

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

CSimulation::dKeepWithin360
static double dKeepWithin360(double const)
Constrains the supplied angle to be within 0 and 360 degrees.
Definition gis_utils.cpp:391

CSimulation::m_strDeepWaterWaveStationsShapefile
string m_strDeepWaterWaveStationsShapefile
The name of the deep water wave stations shape file.
Definition simulation.h:1321

CSimulation::m_VdDepthOverDB
vector< double > m_VdDepthOverDB
For erosion potential lookup.
Definition simulation.h:1417

CSimulation::CalcCoastTangents
void CalcCoastTangents(int const)
Calculates tangents to a coastline: the tangent is assumed to be the orientation of energy/sediment f...
Definition calc_waves.cpp:2292

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_VstrGDALICSDriverCode
vector< string > m_VstrGDALICSDriverCode
GDAL driver code for the initial consolidated sand sediment GIS data.
Definition simulation.h:1534

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

CSimulation::DoCliffCollapseTalusDeposition
void DoCliffCollapseTalusDeposition(int const, CRWCliff const *, double const, double const, int const)
Deposit the unconsolidated sediment from cliff collapse as talus on the cell on which collapse occurr...
Definition do_cliff_collapse.cpp:703

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

CSimulation::nGetGridYMax
int nGetGridYMax(void) const
Returns the size of the grid in the Y direction.
Definition utils.cpp:136

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::KeepWithinValidGrid
void KeepWithinValidGrid(int &, int &) const
Constrains the supplied point (in the grid CRS) to be a valid cell within the raster grid.
Definition gis_utils.cpp:212

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_VLowestSWLCoastLine
vector< CGeomLine > m_VLowestSWLCoastLine
Coastline (external CRS) at the lowest SWL so far during this simulation.
Definition simulation.h:1567

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::m_strGDALISSDataType
string m_strGDALISSDataType
GDAL data type for the initial suspended sediment raster file.
Definition simulation.h:1267

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

CSimulation::nTruncateProfileMultiLineDifferentCoasts
int nTruncateProfileMultiLineDifferentCoasts(CGeomProfile *, double const, double const)
Truncates the CGeomMultiLine (external CRS) of a profile which has hit a different coast,...
Definition multiple_coastlines.cpp:403

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_VstrGDALIUCProjection
vector< string > m_VstrGDALIUCProjection
GDAL projection for the initial unconsolidated coarse sediment GIS data.
Definition simulation.h:1516

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::nTruncateProfilesDifferentCoasts
int nTruncateProfilesDifferentCoasts(int const, int const, int const, int const, int const, int const)
Truncates two intersecting coast-normal profile belonging to different coasts.
Definition multiple_coastlines.cpp:181

CSimulation::m_strGDALLDataType
string m_strGDALLDataType
GDAL data type for the initial landform class raster file.
Definition simulation.h:1219

CSimulation::m_VFloodWaveSetupSurge
vector< CRWCoast > m_VFloodWaveSetupSurge
TODO 007 Finish surge and runup stuff.
Definition simulation.h:1573

CSimulation::strTrim
static string strTrim(string const *)
Trims whitespace from both sides of a string, does not change the original string.
Definition utils.cpp:2514

CSimulation::m_strRasterGISOutFormat
string m_strRasterGISOutFormat
Raster GIS output format.
Definition simulation.h:1162

CSimulation::m_strGDALIWDriverCode
string m_strGDALIWDriverCode
GDAL code for the initial water depth raster file.
Definition simulation.h:1246

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::nCreateCShoreInfile
int nCreateCShoreInfile(int const, int const, int const, int const, int const, int const, int const, int const, int const, int const, int const, int const, int const, double const, double const, double const, double const, double const, double const, double const, double const, vector< double > const *, vector< double > const *, vector< double > const *)

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

CSimulation::dGetMissingValue
double dGetMissingValue(void) const
Returns the NODATA value.
Definition utils.cpp:88

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::ulConvertToTimestep
unsigned long ulConvertToTimestep(string const *) const
For sediment input events, parses a string that may be relative (a number of hours or days after the ...
Definition utils.cpp:2926

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_strOGRFloodGeometry
string m_strOGRFloodGeometry
GDAL geometry for the flood input locations point or vector file.
Definition simulation.h:1300

CSimulation::bCreateNotchInland
bool bCreateNotchInland(int const, int const, int const, int const, double const, double const)
If possible, creates an erosional notch further inland from a given coastline point.
Definition do_cliff_collapse.cpp:605

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::bIsAdjacentEdgeCell
bool bIsAdjacentEdgeCell(CGeom2DIPoint const *, CGeom2DIPoint const *)
Given two different edge cells, returns true if they are adjacent.
Definition gis_utils.cpp:1971

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

CSimulation::dGetD50Coarse
double dGetD50Coarse(void) const
Returns the global d50 value for coarse sediment.
Definition utils.cpp:160

CSimulation::m_strOGRSedInputDriverDesc
string m_strOGRSedInputDriverDesc
Definition simulation.h:1285

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::MergeProfilesAtFinalLineSegments
void MergeProfilesAtFinalLineSegments(int const, CGeomProfile *, CGeomProfile *, int const, int const, double const, double const, double const, double const)
Merges two profiles which intersect at their final (most seaward) line segments, seaward of their poi...
Definition create_profiles.cpp:1727

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::m_VlDeepWaterWaveValuesAtTimestep
vector< unsigned long > m_VlDeepWaterWaveValuesAtTimestep
Calculate deep water wave values at these timesteps.
Definition simulation.h:1408

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_strOGRDWWVDriverCode
string m_strOGRDWWVDriverCode
GDAL code for the deep water wave stations vector file.
Definition simulation.h:1270

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_VdFloodLocationX
vector< double > m_VdFloodLocationX
X coordinate (grid CRS) for total water level flooding.
Definition simulation.h:1462

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

CSimulation::m_VstrGDALICSDriverDesc
vector< string > m_VstrGDALICSDriverDesc
GDAL driver description for the initial consolidated sand sediment GIS data.
Definition simulation.h:1537

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::InterpolateWavePropertiesBetweenProfiles
void InterpolateWavePropertiesBetweenProfiles(int const, int const)
Interpolates wave properties from profiles to the coastline points between two profiles....
Definition calc_waves.cpp:2072

CSimulation::dSubtractProfiles
static double dSubtractProfiles(vector< double > const *, vector< double > const *, vector< bool > const *)
Calculate the total elevation difference between every point in two elevation profiles (first profile...
Definition utils.cpp:2717

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::strToLower
static string strToLower(string const *)
Returns the lower case version of an string, leaving the original unchanged.
Definition utils.cpp:2539

CSimulation::m_VHighestSWLCoastLine
vector< CGeomLine > m_VHighestSWLCoastLine
Coastline (external CRS) at the highest SWL so far during this simulation.
Definition simulation.h:1564

CSimulation::m_VdThisIterDeepWaterWaveStationHeight
vector< double > m_VdThisIterDeepWaterWaveStationHeight
This-iteration wave height at deep water wave station.
Definition simulation.h:1435

CSimulation::nCalcPotentialPlatformErosionBetweenProfiles
int nCalcPotentialPlatformErosionBetweenProfiles(int const, CGeomProfile *, int const)
Calculates potential platform erosion on cells to one side of a given coastline-normal profile,...
Definition do_shore_platform_erosion.cpp:393

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_strGDALBasementDEMDriverCode
string m_strGDALBasementDEMDriverCode
GDAL code for the basement DEM raster file type.
Definition simulation.h:1198

CSimulation::m_VstrGDALIUFDriverCode
vector< string > m_VstrGDALIUFDriverCode
GDAL driver code for the initial unconsolidated fine sediment GIS data.
Definition simulation.h:1486

CSimulation::WritePolygonSortedSequence
void WritePolygonSortedSequence(vector< vector< vector< int > > > &)
Writes to the log file a table showing the sorted sequence of polygon processing for all coasts,...
Definition write_output.cpp:2067

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::nSaveProfile
int nSaveProfile(int const, CGeomProfile const *, int const, vector< double > const *, vector< double > const *, vector< double > const *, vector< double > const *, vector< double > const *, vector< double > const *, vector< double > const *, vector< CGeom2DIPoint > *const, vector< double > const *) const
Save a coastline-normal profile.
Definition write_output.cpp:1276

CSimulation::WritePolygonSedimentBeforeMovement
void WritePolygonSedimentBeforeMovement(void)
Writes to the log file a table showing per-polygon totals of stored unconsolidated beach sediment pri...
Definition write_output.cpp:1881

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::BeachDepositionTSStream
ofstream BeachDepositionTSStream
Beach sediment deposition time series file output stream.
Definition simulation.h:1366

CSimulation::dVSmoothProfileSlope
vector< double > dVSmoothProfileSlope(vector< double > *) const
Does running-mean smoothing of the slope of a coastline-normal profile.
Definition smooth_line.cpp:349

CSimulation::m_strInitialBasementDEMFile
string m_strInitialBasementDEMFile
Name of initial basement DEM file.
Definition simulation.h:1168

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::nDoSedimentInputEvent
int nDoSedimentInputEvent(int const)
Do a sediment input event.
Definition do_sediment_input_event.cpp:66

CSimulation::strTrimRight
static string strTrimRight(string const *)
Trims whitespace from the right side of a string, does not change the original string.
Definition utils.cpp:2494

CSimulation::m_VdDeepWaterWaveStationX
vector< double > m_VdDeepWaterWaveStationX
X coordinate (grid CRS) for deep water wave station.
Definition simulation.h:1429

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::dGetD50Fine
double dGetD50Fine(void) const
Returns the global d50 value for fine sediment.
Definition utils.cpp:144

CSimulation::m_strLogFile
string m_strLogFile
Name of output log file.
Definition simulation.h:1189

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::nDoUnconsDepositionOnPolygon
int nDoUnconsDepositionOnPolygon(int const, CGeomCoastPolygon *, int const, double, double &)
Deposits unconsolidated beach sediment (sand or coarse) on the cells within a polygon....
Definition do_beach_within_polygon.cpp:749

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::nReadCShoreOutput
int nReadCShoreOutput(int const, string const *, int const, int const, vector< double > const *, vector< double > *)

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_VdSedimentInputLocationX
vector< double > m_VdSedimentInputLocationX
X coordinate (grid CRS) for sediment input event.
Definition simulation.h:1456

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_strGDALLProjection
string m_strGDALLProjection
GDAL projection string for the initial landform class raster file.
Definition simulation.h:1216

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::nCellByCellFillShadowZone
int nCellByCellFillShadowZone(int const, int const, CGeom2DIPoint const *, CGeom2DIPoint const *, CGeom2DIPoint const *)
Cell-by-cell fills a shadow zone from the centroid.
Definition calc_shadow_zones.cpp:682

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::nTraceSeawardCliffEdge
void nTraceSeawardCliffEdge(void)
Definition locate_cliff_toe.cpp:189

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

CSimulation::m_strGDALIHProjection
string m_strGDALIHProjection
GDAL projection string for the initial intervention height raster file.
Definition simulation.h:1240

CSimulation::CheckForIntersectingProfiles
void CheckForIntersectingProfiles(void)
Checks all coastline-normal profiles for intersection, and modifies those that intersect.
Definition create_profiles.cpp:989

CSimulation::nTraceFloodCoastLine
int nTraceFloodCoastLine(unsigned int const, int const, int const, vector< bool > *, vector< CGeom2DIPoint > const *)
Traces a coastline (which is defined to be just above still water level) on the grid using the 'wall ...
Definition do_surge_flood.cpp:318

CSimulation::nDoTimeUnits
static int nDoTimeUnits(string const *)
This finds time units in a string.
Definition utils.cpp:450

CSimulation::RasterizePolygonJoiningLine
void RasterizePolygonJoiningLine(int const, CGeom2DIPoint const *, CGeom2DIPoint const *, int const)
Puts a polygon 'joining line' (the line which is the seaward boundary of the polygon,...
Definition create_polygons.cpp:281

CSimulation::m_strGDALICDriverDesc
string m_strGDALICDriverDesc
GDAL description of the initial intervention class raster file.
Definition simulation.h:1225

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_VCliffToe
vector< CGeomLine > m_VCliffToe
The traced cliff toe lines (in external CRS)
Definition simulation.h:1570

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_VstrGDALIUSProjection
vector< string > m_VstrGDALIUSProjection
GDAL projection for the initial unconsolidated sand sediment GIS data.
Definition simulation.h:1504

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

CSimulation::m_VdThisIterDeepWaterWaveStationPeriod
vector< double > m_VdThisIterDeepWaterWaveStationPeriod
This-iteration wave period at deep water wave station.
Definition simulation.h:1441

CSimulation::dGridCentroidYToExtCRSY
double dGridCentroidYToExtCRSY(int const) const
Given the integer Y-axis ordinate of a cell in the raster grid CRS, returns the external CRS Y-axis o...
Definition gis_utils.cpp:74

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

CSimulation::CalcD50AndFillWaveCalcHoles
void CalcD50AndFillWaveCalcHoles(void)
Calculates an average d50 for each polygon. Also fills in 'holes' in active zone and wave calcs i....
Definition calc_waves.cpp:2377

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_strCMEDir
string m_strCMEDir
The CME folder.
Definition simulation.h:1150

CSimulation::nCreateProfile
int nCreateProfile(int const, int const, int const, int const, bool const, CGeom2DIPoint const *)
Creates a single coastline-normal profile (which may be an intervention profile)
Definition create_profiles.cpp:435

CSimulation::m_VnProfileToSave
vector< int > m_VnProfileToSave
The numbers of the profiles which are to be saved.
Definition simulation.h:1390

CSimulation::FillInBeachProtectionHolesAndRemoveLegacyCliffs
void FillInBeachProtectionHolesAndRemoveLegacyCliffs(void)
Fills in 'holes' in the beach protection i.e. orphan cells which get omitted because of rounding prob...
Definition do_shore_platform_erosion.cpp:1138

CSimulation::nDoCliffCollapse
int nDoCliffCollapse(int const, CRWCliff *, double &, double &, double &, int &, double &, double &)
Simulates cliff collapse on a single cell. Collapse happens when when a notch which is incised into t...
Definition do_cliff_collapse.cpp:199

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::VdInterpolateCShoreProfileOutput
vector< double > VdInterpolateCShoreProfileOutput(vector< double > const *, vector< double > const *, vector< double > const *)
Returns a linearly interpolated vector of doubles, to make CShore profile output compatible with CME....
Definition interpolate.cpp:135

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::BeachSedimentNetChangeTSStream
ofstream BeachSedimentNetChangeTSStream
Beach sediment net change (erosion - deposition) time series file output stream.
Definition simulation.h:1369

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

CSimulation::bIncreaseCliffNotchIncision
bool bIncreaseCliffNotchIncision(int const, int const, int const, CRWCliff *, double const)
Increase the incision (if any) of a cliff notch, assuming a linear decrease in incision with distance...
Definition do_cliff_collapse.cpp:483

CSimulation::m_strOGRDWWVDriverDesc
string m_strOGRDWWVDriverDesc
Definition simulation.h:1273

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::bOnOrOffShoreAndUpOrDownCoast
static bool bOnOrOffShoreAndUpOrDownCoast(double const, double const, int const, bool &)
Determines whether the wave orientation at this point on a coast is onshore or offshore,...
Definition calc_shadow_zones.cpp:47

CSimulation::m_VstrGDALICFProjection
vector< string > m_VstrGDALICFProjection
GDAL projection for the initial consolidated fine sediment GIS data.
Definition simulation.h:1528

CSimulation::m_strOGRFloodDriverCode
string m_strOGRFloodDriverCode
GDAL code for the flood input locations point or vector file.
Definition simulation.h:1294

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

CSimulation::m_VstrGDALICCProjection
vector< string > m_VstrGDALICCProjection
GDAL projection for the initial consolidated coarse sediment GIS data.
Definition simulation.h:1552

CSimulation::dGetTimeMultiplier
static double dGetTimeMultiplier(string const *)
Given a string containing time units, this returns the appropriate multiplier.
Definition utils.cpp:376

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

CSimulation::GenerateSyntheticTransects
void GenerateSyntheticTransects(vector< TransectWaveData > const *, vector< TransectWaveData > *)
Definition calc_waves.cpp:143

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

CSimulation::nGetGridXMax
int nGetGridXMax(void) const
Returns the cell size.
Definition utils.cpp:128

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::bWriteProfileData
bool bWriteProfileData(int const, CGeomProfile const *, int const, vector< double > const *, vector< double > const *, vector< double > const *, vector< double > const *, vector< double > const *, vector< double > const *, vector< double > const *, vector< CGeom2DIPoint > *const, vector< double > const *) const
Writes values for a single profile, for checking purposes.
Definition write_output.cpp:1299

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::nLocateCliffCell
void nLocateCliffCell(void)
Definition locate_cliff_toe.cpp:95

CSimulation::nInterpolateWavesToPolygonCells
int nInterpolateWavesToPolygonCells(vector< TransectWaveData > const *, vector< double > const *, vector< double > const *, vector< double > const *, vector< double > const *)
Definition gis_raster.cpp:2147

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::dGridYToExtCRSY
double dGridYToExtCRSY(double const) const
Given a real-valued Y-axis ordinate in the raster grid CRS (i.e. not the centroid of a cell),...
Definition gis_utils.cpp:104

CSimulation::bWriteParProfileData
bool bWriteParProfileData(int const, int const, int const, int const, int const, vector< double > const *, vector< double > const *, vector< double > const *, vector< double > const *, vector< double > const *, vector< double > const *, vector< double > const *, vector< CGeom2DIPoint > *const, vector< double > const *) const
Writes values for a single parallel profile, for checking purposes.
Definition write_output.cpp:1369

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::bWritePerTimestepResultsCSV
bool bWritePerTimestepResultsCSV(void)
Write the results for this timestep to the .out file in CSV format.
Definition write_output.cpp:916

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_strMailAddress
string m_strMailAddress
An email addresx to which to send end-of-simulation messages.
Definition simulation.h:1156

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::bConfigureFromDatFile
bool bConfigureFromDatFile(CConfiguration &config)

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::strListTSFiles
string strListTSFiles(void) const
Return a space-separated string containing the names of the time series output files.
Definition utils.cpp:1123

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_strGDALLDriverDesc
string m_strGDALLDriverDesc
GDAL description of the initial landform class raster file.
Definition simulation.h:1213

CSimulation::SetRasterFileCreationDefaults
void SetRasterFileCreationDefaults(void)
Sets per-driver defaults for raster files created using GDAL.
Definition gis_utils.cpp:1743

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::m_VEdgeCell
vector< CGeom2DIPoint > m_VEdgeCell
Edge cells.
Definition simulation.h:1579

CSimulation::bCheckForIntersection
static bool bCheckForIntersection(CGeomProfile *const, CGeomProfile *const, int &, int &, double &, double &, double &, double &)
Checks all line segments of a pair of coastline-normal profiles for intersection. If the lines inters...
Definition create_profiles.cpp:1306

CSimulation::nInterpolateAllDeepWaterWaveValues
int nInterpolateAllDeepWaterWaveValues(void)
Definition gis_raster.cpp:2391

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_VnFloodLocationID
vector< int > m_VnFloodLocationID
ID for flood location.
Definition simulation.h:1399

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::m_VulProfileTimestep
vector< unsigned long > m_VulProfileTimestep
Timesteps at which to save profiles.
Definition simulation.h:1405

CSimulation::nCalcPotentialPlatformErosionOnProfile
int nCalcPotentialPlatformErosionOnProfile(int const, CGeomProfile *)
Calculates potential (i.e. unconstrained by available sediment) erosional lowering of the shore platf...
Definition do_shore_platform_erosion.cpp:164

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::bParseDate
static bool bParseDate(string const *, int &, int &, int &)
Parses a date string into days, months, and years, and checks each of them.
Definition utils.cpp:2804

CSimulation::m_strFloodLocationShapefile
string m_strFloodLocationShapefile
The name of the flood loction events shape file.
Definition simulation.h:1333

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::PtiFollowWaveAngle
static CGeom2DIPoint PtiFollowWaveAngle(CGeom2DIPoint const *, double const, double &)
Given a cell and a wave orientation, finds the 'upwave' cell.
Definition calc_shadow_zones.cpp:71

CSimulation::m_VdSavGolFCRWCoast
vector< double > m_VdSavGolFCRWCoast
Savitzky-Golay filter coefficients for the coastline vector(s)
Definition simulation.h:1420

CSimulation::m_VdSavGolFCGeomProfile
vector< double > m_VdSavGolFCGeomProfile
Savitzky-Golay filter coefficients for the profile vectors.
Definition simulation.h:1423

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::nValidateCliffToeDirection
CGeomLine nValidateCliffToeDirection(CGeomLine &CliffEdge, bool bReverse)
Definition locate_cliff_toe.cpp:502

CSimulation::nGetCoastNormalEndPoint
int nGetCoastNormalEndPoint(int const, int const, int const, CGeom2DPoint const *, double const, CGeom2DPoint *, CGeom2DIPoint *, bool const)
Finds the end point of a coastline-normal line, given the start point on the vector coastline....
Definition create_profiles.cpp:696

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

CSimulation::m_strGDALIWProjection
string m_strGDALIWProjection
GDAL projection string for the initial water depth raster file.
Definition simulation.h:1252

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::dAngleSubtended
static double dAngleSubtended(CGeom2DIPoint const *, CGeom2DIPoint const *, CGeom2DIPoint const *)
Returns the signed angle BAC (in radians) subtended between three CGeom2DIPoints B A C....
Definition gis_utils.cpp:695

CSimulation::m_VstrGDALIUSDriverDesc
vector< string > m_VstrGDALIUSDriverDesc
GDAL driver description for the initial unconsolidated sand sediment GIS data.
Definition simulation.h:1501

CSimulation::m_strDurationUnits
string m_strDurationUnits
The duration units for this simulation.
Definition simulation.h:1318

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

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::bElevAboveDeanElev
bool bElevAboveDeanElev(int const, int const, double const, CRWCellLandform const *)
Return true if the given elevation is higher than the Dean elevation (and other land use conditions a...
Definition do_beach_within_polygon.cpp:1836

CSimulation::bDetectFileFormat
bool bDetectFileFormat(string const &strFileName, bool &bIsYaml)
Detects whether the input file is in YAML or .dat format.
Definition read_input.cpp:4083

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

CSimulation::DoActualPlatformErosionOnCell
void DoActualPlatformErosionOnCell(int const, int const)
Calculates actual (constrained by available sediment) erosion of the consolidated shore platform on a...
Definition do_shore_platform_erosion.cpp:735

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

CSimulation::dExtCRSXToGridX
double dExtCRSXToGridX(double const) const
Transforms an X-axis ordinate in the external CRS to the equivalent X-axis ordinate in the raster gri...
Definition gis_utils.cpp:113

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::bWritePerTimestepResultsFixedWidth
bool bWritePerTimestepResultsFixedWidth(void)
Write the results for this timestep to the .out file in fixed-width format.
Definition write_output.cpp:678

CSimulation::nInsertPointIntoProfilesIfNeededThenUpdate
int nInsertPointIntoProfilesIfNeededThenUpdate(int const, CGeomProfile *, double const, double const, int const, CGeomProfile *, int const, bool const)
Inserts an intersection point into the profile that is to be retained, if that point is not already p...
Definition create_profiles.cpp:1951

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::FillPotentialPlatformErosionHoles
void FillPotentialPlatformErosionHoles(void)
Fills in 'holes' in the potential platform erosion i.e. orphan cells which get omitted because of rou...
Definition do_shore_platform_erosion.cpp:1240

CSimulation::bSurroundedByDriftCells
bool bSurroundedByDriftCells(int const, int const)
Returns true if this cell has four drift cells surrounding it.
Definition assign_landforms.cpp:515

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_strOGRDWWVGeometry
string m_strOGRDWWVGeometry
GDAL geometry for the deep water wave stations vector file.
Definition simulation.h:1276

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::dLookUpErosionPotential
double dLookUpErosionPotential(double const)
The erosion potential lookup: it returns a value for erosion potential given a value of Depth Over DB...
Definition do_shore_platform_erosion.cpp:1087

CSimulation::m_VstrGDALICFDriverDesc
vector< string > m_VstrGDALICFDriverDesc
GDAL driver description for the initial consolidated fine sediment GIS data.
Definition simulation.h:1525

CSimulation::m_VdSedimentInputLocationY
vector< double > m_VdSedimentInputLocationY
X coordinate (grid CRS) for sediment input event.
Definition simulation.h:1459

CSimulation::WritePolygonUnsortedSequence
void WritePolygonUnsortedSequence(vector< vector< vector< int > > > &)
Writes to the log file a table showing the unsorted sequence of polygon processing for all coasts.
Definition write_output.cpp:1996

CSimulation::strGetBuild
static string strGetBuild(void)
Returns the date and time on which the program was compiled.
Definition utils.cpp:1744

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

CSimulation::m_VstrGDALIUFDriverDesc
vector< string > m_VstrGDALIUFDriverDesc
GDAL driver description for the initial unconsolidated fine sediment GIS data.
Definition simulation.h:1489

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_strGDALIWDataType
string m_strGDALIWDataType
GDAL data type for the initial water depth raster file.
Definition simulation.h:1255

CSimulation::m_VstrGDALIUSDataType
vector< string > m_VstrGDALIUSDataType
GDAL data type for the initial unconsolidated sand sediment GIS data.
Definition simulation.h:1507

CSimulation::bApplyConfiguration
bool bApplyConfiguration(CConfiguration const &config)
Applies configuration values to simulation member variables.
Definition read_input.cpp:4638

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::nRemoveSmallCliffIslands
void nRemoveSmallCliffIslands(int const)
Definition locate_cliff_toe.cpp:112

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::AllPolygonsUpdateStoredUncons
void AllPolygonsUpdateStoredUncons(int const)
Before simulating beach erosion, update the per-polygon values of pre-existing unconsolidated sedimen...
Definition do_beach_sediment_movement.cpp:868

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::PtiWeightedAverage
static CGeom2DIPoint PtiWeightedAverage(CGeom2DIPoint const *, CGeom2DIPoint const *, double const)
Returns an integer point (grid CRS) which is the weighted average of two other grid CRS integer point...
Definition gis_utils.cpp:439

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_strGDALBasementDEMDataType
string m_strGDALBasementDEMDataType
GDAL data type for the basement DEM raster file.
Definition simulation.h:1207

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_strDeepWaterWavesInputFile
string m_strDeepWaterWavesInputFile
The name of the deep water wave stations time series file.
Definition simulation.h:1324

CSimulation::pstrChangeToBackslash
static string pstrChangeToBackslash(string const *)
Changes all forward slashes in the input string to backslashes, leaving the original unchanged.
Definition utils.cpp:2459

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_strGDALICProjection
string m_strGDALICProjection
GDAL projection string for the initial intervention class raster file.
Definition simulation.h:1228

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::nDoUnconsErosionOnPolygon
int nDoUnconsErosionOnPolygon(int const, CGeomCoastPolygon *, int const, double const, double &)
Erodes unconsolidated beach sediment of one texture class on the cells within a polygon....
Definition do_beach_within_polygon.cpp:39

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::strGetErrorText
static string strGetErrorText(int const)
Returns an error message given an error code.
Definition utils.cpp:2023

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::dTriangleAreax2
static double dTriangleAreax2(CGeom2DPoint const *, CGeom2DPoint const *, CGeom2DPoint const *)
Returns twice the signed area of a triangle, defined by three points.
Definition gis_utils.cpp:176

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::LSmoothCoastSavitzkyGolay
CGeomLine LSmoothCoastSavitzkyGolay(CGeomLine *, int const, int const) const
Does smoothing of a CGeomLine coastline vector (is in external CRS coordinates) using a Savitzky-Gola...
Definition smooth_line.cpp:81

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_strGDALISSDriverDesc
string m_strGDALISSDriverDesc
GDAL description for the initial suspended sediment raster file.
Definition simulation.h:1261

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

CSimulation::AnnounceAllocateMemory
static void AnnounceAllocateMemory(void)
Tells the user that we are now allocating memory.
Definition utils.cpp:508

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::nFindIndex
int nFindIndex(vector< double > const *, double const)
This is used by VdInterpolateCShoreProfileOutput, it returns the index of the value in pVdX which is ...
Definition interpolate.cpp:113

CSimulation::dGetD50Sand
double dGetD50Sand(void) const
Returns the global d50 value for sand sediment.
Definition utils.cpp:152

CSimulation::m_strGDALRasterOutputDriverLongname
string m_strGDALRasterOutputDriverLongname
GDAL raster output driver long name.
Definition simulation.h:1306

CSimulation::CalcMHWElevation
void CalcMHWElevation(int const)
Calculate Mean High Water (MHW) elevation for a given duration (in days). This is a tidal datum deter...
Definition utils.cpp:3091

CSimulation::m_VstrGDALIUCDriverCode
vector< string > m_VstrGDALIUCDriverCode
GDAL driver code for the initial unconsolidated coarse sediment GIS data.
Definition simulation.h:1510

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::dExtCRSYToGridY
double dExtCRSYToGridY(double const) const
Transforms a Y-axis ordinate in the external CRS to the equivalent Y-axis ordinate in the raster grid...
Definition gis_utils.cpp:122

CSimulation::WritePolygonPotentialErosion
void WritePolygonPotentialErosion(void)
Writes to the log file a table showing per-polygon potential erosion of all size classes of unconsoli...
Definition write_output.cpp:1922

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_VdSliceElev
vector< double > m_VdSliceElev
Elevations for raster slice output.
Definition simulation.h:1411

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::strDispTime
static string strDispTime(double const, bool const, bool const)
strDispTime returns a string formatted as h:mm:ss, given a parameter in seconds, with rounding and fr...
Definition utils.cpp:1682

CSimulation::m_strOGRSedInputGeometry
string m_strOGRSedInputGeometry
GDAL geometry for the sediment input event locations vector file.
Definition simulation.h:1288

CSimulation::m_strOGRSedInputDriverCode
string m_strOGRSedInputDriverCode
GDAL code for the sediment input event locations vector file.
Definition simulation.h:1282

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

CSimulation::nGetThisProfileElevationsForCShore
int nGetThisProfileElevationsForCShore(int const, CGeomProfile *, int const, vector< double > *, vector< double > *, vector< double > *)
Get profile horizontal distance and bottom elevation vectors in CShore units.
Definition calc_waves.cpp:1663

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_strGDALIWDriverDesc
string m_strGDALIWDriverDesc
GDAL description for the initial water depth raster file.
Definition simulation.h:1249

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::bIsWithinValidGrid
bool bIsWithinValidGrid(int const, int const) const
Checks whether the supplied point (an x-y pair, in the grid CRS) is within the raster grid,...
Definition gis_utils.cpp:184

CSimulation::nDoParallelProfileUnconsErosion
int nDoParallelProfileUnconsErosion(CGeomCoastPolygon *, int const, int const, int const, int const, int const, int const, vector< CGeom2DIPoint > const *, vector< double > const *, double &, double &, double &)
This routine erodes unconsolidated beach sediment (either fine, sand, or coarse) on a parallel profil...
Definition do_beach_within_polygon.cpp:486

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_strGDALBasementDEMDriverDesc
string m_strGDALBasementDEMDriverDesc
GDAL description of the basement DEM raster file type.
Definition simulation.h:1201

CSimulation::nFindClosestCoastPoint
int nFindClosestCoastPoint(int const, int const, int &)
Finds the number of the closest point on any coastline to a given point, or INT_NODATA in case of err...
Definition gis_utils.cpp:1897

CSimulation::ModifyBreakingWavePropertiesWithinShadowZoneToCoastline
void ModifyBreakingWavePropertiesWithinShadowZoneToCoastline(int const, int const)
Modifies the wave breaking properties at coastline points of profiles within the shadow zone.
Definition calc_waves.cpp:1992

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_strInterventionHeightFile
string m_strInterventionHeightFile
Name of intervention height file.
Definition simulation.h:1177

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_VstrGDALICSDataType
vector< string > m_VstrGDALICSDataType
GDAL data type for the initial consolidated sand sediment GIS data.
Definition simulation.h:1543

CSimulation::dGridXToExtCRSX
double dGridXToExtCRSX(double const) const
Given a real-valued X-axis ordinate in the raster grid CRS (i.e. not the centroid of a cell),...
Definition gis_utils.cpp:95

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_strOGRFloodDriverDesc
string m_strOGRFloodDriverDesc
Definition simulation.h:1297

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::dGetThisIterSWL
double dGetThisIterSWL(void) const
Returns this timestep's SWL.
Definition utils.cpp:96

CSimulation::m_VstrGDALICSProjection
vector< string > m_VstrGDALICSProjection
GDAL dprojection for the initial consolidated sand sediment GIS data.
Definition simulation.h:1540

CSimulation::CalcProcessStats
void CalcProcessStats(void)
This calculates and displays process statistics.
Definition utils.cpp:1796

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

CSimulation::DoShadowZoneAndDownDriftZone
void DoShadowZoneAndDownDriftZone(int const, int const, int const, int const)
Traverse the shadow zone, changing wave orientation and height, and the down-drift zone,...
Definition calc_shadow_zones.cpp:808

CSimulation::dCalcCurvature
static double dCalcCurvature(int const, CGeom2DPoint const *, CGeom2DPoint const *, CGeom2DPoint const *)
Calculates signed Menger curvature (https://en.wikipedia.org/wiki/Menger_curvature#Definition) from t...
Definition calc_curvature.cpp:156

CSimulation::PtGridCentroidToExt
CGeom2DPoint PtGridCentroidToExt(CGeom2DIPoint const *) const
Transforms a pointer to a CGeom2DIPoint in the raster grid CRS (assumed to be the centroid of a cell)...
Definition gis_utils.cpp:83

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

CSimulation::DoCoastCurvature
void DoCoastCurvature(int const, int const)
Calculates both detailed and smoothed curvature for every point on a coastline.
Definition calc_curvature.cpp:40

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_strOGRFloodDataType
string m_strOGRFloodDataType
GDAL data type for the flood input locations point or vector file.
Definition simulation.h:1303

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::nTraceAllCoasts
int nTraceAllCoasts(void)
Locates all the potential coastline start/finish points on the edges of the raster grid,...
Definition locate_coast.cpp:306

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

CSimulation::m_strGDALRasterOutputDriverExtension
string m_strGDALRasterOutputDriverExtension
GDAL raster output driver file extension.
Definition simulation.h:1309

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

CSimulation::m_strGDALBasementDEMProjection
string m_strGDALBasementDEMProjection
GDAL projection string for the basement DEM raster file.
Definition simulation.h:1204

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::AppendEnsureNoGap
static void AppendEnsureNoGap(vector< CGeom2DIPoint > *, CGeom2DIPoint const *)
Appends a CGeom2DIPoint to a vector<CGeom2DIPoint>, making sure that the new end point touches the pr...
Definition utils.cpp:2640

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::dGridCentroidXToExtCRSX
double dGridCentroidXToExtCRSX(int const) const
Given the integer X-axis ordinate of a cell in the raster grid CRS, returns the external CRS X-axis o...
Definition gis_utils.cpp:65

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

CSimulation::m_strOGRDWWVDataType
string m_strOGRDWWVDataType
GDAL data type for the deep water wave stations vector file.
Definition simulation.h:1279

CSimulation::dGetInterpolatedValue
double dGetInterpolatedValue(vector< double > const *, vector< double > const *, double, bool)
Definition interpolate.cpp:33

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

CSimulation::nLocateAndCreateGridEdgeProfile
int nLocateAndCreateGridEdgeProfile(bool const, int const, int &)
Creates a 'special' profile at each end of a coastline, at the edge of the raster grid....
Definition create_profiles.cpp:515

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_strGDALIHDriverCode
string m_strGDALIHDriverCode
GDAL code for the initial intervention height raster file.
Definition simulation.h:1234

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::TruncateOneProfileRetainOtherProfile
void TruncateOneProfileRetainOtherProfile(int const, CGeomProfile *, CGeomProfile *, double, double, int, int, bool const)
Truncates one intersecting profile at the point of intersection, and retains the other profile.
Definition create_profiles.cpp:1874

CSimulation::m_strGDALICDriverCode
string m_strGDALICDriverCode
GDAL code for the initial intervention class raster file.
Definition simulation.h:1222

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

CSimulation::dCalcBeachProtectionFactor
double dCalcBeachProtectionFactor(int const, int const, double const)
Calculates the (inverse) beach protection factor as in SCAPE: 0 is fully protected,...
Definition do_shore_platform_erosion.cpp:1102

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::ProcessDownDriftCell
void ProcessDownDriftCell(int const, int const, int const, double const, int const)
Process a single cell which is in the downdrift zone, changing its wave height.
Definition calc_shadow_zones.cpp:1238

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

CSimulation::m_VdThisIterDeepWaterWaveStationAngle
vector< double > m_VdThisIterDeepWaterWaveStationAngle
This-iteration wave orientation at deep water wave station.
Definition simulation.h:1438

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::nValidateCliffToeEdges
void nValidateCliffToeEdges(void)
Definition locate_cliff_toe.cpp:457

CSimulation::CellByCellFillSea
void CellByCellFillSea(int const, int const)
Cell-by-cell fills all sea cells starting from a given cell. The cell-by-cell fill (aka 'floodfill') ...
Definition locate_coast.cpp:128

CSimulation::m_VstrGDALIUCDriverDesc
vector< string > m_VstrGDALIUCDriverDesc
GDAL driver description for the initial unconsolidated coarse sediment GIS data.
Definition simulation.h:1513

CSimulation::bIsInterventionCell
bool bIsInterventionCell(int const, int const) const
Returns true if the cell is an intervention.
Definition utils.cpp:3066

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::bCreateErosionPotentialLookUp
bool bCreateErosionPotentialLookUp(vector< double > *, vector< double > *, vector< double > *)
Creates a look-up table for erosion potential, given depth over DB.
Definition do_shore_platform_erosion.cpp:1034

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::m_VnSavGolIndexCoast
vector< int > m_VnSavGolIndexCoast
Savitzky-Golay shift index for the coastline vector(s)
Definition simulation.h:1402

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_VdFloodLocationY
vector< double > m_VdFloodLocationY
X coordinate (grid CRS) for total water level flooding.
Definition simulation.h:1465

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_strGDALIHDriverDesc
string m_strGDALIHDriverDesc
GDAL description for the initial intervention height raster file.
Definition simulation.h:1237

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::PtiFindClosestCoastPoint
CGeom2DIPoint PtiFindClosestCoastPoint(int const, int const, int &)
Finds the closest point on any coastline to a given point.
Definition gis_utils.cpp:1861

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_VstrGDALICCDriverDesc
vector< string > m_VstrGDALICCDriverDesc
GDAL driver decription for the initial consolidated coarse sediment GIS data.
Definition simulation.h:1549

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::CalcDeanProfile
static void CalcDeanProfile(vector< double > *, double const, double const, double const, bool const, int const, double const)
Calculates a Dean equilibrium profile h(y) = A * y^(2/3) where h(y) is the distance below the highest...
Definition utils.cpp:2678

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::m_strGDALIHDataType
string m_strGDALIHDataType
GDAL data type for the initial intervention height raster file.
Definition simulation.h:1243

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_pVSedInputEvent
vector< CRWSedInputEvent * > m_pVSedInputEvent
Sediment input events.
Definition simulation.h:1588

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_VdTSDeepWaterWaveStationHeight
vector< double > m_VdTSDeepWaterWaveStationHeight
Time series of wave heights at deep water wave station.
Definition simulation.h:1444

CSimulation::WritePolygonActualMovement
void WritePolygonActualMovement(vector< vector< vector< int > > > &)
Writes to the log file a table showing per-polygon actual movement of unconsolidated beach sediment f...
Definition write_output.cpp:2143

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_VstrGDALIUCDataType
vector< string > m_VstrGDALIUCDataType
GDAL data type for the initial unconsolidated coarse sediment GIS data.
Definition simulation.h:1519

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::PtiPolygonCentroid
static CGeom2DIPoint PtiPolygonCentroid(vector< CGeom2DIPoint > *)
Returns an integer point (grid CRS) which is the centroid of a polygon, given by a vector of grid CRS...
Definition gis_utils.cpp:505

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::InterpolateWaveHeightToCoastPoints
void InterpolateWaveHeightToCoastPoints(int const)
Linearly interpolates wave properties from profiles to the coastline cells between two profiles.
Definition calc_waves.cpp:2250

CSimulation::BeachErosionTSStream
ofstream BeachErosionTSStream
Beach sediment erosion time series file output stream.
Definition simulation.h:1363

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::FindAllInundatedCells
int FindAllInundatedCells(void)
Finds and flags all sea areas which have at least one cell at a grid edge (i.e. does not flag 'inland...
Definition locate_coast.cpp:1617

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::nLandformToGrid
int nLandformToGrid(int const, int const)
At the end of each timestep, this routine stores the attributes from a single coastal landform object...
Definition assign_landforms.cpp:317

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

CSimulation::m_VdTSDeepWaterWaveStationAngle
vector< double > m_VdTSDeepWaterWaveStationAngle
Time series of wave orientation at deep water wave station.
Definition simulation.h:1447

CSimulation::VstrSplit
static vector< string > * VstrSplit(string const *, char const, vector< string > *)
From http://stackoverflow.com/questions/236129/split-a-string-in-c They implement (approximately) Pyt...
Definition utils.cpp:2580

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_VstrGDALIUSDriverCode
vector< string > m_VstrGDALIUSDriverCode
GDAL driver code for the initial unconsolidated sand sediment GIS data.
Definition simulation.h:1498

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

CSimulation::dCalcWaveAngleToCoastNormal
static double dCalcWaveAngleToCoastNormal(double const, double const, int const)
Calculates the angle between the wave direction and a normal to the coastline tangent....
Definition calc_waves.cpp:785

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

CSimulation::m_VEdgeCellEdge
vector< int > m_VEdgeCellEdge
The grid edge that each edge cell belongs to.
Definition simulation.h:1582

CSimulation::nTruncateProfileHitDifferentCoast
int nTruncateProfileHitDifferentCoast(int const, int const, int const, int const)
Truncates a profile which has hit a different coast.
Definition multiple_coastlines.cpp:322

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

GDALDataType

cme.h
This file contains global definitions for CoastalME.

SAVEMAX
int const SAVEMAX
Definition cme.h:368

NUMBER_OF_RNGS
int const NUMBER_OF_RNGS
Definition cme.h:367

configuration.h
Unified configuration class for CoastalME simulation parameters.

line.h
Contains CGeomLine definitions.

yaml_parser.h
Simple YAML parser for CoastalME configuration files.