Geometry class for the cell objects which comprise the raster grid. More...

#include <cell.h>

Public Member Functions
	CGeomCell ()
	Constructor with initialization list.

	~CGeomCell (void)
	Destructor.

void	SetInContiguousSea (void)
	Set this cell as a sea cell.

bool	bIsInContiguousSea (void) const
	Is this a sea cell?

void	SetInContiguousFlood (void)
	Set this cell as in the contiguous runup flood area.

void	UnSetInContiguousFlood (void)
	Set this cell as not in the contiguous runup flood area.

void	SetFloodBySetupSurge (void)
	Set this cell as flooded by setup surge.

bool	bIsFloodBySetupSurge (void) const
	Is this cell flooded by setup surge?

void	SetFloodBySetupSurgeRunup (void)
	Set this cell as flooded by setup surge runup.

bool	bIsFloodBySetupSurgeRunup (void) const
	Is this cell flooded by setup surge runup?

bool	bIsInContiguousSeaArea (void) const
	Is this cell in the contiguous sea area?

void	SetInActiveZone (bool const)
	Sets a flag to show whether this cell is in the active zone.

bool	bIsInActiveZone (void) const
	Returns a flag which shows whether this cell is in the active zone.

bool	bPotentialPlatformErosion (void) const
	Returns true if this cell has had potential erosion this timestep.

void	SetAsCoastline (bool const)
	Marks this cell as 'under' a coastline.

bool	bIsCoastline (void) const
	Returns true if the cell is 'under' a coastline.

void	SetAsFloodLine (bool const)
	Marks this cell is flood line.

bool	bIsFloodLine (void) const
	Returns true if the cell is flood line.

void	SetAsCliff (bool const)
	Marks this cell as 'under' a coastline.

bool	bIsCliff (void) const
	Returns true if the cell is 'under' a coastline.

void	SetProfileID (int const)
	Marks this cell as 'under' a coastline-normal profile.

int	nGetProfileID (void) const

bool	bIsProfile (void) const
	Returns true if this cell is 'under' a coastline normal.

void	SetShadowZoneBoundary (void)
	Sets a flag to show that this cell is a shadow zone boundary.

bool	bIsShadowZoneBoundary (void) const
	Returns a flag which shows whether this cell is a shadow zone boundary.

void	SetBoundingBoxEdge (int const)
	Set the edge number if this cell is an edge bounding-box cell.

int	nGetBoundingBoxEdge (void) const
	Returns the number of the bounding-box edge, or NO_DIRECTION if it is not.

bool	bIsBoundingBoxEdge (void) const
	Is this an edge bounding-box cell?

void	SetPossibleCoastStartCell (void)

bool	bIsPossibleCoastStartCell (void) const

void	SetPossibleFloodStartCell (void)

bool	bIsPossibleFloodStartCell (void) const

void	SetPolygonID (int const)
	Sets the global ID number of the polygon which 'contains' this cell.

int	nGetPolygonID (void) const

void	SetPolygonCoastID (int const)
	Sets the coast number of the polygon which 'contains' this cell.

int	nGetPolygonCoastID (void) const

void	SetCoastAndPolygonID (int const, int const)

CRWCellLandform *	pGetLandform (void)
	Returns a pointer to this cell's CRWCellLandform object.

void	SetWaveFlood (void)
	Set this cell as flooded by swl + surge + setup + runup.

bool	bIsElevLessThanWaterLevel (void) const

void	SetCheckCell (void)

bool	bIsCellCheck (void) const

void	SetCheckFloodCell (void)
	Set this cell as checked (flood switch)

void	UnSetCheckFloodCell (void)
	Set the cell as not checked (flood switch)

bool	bIsCellFloodCheck (void) const
	Returns true if this cell is checked, false otherwise (flood switch)

void	SetLocalConsSlope (double const)
	Sets the local slope of the consolidated sediment only.

double	dGetLocalConsSlope (void) const
	Returns the local slope of the consolidated sediment only.

void	SetBasementElev (double const)
	Sets this cell's basement elevation.

double	dGetBasementElev (void) const
	Returns this cell's basement elevation.

bool	bBasementElevIsMissingValue (void) const

void	SetSlope (double const)
	Sets this cell's slope.

double	dGetSlope (void) const
	Returns this cell's slope.

double	dGetSedimentTopElev (void) const

double	dGetSedimentPlusInterventionTopElev (void) const

double	dGetOverallTopElev (void) const

bool	bIsInundated (void) const

double	dGetThisIterSWL (void) const
	Returns the sea surface elevation at current iteration.

double	dGetThisIterTotWaterLevel (void) const
	Returns the total water level at current iteration.

void	SetSeaDepth (void)

double	dGetSeaDepth (void) const
	Returns the depth of seawater on this cell.

void	InitCell (void)
	Initialise values for this cell.

double	dGetTotSeaDepth (void) const
	Returns the total depth of seawater on this cell.

void	SetWaveHeight (double const)
	Sets the wave height on this cell, also increments the total wave height.

double	dGetWaveHeight (void) const
	Returns the wave height on this cell.

double	dGetTotWaveHeight (void) const
	Returns the total wave height on this cell.

void	SetWaveAngle (double const)

double	dGetWaveAngle (void) const
	Returns the wave orientation on this cell.

double	dGetTotWaveAngle (void) const
	Returns the total wave orientation on this cell.

void	SetCellDeepWaterWaveHeight (double const)
	Sets the deep water wave height on this cell.

double	dGetCellDeepWaterWaveHeight (void) const
	Returns the deep water wave height on this cell.

void	SetCellDeepWaterWaveAngle (double const)
	Sets the deep water wave orientation on this cell.

double	dGetCellDeepWaterWaveAngle (void) const
	Returns the deep water wave orientation on this cell.

void	SetCellDeepWaterWavePeriod (double const)
	Sets the deep water wave Period on this cell.

double	dGetCellDeepWaterWavePeriod (void) const
	Returns the deep water wave period on this cell.

void	SetWaveValuesToDeepWaterWaveValues (void)

void	SetBeachProtectionFactor (double const)

double	dGetBeachProtectionFactor (void) const
	Returns this cell's beach protection factor.

void	SetSuspendedSediment (double const)

void	AddSuspendedSediment (double const)

double	dGetSuspendedSediment (void) const
	Returns the suspended sediment depth equivalent on this cell.

double	dGetTotSuspendedSediment (void) const
	Returns the total suspended sediment depth equivalent on this cell.

int	nGetTopNonZeroLayerAboveBasement (void) const

int	nGetTopLayerAboveBasement (void) const

double	dGetConsSedTopForLayerAboveBasement (int const) const

CRWCellLayer *	pGetLayerAboveBasement (int const)

void	AppendLayers (int const)
	Appends sediment layers.

void	CalcAllLayerElevsAndD50 (void)

int	nGetLayerAtElev (double const) const

double	dCalcLayerElev (const int)
	For this cell, calculates the elevation of the top of a given layer.

double	dGetTotConsFineThickConsiderNotch (void) const

double	dGetTotUnconsFine (void) const
	Returns the total thickness of fine unconsolidated sediment on this cell.

double	dGetTotConsSandThickConsiderNotch (void) const

double	dGetTotUnconsSand (void) const

double	dGetTotConsCoarseThickConsiderNotch (void) const

double	dGetTotUnconsCoarse (void) const
	Returns the total thickness of coarse unconsolidated sediment on this cell.

double	dGetTotConsThickness (void) const

double	dGetTotUnconsThickness (void) const

double	dGetTotAllSedThickness (void) const
	Returns the total thickness of all sediment (all size classes) on this cell.

void	SetPotentialPlatformErosion (double const)

double	dGetPotentialPlatformErosion (void) const
	Get potential (unconstrained) shore platform erosion.

double	dGetTotPotentialPlatformErosion (void) const
	Get total potential (unconstrained) shore platform erosion.

void	SetActualPlatformErosion (double const)

double	dGetActualPlatformErosion (void) const
	Get actual (constrained) shore platform erosion.

double	dGetTotActualPlatformErosion (void) const
	Get total actual (constrained) shore platform erosion.

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
	Get potential (unconstrained) beach erosion.

double	dGetTotPotentialBeachErosion (void) const
	Get total potential (supply-unconstrained) beach erosion.

void	SetActualBeachErosion (double const)

double	dGetActualBeachErosion (void) const
	Get actual (supply-constrained) beach erosion.

double	dGetTotActualBeachErosion (void) const
	Get total actual (supply-constrained) beach erosion.

void	IncrBeachDeposition (double const)

