CoastalME (Coastal Modelling Environment)
Simulates the long-term behaviour of complex coastlines
Loading...
Searching...
No Matches
cell.h
Go to the documentation of this file.
1
13
14#ifndef CELL_H
15#define CELL_H
16/* ===============================================================================================================================
17
18 This file is part of CoastalME, the Coastal Modelling Environment.
19
20 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.
21
22 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.
23
24 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.
25
26===============================================================================================================================*/
27#include <vector>
28using std::vector;
29
30// #include "cme.h"
31#include "cell_landform.h"
32#include "cell_layer.h"
33#include "raster_grid.h"
34
35class CGeomRasterGrid; // Forward declaration
36
38{
39 friend class CSimulation;
40
41private:
44
47
50
53
56
59
60 // //! TODO 007 What is this used for?
61 // bool m_bCheckCell;
62
65
68
71
74
77
80
83
86
89
92
95
98
101
104
107
110
113
116
119
122
125
128
131
134
137
140
143
146
149
152
155
158
161
164
167
170
173
176
179
182
185
188
191
194
197
200
203
206
209
212
213 // Initialize these as empty vectors
215 vector<CRWCellLayer> m_VLayerAboveBasement;
216
218 vector<double> m_VdAllHorizonTopElev;
219
220protected:
221
222public:
224
225 CGeomCell();
226 ~CGeomCell(void);
227
228 void SetInContiguousSea(void);
229 bool bIsInContiguousSea(void) const;
230
231 void SetInContiguousFlood(void);
232 void UnSetInContiguousFlood(void);
233 void SetFloodBySetupSurge(void);
234 bool bIsFloodBySetupSurge(void) const;
235 void SetFloodBySetupSurgeRunup(void);
236 bool bIsFloodBySetupSurgeRunup(void) const;
237 bool bIsInContiguousSeaArea(void) const;
238
239 void SetInActiveZone(bool const);
240 bool bIsInActiveZone(void) const;
241 bool bPotentialPlatformErosion(void) const;
242 // bool bActualPlatformErosion(void) const;
243 void SetAsCoastline(bool const);
244 bool bIsCoastline(void) const;
245 void SetAsFloodLine(bool const);
246 bool bIsFloodLine(void) const;
247
248 void SetProfileID(int const);
249 int nGetProfileID(void) const;
250 bool bIsProfile(void) const;
251
252 void SetShadowZoneBoundary(void);
253 bool bIsShadowZoneBoundary(void) const;
254
255 void SetBoundingBoxEdge(int const);
256 int nGetBoundingBoxEdge(void) const;
257 bool bIsBoundingBoxEdge(void) const;
258
259 void SetPossibleCoastStartCell(void);
260 bool bIsPossibleCoastStartCell(void) const;
261
262 void SetPossibleFloodStartCell(void);
263 bool bIsPossibleFloodStartCell(void) const;
264
265 void SetPolygonID(int const);
266 int nGetPolygonID(void) const;
267
268 void SetPolygonCoastID(int const);
269 int nGetPolygonCoastID(void) const;
270
271 void SetCoastAndPolygonID(int const, int const);
272
274
275 void SetWaveFlood(void);
276 bool bIsElevLessThanWaterLevel(void) const;
277
278 void SetCheckCell(void);
279 bool bIsCellCheck(void) const;
280
281 void SetCheckFloodCell(void);
282 void UnSetCheckFloodCell(void);
283 bool bIsCellFloodCheck(void) const;
284
285 void SetLocalConsSlope(double const);
286 double dGetLocalConsSlope(void) const;
287
288 void SetBasementElev(double const);
289 double dGetBasementElev(void) const;
290 bool bBasementElevIsMissingValue(void) const;
291
292 // double dGetVolEquivSedTopElev(void) const;
293 double dGetSedimentTopElev(void) const;
294 double dGetSedimentPlusInterventionTopElev(void) const;
295 double dGetOverallTopElev(void) const;
296
297 bool bIsInundated(void) const;
298 double dGetThisIterSWL(void) const;
299 double dGetThisIterTotWaterLevel(void) const;
300 // bool bIsSeaIncBeach(void) const;
301 void SetSeaDepth(void);
302 double dGetSeaDepth(void) const;
303 void InitCell(void);
304 double dGetTotSeaDepth(void) const;
305
306 void SetWaveHeight(double const);
307 double dGetWaveHeight(void) const;
308 double dGetTotWaveHeight(void) const;
309 void SetWaveAngle(double const);
310 double dGetWaveAngle(void) const;
311 double dGetTotWaveAngle(void) const;
312
313 void SetCellDeepWaterWaveHeight(double const);
314 double dGetCellDeepWaterWaveHeight(void) const;
315 void SetCellDeepWaterWaveAngle(double const);
316 double dGetCellDeepWaterWaveAngle(void) const;
317 void SetCellDeepWaterWavePeriod(double const);
318 double dGetCellDeepWaterWavePeriod(void) const;
319
321
322 void SetBeachProtectionFactor(double const);
323 double dGetBeachProtectionFactor(void) const;
324
325 void SetSuspendedSediment(double const);
326 void AddSuspendedSediment(double const);
327 double dGetSuspendedSediment(void) const;
328 double dGetTotSuspendedSediment(void) const;
329
330 int nGetTopNonZeroLayerAboveBasement(void) const;
331 int nGetTopLayerAboveBasement(void) const;
332
333 double dGetConsSedTopForLayerAboveBasement(int const) const;
335 void AppendLayers(int const);
336 void CalcAllLayerElevsAndD50(void);
337 int nGetLayerAtElev(double const) const;
338 double dCalcLayerElev(const int);
339
340 double dGetTotConsFineThickConsiderNotch(void) const;
341 double dGetTotUnconsFine(void) const;
342 double dGetTotConsSandThickConsiderNotch(void) const;
343 double dGetTotUnconsSand(void) const;
344 double dGetTotConsCoarseThickConsiderNotch(void) const;
345 double dGetTotUnconsCoarse(void) const;
346
347 double dGetTotConsThickness(void) const;
348 double dGetTotUnconsThickness(void) const;
349 double dGetTotAllSedThickness(void) const;
350
351 void SetPotentialPlatformErosion(double const);
352 double dGetPotentialPlatformErosion(void) const;
353 double dGetTotPotentialPlatformErosion(void) const;
354
355 void SetActualPlatformErosion(double const);
356 double dGetActualPlatformErosion(void) const;
357 double dGetTotActualPlatformErosion(void) const;
358
359 void IncrCliffCollapseErosion(double const, double const, double const);
360 double dGetThisIterCliffCollapseErosionFine(void) const;
361 double dGetThisIterCliffCollapseErosionSand(void) const;
363 double dGetTotCliffCollapseFine(void) const;
364 double dGetTotCliffCollapseSand(void) const;
365 double dGetTotCliffCollapseCoarse(void) const;
366
367 void AddSandTalusDeposition(double const);
369 double dGetTotSandTalusDeposition(void) const;
370 void AddCoarseTalusDeposition(double const);
372 double dGetTotCoarseTalusDeposition(void) const;
373
374 void SetPotentialBeachErosion(double const);
375 double dGetPotentialBeachErosion(void) const;
376 double dGetTotPotentialBeachErosion(void) const;
377 void SetActualBeachErosion(double const);
378 double dGetActualBeachErosion(void) const;
379 double dGetTotActualBeachErosion(void) const;
380 // bool bActualBeachErosionThisIter(void) const;
381
382 void IncrBeachDeposition(double const);
383 double dGetBeachDeposition(void) const;
384 double dGetTotBeachDeposition(void) const;
385 // bool bBeachDepositionThisIter(void) const;
386
387 bool bBeachErosionOrDepositionThisIter(void) const;
388
389 double dGetUnconsD50(void) const;
390
391 void SetInterventionClass(int const);
392 int nGetInterventionClass(void) const;
393 void SetInterventionHeight(double const);
394 double dGetInterventionHeight(void) const;
395 double dGetInterventionTopElev(void) const;
396
397 void SetShadowZoneNumber(int const);
398 int nGetShadowZoneNumber(void) const;
399 bool bIsinThisShadowZone(int const) const;
400 bool bIsinAnyShadowZone(void) const;
401 void SetDownDriftZoneNumber(int const);
402 int nGetDownDriftZoneNumber(void) const;
403};
404#endif // CELL_H
Contains CRWCellLandform definitions.
Contains CRWCellLayer definitions.
double m_dTotActualPlatformErosion
Total depth of sediment actually eroded from the shore platform.
Definition cell.h:154
double dGetTotCliffCollapseFine(void) const
Returns the running total depth of fine-sized sediment eroded by cliff collapse on this cell.
Definition cell.cpp:1017
void SetCellDeepWaterWavePeriod(double const)
Sets the deep water wave Period on this cell.
Definition cell.cpp:955
double dGetTotWaveHeight(void) const
Returns the total wave height on this cell.
Definition cell.cpp:906
void SetInContiguousFlood(void)
Set this cell as in the contiguous runup flood area.
Definition cell.cpp:129
double dGetThisIterCliffCollapseErosionFine(void) const
Returns the depth of this-timestep fine-sized sediment cliff collapse on this cell.
Definition cell.cpp:999
double m_dTotTalusCoarseDeposition
Total depth of unconsolidated coarse sediment deposited as a result of cliff collapse.
Definition cell.h:184
double dGetTotCoarseTalusDeposition(void) const
Returns the total depth of coarse talus deposition from cliff collapse on this cell.
Definition cell.cpp:1067
double m_dTotPotentialPlatformErosion
Total depth of sediment eroded from the shore platform, if no supply-limitation.
Definition cell.h:148
int m_nBoundingBoxEdge
If this cell is an edge (or bounding box) cell, this specifies the edge.
Definition cell.h:82
double m_dWaveAngle
Wave orientation.
Definition cell.h:118
double dGetTotPotentialPlatformErosion(void) const
Get total potential (unconstrained) shore platform erosion.
Definition cell.cpp:806
bool bIsinAnyShadowZone(void) const
Returns true if this cell is in any shadow zone, false otherwise.
Definition cell.cpp:327
double dGetTotConsFineThickConsiderNotch(void) const
Returns the total thickness of fine consolidated sediment on this cell, minus the depth-equivalent of...
Definition cell.cpp:611
bool bIsFloodBySetupSurge(void) const
Is this cell flooded by setup surge?
Definition cell.cpp:147
bool m_bCheckFloodCell
TODO 007 What is this used for?
Definition cell.h:64
void CalcAllLayerElevsAndD50(void)
For this cell, calculates the elevation of the top of every layer, and the d50 for the topmost uncons...
Definition cell.cpp:730
int nGetTopLayerAboveBasement(void) const
Returns the index of the topmost sediment layer (layer 0 being the one just above basement),...
Definition cell.cpp:511
double dCalcLayerElev(const int)
For this cell, calculates the elevation of the top of a given layer.
Definition cell.cpp:781
int nGetShadowZoneNumber(void) const
Gets the number of the shadow zone that this cell is in.
Definition cell.cpp:312
void SetWaveHeight(double const)
Sets the wave height on this cell, also increments the total wave height.
Definition cell.cpp:890
bool bIsShadowZoneBoundary(void) const
Returns a flag which shows whether this cell is a shadow zone boundary.
Definition cell.cpp:189
double dGetCellDeepWaterWavePeriod(void) const
Returns the deep water wave period on this cell.
Definition cell.cpp:961
void InitCell(void)
Initialise values for this cell.
Definition cell.cpp:837
double dGetCellDeepWaterWaveAngle(void) const
Returns the deep water wave orientation on this cell.
Definition cell.cpp:949
bool bBeachErosionOrDepositionThisIter(void) const
Returns true only if this cell has had no deposition or erosion this timestep.
Definition cell.cpp:1142
double dGetTotPotentialBeachErosion(void) const
Get total potential (supply-unconstrained) beach erosion.
Definition cell.cpp:1086
bool bIsFloodBySetupSurgeRunup(void) const
Is this cell flooded by setup surge runup?
Definition cell.cpp:159
void SetInActiveZone(bool const)
Sets a flag to show whether this cell is in the active zone.
Definition cell.cpp:171
double dGetPotentialBeachErosion(void) const
Get potential (unconstrained) beach erosion.
Definition cell.cpp:1080
bool bIsInContiguousSea(void) const
Is this a sea cell?
Definition cell.cpp:123
double m_dBeachProtectionFactor
Only meaningful if in zone of platform erosion. 0 is fully protected; 1 = no protection.
Definition cell.h:136
bool m_bInContiguousSea
Switch to indicate if this is a sea cell, contiguous with other sea cells.
Definition cell.h:43
int nGetPolygonCoastID(void) const
Returns the coast number of the polygon which 'contains' this cell (returns INT_NODATA if the cell is...
Definition cell.cpp:293
bool bIsBoundingBoxEdge(void) const
Is this an edge bounding-box cell?
Definition cell.cpp:111
double m_dTotActualBeachErosion
Total depth of unconsolidated beach sediment actually eroded.
Definition cell.h:196
double dGetTotBeachDeposition(void) const
Get beach erosion.
Definition cell.cpp:1130
void SetSuspendedSediment(double const)
Sets this cell's suspended sediment depth equivalent, it also increments the running total of suspend...
Definition cell.cpp:466
double dGetTotWaveAngle(void) const
Returns the total wave orientation on this cell.
Definition cell.cpp:925
void IncrBeachDeposition(double const)
Increment this-timestep beach deposition, also increment total beach deposition.
Definition cell.cpp:1117
void SetActualPlatformErosion(double const)
Set this-timestep actual (constrained) shore platform erosion and increment total actual shore platfo...
Definition cell.cpp:812
double dGetSeaDepth(void) const
Returns the depth of seawater on this cell.
Definition cell.cpp:454
bool bPotentialPlatformErosion(void) const
Returns true if this cell has had potential erosion this timestep.
Definition cell.cpp:219
double dGetTotActualBeachErosion(void) const
Get total actual (supply-constrained) beach erosion.
Definition cell.cpp:1105
double m_dBasementElevation
Elevation of basement surface (m)
Definition cell.h:103
int m_nCoastlineNormal
If this cell is 'under' a coastline normal, this is the number of the normal.
Definition cell.h:91
double dGetCellDeepWaterWaveHeight(void) const
Returns the deep water wave height on this cell.
Definition cell.cpp:937
double dGetInterventionTopElev(void) const
Returns the elevation of the top of the intervention, assuming it rests on the sediment-top surface.
Definition cell.cpp:1201
double dGetOverallTopElev(void) const
Returns the highest elevation of the cell, which is either the sediment top elevation plus interventi...
Definition cell.cpp:569
double dGetTotUnconsFine(void) const
Returns the total thickness of fine unconsolidated sediment on this cell.
Definition cell.cpp:628
double m_dLocalConsSlope
Used in erosion calculations, stored here for display purposes.
Definition cell.h:100
int nGetTopNonZeroLayerAboveBasement(void) const
Returns the index of the topmost sediment layer (layer 0 being the one just above basement) with non-...
Definition cell.cpp:494
bool m_bFloodBySetupSurgeRunup
TODO 007 What is this used for?
Definition cell.h:79
double dGetTotConsSandThickConsiderNotch(void) const
Returns the total thickness of sand-sized consolidated sediment on this cell, minus the depth-equival...
Definition cell.cpp:639
double dGetTotSandTalusDeposition(void) const
Returns the total depth of sand talus deposition from cliff collapse on this cell.
Definition cell.cpp:1061
double m_dBeachDepositionThisIter
Depth of unconsolidated beach sediment deposited this timestep.
Definition cell.h:199
bool m_bPossibleFloodStartCell
TODO 007 What is this used for?
Definition cell.h:73
double dGetTotCliffCollapseSand(void) const
Returns the running total depth of sand-sized sediment eroded by cliff collapse on this cell.
Definition cell.cpp:1023
double dGetBeachDeposition(void) const
Get beach deposition.
Definition cell.cpp:1124
bool bIsInundated(void) const
Returns true if the elevation of the sediment top surface for this cell (plus any intervention) is le...
Definition cell.cpp:575
void AppendLayers(int const)
Appends sediment layers.
Definition cell.cpp:723
bool bIsPossibleCoastStartCell(void) const
Returns a flag which shows whether this cell has been flagged as a possible start- or end-point for a...
Definition cell.cpp:201
int m_nPolygonCoastID
If this cell is within a polygon, this is the ID of the polygon's coast.
Definition cell.h:88
void SetActualBeachErosion(double const)
Set this-timestep actual (supply-constrained) beach erosion and increment total actual beach erosion.
Definition cell.cpp:1092
double dGetBeachProtectionFactor(void) const
Returns this cell's beach protection factor.
Definition cell.cpp:981
double m_dTalusSandDepositionThisIter
Depth of unconsolidated sand sediment deposited as a result of cliff collapse this timestep.
Definition cell.h:175
double m_dTalusCoarseDepositionThisIter
Depth of unconsolidated coarse sediment deposited as a result of cliff collapse this timestep.
Definition cell.h:181
double dGetTotAllSedThickness(void) const
Returns the total thickness of all sediment (all size classes) on this cell.
Definition cell.cpp:717
double m_dTotBeachDeposition
Total depth of unconsolidated beach sediment deposited.
Definition cell.h:202
void AddCoarseTalusDeposition(double const)
Increments the depth of this-timestep coarse-sized talus from cliff collapse on this cell,...
Definition cell.cpp:1042
void SetPotentialBeachErosion(double const)
Set potential (unconstrained) beach erosion and increment total beach potential erosion.
Definition cell.cpp:1073
double m_dTotWaveHeight
Total wave height (m) (used to calc average)
Definition cell.h:115
int nGetPolygonID(void) const
Returns the global ID number of the polygon which 'contains' this cell (returns INT_NODATA if the cel...
Definition cell.cpp:281
double dGetSedimentTopElev(void) const
Returns the true elevation of the sediment's top surface for this cell (if there is a cliff notch,...
Definition cell.cpp:557
~CGeomCell(void)
Destructor.
Definition cell.cpp:94
int nGetBoundingBoxEdge(void) const
Returns the number of the bounding-box edge, or NO_DIRECTION if it is not.
Definition cell.cpp:105
bool bIsInActiveZone(void) const
Returns a flag which shows whether this cell is in the active zone.
Definition cell.cpp:177
CRWCellLayer * pGetLayerAboveBasement(int const)
Return a reference to the Nth sediment layer (layer 0 being just above basement)
Definition cell.cpp:537
double m_dTotWaveAngle
Total wave orientation (used to calc average)
Definition cell.h:124
void SetInterventionHeight(double const)
Sets the intervention height.
Definition cell.cpp:1189
bool bIsFloodLine(void) const
Returns true if the cell is flood line.
Definition cell.cpp:248
int nGetProfileID(void) const
If this cell is 'under' a coastline-normal profile, returns the number of the profile....
Definition cell.cpp:260
double m_dCliffCollapseSandThisIter
Depth of sand sediment (consolidated and unconsolidated) removed via cliff collapse this timestep.
Definition cell.h:160
double dGetThisIterCliffCollapseCoarseTalusDeposition(void) const
Retuns the depth of this-timestep coarse talus deposition from cliff collapse on this cell.
Definition cell.cpp:1055
double dGetSedimentPlusInterventionTopElev(void) const
Returns the true elevation of the sediment's top surface for this cell (if there is a cliff notch,...
Definition cell.cpp:563
double dGetInterventionHeight(void) const
Returns the intervention height.
Definition cell.cpp:1195
bool bIsCellCheck(void) const
void SetPolygonID(int const)
Sets the global ID number of the polygon which 'contains' this cell.
Definition cell.cpp:275
void SetAsCoastline(bool const)
Marks this cell as 'under' a coastline.
Definition cell.cpp:230
double m_dPotentialPlatformErosionThisIter
Depth of sediment on the shore platform that could be eroded this timestep, if no supply-limitation.
Definition cell.h:145
double m_dTotSandCliffCollapse
Total depth of sand sediment (consolidated and unconsolidated) removed via cliff collapse.
Definition cell.h:169
double dGetThisIterSWL(void) const
Returns the sea surface elevation at current iteration.
Definition cell.cpp:581
int nGetInterventionClass(void) const
Gets the intervention class.
Definition cell.cpp:1172
void SetLocalConsSlope(double const)
Sets the local slope of the consolidated sediment only.
Definition cell.cpp:421
double dGetThisIterCliffCollapseSandTalusDeposition(void) const
Returns the depth of this-timestep sand talus deposition from cliff collapse on this cell.
Definition cell.cpp:1049
void SetDownDriftZoneNumber(int const)
Sets the down drift zone number.
Definition cell.cpp:403
static CGeomRasterGrid * m_pGrid
Definition cell.h:223
double dGetWaveHeight(void) const
Returns the wave height on this cell.
Definition cell.cpp:900
double dGetWaveAngle(void) const
Returns the wave orientation on this cell.
Definition cell.cpp:919
double dGetTotSeaDepth(void) const
Returns the total depth of seawater on this cell.
Definition cell.cpp:460
double m_dTotFineCliffCollapse
Total depth of fine sediment (consolidated and unconsolidated) removed via cliff collapse.
Definition cell.h:166
int nGetLayerAtElev(double const) const
Given an elevation, this finds the index of the layer that contains that elevation (layer 0 being the...
Definition cell.cpp:765
double m_dTotCoarseCliffCollapse
Total depth of coarse sediment (consolidated and unconsolidated) removed via cliff collapse.
Definition cell.h:172
CRWCellLandform m_Landform
This cell's landform data.
Definition cell.h:211
void SetCoastAndPolygonID(int const, int const)
Sets the coast number, and the polygon ID, of the polygon which 'contains' this cell.
Definition cell.cpp:299
double m_dCliffCollapseFineThisIter
Depth of fine sediment (consolidated and unconsolidated) removed via cliff collapse this timestep.
Definition cell.h:157
double m_dDeepWaterWaveHeight
Wave height if this is a deep water cell.
Definition cell.h:127
double dGetLocalConsSlope(void) const
Returns the local slope of the consolidated sediment only.
Definition cell.cpp:427
double m_dActualBeachErosionThisIter
Depth of unconsolidated beach sediment actually eroded this timestep.
Definition cell.h:193
double m_dTotSuspendedSediment
Total depth of suspended sediment (m) since simulation start (used to calc average)
Definition cell.h:142
void SetInterventionClass(int const)
Sets the landform category and subcategory for an intervention.
Definition cell.cpp:1157
bool m_bInContiguousFlood
Switch to indicate that this cell is in the contiguous runup flood area.
Definition cell.h:46
void SetWaveValuesToDeepWaterWaveValues(void)
Sets wave height to the deep water wave height value, and sets wave orientation to the deep water wav...
Definition cell.cpp:967
void SetBoundingBoxEdge(int const)
Set the edge number if this cell is an edge bounding-box cell.
Definition cell.cpp:99
double dGetTotUnconsCoarse(void) const
Returns the total thickness of coarse unconsolidated sediment on this cell.
Definition cell.cpp:684
void SetFloodBySetupSurgeRunup(void)
Set this cell as flooded by setup surge runup.
Definition cell.cpp:153
void SetPotentialPlatformErosion(double const)
Set potential (unconstrained) shore platform erosion and increment total shore platform potential ero...
Definition cell.cpp:793
bool m_bIsInActiveZone
Switch to indicate that this cell is in the active zone.
Definition cell.h:49
void SetPossibleFloodStartCell(void)
Sets a flag to show that this cell has been flagged as a possible start-point for runup flooding.
Definition cell.cpp:207
void AddSuspendedSediment(double const)
Adds to this cell's suspended sediment depth equivalent, it also increments the running total of susp...
Definition cell.cpp:474
bool m_bShadowBoundary
Switch to show this cell is 'under' a shadow boundaryu.
Definition cell.h:67
int nGetDownDriftZoneNumber(void) const
Gets the down drift zone number.
Definition cell.cpp:409
double dGetTotUnconsSand(void) const
Returns the total thickness of sand-sized unconsolidated sediment on this cell.
Definition cell.cpp:656
void UnSetInContiguousFlood(void)
Set this cell as not in the contiguous runup flood area.
Definition cell.cpp:135
friend class CSimulation
Definition cell.h:39
bool bIsInContiguousSeaArea(void) const
Is this cell in the contiguous sea area?
Definition cell.cpp:165
double dGetUnconsD50(void) const
Returns the D50 of unconsolidated sediment on this cell.
Definition cell.cpp:1151
double m_dPotentialBeachErosionThisIter
Depth of unconsolidated beach sediment that could be eroded this timestep, if no supply-limitation.
Definition cell.h:187
bool bIsCellFloodCheck(void) const
Returns true if this cell is checked, false otherwise (flood switch)
Definition cell.cpp:397
double dGetTotActualPlatformErosion(void) const
Get total actual (constrained) shore platform erosion.
Definition cell.cpp:825
bool bIsElevLessThanWaterLevel(void) const
Returns true if the top elevation of this cell (sediment plus any intervention) is less than this ite...
Definition cell.cpp:367
vector< double > m_VdAllHorizonTopElev
Number of layer-top elevations (inc. that of the basement, which is m_VdAllHorizonTopElev[0]); size 1...
Definition cell.h:218
double m_dWavePeriod
Wave period (s)
Definition cell.h:121
double m_dSeaDepth
Depth of still water (m), is zero if not inundated.
Definition cell.h:106
double dGetTotUnconsThickness(void) const
Returns the total thickness of unconsolidated sediment (all size classes) on this cell.
Definition cell.cpp:706
double dGetBasementElev(void) const
Returns this cell's basement elevation.
Definition cell.cpp:439
int m_nPolygonID
If this cell is within a polygon, this is the ID of the polygon.
Definition cell.h:85
bool bIsPossibleFloodStartCell(void) const
Returns a flag which shows whether this cell has been flagged as a possible start point for runup flo...
Definition cell.cpp:213
double m_dActualPlatformErosionThisIter
Depth of sediment actually eroded from the shore platform this timestep.
Definition cell.h:151
double dGetPotentialPlatformErosion(void) const
Get potential (unconstrained) shore platform erosion.
Definition cell.cpp:800
double dGetTotSuspendedSediment(void) const
Returns the total suspended sediment depth equivalent on this cell.
Definition cell.cpp:488
double m_dDeepWaterWaveAngle
Wave orientation if this is a deep water cell.
Definition cell.h:130
double dGetActualBeachErosion(void) const
Get actual (supply-constrained) beach erosion.
Definition cell.cpp:1099
void SetSeaDepth(void)
Returns the depth of seawater on this cell if the sediment top is < SWL, or zero.
Definition cell.cpp:831
void SetShadowZoneNumber(int const)
Set the number of the shadow zone that this cell is in.
Definition cell.cpp:306
double dGetTotConsCoarseThickConsiderNotch(void) const
Returns the total thickness of coarse consolidated sediment on this cell, minus the depth-equivalent ...
Definition cell.cpp:667
void SetCellDeepWaterWaveAngle(double const)
Sets the deep water wave orientation on this cell.
Definition cell.cpp:943
bool m_bPossibleCoastStartCell
Switch to show that this cell could be the start of a coastline.
Definition cell.h:70
CGeomCell()
Constructor with initialization list.
Definition cell.cpp:36
double dGetActualPlatformErosion(void) const
Get actual (constrained) shore platform erosion.
Definition cell.cpp:819
void SetFloodBySetupSurge(void)
Set this cell as flooded by setup surge.
Definition cell.cpp:141
int m_nShadowZoneNumber
If this cell is within a shadow zone, this is the number of the shadow zone.
Definition cell.h:94
bool bIsinThisShadowZone(int const) const
Returns true if this cell is in the shadow zone with number given by the parameter,...
Definition cell.cpp:318
double m_dDeepWaterWavePeriod
Wave period if this is a deep water cell.
Definition cell.h:133
double m_dTotPotentialBeachErosion
Total depth of unconsolidated beach sediment eroded; if no supply-limitation.
Definition cell.h:190
double m_dSuspendedSediment
Suspended sediment as depth equivalent (m)
Definition cell.h:139
double m_dTotTalusSandDeposition
Total depth of unconsolidated sand sediment deposited as a result of cliff collapse.
Definition cell.h:178
double dGetTotConsThickness(void) const
Returns the total thickness of consolidated sediment (all size classes) on this cell.
Definition cell.cpp:695
void SetCheckFloodCell(void)
Set this cell as checked (flood switch)
Definition cell.cpp:385
void SetInContiguousSea(void)
Set this cell as a sea cell.
Definition cell.cpp:117
int m_nDownDriftZoneNumber
If this cell is within a downdrift zone, this is the number of the downdrift zone.
Definition cell.h:97
double m_dWaveHeight
Wave height (m)
Definition cell.h:112
void SetWaveAngle(double const)
Sets the wave orientation on this cell, also increments the total wave orientation.
Definition cell.cpp:912
void SetProfileID(int const)
Marks this cell as 'under' a coastline-normal profile.
Definition cell.cpp:254
void SetPossibleCoastStartCell(void)
Sets a flag to show that this cell has been flagged as a possible start- or end-point for a coastline...
Definition cell.cpp:195
void SetShadowZoneBoundary(void)
Sets a flag to show that this cell is a shadow zone boundary.
Definition cell.cpp:183
double dGetThisIterCliffCollapseErosionCoarse(void) const
Returns the depth of this-timestep coarse-sized sediment cliff collapse on this cell.
Definition cell.cpp:1011
void SetBasementElev(double const)
Sets this cell's basement elevation.
Definition cell.cpp:433
void IncrCliffCollapseErosion(double const, double const, double const)
Increments the fine, sand, and coarse depths of this-timestep cliff collapse on this cell,...
Definition cell.cpp:987
void AddSandTalusDeposition(double const)
Increments the depth of this-timestep sand-sized talus from cliff collapse on this cell,...
Definition cell.cpp:1035
double dGetSuspendedSediment(void) const
Returns the suspended sediment depth equivalent on this cell.
Definition cell.cpp:482
bool bIsProfile(void) const
Returns true if this cell is 'under' a coastline normal.
Definition cell.cpp:266
double m_dUnconsD50
d50 of unconsolidated sediment on top layer with unconsolidated sediment depth > 0
Definition cell.h:205
double m_dInterventionHeight
Height of intervention structure.
Definition cell.h:208
vector< CRWCellLayer > m_VLayerAboveBasement
Number of layers NOT including the basement. Layer 0 is the lowest.
Definition cell.h:215
bool m_bFloodLine
Switch to indicate that this cell is 'under' a runup flood line.
Definition cell.h:55
bool bIsCoastline(void) const
Returns true if the cell is 'under' a coastline.
Definition cell.cpp:236
void SetPolygonCoastID(int const)
Sets the coast number of the polygon which 'contains' this cell.
Definition cell.cpp:287
void UnSetCheckFloodCell(void)
Set the cell as not checked (flood switch)
Definition cell.cpp:391
void SetCellDeepWaterWaveHeight(double const)
Sets the deep water wave height on this cell.
Definition cell.cpp:931
void SetCheckCell(void)
double dGetThisIterCliffCollapseErosionSand(void) const
Returns the depth of this-timestep sand-sized sediment cliff collapse on this cell.
Definition cell.cpp:1005
bool bBasementElevIsMissingValue(void) const
Returns true if this cells's basement data is NODATA, is needed for irregularly-shaped DEMs.
Definition cell.cpp:445
double dGetTotCliffCollapseCoarse(void) const
Returns the running total depth of coarse-sized sediment eroded by cliff collapse on this cell.
Definition cell.cpp:1029
bool m_bWaveFlood
Switch to indicate that this cell is 'under' a runup wave flood line.
Definition cell.h:58
double m_dCliffCollapseCoarseThisIter
Depth of coarse sediment (consolidated and unconsolidated) removed via cliff collapse this timestep.
Definition cell.h:163
CRWCellLandform * pGetLandform(void)
Returns a pointer to this cell's CRWCellLandform object.
Definition cell.cpp:415
void SetBeachProtectionFactor(double const)
Definition cell.cpp:975
void SetWaveFlood(void)
Set this cell as flooded by swl + surge + setup + runup.
Definition cell.cpp:336
void SetAsFloodLine(bool const)
Marks this cell is flood line.
Definition cell.cpp:242
double m_dTotSeaDepth
Total depth of still water (m) since beginning of simulation (used to calc average)
Definition cell.h:109
double dGetConsSedTopForLayerAboveBasement(int const) const
Returns the elevation of the top of the consolidated sediment only, for a given layer (layer 0 being ...
Definition cell.cpp:520
bool m_bFloodBySetupSurge
TODO 007 What is this used for?
Definition cell.h:76
double dGetThisIterTotWaterLevel(void) const
Returns the total water level at current iteration.
Definition cell.cpp:587
bool m_bCoastline
Switch to indicate that this cell is 'under' a coastline.
Definition cell.h:52
Geometry cass used to represent the raster grid of cell objects.
Definition raster_grid.h:34
Real-world class used to represent the landform of a cell.
Real-world class used to represent the sediment layers associated with a cell object.
Definition cell_layer.h:32
Contains CGeomRasterGrid definitions.