cell.h

Go to the documentation of this file.

 
#ifndef CELL_H
#define CELL_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 "cell_landform.h"
#include "cell_layer.h"
#include "cme.h"
#include "raster_grid.h"
 
class CGeomRasterGrid; // Forward declaration
 
class CGeomCell {
  friend class CSimulation;
 
private:
  bool m_bInContiguousSea;

  bool m_bInContiguousFlood;

  bool m_bIsInActiveZone;

  bool m_bCoastline;

  bool m_bCliff;

  bool m_bFloodLine;

  bool m_bWaveFlood;
 
  // //! TODO 007 What is this used for?
  // bool m_bCheckCell;

  bool m_bCheckFloodCell;

  bool m_bShadowBoundary;

  bool m_bPossibleCoastStartCell;

  bool m_bPossibleFloodStartCell;

  bool m_bFloodBySetupSurge;

  bool m_bFloodBySetupSurgeRunup;

  int m_nBoundingBoxEdge;

  int m_nPolygonID;

  int m_nPolygonCoastID;

  int m_nCoastlineNormal;

  int m_nShadowZoneNumber;

  int m_nDownDriftZoneNumber;

  double m_dLocalConsSlope;

  double m_dBasementElevation;

  double m_dSlope;

  double m_dSeaDepth;

  double m_dTotSeaDepth;

  double m_dWaveHeight;

  double m_dTotWaveHeight;

  double m_dWaveAngle;

  double m_dWavePeriod;

  double m_dTotWaveAngle;

  double m_dDeepWaterWaveHeight;

  double m_dDeepWaterWaveAngle;

  double m_dDeepWaterWavePeriod;

  double m_dBeachProtectionFactor;

  double m_dSuspendedSediment;

  double m_dTotSuspendedSediment;

  double m_dPotentialPlatformErosionThisIter;

  double m_dTotPotentialPlatformErosion;

  double m_dActualPlatformErosionThisIter;

  double m_dTotActualPlatformErosion;

  double m_dCliffCollapseFineThisIter;

  double m_dCliffCollapseSandThisIter;

  double m_dCliffCollapseCoarseThisIter;

  double m_dTotFineCliffCollapse;

  double m_dTotSandCliffCollapse;

  double m_dTotCoarseCliffCollapse;

  double m_dTalusSandDepositionThisIter;

  double m_dTotTalusSandDeposition;

  double m_dTalusCoarseDepositionThisIter;

  double m_dTotTalusCoarseDeposition;

  double m_dPotentialBeachErosionThisIter;

  double m_dTotPotentialBeachErosion;

  double m_dActualBeachErosionThisIter;

  double m_dTotActualBeachErosion;

  double m_dBeachDepositionThisIter;

  double m_dTotBeachDeposition;

  double m_dUnconsD50;

  double m_dInterventionHeight;

  CRWCellLandform m_Landform;
 
  // Initialize these as empty vectors
  vector<CRWCellLayer> m_VLayerAboveBasement;

  vector<double> m_VdAllHorizonTopElev;
 
protected:
public:
  static CGeomRasterGrid *m_pGrid;
 
  CGeomCell();
  ~CGeomCell(void);
 
  void SetInContiguousSea(void);
  bool bIsInContiguousSea(void) const;
 
  void SetInContiguousFlood(void);
  void UnSetInContiguousFlood(void);
  void SetFloodBySetupSurge(void);
  bool bIsFloodBySetupSurge(void) const;
  void SetFloodBySetupSurgeRunup(void);
  bool bIsFloodBySetupSurgeRunup(void) const;
  bool bIsInContiguousSeaArea(void) const;
 
  void SetInActiveZone(bool const);
  bool bIsInActiveZone(void) const;
  bool bPotentialPlatformErosion(void) const;
  // bool bActualPlatformErosion(void) const;
  void SetAsCoastline(bool const);
  bool bIsCoastline(void) const;
  void SetAsFloodLine(bool const);
  bool bIsFloodLine(void) const;
 
  void SetAsCliff(bool const);
  bool bIsCliff(void) const;
 
  void SetProfileID(int const);
  int nGetProfileID(void) const;
  bool bIsProfile(void) const;
 
  void SetShadowZoneBoundary(void);
  bool bIsShadowZoneBoundary(void) const;
 
  void SetBoundingBoxEdge(int const);
  int nGetBoundingBoxEdge(void) const;
  bool bIsBoundingBoxEdge(void) const;
 
  void SetPossibleCoastStartCell(void);
  bool bIsPossibleCoastStartCell(void) const;
 
  void SetPossibleFloodStartCell(void);
  bool bIsPossibleFloodStartCell(void) const;
 
  void SetPolygonID(int const);
  int nGetPolygonID(void) const;
 
  void SetPolygonCoastID(int const);
  int nGetPolygonCoastID(void) const;
 
  void SetCoastAndPolygonID(int const, int const);
 
  CRWCellLandform *pGetLandform(void);
 
  void SetWaveFlood(void);
  bool bIsElevLessThanWaterLevel(void) const;
 
  void SetCheckCell(void);
  bool bIsCellCheck(void) const;
 
  void SetCheckFloodCell(void);
  void UnSetCheckFloodCell(void);
  bool bIsCellFloodCheck(void) const;
 