double	dGetBeachDeposition (void) const
	Get beach deposition.

double	dGetTotBeachDeposition (void) const
	Get beach erosion.

bool	bBeachErosionOrDepositionThisIter (void) const

double	dGetUnconsD50 (void) const
	Returns the D50 of unconsolidated sediment on this cell.

void	SetInterventionClass (int const)
	Sets the landform category and subcategory for an intervention.

int	nGetInterventionClass (void) const
	Gets the intervention class.

void	SetInterventionHeight (double const)
	Sets the intervention height.

double	dGetInterventionHeight (void) const
	Returns the intervention height.

double	dGetInterventionTopElev (void) const

void	SetShadowZoneNumber (int const)
	Set the number of the shadow zone that this cell is in.

int	nGetShadowZoneNumber (void) const
	Gets the number of the shadow zone that this cell is in.

bool	bIsinThisShadowZone (int const) const

bool	bIsinAnyShadowZone (void) const
	Returns true if this cell is in any shadow zone, false otherwise.

void	SetDownDriftZoneNumber (int const)
	Sets the down drift zone number.

int	nGetDownDriftZoneNumber (void) const
	Gets the down drift zone number.

Static Public Attributes
static CGeomRasterGrid *	m_pGrid = NULL

Private Attributes
bool	m_bInContiguousSea
	Switch to indicate if this is a sea cell, contiguous with other sea cells.

bool	m_bInContiguousFlood
	Switch to indicate that this cell is in the contiguous runup flood area.

bool	m_bIsInActiveZone
	Switch to indicate that this cell is in the active zone.

bool	m_bCoastline
	Switch to indicate that this cell is 'under' a coastline.

bool	m_bCliff
	Is this cell a cliff.

bool	m_bFloodLine
	Switch to indicate that this cell is 'under' a runup flood line.

bool	m_bWaveFlood
	Switch to indicate that this cell is 'under' a runup wave flood line.

bool	m_bCheckFloodCell
	TODO 007 What is this used for?

bool	m_bShadowBoundary
	Switch to show this cell is 'under' a shadow boundaryu.

bool	m_bPossibleCoastStartCell
	Switch to show that this cell could be the start of a coastline.

bool	m_bPossibleFloodStartCell
	TODO 007 What is this used for?

bool	m_bFloodBySetupSurge
	TODO 007 What is this used for?

bool	m_bFloodBySetupSurgeRunup
	TODO 007 What is this used for?

int	m_nBoundingBoxEdge
	If this cell is an edge (or bounding box) cell, this specifies the edge.

int	m_nPolygonID
	If this cell is within a polygon, this is the ID of the polygon.

int	m_nPolygonCoastID
	If this cell is within a polygon, this is the ID of the polygon's coast.

int	m_nCoastlineNormal

int	m_nShadowZoneNumber

int	m_nDownDriftZoneNumber

double	m_dLocalConsSlope
	Used in erosion calculations, stored here for display purposes.

double	m_dBasementElevation
	Elevation of basement surface (m)

double	m_dSlope
	Slope at this cell (degrees or unitless)

double	m_dSeaDepth
	Depth of still water (m), is zero if not inundated.

double	m_dTotSeaDepth

double	m_dWaveHeight
	Wave height (m)

double	m_dTotWaveHeight
	Total wave height (m) (used to calc average)

double	m_dWaveAngle
	Wave orientation.

double	m_dWavePeriod
	Wave period (s)

double	m_dTotWaveAngle
	Total wave orientation (used to calc average)

double	m_dDeepWaterWaveHeight
	Wave height if this is a deep water cell.

double	m_dDeepWaterWaveAngle
	Wave orientation if this is a deep water cell.

double	m_dDeepWaterWavePeriod
	Wave period if this is a deep water cell.

double	m_dBeachProtectionFactor

double	m_dSuspendedSediment
	Suspended sediment as depth equivalent (m)

double	m_dTotSuspendedSediment

double	m_dPotentialPlatformErosionThisIter

double	m_dTotPotentialPlatformErosion

double	m_dActualPlatformErosionThisIter
	Depth of sediment actually eroded from the shore platform this timestep.

double	m_dTotActualPlatformErosion
	Total depth of sediment actually eroded from the shore platform.

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
	Depth of unconsolidated beach sediment actually eroded this timestep.

double	m_dTotActualBeachErosion
	Total depth of unconsolidated beach sediment actually eroded.

double	m_dBeachDepositionThisIter
	Depth of unconsolidated beach sediment deposited this timestep.

double	m_dTotBeachDeposition
	Total depth of unconsolidated beach sediment deposited.

double	m_dUnconsD50

double	m_dInterventionHeight
	Height of intervention structure.

CRWCellLandform	m_Landform
	This cell's landform data.

vector< CRWCellLayer >	m_VLayerAboveBasement
	Number of layers NOT including the basement. Layer 0 is the lowest.

vector< double >	m_VdAllHorizonTopElev

Friends
class	CSimulation

Detailed Description

Geometry class for the cell objects which comprise the raster grid.

TODO 001 This is a more detailed description of the CGeomCell class.

Author: David Favis-Mortlock; Andres Payo

Date: 2025

Copyright: GNU General Public License

Definition at line 44 of file cell.h.

Constructor & Destructor Documentation

◆ CGeomCell()

CGeomCell::CGeomCell ( )

Constructor with initialization list.

Definition at line 41 of file cell.cpp.

◆ ~CGeomCell()

CGeomCell::~CGeomCell ( void )

Destructor.

Definition at line 71 of file cell.cpp.

Member Function Documentation

◆ AddCoarseTalusDeposition()

void CGeomCell::AddCoarseTalusDeposition ( double const dDepth )

Increments the depth of this-timestep coarse-sized talus from cliff collapse on this cell, also increments the total

Definition at line 925 of file cell.cpp.

◆ AddSandTalusDeposition()

void CGeomCell::AddSandTalusDeposition ( double const dDepth )

Increments the depth of this-timestep sand-sized talus from cliff collapse on this cell, also increments the total

Definition at line 918 of file cell.cpp.

◆ AddSuspendedSediment()

void CGeomCell::AddSuspendedSediment ( double const dIncSedDepth )

Adds to this cell's suspended sediment depth equivalent, it also increments the running total of suspended sediment depth equivalent

Definition at line 374 of file cell.cpp.

◆ AppendLayers()

void CGeomCell::AppendLayers ( int const nLayer )

Appends sediment layers.

Definition at line 626 of file cell.cpp.

◆ bBasementElevIsMissingValue()

bool CGeomCell::bBasementElevIsMissingValue ( void ) const

Returns true if this cells's basement data is NODATA, is needed for irregularly-shaped DEMs

Definition at line 348 of file cell.cpp.

◆ bBeachErosionOrDepositionThisIter()

bool CGeomCell::bBeachErosionOrDepositionThisIter ( void ) const

Returns true only if this cell has had no deposition or erosion this timestep

Definition at line 1019 of file cell.cpp.

◆ bIsBoundingBoxEdge()

bool CGeomCell::bIsBoundingBoxEdge ( void ) const

Is this an edge bounding-box cell?

Definition at line 82 of file cell.cpp.

◆ bIsCellCheck()

bool CGeomCell::bIsCellCheck ( void ) const

◆ bIsCellFloodCheck()

bool CGeomCell::bIsCellFloodCheck ( void ) const

Returns true if this cell is checked, false otherwise (flood switch)

Definition at line 307 of file cell.cpp.

◆ bIsCliff()

bool CGeomCell::bIsCliff ( void ) const

Returns true if the cell is 'under' a coastline.

Definition at line 177 of file cell.cpp.

◆ bIsCoastline()

bool CGeomCell::bIsCoastline ( void ) const

Returns true if the cell is 'under' a coastline.

Definition at line 171 of file cell.cpp.

◆ bIsElevLessThanWaterLevel()

bool CGeomCell::bIsElevLessThanWaterLevel ( void ) const

Returns true if the top elevation of this cell (sediment plus any intervention) is less than this iteration's total water level

Definition at line 282 of file cell.cpp.

◆ bIsFloodBySetupSurge()

bool CGeomCell::bIsFloodBySetupSurge ( void ) const

Is this cell flooded by setup surge?

Definition at line 102 of file cell.cpp.

◆ bIsFloodBySetupSurgeRunup()

bool CGeomCell::bIsFloodBySetupSurgeRunup ( void ) const

Is this cell flooded by setup surge runup?

Definition at line 112 of file cell.cpp.

◆ bIsFloodLine()

bool CGeomCell::bIsFloodLine ( void ) const

Returns true if the cell is flood line.

