coast_polygon.h

Go to the documentation of this file.

 
#ifndef COASTPOLYGON_H
#define COASTPOLYGON_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 "2d_shape.h"
 
class CGeomCoastPolygon : public CA2DShape
{
private:
   bool m_bUnconsSedimentMovementDownCoastThisIter;
 
   // Does the polygon meet at a point at its seaward end? (is it roughly triangular?)
//   bool m_bIsPointedSeaward;

   bool m_bCoastEndPolygon;

   bool m_bCoastStartPolygon;

   int m_nGlobalID;

   int m_nCoastID;

   int m_nCoastNode;

   int m_nProfileUpCoast;

   int m_nProfileDownCoast;

   int m_nProfileUpCoastNumPointsUsed;

   int m_nProfileDownCoastNumPointsUsed;

   int m_nNumCells;

   double m_dAvgUnconsD50;

   double m_dSeawaterVolume;
 
   // Note: all sediment depths are in m, and here cover the area of a single raster cell: to convert to a volume, multiply by m_dCellArea

   double m_dPotentialBeachErosionAllUncons;

   double m_dBeachErosionUnconsFine;

   double m_dBeachErosionUnconsSand;

   double m_dBeachErosionUnconsCoarse;

   double m_dBeachDepositionUnconsSand;

   double m_dBeachDepositionUnconsCoarse;

   double m_dSuspensionUnconsFine;

   double m_dToDoBeachDepositionUnconsSand;

   double m_dToDoBeachDepositionUnconsCoarse;

   double m_dBeachSandErodedDeanProfile;

   double m_dBeachCoarseErodedDeanProfile;

   double m_dCliffCollapseErosionFine;

   double m_dCliffCollapseErosionSand;

   double m_dCliffCollapseErosionCoarse;

   double m_dCliffCollapseTalusFineToSuspension;

   double m_dCliffCollapseTalusSand;

   double m_dCliffCollapseTalusCoarse;

   double m_dCliffCollapseSandErodedDeanProfile;

   double m_dCliffCollapseCoarseErodedDeanProfile;

   double m_dPlatformErosionToSuspensionFine;

   double m_dPlatformErosionUnconsSand;

   double m_dPlatformErosionUnconsCoarse;

   double m_dPreExistingUnconsFine;

   double m_dPreExistingUnconsSand;

   double m_dPreExistingUnconsCoarse;

   double m_dPreExistingConsFine;

   double m_dPreExistingConsSand;

   double m_dPreExistingConsCoarse;

   double m_dSedimentInputFine;

   double m_dSedimentInputSand;

   double m_dSedimentInputCoarse;

   double m_dLength;

   CGeom2DIPoint m_PtiNode;

   CGeom2DIPoint m_PtiAntinode;

   vector<int> m_VnUpCoastAdjacentPolygon;

   vector<int> m_VnDownCoastAdjacentPolygon;

   vector<int> m_VnCircularityWith;

   vector<double> m_VdUpCoastAdjacentPolygonBoundaryShare;

   vector<double> m_VdDownCoastAdjacentPolygonBoundaryShare;

   vector<CGeom2DIPoint> m_VPtiVertices;
 
protected:
 
public:
   CGeomCoastPolygon(int const, int const, int const, int const, int const, vector<CGeom2DPoint> const*, int const, int const, CGeom2DIPoint const*, CGeom2DIPoint const*, bool const, bool const);
   ~CGeomCoastPolygon(void) override;
 
   void SetDownCoastThisIter(bool const);
   bool bDownCoastThisIter(void) const;
 
   void SetCoastEndPolygon(void);
   bool bIsCoastEndPolygon(void) const;
   void SetCoastStartPolygon(void);
   bool bIsCoastStartPolygon(void) const;
 
   int nGetGlobalID(void) const;
   int nGetCoastID(void) const;
 
//    void SetCoastNode(int const);
   int nGetNodeCoastPoint(void) const;
   CGeom2DIPoint* pPtiGetNode(void);
   CGeom2DIPoint* pPtiGetAntiNode(void);
 
   void SetLength(double const);
   double dGetLength(void) const;
 
//    void SetNotPointed(void);
//    bool bIsPointed(void) const;
 
   void SetNumCellsInPolygon(int const);
   // int nGetNumCellsinPolygon(void) const;
 
   int nGetUpCoastProfile(void) const;
   int nGetDownCoastProfile(void) const;
 
//    void SetBoundary(vector<CGeom2DPoint> const*);
//    vector<CGeom2DPoint>* pPtVGetBoundary(void);
   CGeom2DPoint* pPtGetBoundaryPoint(int const);
   int nGetBoundarySize(void) const;
 
   int nGetNumPointsUsedUpCoastProfile(void) const;
   int nGetNumPointsUsedDownCoastProfile(void) const;
 
   void SetSeawaterVolume(const double);
   double dGetSeawaterVolume(void) const;
 
   void AddPotentialErosion(double const);
   double dGetPotentialErosion(void) const;
 
   void SetBeachErosionUnconsFine(double const);
   double dGetBeachErosionUnconsFine(void) const;
   void SetBeachErosionUnconsSand(double const);
   double dGetBeachErosionUnconsSand(void) const;
   void SetBeachErosionUnconsCoarse(double const);
   double dGetBeachErosionUnconsCoarse(void) const;
   double dGeBeachErosionAllUncons(void) const;
 