  void SetLocalConsSlope(double const);
  double dGetLocalConsSlope(void) const;
 
  void SetBasementElev(double const);
  double dGetBasementElev(void) const;
  bool bBasementElevIsMissingValue(void) const;
 
  void SetSlope(double const);
  double dGetSlope(void) const;
 
  // double dGetVolEquivSedTopElev(void) const;
  double dGetSedimentTopElev(void) const;
  double dGetSedimentPlusInterventionTopElev(void) const;
  double dGetOverallTopElev(void) const;
 
  bool bIsInundated(void) const;
  double dGetThisIterSWL(void) const;
  double dGetThisIterTotWaterLevel(void) const;
  // bool bIsSeaIncBeach(void) const;
  void SetSeaDepth(void);
  double dGetSeaDepth(void) const;
  void InitCell(void);
  double dGetTotSeaDepth(void) const;
 
  void SetWaveHeight(double const);
  double dGetWaveHeight(void) const;
  double dGetTotWaveHeight(void) const;
  void SetWaveAngle(double const);
  double dGetWaveAngle(void) const;
  double dGetTotWaveAngle(void) const;
 
  void SetCellDeepWaterWaveHeight(double const);
  double dGetCellDeepWaterWaveHeight(void) const;
  void SetCellDeepWaterWaveAngle(double const);
  double dGetCellDeepWaterWaveAngle(void) const;
  void SetCellDeepWaterWavePeriod(double const);
  double dGetCellDeepWaterWavePeriod(void) const;
 
  void SetWaveValuesToDeepWaterWaveValues(void);
 
  void SetBeachProtectionFactor(double const);
  double dGetBeachProtectionFactor(void) const;
 
  void SetSuspendedSediment(double const);
  void AddSuspendedSediment(double const);
  double dGetSuspendedSediment(void) const;
  double dGetTotSuspendedSediment(void) const;
 
  int nGetTopNonZeroLayerAboveBasement(void) const;
  int nGetTopLayerAboveBasement(void) const;
 
  double dGetConsSedTopForLayerAboveBasement(int const) const;
  CRWCellLayer *pGetLayerAboveBasement(int const);
  void AppendLayers(int const);
  void CalcAllLayerElevsAndD50(void);
  int nGetLayerAtElev(double const) const;
  double dCalcLayerElev(const int);
 
  double dGetTotConsFineThickConsiderNotch(void) const;
  double dGetTotUnconsFine(void) const;
  double dGetTotConsSandThickConsiderNotch(void) const;
  double dGetTotUnconsSand(void) const;
  double dGetTotConsCoarseThickConsiderNotch(void) const;
  double dGetTotUnconsCoarse(void) const;
 
  double dGetTotConsThickness(void) const;
  double dGetTotUnconsThickness(void) const;
  double dGetTotAllSedThickness(void) const;
 
  void SetPotentialPlatformErosion(double const);
  double dGetPotentialPlatformErosion(void) const;
  double dGetTotPotentialPlatformErosion(void) const;
 
  void SetActualPlatformErosion(double const);
  double dGetActualPlatformErosion(void) const;
  double dGetTotActualPlatformErosion(void) const;
 
  void IncrCliffCollapseErosion(double const, double const, double const);
  double dGetThisIterCliffCollapseErosionFine(void) const;
  double dGetThisIterCliffCollapseErosionSand(void) const;
  double dGetThisIterCliffCollapseErosionCoarse(void) const;
  double dGetTotCliffCollapseFine(void) const;
  double dGetTotCliffCollapseSand(void) const;
  double dGetTotCliffCollapseCoarse(void) const;
 
  void AddSandTalusDeposition(double const);
  double dGetThisIterCliffCollapseSandTalusDeposition(void) const;
  double dGetTotSandTalusDeposition(void) const;
  void AddCoarseTalusDeposition(double const);
  double dGetThisIterCliffCollapseCoarseTalusDeposition(void) const;
  double dGetTotCoarseTalusDeposition(void) const;
 
  void SetPotentialBeachErosion(double const);
  double dGetPotentialBeachErosion(void) const;
  double dGetTotPotentialBeachErosion(void) const;
  void SetActualBeachErosion(double const);
  double dGetActualBeachErosion(void) const;
  double dGetTotActualBeachErosion(void) const;
  // bool bActualBeachErosionThisIter(void) const;
 
  void IncrBeachDeposition(double const);
  double dGetBeachDeposition(void) const;
  double dGetTotBeachDeposition(void) const;
  // bool bBeachDepositionThisIter(void) const;
 
  bool bBeachErosionOrDepositionThisIter(void) const;
 
  double dGetUnconsD50(void) const;
 
  void SetInterventionClass(int const);
  int nGetInterventionClass(void) const;
  void SetInterventionHeight(double const);
  double dGetInterventionHeight(void) const;
  double dGetInterventionTopElev(void) const;
 
  void SetShadowZoneNumber(int const);
  int nGetShadowZoneNumber(void) const;
  bool bIsinThisShadowZone(int const) const;
  bool bIsinAnyShadowZone(void) const;
  void SetDownDriftZoneNumber(int const);
  int nGetDownDriftZoneNumber(void) const;
};
#endif // CELL_H