Definition at line 183 of file cell.cpp.

◆ bIsInActiveZone()

bool CGeomCell::bIsInActiveZone ( void ) const

Returns a flag which shows whether this cell is in the active zone.

Definition at line 125 of file cell.cpp.

◆ bIsinAnyShadowZone()

bool CGeomCell::bIsinAnyShadowZone ( void ) const

Returns true if this cell is in any shadow zone, false otherwise.

Definition at line 244 of file cell.cpp.

◆ bIsInContiguousSea()

bool CGeomCell::bIsInContiguousSea ( void ) const

Is this a sea cell?

Definition at line 90 of file cell.cpp.

◆ bIsInContiguousSeaArea()

bool CGeomCell::bIsInContiguousSeaArea ( void ) const

Is this cell in the contiguous sea area?

Definition at line 117 of file cell.cpp.

◆ bIsinThisShadowZone()

bool CGeomCell::bIsinThisShadowZone ( int const nZone ) const

Returns true if this cell is in the shadow zone with number given by the parameter, false otherwise

Definition at line 236 of file cell.cpp.

◆ bIsInundated()

bool CGeomCell::bIsInundated ( void ) const

Returns true if the elevation of the sediment top surface for this cell (plus any intervention) is less than the grid's this-timestep still water elevation

Definition at line 478 of file cell.cpp.

◆ bIsPossibleCoastStartCell()

bool CGeomCell::bIsPossibleCoastStartCell ( void ) const

Returns a flag which shows whether this cell has been flagged as a possible start- or end-point for a coastline

Definition at line 141 of file cell.cpp.

◆ bIsPossibleFloodStartCell()

bool CGeomCell::bIsPossibleFloodStartCell ( void ) const

Returns a flag which shows whether this cell has been flagged as a possible start point for runup flooding

Definition at line 153 of file cell.cpp.

◆ bIsProfile()

bool CGeomCell::bIsProfile ( void ) const

Returns true if this cell is 'under' a coastline normal.

Definition at line 195 of file cell.cpp.

◆ bIsShadowZoneBoundary()

bool CGeomCell::bIsShadowZoneBoundary ( void ) const

Returns a flag which shows whether this cell is a shadow zone boundary.

Definition at line 131 of file cell.cpp.

◆ bPotentialPlatformErosion()

bool CGeomCell::bPotentialPlatformErosion ( void ) const

Returns true if this cell has had potential erosion this timestep.

Definition at line 158 of file cell.cpp.

◆ CalcAllLayerElevsAndD50()

void CGeomCell::CalcAllLayerElevsAndD50 ( void )

For this cell, calculates the elevation of the top of every layer, and the d50 for the topmost unconsolidated sediment layer

Definition at line 633 of file cell.cpp.

◆ dCalcLayerElev()

double CGeomCell::dCalcLayerElev ( const int nLayer )

For this cell, calculates the elevation of the top of a given layer.

Definition at line 697 of file cell.cpp.

◆ dGetActualBeachErosion()

double CGeomCell::dGetActualBeachErosion ( void ) const

Get actual (supply-constrained) beach erosion.

Definition at line 979 of file cell.cpp.

◆ dGetActualPlatformErosion()

double CGeomCell::dGetActualPlatformErosion ( void ) const

Get actual (constrained) shore platform erosion.

Definition at line 732 of file cell.cpp.

◆ dGetBasementElev()

double CGeomCell::dGetBasementElev ( void ) const

Returns this cell's basement elevation.

Definition at line 336 of file cell.cpp.

◆ dGetBeachDeposition()

double CGeomCell::dGetBeachDeposition ( void ) const

Get beach deposition.

Definition at line 1002 of file cell.cpp.

◆ dGetBeachProtectionFactor()

double CGeomCell::dGetBeachProtectionFactor ( void ) const

Returns this cell's beach protection factor.

Definition at line 862 of file cell.cpp.

◆ dGetCellDeepWaterWaveAngle()

double CGeomCell::dGetCellDeepWaterWaveAngle ( void ) const

Returns the deep water wave orientation on this cell.

Definition at line 834 of file cell.cpp.

◆ dGetCellDeepWaterWaveHeight()

double CGeomCell::dGetCellDeepWaterWaveHeight ( void ) const

Returns the deep water wave height on this cell.

Definition at line 824 of file cell.cpp.

◆ dGetCellDeepWaterWavePeriod()

double CGeomCell::dGetCellDeepWaterWavePeriod ( void ) const

Returns the deep water wave period on this cell.

Definition at line 844 of file cell.cpp.

◆ dGetConsSedTopForLayerAboveBasement()

double CGeomCell::dGetConsSedTopForLayerAboveBasement ( int const nLayer ) const

Returns the elevation of the top of the consolidated sediment only, for a given layer (layer 0 being the one just above basement)

Definition at line 419 of file cell.cpp.

◆ dGetInterventionHeight()

double CGeomCell::dGetInterventionHeight ( void ) const

Returns the intervention height.

Definition at line 1064 of file cell.cpp.

◆ dGetInterventionTopElev()

double CGeomCell::dGetInterventionTopElev ( void ) const

Returns the elevation of the top of the intervention, assuming it rests on the sediment-top surface

Definition at line 1070 of file cell.cpp.

◆ dGetLocalConsSlope()

double CGeomCell::dGetLocalConsSlope ( void ) const

Returns the local slope of the consolidated sediment only.

Definition at line 328 of file cell.cpp.

◆ dGetOverallTopElev()

double CGeomCell::dGetOverallTopElev ( void ) const

Returns the highest elevation of the cell, which is either the sediment top elevation plus intervention height, or the sea surface elevation

Definition at line 471 of file cell.cpp.

◆ dGetPotentialBeachErosion()

double CGeomCell::dGetPotentialBeachErosion ( void ) const

Get potential (unconstrained) beach erosion.

Definition at line 962 of file cell.cpp.

◆ dGetPotentialPlatformErosion()

double CGeomCell::dGetPotentialPlatformErosion ( void ) const

Get potential (unconstrained) shore platform erosion.

Definition at line 715 of file cell.cpp.

◆ dGetSeaDepth()

double CGeomCell::dGetSeaDepth ( void ) const

Returns the depth of seawater on this cell.

Definition at line 358 of file cell.cpp.

Referenced by CGeomProfile::nGetCellGivenDepth().

◆ dGetSedimentPlusInterventionTopElev()

double CGeomCell::dGetSedimentPlusInterventionTopElev ( void ) const

Returns the true elevation of the sediment's top surface for this cell (if there is a cliff notch, ignore the missing volume) plus the height of any intervention

Definition at line 465 of file cell.cpp.

◆ dGetSedimentTopElev()

double CGeomCell::dGetSedimentTopElev ( void ) const

Returns the true elevation of the sediment's top surface for this cell (if there is a cliff notch, ignore the missing volume)

Definition at line 458 of file cell.cpp.

◆ dGetSlope()

double CGeomCell::dGetSlope ( void ) const

Returns this cell's slope.

Definition at line 344 of file cell.cpp.

◆ dGetSuspendedSediment()

double CGeomCell::dGetSuspendedSediment ( void ) const

Returns the suspended sediment depth equivalent on this cell.

Definition at line 382 of file cell.cpp.

◆ dGetThisIterCliffCollapseCoarseTalusDeposition()

double CGeomCell::dGetThisIterCliffCollapseCoarseTalusDeposition ( void ) const

Retuns the depth of this-timestep coarse talus deposition from cliff collapse on this cell

Definition at line 938 of file cell.cpp.

◆ dGetThisIterCliffCollapseErosionCoarse()

double CGeomCell::dGetThisIterCliffCollapseErosionCoarse ( void ) const

Returns the depth of this-timestep coarse-sized sediment cliff collapse on this cell

Definition at line 894 of file cell.cpp.

◆ dGetThisIterCliffCollapseErosionFine()

double CGeomCell::dGetThisIterCliffCollapseErosionFine ( void ) const

Returns the depth of this-timestep fine-sized sediment cliff collapse on this cell

Definition at line 882 of file cell.cpp.

◆ dGetThisIterCliffCollapseErosionSand()

double CGeomCell::dGetThisIterCliffCollapseErosionSand ( void ) const

Returns the depth of this-timestep sand-sized sediment cliff collapse on this cell

Definition at line 888 of file cell.cpp.

◆ dGetThisIterCliffCollapseSandTalusDeposition()

double CGeomCell::dGetThisIterCliffCollapseSandTalusDeposition ( void ) const

Returns the depth of this-timestep sand talus deposition from cliff collapse on this cell