   void SetBeachDepositionUnconsSand(double const);
   double dGetBeachDepositionUnconsSand(void) const;
   void SetBeachDepositionUnconsCoarse(double const);
   double dGetBeachDepositionUnconsCoarse(void) const;
 
   void AddToSuspensionUnconsFine(double const);
   // void SetZeroSuspensionUnconsFine(void);
   double dGetSuspensionUnconsFine(void) const;
 
   void SetZeroToDoDepositionUnconsSand(void);
   void AddToDoBeachDepositionUnconsSand(double const);
   double dGetToDoBeachDepositionUnconsSand(void) const;
   void SetZeroToDoDepositionUnconsCoarse(void);
   void AddToDoBeachDepositionUnconsCoarse(double const);
   double dGetToDoBeachDepositionUnconsCoarse(void) const;
   double dGetBeachDepositionAndSuspensionAllUncons(void) const;
 
   void AddBeachSandErodedDeanProfile(double const);
   double dGetBeachSandErodedDeanProfile(void) const;
   void AddBeachCoarseErodedDeanProfile(double const);
   double dGetBeachCoarseErodedDeanProfile(void) const;
 
   void SetUpCoastAdjacentPolygons(vector<int> const*);
   int nGetUpCoastAdjacentPolygon(int const) const;
   int nGetNumUpCoastAdjacentPolygons(void) const;
 
   void SetDownCoastAdjacentPolygons(vector<int> const*);
   int nGetDownCoastAdjacentPolygon(int const) const;
   int nGetNumDownCoastAdjacentPolygons(void) const;
 
   void SetUpCoastAdjacentPolygonBoundaryShares(vector<double> const*);
   double dGetUpCoastAdjacentPolygonBoundaryShare(int const) const;
 
   void SetDownCoastAdjacentPolygonBoundaryShares(vector<double> const*);
   double dGetDownCoastAdjacentPolygonBoundaryShare(int const) const;
 
   // int nGetPointInPolygonSearchStartPoint(void) const;
 
   void SetAvgUnconsD50(double const);
   double dGetAvgUnconsD50(void) const;
 
   void Display(void) override;
   
   void AddCircularity(int const);
   vector<int> VnGetCircularities(void) const;
   
   void AddCliffCollapseErosionFine(double const);
   double dGetCliffCollapseErosionFine(void) const;
   void AddCliffCollapseErosionSand(double const);
   double dGetCliffCollapseErosionSand(void) const;
   void AddCliffCollapseErosionCoarse(double const);
   double dGetCliffCollapseErosionCoarse(void) const;   
   
   void AddCliffCollapseToSuspensionFine(double const);
   double dGetCliffCollapseToSuspensionFine(void) const;
   void AddCliffCollapseUnconsSandDeposition(double const);
   double dGetCliffCollapseUnconsSandDeposition(void) const;
   void AddCliffCollapseUnconsCoarseDeposition(double const);
   double dGetCliffCollapseUnconsCoarseDeposition(void) const;   
 
   void AddCliffCollapseFineErodedDeanProfile(double const);
   double dGetCliffCollapseFineErodedDeanProfile(void) const;
   void AddCliffCollapseSandErodedDeanProfile(double const);
   double dGetCliffCollapseSandErodedDeanProfile(void) const;
   void AddCliffCollapseCoarseErodedDeanProfile(double const);
   double dGetCliffCollapseCoarseErodedDeanProfile(void) const;
   
   void AddPlatformErosionToSuspensionUnconsFine(double const);
   double dGetPlatformErosionToSuspensionUnconsFine(void) const;
   void AddPlatformErosionUnconsSand(double const);
   double dGetPlatformErosionUnconsSand(void) const;
   void AddPlatformErosionUnconsCoarse(double const);
   double dGetPlatformErosionUnconsCoarse(void) const;
   
   void SetPreExistingUnconsFine(double const);
   double dGetPreExistingUnconsFine(void) const;
   void SetPreExistingUnconsSand(double const);
   double dGetPreExistingUnconsSand(void) const;
   void SetPreExistingUnconsCoarse(double const);
   double dGetPreExistingUnconsCoarse(void) const;
 
   void SetPreExistingConsFine(double const);
   double dGetPreExistingConsFine(void) const;
   void SetPreExistingConsSand(double const);
   double dGetPreExistingConsSand(void) const;
   void SetPreExistingConsCoarse(double const);
   double dGetPreExistingConsCoarse(void) const;
 
   void SetSedimentInputUnconsFine(double const);
   double dGetSedimentInputUnconsFine(void) const;
   void SetSedimentInputUnconsSand(double const);
   double dGetSedimentInputUnconsSand(void) const;
   void SetSedimentInputUnconsCoarse(double const);
   double dGetSedimentInputUnconsCoarse(void) const;
 
   void AppendVertex(CGeom2DIPoint const*);
   int nGetNumVertices(void) const;
   CGeom2DIPoint PtiGetVertex(int const) const;
 
   CGeom2DIPoint PtiGetFillStartPoint(void);
};
#endif //COASTPOLYGON_H