Definition at line 932 of file cell.cpp.

◆ dGetThisIterSWL()

double CGeomCell::dGetThisIterSWL ( void ) const

Returns the sea surface elevation at current iteration.

Definition at line 484 of file cell.cpp.

◆ dGetThisIterTotWaterLevel()

double CGeomCell::dGetThisIterTotWaterLevel ( void ) const

Returns the total water level at current iteration.

Definition at line 489 of file cell.cpp.

◆ dGetTotActualBeachErosion()

double CGeomCell::dGetTotActualBeachErosion ( void ) const

Get total actual (supply-constrained) beach erosion.

Definition at line 984 of file cell.cpp.

◆ dGetTotActualPlatformErosion()

double CGeomCell::dGetTotActualPlatformErosion ( void ) const

Get total actual (constrained) shore platform erosion.

Definition at line 737 of file cell.cpp.

◆ dGetTotAllSedThickness()

double CGeomCell::dGetTotAllSedThickness ( void ) const

Returns the total thickness of all sediment (all size classes) on this cell.

Definition at line 621 of file cell.cpp.

◆ dGetTotBeachDeposition()

double CGeomCell::dGetTotBeachDeposition ( void ) const

Get beach erosion.

Definition at line 1007 of file cell.cpp.

◆ dGetTotCliffCollapseCoarse()

double CGeomCell::dGetTotCliffCollapseCoarse ( void ) const

Returns the running total depth of coarse-sized sediment eroded by cliff collapse on this cell

Definition at line 912 of file cell.cpp.

◆ dGetTotCliffCollapseFine()

double CGeomCell::dGetTotCliffCollapseFine ( void ) const

Returns the running total depth of fine-sized sediment eroded by cliff collapse on this cell

Definition at line 900 of file cell.cpp.

◆ dGetTotCliffCollapseSand()

double CGeomCell::dGetTotCliffCollapseSand ( void ) const

Returns the running total depth of sand-sized sediment eroded by cliff collapse on this cell

Definition at line 906 of file cell.cpp.

◆ dGetTotCoarseTalusDeposition()

double CGeomCell::dGetTotCoarseTalusDeposition ( void ) const

Returns the total depth of coarse talus deposition from cliff collapse on this cell

Definition at line 950 of file cell.cpp.

◆ dGetTotConsCoarseThickConsiderNotch()

double CGeomCell::dGetTotConsCoarseThickConsiderNotch ( void ) const

Returns the total thickness of coarse consolidated sediment on this cell, minus the depth-equivalent of any cliff notch

Definition at line 573 of file cell.cpp.

◆ dGetTotConsFineThickConsiderNotch()

double CGeomCell::dGetTotConsFineThickConsiderNotch ( void ) const

Returns the total thickness of fine consolidated sediment on this cell, minus the depth-equivalent of any cliff notch

Definition at line 518 of file cell.cpp.

◆ dGetTotConsSandThickConsiderNotch()

double CGeomCell::dGetTotConsSandThickConsiderNotch ( void ) const

Returns the total thickness of sand-sized consolidated sediment on this cell, minus the depth-equivalent of any cliff notch

Definition at line 545 of file cell.cpp.

◆ dGetTotConsThickness()

double CGeomCell::dGetTotConsThickness ( void ) const

Returns the total thickness of consolidated sediment (all size classes) on this cell

Definition at line 600 of file cell.cpp.

Referenced by dGetTotAllSedThickness().

◆ dGetTotPotentialBeachErosion()

double CGeomCell::dGetTotPotentialBeachErosion ( void ) const

Get total potential (supply-unconstrained) beach erosion.

Definition at line 967 of file cell.cpp.

◆ dGetTotPotentialPlatformErosion()

double CGeomCell::dGetTotPotentialPlatformErosion ( void ) const

Get total potential (unconstrained) shore platform erosion.

Definition at line 720 of file cell.cpp.

◆ dGetTotSandTalusDeposition()

double CGeomCell::dGetTotSandTalusDeposition ( void ) const

Returns the total depth of sand talus deposition from cliff collapse on this cell

Definition at line 944 of file cell.cpp.

◆ dGetTotSeaDepth()

double CGeomCell::dGetTotSeaDepth ( void ) const

Returns the total depth of seawater on this cell.

Definition at line 361 of file cell.cpp.

◆ dGetTotSuspendedSediment()

double CGeomCell::dGetTotSuspendedSediment ( void ) const

Returns the total suspended sediment depth equivalent on this cell.

Definition at line 387 of file cell.cpp.

◆ dGetTotUnconsCoarse()

double CGeomCell::dGetTotUnconsCoarse ( void ) const

Returns the total thickness of coarse unconsolidated sediment on this cell.

Definition at line 589 of file cell.cpp.

◆ dGetTotUnconsFine()

double CGeomCell::dGetTotUnconsFine ( void ) const

Returns the total thickness of fine unconsolidated sediment on this cell.

Definition at line 534 of file cell.cpp.

◆ dGetTotUnconsSand()

double CGeomCell::dGetTotUnconsSand ( void ) const

Returns the total thickness of sand-sized unconsolidated sediment on this cell

Definition at line 562 of file cell.cpp.

◆ dGetTotUnconsThickness()

double CGeomCell::dGetTotUnconsThickness ( void ) const

Returns the total thickness of unconsolidated sediment (all size classes) on this cell

Definition at line 611 of file cell.cpp.

Referenced by dGetTotAllSedThickness().

◆ dGetTotWaveAngle()

double CGeomCell::dGetTotWaveAngle ( void ) const

Returns the total wave orientation on this cell.

Definition at line 816 of file cell.cpp.

◆ dGetTotWaveHeight()

double CGeomCell::dGetTotWaveHeight ( void ) const

Returns the total wave height on this cell.

Definition at line 803 of file cell.cpp.

◆ dGetUnconsD50()

double CGeomCell::dGetUnconsD50 ( void ) const

Returns the D50 of unconsolidated sediment on this cell.

Definition at line 1027 of file cell.cpp.

◆ dGetWaveAngle()

double CGeomCell::dGetWaveAngle ( void ) const

Returns the wave orientation on this cell.

Definition at line 813 of file cell.cpp.

◆ dGetWaveHeight()

double CGeomCell::dGetWaveHeight ( void ) const

Returns the wave height on this cell.

Definition at line 800 of file cell.cpp.

◆ IncrBeachDeposition()

void CGeomCell::IncrBeachDeposition ( double const dThisDeposition )

Increment this-timestep beach deposition, also increment total beach deposition

Definition at line 996 of file cell.cpp.

◆ IncrCliffCollapseErosion()

void CGeomCell::IncrCliffCollapseErosion	(	double const	dFineDepth,
		double const	dSandDepth,
		double const	dCoarseDepth )

Increments the fine, sand, and coarse depths of this-timestep cliff collapse on this cell, also increments the totals

Definition at line 868 of file cell.cpp.

◆ InitCell()

void CGeomCell::InitCell ( void )

Initialise values for this cell.

Definition at line 750 of file cell.cpp.

◆ nGetBoundingBoxEdge()

int CGeomCell::nGetBoundingBoxEdge ( void ) const

Returns the number of the bounding-box edge, or NO_DIRECTION if it is not.

Definition at line 79 of file cell.cpp.

◆ nGetDownDriftZoneNumber()

int CGeomCell::nGetDownDriftZoneNumber ( void ) const

Gets the down drift zone number.

Definition at line 315 of file cell.cpp.

◆ nGetInterventionClass()

int CGeomCell::nGetInterventionClass ( void ) const

Gets the intervention class.

Definition at line 1043 of file cell.cpp.

◆ nGetLayerAtElev()

int CGeomCell::nGetLayerAtElev ( double const dElev ) const

Given an elevation, this finds the index of the layer that contains that elevation (layer 0 being the first above the basement). Note that the elevation cannot exactly equal the elevation of the layer's top surface (this causes problems with e.g. cliff notches, which extend above this elevation)

Returns ELEV_IN_BASEMENT if in basement, ELEV_ABOVE_SEDIMENT_TOP if higher than or equal to sediment top, or layer number (0 to n),

Definition at line 679 of file cell.cpp.

◆ nGetPolygonCoastID()

int CGeomCell::nGetPolygonCoastID ( void ) const

Returns the coast number of the polygon which 'contains' this cell (returns INT_NODATA if the cell is not 'in' a polygon)

Definition at line 216 of file cell.cpp.

◆ nGetPolygonID()

int CGeomCell::nGetPolygonID ( void ) const

Returns the global ID number of the polygon which 'contains' this cell (returns INT_NODATA if the cell is not 'in' a polygon)

Definition at line 207 of file cell.cpp.

◆ nGetProfileID()

int CGeomCell::nGetProfileID ( void ) const

If this cell is 'under' a coastline-normal profile, returns the number of the profile. Otherwise it returns INT_NODATA

Definition at line 192 of file cell.cpp.

◆ nGetShadowZoneNumber()

int CGeomCell::nGetShadowZoneNumber ( void ) const

Gets the number of the shadow zone that this cell is in.

Definition at line 232 of file cell.cpp.

◆ nGetTopLayerAboveBasement()

int CGeomCell::nGetTopLayerAboveBasement ( void ) const

Returns the index of the topmost sediment layer (layer 0 being the one just above basement), which could have zero thickness

Definition at line 410 of file cell.cpp.

◆ nGetTopNonZeroLayerAboveBasement()

int CGeomCell::nGetTopNonZeroLayerAboveBasement ( void ) const

Returns the index of the topmost sediment layer (layer 0 being the one just above basement) with non-zero thickness. If there is no such layer, it returns NO_NONZERO_THICKNESS_LAYERS

Definition at line 394 of file cell.cpp.

Referenced by InitCell().

◆ pGetLandform()

CRWCellLandform * CGeomCell::pGetLandform ( void )

Returns a pointer to this cell's CRWCellLandform object.

Definition at line 320 of file cell.cpp.

◆ pGetLayerAboveBasement()

CRWCellLayer * CGeomCell::pGetLayerAboveBasement ( int const nLayer )

Return a reference to the Nth sediment layer (layer 0 being just above basement)

Definition at line 435 of file cell.cpp.

◆ SetActualBeachErosion()

void CGeomCell::SetActualBeachErosion ( double const dThisActualErosion )

Set this-timestep actual (supply-constrained) beach erosion and increment total actual beach erosion

Definition at line 973 of file cell.cpp.

◆ SetActualPlatformErosion()

void CGeomCell::SetActualPlatformErosion ( double const dThisActualErosion )

Set this-timestep actual (constrained) shore platform erosion and increment total actual shore platform erosion

Definition at line 726 of file cell.cpp.

◆ SetAsCliff()

void CGeomCell::SetAsCliff ( bool const bNewFlag )

Marks this cell as 'under' a coastline.

Definition at line 174 of file cell.cpp.

◆ SetAsCoastline()

void CGeomCell::SetAsCoastline ( bool const bNewFlag )

Marks this cell as 'under' a coastline.

Definition at line 168 of file cell.cpp.

◆ SetAsFloodLine()

void CGeomCell::SetAsFloodLine ( bool const bNewFlag )

Marks this cell is flood line.

Definition at line 180 of file cell.cpp.

◆ SetBasementElev()

void CGeomCell::SetBasementElev ( double const dNewElev )

Sets this cell's basement elevation.

Definition at line 331 of file cell.cpp.

◆ SetBeachProtectionFactor()

void CGeomCell::SetBeachProtectionFactor ( double const dFactor )

Definition at line 857 of file cell.cpp.

◆ SetBoundingBoxEdge()

void CGeomCell::SetBoundingBoxEdge ( int const nDirection )

Set the edge number if this cell is an edge bounding-box cell.

Definition at line 74 of file cell.cpp.

◆ SetCellDeepWaterWaveAngle()

void CGeomCell::SetCellDeepWaterWaveAngle ( double const dWaveAngle )

Sets the deep water wave orientation on this cell.

Definition at line 829 of file cell.cpp.

◆ SetCellDeepWaterWaveHeight()

void CGeomCell::SetCellDeepWaterWaveHeight ( double const dWaveHeight )

Sets the deep water wave height on this cell.

Definition at line 819 of file cell.cpp.

◆ SetCellDeepWaterWavePeriod()

void CGeomCell::SetCellDeepWaterWavePeriod ( double const dWavePeriod )

Sets the deep water wave Period on this cell.

Definition at line 839 of file cell.cpp.

◆ SetCheckCell()

void CGeomCell::SetCheckCell ( void )

◆ SetCheckFloodCell()

void CGeomCell::SetCheckFloodCell ( void )

Set this cell as checked (flood switch)

Definition at line 301 of file cell.cpp.

◆ SetCoastAndPolygonID()

void CGeomCell::SetCoastAndPolygonID	(	int const	nPolyCoastID,
		int const	nPolyID )

Sets the coast number, and the polygon ID, of the polygon which 'contains' this cell

Definition at line 220 of file cell.cpp.

◆ SetDownDriftZoneNumber()

void CGeomCell::SetDownDriftZoneNumber ( int const nCode )

Sets the down drift zone number.

Definition at line 310 of file cell.cpp.

◆ SetFloodBySetupSurge()

void CGeomCell::SetFloodBySetupSurge ( void )

Set this cell as flooded by setup surge.

Definition at line 99 of file cell.cpp.

◆ SetFloodBySetupSurgeRunup()

void CGeomCell::SetFloodBySetupSurgeRunup ( void )

Set this cell as flooded by setup surge runup.

Definition at line 107 of file cell.cpp.

◆ SetInActiveZone()

void CGeomCell::SetInActiveZone ( bool const bFlag )

Sets a flag to show whether this cell is in the active zone.

Definition at line 122 of file cell.cpp.

◆ SetInContiguousFlood()

void CGeomCell::SetInContiguousFlood ( void )

Set this cell as in the contiguous runup flood area.

Definition at line 93 of file cell.cpp.

◆ SetInContiguousSea()

void CGeomCell::SetInContiguousSea ( void )

Set this cell as a sea cell.

Definition at line 87 of file cell.cpp.

◆ SetInterventionClass()

void CGeomCell::SetInterventionClass ( int const nSubCatCode )

Sets the landform category and subcategory for an intervention.

Definition at line 1030 of file cell.cpp.

◆ SetInterventionHeight()

void CGeomCell::SetInterventionHeight ( double const dHeight )

Sets the intervention height.

Definition at line 1059 of file cell.cpp.

◆ SetLocalConsSlope()

void CGeomCell::SetLocalConsSlope ( double const dNewSlope )

Sets the local slope of the consolidated sediment only.

Definition at line 323 of file cell.cpp.

◆ SetPolygonCoastID()

void CGeomCell::SetPolygonCoastID ( int const nPolyCoastID )

Sets the coast number of the polygon which 'contains' this cell.

Definition at line 210 of file cell.cpp.

◆ SetPolygonID()

void CGeomCell::SetPolygonID ( int const nPolyID )

Sets the global ID number of the polygon which 'contains' this cell.

Definition at line 203 of file cell.cpp.

◆ SetPossibleCoastStartCell()

void CGeomCell::SetPossibleCoastStartCell ( void )

Sets a flag to show that this cell has been flagged as a possible start- or end-point for a coastline

Definition at line 135 of file cell.cpp.

◆ SetPossibleFloodStartCell()

void CGeomCell::SetPossibleFloodStartCell ( void )

Sets a flag to show that this cell has been flagged as a possible start-point for runup flooding

Definition at line 147 of file cell.cpp.

◆ SetPotentialBeachErosion()

void CGeomCell::SetPotentialBeachErosion ( double const dPotentialIn )

Set potential (unconstrained) beach erosion and increment total beach potential erosion

Definition at line 956 of file cell.cpp.

◆ SetPotentialPlatformErosion()

void CGeomCell::SetPotentialPlatformErosion ( double const dPotentialIn )

Set potential (unconstrained) shore platform erosion and increment total shore platform potential erosion

Definition at line 709 of file cell.cpp.

◆ SetProfileID()

void CGeomCell::SetProfileID ( int const nNormal )

Marks this cell as 'under' a coastline-normal profile.

Definition at line 186 of file cell.cpp.

◆ SetSeaDepth()

void CGeomCell::SetSeaDepth ( void )

Returns the depth of seawater on this cell if the sediment top is < SWL, or zero

Definition at line 743 of file cell.cpp.

◆ SetShadowZoneBoundary()

void CGeomCell::SetShadowZoneBoundary ( void )

Sets a flag to show that this cell is a shadow zone boundary.

Definition at line 128 of file cell.cpp.

◆ SetShadowZoneNumber()

void CGeomCell::SetShadowZoneNumber ( int const nCode )

Set the number of the shadow zone that this cell is in.

Definition at line 227 of file cell.cpp.

◆ SetSlope()

void CGeomCell::SetSlope ( double const dNewSlope )

Sets this cell's slope.

Definition at line 341 of file cell.cpp.

◆ SetSuspendedSediment()

void CGeomCell::SetSuspendedSediment ( double const dNewSedDepth )

Sets this cell's suspended sediment depth equivalent, it also increments the running total of suspended sediment depth equivalent

Definition at line 365 of file cell.cpp.

◆ SetWaveAngle()

void CGeomCell::SetWaveAngle ( double const dWaveAngle )

Sets the wave orientation on this cell, also increments the total wave orientation

Definition at line 807 of file cell.cpp.

◆ SetWaveFlood()

void CGeomCell::SetWaveFlood ( void )

Set this cell as flooded by swl + surge + setup + runup.

Definition at line 252 of file cell.cpp.

◆ SetWaveHeight()

void CGeomCell::SetWaveHeight ( double const dWaveHeight )

Sets the wave height on this cell, also increments the total wave height.

Definition at line 791 of file cell.cpp.

◆ SetWaveValuesToDeepWaterWaveValues()

void CGeomCell::SetWaveValuesToDeepWaterWaveValues ( void )

Sets wave height to the deep water wave height value, and sets wave orientation to the deep water wave orientation value

Definition at line 850 of file cell.cpp.

◆ UnSetCheckFloodCell()

void CGeomCell::UnSetCheckFloodCell ( void )

Set the cell as not checked (flood switch)

Definition at line 304 of file cell.cpp.

◆ UnSetInContiguousFlood()

void CGeomCell::UnSetInContiguousFlood ( void )

Set this cell as not in the contiguous runup flood area.

Definition at line 96 of file cell.cpp.

Friends And Related Symbol Documentation

◆ CSimulation

friend class CSimulation

friend

Definition at line 45 of file cell.h.

Referenced by CSimulation.

Field Documentation

◆ m_bCheckFloodCell

bool CGeomCell::m_bCheckFloodCell

private

TODO 007 What is this used for?

Definition at line 73 of file cell.h.

Referenced by bIsCellFloodCheck(), CGeomCell(), InitCell(), SetCheckFloodCell(), and UnSetCheckFloodCell().

◆ m_bCliff

bool CGeomCell::m_bCliff

private

Is this cell a cliff.

Definition at line 61 of file cell.h.

Referenced by bIsCliff(), CGeomCell(), and SetAsCliff().

◆ m_bCoastline

bool CGeomCell::m_bCoastline

private

Switch to indicate that this cell is 'under' a coastline.

Definition at line 58 of file cell.h.

Referenced by bIsCoastline(), CGeomCell(), InitCell(), and SetAsCoastline().

◆ m_bFloodBySetupSurge

bool CGeomCell::m_bFloodBySetupSurge

private

TODO 007 What is this used for?

Definition at line 85 of file cell.h.

Referenced by bIsFloodBySetupSurge(), and SetFloodBySetupSurge().

◆ m_bFloodBySetupSurgeRunup

bool CGeomCell::m_bFloodBySetupSurgeRunup

private

TODO 007 What is this used for?

Definition at line 88 of file cell.h.

Referenced by bIsFloodBySetupSurgeRunup(), and SetFloodBySetupSurgeRunup().

◆ m_bFloodLine

bool CGeomCell::m_bFloodLine

private

Switch to indicate that this cell is 'under' a runup flood line.

Definition at line 64 of file cell.h.

Referenced by bIsFloodLine(), CGeomCell(), InitCell(), and SetAsFloodLine().

◆ m_bInContiguousFlood

bool CGeomCell::m_bInContiguousFlood

private

Switch to indicate that this cell is in the contiguous runup flood area.

Definition at line 52 of file cell.h.

Referenced by bIsInContiguousSeaArea(), CGeomCell(), InitCell(), SetInContiguousFlood(), and UnSetInContiguousFlood().

◆ m_bInContiguousSea

bool CGeomCell::m_bInContiguousSea

private

Switch to indicate if this is a sea cell, contiguous with other sea cells.

Definition at line 49 of file cell.h.

Referenced by bIsInContiguousSea(), CGeomCell(), InitCell(), and SetInContiguousSea().

◆ m_bIsInActiveZone

bool CGeomCell::m_bIsInActiveZone

private

Switch to indicate that this cell is in the active zone.

Definition at line 55 of file cell.h.

Referenced by bIsInActiveZone(), CGeomCell(), InitCell(), and SetInActiveZone().

◆ m_bPossibleCoastStartCell

bool CGeomCell::m_bPossibleCoastStartCell

private

Switch to show that this cell could be the start of a coastline.

Definition at line 79 of file cell.h.

Referenced by bIsPossibleCoastStartCell(), CGeomCell(), InitCell(), and SetPossibleCoastStartCell().

◆ m_bPossibleFloodStartCell

bool CGeomCell::m_bPossibleFloodStartCell

private

TODO 007 What is this used for?

Definition at line 82 of file cell.h.

Referenced by bIsPossibleFloodStartCell(), CGeomCell(), InitCell(), and SetPossibleFloodStartCell().

◆ m_bShadowBoundary

bool CGeomCell::m_bShadowBoundary

private

Switch to show this cell is 'under' a shadow boundaryu.

Definition at line 76 of file cell.h.

Referenced by bIsShadowZoneBoundary(), CGeomCell(), InitCell(), and SetShadowZoneBoundary().

◆ m_bWaveFlood

bool CGeomCell::m_bWaveFlood

private

Switch to indicate that this cell is 'under' a runup wave flood line.

Definition at line 67 of file cell.h.

Referenced by CGeomCell(), InitCell(), and SetWaveFlood().

◆ m_dActualBeachErosionThisIter

double CGeomCell::m_dActualBeachErosionThisIter

private

Depth of unconsolidated beach sediment actually eroded this timestep.

Definition at line 225 of file cell.h.

Referenced by bBeachErosionOrDepositionThisIter(), CGeomCell(), dGetActualBeachErosion(), InitCell(), and SetActualBeachErosion().

◆ m_dActualPlatformErosionThisIter

double CGeomCell::m_dActualPlatformErosionThisIter

private

Depth of sediment actually eroded from the shore platform this timestep.

Definition at line 171 of file cell.h.

Referenced by CGeomCell(), dGetActualPlatformErosion(), InitCell(), and SetActualPlatformErosion().

◆ m_dBasementElevation

double CGeomCell::m_dBasementElevation

private

Elevation of basement surface (m)

Definition at line 115 of file cell.h.

Referenced by bBasementElevIsMissingValue(), CalcAllLayerElevsAndD50(), CGeomCell(), dCalcLayerElev(), dGetBasementElev(), dGetConsSedTopForLayerAboveBasement(), and SetBasementElev().

◆ m_dBeachDepositionThisIter

double CGeomCell::m_dBeachDepositionThisIter

private

Depth of unconsolidated beach sediment deposited this timestep.

Definition at line 231 of file cell.h.

Referenced by bBeachErosionOrDepositionThisIter(), CGeomCell(), dGetBeachDeposition(), IncrBeachDeposition(), and InitCell().

◆ m_dBeachProtectionFactor

double CGeomCell::m_dBeachProtectionFactor

private

Only meaningful if in zone of platform erosion. 0 is fully protected; 1 = no protection

Definition at line 153 of file cell.h.

Referenced by CGeomCell(), dGetBeachProtectionFactor(), InitCell(), and SetBeachProtectionFactor().

◆ m_dCliffCollapseCoarseThisIter

double CGeomCell::m_dCliffCollapseCoarseThisIter

private

Depth of coarse sediment (consolidated and unconsolidated) removed via cliff collapse this timestep

Definition at line 186 of file cell.h.

Referenced by CGeomCell(), dGetThisIterCliffCollapseErosionCoarse(), IncrCliffCollapseErosion(), and InitCell().

◆ m_dCliffCollapseFineThisIter

double CGeomCell::m_dCliffCollapseFineThisIter

private

Depth of fine sediment (consolidated and unconsolidated) removed via cliff collapse this timestep

Definition at line 178 of file cell.h.

Referenced by CGeomCell(), dGetThisIterCliffCollapseErosionFine(), IncrCliffCollapseErosion(), and InitCell().

◆ m_dCliffCollapseSandThisIter

double CGeomCell::m_dCliffCollapseSandThisIter

private

Depth of sand sediment (consolidated and unconsolidated) removed via cliff collapse this timestep

Definition at line 182 of file cell.h.

Referenced by CGeomCell(), dGetThisIterCliffCollapseErosionSand(), IncrCliffCollapseErosion(), and InitCell().

◆ m_dDeepWaterWaveAngle

double CGeomCell::m_dDeepWaterWaveAngle

private

Wave orientation if this is a deep water cell.

Definition at line 146 of file cell.h.

Referenced by CGeomCell(), dGetCellDeepWaterWaveAngle(), SetCellDeepWaterWaveAngle(), and SetWaveValuesToDeepWaterWaveValues().

◆ m_dDeepWaterWaveHeight

double CGeomCell::m_dDeepWaterWaveHeight

private

Wave height if this is a deep water cell.

Definition at line 143 of file cell.h.

Referenced by CGeomCell(), dGetCellDeepWaterWaveHeight(), SetCellDeepWaterWaveHeight(), and SetWaveValuesToDeepWaterWaveValues().

◆ m_dDeepWaterWavePeriod

double CGeomCell::m_dDeepWaterWavePeriod

private

Wave period if this is a deep water cell.

Definition at line 149 of file cell.h.

Referenced by dGetCellDeepWaterWavePeriod(), SetCellDeepWaterWavePeriod(), and SetWaveValuesToDeepWaterWaveValues().

◆ m_dInterventionHeight

double CGeomCell::m_dInterventionHeight

private

Height of intervention structure.

Definition at line 241 of file cell.h.

Referenced by bIsElevLessThanWaterLevel(), bIsInundated(), CGeomCell(), dGetInterventionHeight(), dGetInterventionTopElev(), dGetOverallTopElev(), dGetSedimentPlusInterventionTopElev(), SetInterventionHeight(), and SetSeaDepth().

◆ m_dLocalConsSlope

double CGeomCell::m_dLocalConsSlope

private

Used in erosion calculations, stored here for display purposes.

Definition at line 112 of file cell.h.

Referenced by CGeomCell(), dGetLocalConsSlope(), InitCell(), and SetLocalConsSlope().

◆ m_dPotentialBeachErosionThisIter

double CGeomCell::m_dPotentialBeachErosionThisIter

private

Depth of unconsolidated beach sediment that could be eroded this timestep, if no supply-limitation

Definition at line 218 of file cell.h.

Referenced by CGeomCell(), dGetPotentialBeachErosion(), InitCell(), and SetPotentialBeachErosion().

◆ m_dPotentialPlatformErosionThisIter

double CGeomCell::m_dPotentialPlatformErosionThisIter

private

Depth of sediment on the shore platform that could be eroded this timestep, if no supply-limitation

Definition at line 164 of file cell.h.

Referenced by bPotentialPlatformErosion(), CGeomCell(), dGetPotentialPlatformErosion(), InitCell(), and SetPotentialPlatformErosion().

◆ m_dSeaDepth

double CGeomCell::m_dSeaDepth

private

Depth of still water (m), is zero if not inundated.

Definition at line 121 of file cell.h.

Referenced by CGeomCell(), dGetOverallTopElev(), dGetSeaDepth(), InitCell(), and SetSeaDepth().

◆ m_dSlope

double CGeomCell::m_dSlope

private

Slope at this cell (degrees or unitless)

Definition at line 118 of file cell.h.

Referenced by CGeomCell(), dGetSlope(), and SetSlope().

◆ m_dSuspendedSediment

double CGeomCell::m_dSuspendedSediment

private

Suspended sediment as depth equivalent (m)

Definition at line 156 of file cell.h.

Referenced by AddSuspendedSediment(), CGeomCell(), dGetSuspendedSediment(), and SetSuspendedSediment().

◆ m_dTalusCoarseDepositionThisIter

double CGeomCell::m_dTalusCoarseDepositionThisIter

private

Depth of unconsolidated coarse sediment deposited as a result of cliff collapse this timestep

Definition at line 210 of file cell.h.

Referenced by AddCoarseTalusDeposition(), CGeomCell(), dGetThisIterCliffCollapseCoarseTalusDeposition(), and InitCell().

◆ m_dTalusSandDepositionThisIter

double CGeomCell::m_dTalusSandDepositionThisIter

private

Depth of unconsolidated sand sediment deposited as a result of cliff collapse this timestep

Definition at line 202 of file cell.h.

Referenced by AddSandTalusDeposition(), CGeomCell(), dGetThisIterCliffCollapseSandTalusDeposition(), and InitCell().

◆ m_dTotActualBeachErosion

double CGeomCell::m_dTotActualBeachErosion

private

Total depth of unconsolidated beach sediment actually eroded.

Definition at line 228 of file cell.h.

Referenced by CGeomCell(), dGetTotActualBeachErosion(), and SetActualBeachErosion().

◆ m_dTotActualPlatformErosion

double CGeomCell::m_dTotActualPlatformErosion

private

Total depth of sediment actually eroded from the shore platform.

Definition at line 174 of file cell.h.

Referenced by CGeomCell(), dGetTotActualPlatformErosion(), and SetActualPlatformErosion().

◆ m_dTotBeachDeposition

double CGeomCell::m_dTotBeachDeposition

private

Total depth of unconsolidated beach sediment deposited.

Definition at line 234 of file cell.h.

Referenced by CGeomCell(), dGetTotBeachDeposition(), and IncrBeachDeposition().

◆ m_dTotCoarseCliffCollapse

double CGeomCell::m_dTotCoarseCliffCollapse

private

Total depth of coarse sediment (consolidated and unconsolidated) removed via cliff collapse

Definition at line 198 of file cell.h.

Referenced by CGeomCell(), dGetTotCliffCollapseCoarse(), and IncrCliffCollapseErosion().

◆ m_dTotFineCliffCollapse

double CGeomCell::m_dTotFineCliffCollapse

private

Total depth of fine sediment (consolidated and unconsolidated) removed via cliff collapse

Definition at line 190 of file cell.h.

Referenced by CGeomCell(), dGetTotCliffCollapseFine(), and IncrCliffCollapseErosion().

◆ m_dTotPotentialBeachErosion

double CGeomCell::m_dTotPotentialBeachErosion

private

Total depth of unconsolidated beach sediment eroded; if no supply-limitation

Definition at line 222 of file cell.h.

Referenced by CGeomCell(), dGetTotPotentialBeachErosion(), and SetPotentialBeachErosion().

◆ m_dTotPotentialPlatformErosion

double CGeomCell::m_dTotPotentialPlatformErosion

private

Total depth of sediment eroded from the shore platform, if no supply-limitation

Definition at line 168 of file cell.h.

Referenced by CGeomCell(), dGetTotPotentialPlatformErosion(), and SetPotentialPlatformErosion().

◆ m_dTotSandCliffCollapse

double CGeomCell::m_dTotSandCliffCollapse

private

Total depth of sand sediment (consolidated and unconsolidated) removed via cliff collapse

Definition at line 194 of file cell.h.

Referenced by CGeomCell(), dGetTotCliffCollapseSand(), and IncrCliffCollapseErosion().

◆ m_dTotSeaDepth

double CGeomCell::m_dTotSeaDepth

private

Total depth of still water (m) since beginning of simulation (used to calc average)

Definition at line 125 of file cell.h.

Referenced by CGeomCell(), and dGetTotSeaDepth().

◆ m_dTotSuspendedSediment

double CGeomCell::m_dTotSuspendedSediment

private

Total depth of suspended sediment (m) since simulation start (used to calc average)

Definition at line 160 of file cell.h.

Referenced by AddSuspendedSediment(), CGeomCell(), dGetTotSuspendedSediment(), and SetSuspendedSediment().

◆ m_dTotTalusCoarseDeposition

double CGeomCell::m_dTotTalusCoarseDeposition

private

Total depth of unconsolidated coarse sediment deposited as a result of cliff collapse

Definition at line 214 of file cell.h.

Referenced by AddCoarseTalusDeposition(), CGeomCell(), and dGetTotCoarseTalusDeposition().

◆ m_dTotTalusSandDeposition

double CGeomCell::m_dTotTalusSandDeposition

private

Total depth of unconsolidated sand sediment deposited as a result of cliff collapse

Definition at line 206 of file cell.h.

Referenced by AddSandTalusDeposition(), CGeomCell(), and dGetTotSandTalusDeposition().

◆ m_dTotWaveAngle

double CGeomCell::m_dTotWaveAngle

private

Total wave orientation (used to calc average)

Definition at line 140 of file cell.h.

Referenced by CGeomCell(), dGetTotWaveAngle(), and SetWaveAngle().

◆ m_dTotWaveHeight

double CGeomCell::m_dTotWaveHeight

private

Total wave height (m) (used to calc average)

Definition at line 131 of file cell.h.

Referenced by CGeomCell(), dGetTotWaveHeight(), and SetWaveHeight().

◆ m_dUnconsD50

double CGeomCell::m_dUnconsD50

private

d50 of unconsolidated sediment on top layer with unconsolidated sediment depth > 0

Definition at line 238 of file cell.h.

Referenced by CalcAllLayerElevsAndD50(), CGeomCell(), and dGetUnconsD50().

◆ m_dWaveAngle

double CGeomCell::m_dWaveAngle

private

Wave orientation.

Definition at line 134 of file cell.h.

Referenced by CGeomCell(), dGetWaveAngle(), InitCell(), SetWaveAngle(), and SetWaveValuesToDeepWaterWaveValues().

◆ m_dWaveHeight

double CGeomCell::m_dWaveHeight

private

Wave height (m)

Definition at line 128 of file cell.h.

Referenced by CGeomCell(), dGetWaveHeight(), InitCell(), SetWaveHeight(), and SetWaveValuesToDeepWaterWaveValues().

◆ m_dWavePeriod

double CGeomCell::m_dWavePeriod

private

Wave period (s)

Definition at line 137 of file cell.h.

Referenced by SetWaveValuesToDeepWaterWaveValues().

◆ m_Landform

CRWCellLandform CGeomCell::m_Landform

private

This cell's landform data.

Definition at line 244 of file cell.h.

Referenced by CGeomCell(), nGetInterventionClass(), pGetLandform(), and SetInterventionClass().

◆ m_nBoundingBoxEdge

int CGeomCell::m_nBoundingBoxEdge

private

If this cell is an edge (or bounding box) cell, this specifies the edge.

Definition at line 91 of file cell.h.

Referenced by bIsBoundingBoxEdge(), CGeomCell(), nGetBoundingBoxEdge(), and SetBoundingBoxEdge().

◆ m_nCoastlineNormal

int CGeomCell::m_nCoastlineNormal

private

If this cell is 'under' a coastline normal, this is the number of the normal

Definition at line 101 of file cell.h.

Referenced by bIsProfile(), CGeomCell(), InitCell(), nGetProfileID(), and SetProfileID().

◆ m_nDownDriftZoneNumber

int CGeomCell::m_nDownDriftZoneNumber

private

If this cell is within a downdrift zone, this is the number of the downdrift zone

Definition at line 109 of file cell.h.

Referenced by CGeomCell(), InitCell(), nGetDownDriftZoneNumber(), and SetDownDriftZoneNumber().

◆ m_nPolygonCoastID

int CGeomCell::m_nPolygonCoastID

private

If this cell is within a polygon, this is the ID of the polygon's coast.

Definition at line 97 of file cell.h.

Referenced by CGeomCell(), InitCell(), nGetPolygonCoastID(), SetCoastAndPolygonID(), and SetPolygonCoastID().

◆ m_nPolygonID

int CGeomCell::m_nPolygonID

private

If this cell is within a polygon, this is the ID of the polygon.

Definition at line 94 of file cell.h.

Referenced by CGeomCell(), InitCell(), nGetPolygonID(), SetCoastAndPolygonID(), and SetPolygonID().

◆ m_nShadowZoneNumber

int CGeomCell::m_nShadowZoneNumber

private

If this cell is within a shadow zone, this is the number of the shadow zone

Definition at line 105 of file cell.h.

Referenced by bIsinAnyShadowZone(), bIsinThisShadowZone(), CGeomCell(), InitCell(), nGetShadowZoneNumber(), and SetShadowZoneNumber().

◆ m_pGrid

CGeomRasterGrid * CGeomCell::m_pGrid = NULL

static

Definition at line 257 of file cell.h.

Referenced by bBasementElevIsMissingValue(), bIsElevLessThanWaterLevel(), bIsInundated(), CalcAllLayerElevsAndD50(), dGetThisIterSWL(), dGetThisIterTotWaterLevel(), CGeomRasterGrid::nCreateGrid(), and SetSeaDepth().

◆ m_VdAllHorizonTopElev

vector<double> CGeomCell::m_VdAllHorizonTopElev

private

Number of layer-top elevations (inc. that of the basement, which is m_VdAllHorizonTopElev[0]); size 1 greater than size of m_VLayerAboveBasement

Definition at line 253 of file cell.h.

Referenced by bIsElevLessThanWaterLevel(), bIsInundated(), CalcAllLayerElevsAndD50(), dGetInterventionTopElev(), dGetOverallTopElev(), dGetSedimentPlusInterventionTopElev(), dGetSedimentTopElev(), nGetLayerAtElev(), and SetSeaDepth().

◆ m_VLayerAboveBasement

vector<CRWCellLayer> CGeomCell::m_VLayerAboveBasement

private

Number of layers NOT including the basement. Layer 0 is the lowest.

Definition at line 248 of file cell.h.

Referenced by AppendLayers(), CalcAllLayerElevsAndD50(), dCalcLayerElev(), dGetConsSedTopForLayerAboveBasement(), dGetTotConsCoarseThickConsiderNotch(), dGetTotConsFineThickConsiderNotch(), dGetTotConsSandThickConsiderNotch(), dGetTotConsThickness(), dGetTotUnconsCoarse(), dGetTotUnconsFine(), dGetTotUnconsSand(), dGetTotUnconsThickness(), InitCell(), nGetLayerAtElev(), nGetTopLayerAboveBasement(), nGetTopNonZeroLayerAboveBasement(), and pGetLayerAboveBasement().

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Attributes

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ CGeomCell()

◆ ~CGeomCell()

Member Function Documentation

◆ AddCoarseTalusDeposition()

◆ AddSandTalusDeposition()

◆ AddSuspendedSediment()

◆ AppendLayers()

◆ bBasementElevIsMissingValue()

◆ bBeachErosionOrDepositionThisIter()

◆ bIsBoundingBoxEdge()

◆ bIsCellCheck()

◆ bIsCellFloodCheck()

◆ bIsCliff()

◆ bIsCoastline()

◆ bIsElevLessThanWaterLevel()

◆ bIsFloodBySetupSurge()

◆ bIsFloodBySetupSurgeRunup()

◆ bIsFloodLine()

◆ bIsInActiveZone()

◆ bIsinAnyShadowZone()

◆ bIsInContiguousSea()

◆ bIsInContiguousSeaArea()

◆ bIsinThisShadowZone()

◆ bIsInundated()

◆ bIsPossibleCoastStartCell()

◆ bIsPossibleFloodStartCell()

◆ bIsProfile()

◆ bIsShadowZoneBoundary()

◆ bPotentialPlatformErosion()

◆ CalcAllLayerElevsAndD50()

◆ dCalcLayerElev()

◆ dGetActualBeachErosion()

◆ dGetActualPlatformErosion()

◆ dGetBasementElev()

◆ dGetBeachDeposition()

◆ dGetBeachProtectionFactor()

◆ dGetCellDeepWaterWaveAngle()

◆ dGetCellDeepWaterWaveHeight()

◆ dGetCellDeepWaterWavePeriod()

◆ dGetConsSedTopForLayerAboveBasement()

◆ dGetInterventionHeight()

◆ dGetInterventionTopElev()

◆ dGetLocalConsSlope()

◆ dGetOverallTopElev()

◆ dGetPotentialBeachErosion()

◆ dGetPotentialPlatformErosion()

◆ dGetSeaDepth()

◆ dGetSedimentPlusInterventionTopElev()

◆ dGetSedimentTopElev()

◆ dGetSlope()

◆ dGetSuspendedSediment()

◆ dGetThisIterCliffCollapseCoarseTalusDeposition()

◆ dGetThisIterCliffCollapseErosionCoarse()

◆ dGetThisIterCliffCollapseErosionFine()

◆ dGetThisIterCliffCollapseErosionSand()

◆ dGetThisIterCliffCollapseSandTalusDeposition()

◆ dGetThisIterSWL()

◆ dGetThisIterTotWaterLevel()

◆ dGetTotActualBeachErosion()

◆ dGetTotActualPlatformErosion()

◆ dGetTotAllSedThickness()

◆ dGetTotBeachDeposition()

◆ dGetTotCliffCollapseCoarse()

◆ dGetTotCliffCollapseFine()

◆ dGetTotCliffCollapseSand()

◆ dGetTotCoarseTalusDeposition()

◆ dGetTotConsCoarseThickConsiderNotch()

◆ dGetTotConsFineThickConsiderNotch()

◆ dGetTotConsSandThickConsiderNotch()

◆ dGetTotConsThickness()

◆ dGetTotPotentialBeachErosion()

◆ dGetTotPotentialPlatformErosion()

◆ dGetTotSandTalusDeposition()

◆ dGetTotSeaDepth()