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

#include <cell.h>

Public Member Functions
	CGeomCell ()
	Constructor with initialisation list.

	~CGeomCell (void)
	Destructor.

void	SetInContiguousSea (void)
	Set this cell to be 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	bIsInContiguousSeaFlood (void) const
	Is this cell in the contiguous sea flood 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 platform erosion on this cell this timestep.

bool	bActualPlatformErosion (void) const
	Returns true if we have had actual platform erosion on this cell during this timestep.

void	SetAsCoastline (int const)
	Marks this cell with a coastline ID nunber.

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

int	nGetCoastline (void) const
	Returns the ID of the coastline, or INT_NODATA if not a coastline.

void	SetAsFloodline (bool const)
	Marks this cell as a flood line.

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

void	SetAsCliffToe (bool const)
	Marks this cell as a cliff toe cell.

bool	bIsCliffToe (void) const
	Returns true if this cell is marked as a cliff toe.

int	nGetProfileID (void) const
	Gets the ID number of the coast-normal profile which this cell is 'under', or returns INT_NODATA.

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

int	nGetProfileCoastID (void) const
	Gets the coast ID number of the coast-normal profile which this cell is 'under', or returns INT_NODATA.

void	SetCoastAndProfileID (int const, int const)
	Sets the coast ID number, and the profile ID number, of the coast-normal profile which this cell is 'under'.

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)
	Sets a flag to show that this cell has been flagged as a possible start- or end-point for a coastline.

bool	bIsPossibleCoastStartCell (void) const
	Returns a flag which shows whether this cell has been flagged as a possible start- or end-point for a coastline.

void	SetPossibleFloodStartCell (void)
	Sets a flag to show that this cell has been flagged as a possible start-point for runup flooding.

bool	bIsPossibleFloodStartCell (void) const
	Returns a flag which shows whether this cell has been flagged as a possible start point for runup flooding.

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

int	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)

void	SetCoastAndPolygonID (int const, int const)
	Sets the coast number, and the polygon ID, of the polygon which 'contains' this cell.

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	bElevLessThanSWL (void) const
	Returns true if the top elevation (sediment and talus, plus any intervention) of this cell is less than this iteration's SWL.

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	dGetConsSedSlope (void) const
	Returns the local slope of the consolidated sediment only.

void	SetSlopeForCliffToe (double const)
	Sets this cell's slope for cliff toe locating.

double	dGetSlopeForCliffToe (void) const
	Returns this cell's slope for cliff toe locationg.

bool	bIsInundated (void)
	Returns true if the elevation of the sediment top surface (both consolidated and unconsolidated, and any talus) for this cell, plus any intervention, is less than the grid's this-timestep still water elevation.

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

double	dGetThisIterTotWaterLevel (void) const
	Returns the total water level for the current iteration TODO 007 Finish surge and runup stuff.

void	SetSeaDepth (void)
	Returns the depth of seawater on this cell if the sediment top (including talus and intervention) is < SWL, or zero.

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)
	Sets the wave orientation on this cell, also increments the total wave orientation.

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)
	Sets wave height to the deep water wave height value, and sets wave orientation to the deep water wave orientation value.

void	SetBeachProtectionFactor (double const)

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

void	SetSuspendedSediment (double const)
	Sets this cell's suspended sediment depth equivalent, it also increments the running total of suspended sediment depth equivalent.

void	AddSuspendedSediment (double const)
	Adds to this cell's suspended sediment depth equivalent, it also increments the running total of suspended sediment depth equivalent.

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

int	nGetNumOfTopLayerAboveBasement (void) const
	Returns the index of the topmost sediment layer (layer 0 being the one just above basement). Note that this layer could have zero thickness.

int	nGetNumLayers (void) const
	Returns the number of sediment layers on the cell (some could have zero thickness)

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

CRWCellLayer *	pGetLayerAboveBasement (int const)
	Return a reference to the Nth sediment layer (layer 0 being just above basement)

void	AppendLayers (int const)
	Appends sediment layers.

void	CalcAllLayerElevsAndD50 (void)
	For this cell, calculates the elevation of the top of every layer, and the d50 for the topmost unconsolidated sediment layer.

int	nGetLayerAtElev (double const) 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.

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

double	dGetConsFineDepthAllLayers (void) const
	Returns the total (all layers) depth (in external CRS units) of fine consolidated sediment on this cell.

double	dGetUnconsFineDepthAllLayers (void) const
	Returns the total (all layers) depth (in external CRS units) of fine unconsolidated sediment on this cell.

double	dGetConsSandDepthAllLayers (void) const
	Returns the total (all layers) depth (in external CRS units) of sand-sized consolidated sediment on this cell.

double	dGetUnconsSandDepthAllLayers (void) const
	Returns the total (all layers) depth (in external CRS units) of sand-sized unconsolidated sediment on this cell.

double	dGetConsCoarseDepthAllLayers (void) const
	Returns the total (all layers) depth (in external CRS units) of coarse consolidated sediment on this cell.

double	dGetUnconsCoarseDepthAllLayers (void) const
	Returns the total (all layers) depth (in external CRS units) of coarse unconsolidated sediment on this cell.

double	dGetAllConsDepthAllLayers (void) const
	Returns the total (all layers) depth (in external CRS units) of consolidated sediment (all size classes) on this cell.

double	dGetAllUnconsDepthAllLayers (void) const
	Returns the total (all layers) depth (in external CRS units) of unconsolidated sediment (all size classes) on this cell.

double	dGetAllSedDepthAllLayers (void) const
	Returns the total (all layers) depth (in external CRS units) of all sediment (all size classes, both consolidated and unconsolidated) on this cell.

double	dGetTalusDepth (void) const
	Returns the depth of any talus that is on this cell, in any layer.

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

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

bool	bBasementElevIsMissingValue (void) const
	Returns true if this cells's basement data is NODATA, is needed for irregularly-shaped DEMs.

double	dGetAllSedTopElevOmitTalus (void) const
	Returns the elevation of the top surface of sediment (both consolidated and unconsolidated) for this cell, but ignoring any talus. If there is a cliff notch, ignore the missing volume.

double	dGetAllSedTopElevIncTalus (void)
	Returns the elevation of the top surface of sediment (both consolidated and unconsolidated) plus talus for this cell. If there is a cliff notch, ignore the missing volume.

double	dGetTopElevIncSea (void)
	Returns the topmost elevation of the cell, including sea (sediment top elevation (both consolidated and unconsolidated), plus the depth of any talus, plus the height of any intervention, plus the sea depth)

double	dGetConsSedTopElevOmitTalus (void) const
	Returns the elevation of the top surface of sediment (both consolidated and unconsolidated) for this cell, but ignoring any talus. If there is a cliff notch, ignore the missing volume.

double	dGetConsSedTopElevIncTalus (void)
	Returns the elevation of the top surface of sediment (both consolidated and unconsolidated) plus talus for this cell. If there is a cliff notch, ignore the missing volume.

void	SetPotentialPlatformErosion (double const)
	Set potential (unconstrained) shore platform erosion and increment total shore platform potential erosion.

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)
	Set this-timestep actual (constrained) shore platform erosion and increment total actual shore platform erosion.

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)
	Increments the fine, sand, and coarse depths of this-timestep cliff collapse on this cell, also increments the totals.

double	dGetThisIterCliffCollapseErosionFine (void) const
	Returns the depth of this-timestep fine-sized sediment cliff collapse on this cell.

double	dGetThisIterCliffCollapseErosionSand (void) const
	Returns the depth of this-timestep sand-sized sediment cliff collapse on this cell.

double	dGetThisIterCliffCollapseErosionCoarse (void) const
	Returns the depth of this-timestep coarse-sized sediment cliff collapse on this cell.

double	dGetTotCliffCollapseFine (void) const
	Returns the running total depth of fine-sized sediment eroded by cliff collapse on this cell.

double	dGetTotCliffCollapseSand (void) const
	Returns the running total depth of sand-sized sediment eroded by cliff collapse on this cell.

double	dGetTotCliffCollapseCoarse (void) const
	Returns the running total depth of coarse-sized sediment eroded by cliff collapse on this cell.

void	AddSandTalusDeposition (double const)
	Increments the depth of this-timestep sand-sized cliff collapse talus on this cell, also increments the total.

double	dGetThisIterCliffCollapseSandTalusDeposition (void) const
	Returns the depth of this-timestep sand talus deposition from cliff collapse on this cell.

double	dGetTotSandTalusDeposition (void) const
	Returns the total depth of sand talus deposition from cliff collapse on this cell.

void	AddCoarseTalusDeposition (double const)
	Increments the depth of this-timestep coarse-sized cliff collapse talus on this cell, also increments the total.

double	dGetThisIterCliffCollapseCoarseTalusDeposition (void) const
	Retuns the depth of this-timestep coarse talus deposition from cliff collapse on this cell.

double	dGetTotCoarseTalusDeposition (void) const
	Returns the total depth of coarse talus deposition from cliff collapse on this cell.

void	AddSandTalusToUncons (double const)
	Adds to the totals of sand-sized talus moved to unconsolidated sediment on this cell.

double	dGetThisIterSandTalusToUncons (void)
	Returns the this-iteration total of sand-sized talus moved to unconsolidated sediment on this cell.

double	dGetTotSandTalusToUncons (void)
	Returns the grand total of sand-sized talus moved to unconsolidated sediment on this cell.

void	AddCoarseTalusToUncons (double const)
	Adds to the totals of coarse-sized talus moved to unconsolidated sediment on this cell.

double	dGetThisIterCoarseTalusToUncons (void)
	Returns the this-iteration total of coarse-sized talus moved to unconsolidated sediment on this cell.

double	dGetTotCoarseTalusToUncons (void)
	Returns the grand total of coarse-sized talus moved to unconsolidated sediment on this cell.

void	SetPotentialBeachErosion (double const)
	Set potential (unconstrained) beach erosion and increment total beach potential erosion.

double	dGetPotentialBeachErosion (void) const
	Get potential (unconstrained) beach erosion.

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

void	SetActualBeachErosion (double const)
	Set this-timestep actual (supply-constrained) beach erosion and increment total actual beach erosion.

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)
	Increment this-timestep beach deposition, also increment total beach deposition.

double	dGetBeachDeposition (void) const
	Get beach deposition.

double	dGetTotBeachDeposition (void) const
	Get beach erosion.

bool	bBeachErosionOrDepositionThisIter (void) const
	Returns true only if this cell has had no deposition or erosion this timestep.

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

int	nGetInterventionClass (void) const
	Gets the intervention class for this cell, or returns INT_NODATA if there is not an intervention here.

void	SetInterventionHeight (double const)
	Sets the intervention height.

double	dGetInterventionHeight (void) const
	Returns the intervention height.

double	dGetInterventionTopElev (void) const
	Returns the elevation of the top of the intervention, assuming it rests on the sediment-top surface.

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
	Returns true if this cell is in the shadow zone with number given by the parameter, false otherwise.

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_bCliffToe
	Is this cell a cliff toe?

bool	m_bFloodLine
	Switch to indicate that this cell is 'under' a runup flood line TODO 007 Finish surge and runup stuff.

bool	m_bWaveFlood
	Switch to indicate that this cell is 'under' a runup wave flood line TODO 007 Finish surge and runup stuff.

bool	m_bCheckFloodCell
	TODO 007 Finish surge and runup stuff.

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

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

bool	m_bPossibleFloodStartCell
	TODO 007 Finish surge and runup stuff.

bool	m_bFloodBySetupSurge
	TODO 007 Finish surge and runup stuff.

bool	m_bFloodBySetupSurgeRunup
	TODO 007 Finish surge and runup stuff.

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

int	m_nCoastlineID
	If this cell is 'under' a coastline, this is the ID number of the coast.

int	m_nProfileID
	If this cell is 'under' a coast-normal profile, this is the ID number of the profile.

int	m_nProfileCoastID
	If this cell is 'under' a coast-normal profile, this is the ID number of the profile's coast.

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 number of the polygon's coast.

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

int	m_nShadowZoneNumber
	If this cell is within a shadow zone, this is the ID number of the shadow zone.

int	m_nDownDriftZoneNumber
	If this cell is within a downdrift zone, this is the ID number of the downdrift zone.

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

double	m_dBasementElevation
	Elevation of basement surface (m)

double	m_dSlopeForCliffToe
	Slope at this cell (degrees or unitless)

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

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

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
	Only meaningful if in zone of platform erosion. 0 = fully protected; 1 = ! no protection.

double	m_dSuspendedSediment
	Suspended sediment as depth equivalent (m)

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

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

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

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
	Depth of fine sediment (consolidated and unconsolidated) removed via cliff collapse this timestep.

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

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

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

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

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

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

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

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

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

double	m_dSandTalusToUnconsThisIter
	Depth of sand-sized cliff collapse talus moved to unconsolidated sediment this timestep.

double	m_dTotSandTalusToUncons
	Total depth of sand-sized cliff collapse talus moved to unconsolidated sediment.

double	m_dCoarseTalusToUnconsThisIter
	Depth of coarse-sized cliff collapse talus moved to unconsolidated sediment this timestep.

double	m_dTotCoarseTalusToUncons
	Total depth of coarse-sized cliff collapse talus moved to unconsolidated sediment.

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

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

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
	d50 of unconsolidated sediment on top layer with unconsolidated sediment depth > 0

double	m_dInterventionHeight
	Height of intervention structure.

CRWCellLandform	m_Landform
	This cell's landform data.

vector< CRWCellLayer >	m_VLayerAboveBasement
	Cell sediment layers NOT including the basement. Layer 0 is the lowest.

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

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 35 of file cell.h.

Constructor & Destructor Documentation

◆ CGeomCell()

CGeomCell::CGeomCell ( )

Constructor with initialisation list.

Definition at line 36 of file cell.cpp.

◆ ~CGeomCell()

CGeomCell::~CGeomCell ( void )

Destructor.

Definition at line 100 of file cell.cpp.

Member Function Documentation

◆ AddCoarseTalusDeposition()

void CGeomCell::AddCoarseTalusDeposition ( double const dDepth )

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

Definition at line 1075 of file cell.cpp.

◆ AddCoarseTalusToUncons()

void CGeomCell::AddCoarseTalusToUncons ( double const dCoarseTalus )

Adds to the totals of coarse-sized talus moved to unconsolidated sediment on this cell.

Definition at line 1125 of file cell.cpp.

◆ AddSandTalusDeposition()

void CGeomCell::AddSandTalusDeposition ( double const dDepth )

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

Definition at line 1068 of file cell.cpp.

◆ AddSandTalusToUncons()

void CGeomCell::AddSandTalusToUncons ( double const dSandTalus )

Adds to the totals of sand-sized talus moved to unconsolidated sediment on this cell.

Definition at line 1106 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 533 of file cell.cpp.

◆ AppendLayers()

void CGeomCell::AppendLayers ( int const nLayer )

Appends sediment layers.

Definition at line 752 of file cell.cpp.

◆ bActualPlatformErosion()

bool CGeomCell::bActualPlatformErosion ( void ) const

Returns true if we have had actual platform erosion on this cell during this timestep.

Definition at line 231 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 504 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 1213 of file cell.cpp.

◆ bElevLessThanSWL()

bool CGeomCell::bElevLessThanSWL ( void ) const

Returns true if the top elevation (sediment and talus, plus any intervention) of this cell is less than this iteration's SWL.

Definition at line 410 of file cell.cpp.

◆ bIsBoundingBoxEdge()

bool CGeomCell::bIsBoundingBoxEdge ( void ) const

Is this an edge bounding-box cell?

Definition at line 117 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 444 of file cell.cpp.

◆ bIsCliffToe()

bool CGeomCell::bIsCliffToe ( void ) const

Returns true if this cell is marked as a cliff toe.

Definition at line 264 of file cell.cpp.

◆ bIsCoastline()

bool CGeomCell::bIsCoastline ( void ) const

Returns true if the cell is a coastline.

Definition at line 243 of file cell.cpp.

◆ bIsFloodBySetupSurge()

bool CGeomCell::bIsFloodBySetupSurge ( void ) const

Is this cell flooded by setup surge?

Definition at line 153 of file cell.cpp.

◆ bIsFloodBySetupSurgeRunup()

bool CGeomCell::bIsFloodBySetupSurgeRunup ( void ) const

Is this cell flooded by setup surge runup?

Definition at line 165 of file cell.cpp.

◆ bIsFloodline()

bool CGeomCell::bIsFloodline ( void ) const

Returns true if the cell is a flood line.

Definition at line 276 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 183 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 350 of file cell.cpp.

◆ bIsInContiguousSea()

bool CGeomCell::bIsInContiguousSea ( void ) const

Is this a sea cell?

Definition at line 129 of file cell.cpp.

◆ bIsInContiguousSeaFlood()

bool CGeomCell::bIsInContiguousSeaFlood ( void ) const

Is this cell in the contiguous sea flood area?

Definition at line 171 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 341 of file cell.cpp.

◆ bIsInundated()

bool CGeomCell::bIsInundated ( void )

Returns true if the elevation of the sediment top surface (both consolidated and unconsolidated, and any talus) for this cell, plus any intervention, is less than the grid's this-timestep still water elevation.

Definition at line 640 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 207 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 219 of file cell.cpp.

◆ bIsProfile()

bool CGeomCell::bIsProfile ( void ) const

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

Definition at line 288 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 195 of file cell.cpp.

◆ bPotentialPlatformErosion()

bool CGeomCell::bPotentialPlatformErosion ( void ) const

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

Definition at line 225 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 759 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 811 of file cell.cpp.

◆ dGetActualBeachErosion()

double CGeomCell::dGetActualBeachErosion ( void ) const

Get actual (supply-constrained) beach erosion.

Definition at line 1170 of file cell.cpp.

◆ dGetActualPlatformErosion()

double CGeomCell::dGetActualPlatformErosion ( void ) const

Get actual (constrained) shore platform erosion.

Definition at line 849 of file cell.cpp.

◆ dGetAllConsDepthAllLayers()

double CGeomCell::dGetAllConsDepthAllLayers ( void ) const

Returns the total (all layers) depth (in external CRS units) of consolidated sediment (all size classes) on this cell.

Definition at line 724 of file cell.cpp.

Referenced by dGetAllSedDepthAllLayers(), and dGetConsSedTopElevOmitTalus().

◆ dGetAllSedDepthAllLayers()

double CGeomCell::dGetAllSedDepthAllLayers ( void ) const

Returns the total (all layers) depth (in external CRS units) of all sediment (all size classes, both consolidated and unconsolidated) on this cell.

Definition at line 746 of file cell.cpp.

◆ dGetAllSedTopElevIncTalus()

double CGeomCell::dGetAllSedTopElevIncTalus ( void )

Returns the elevation of the top surface of sediment (both consolidated and unconsolidated) plus talus for this cell. If there is a cliff notch, ignore the missing volume.

Definition at line 616 of file cell.cpp.

◆ dGetAllSedTopElevOmitTalus()

double CGeomCell::dGetAllSedTopElevOmitTalus ( void ) const

Returns the elevation of the top surface of sediment (both consolidated and unconsolidated) for this cell, but ignoring any talus. If there is a cliff notch, ignore the missing volume.

Definition at line 610 of file cell.cpp.

Referenced by dGetAllSedTopElevIncTalus().

◆ dGetAllUnconsDepthAllLayers()

double CGeomCell::dGetAllUnconsDepthAllLayers ( void ) const

Returns the total (all layers) depth (in external CRS units) of unconsolidated sediment (all size classes) on this cell.

Definition at line 735 of file cell.cpp.

Referenced by dGetAllSedDepthAllLayers().

◆ dGetBasementElev()

double CGeomCell::dGetBasementElev ( void ) const

Returns this cell's basement elevation.

Definition at line 486 of file cell.cpp.

Referenced by dGetConsSedTopElevOmitTalus().

◆ dGetBeachDeposition()

double CGeomCell::dGetBeachDeposition ( void ) const

Get beach deposition.

Definition at line 1195 of file cell.cpp.

◆ dGetBeachProtectionFactor()

double CGeomCell::dGetBeachProtectionFactor ( void ) const

Returns this cell's beach protection factor.

Definition at line 1014 of file cell.cpp.

◆ dGetCellDeepWaterWaveAngle()

double CGeomCell::dGetCellDeepWaterWaveAngle ( void ) const

Returns the deep water wave orientation on this cell.

Definition at line 982 of file cell.cpp.

◆ dGetCellDeepWaterWaveHeight()

double CGeomCell::dGetCellDeepWaterWaveHeight ( void ) const

Returns the deep water wave height on this cell.

Definition at line 970 of file cell.cpp.

◆ dGetCellDeepWaterWavePeriod()

double CGeomCell::dGetCellDeepWaterWavePeriod ( void ) const

Returns the deep water wave period on this cell.

Definition at line 994 of file cell.cpp.

◆ dGetConsCoarseDepthAllLayers()

double CGeomCell::dGetConsCoarseDepthAllLayers ( void ) const

Returns the total (all layers) depth (in external CRS units) of coarse consolidated sediment on this cell.

Definition at line 702 of file cell.cpp.

◆ dGetConsFineDepthAllLayers()

double CGeomCell::dGetConsFineDepthAllLayers ( void ) const

Returns the total (all layers) depth (in external CRS units) of fine consolidated sediment on this cell.

Definition at line 658 of file cell.cpp.

◆ dGetConsSandDepthAllLayers()

double CGeomCell::dGetConsSandDepthAllLayers ( void ) const

Returns the total (all layers) depth (in external CRS units) of sand-sized consolidated sediment on this cell.

Definition at line 680 of file cell.cpp.

◆ dGetConsSedSlope()

double CGeomCell::dGetConsSedSlope ( void ) const

Returns the local slope of the consolidated sediment only.

Definition at line 474 of file cell.cpp.

◆ dGetConsSedTopElevForLayerAboveBasement()

double CGeomCell::dGetConsSedTopElevForLayerAboveBasement ( 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 586 of file cell.cpp.

◆ dGetConsSedTopElevIncTalus()

double CGeomCell::dGetConsSedTopElevIncTalus ( void )

Returns the elevation of the top surface of sediment (both consolidated and unconsolidated) plus talus for this cell. If there is a cliff notch, ignore the missing volume.

Definition at line 628 of file cell.cpp.

◆ dGetConsSedTopElevOmitTalus()

double CGeomCell::dGetConsSedTopElevOmitTalus ( void ) const

Returns the elevation of the top surface of sediment (both consolidated and unconsolidated) for this cell, but ignoring any talus. If there is a cliff notch, ignore the missing volume.

Definition at line 622 of file cell.cpp.

Referenced by dGetConsSedTopElevIncTalus().

◆ dGetInterventionHeight()

double CGeomCell::dGetInterventionHeight ( void ) const

Returns the intervention height.

Definition at line 1244 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 1250 of file cell.cpp.

◆ dGetPotentialBeachErosion()

double CGeomCell::dGetPotentialBeachErosion ( void ) const

Get potential (unconstrained) beach erosion.

Definition at line 1151 of file cell.cpp.

◆ dGetPotentialPlatformErosion()

double CGeomCell::dGetPotentialPlatformErosion ( void ) const

Get potential (unconstrained) shore platform erosion.

Definition at line 830 of file cell.cpp.

◆ dGetSeaDepth()

double CGeomCell::dGetSeaDepth ( void ) const

Returns the depth of seawater on this cell.

Definition at line 513 of file cell.cpp.

Referenced by CGeomProfile::nGetCellGivenDepth().

◆ dGetSlopeForCliffToe()

double CGeomCell::dGetSlopeForCliffToe ( void ) const

Returns this cell's slope for cliff toe locationg.

Definition at line 498 of file cell.cpp.

◆ dGetSuspendedSediment()

double CGeomCell::dGetSuspendedSediment ( void ) const

Returns the suspended sediment depth equivalent on this cell.

Definition at line 541 of file cell.cpp.

◆ dGetTalusDepth()

double CGeomCell::dGetTalusDepth ( void ) const

Returns the depth of any talus that is on this cell, in any layer.

Definition at line 359 of file cell.cpp.

Referenced by dGetAllSedTopElevIncTalus(), dGetConsSedTopElevIncTalus(), and dGetTopElevIncSea().

◆ dGetThisIterCliffCollapseCoarseTalusDeposition()

double CGeomCell::dGetThisIterCliffCollapseCoarseTalusDeposition ( void ) const

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

Definition at line 1088 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 1044 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 1032 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 1038 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 1082 of file cell.cpp.

◆ dGetThisIterCoarseTalusToUncons()

double CGeomCell::dGetThisIterCoarseTalusToUncons ( void )

Returns the this-iteration total of coarse-sized talus moved to unconsolidated sediment on this cell.

Definition at line 1132 of file cell.cpp.

◆ dGetThisIterSandTalusToUncons()

double CGeomCell::dGetThisIterSandTalusToUncons ( void )

Returns the this-iteration total of sand-sized talus moved to unconsolidated sediment on this cell.

Definition at line 1113 of file cell.cpp.

◆ dGetThisIterSWL()

double CGeomCell::dGetThisIterSWL ( void ) const

Returns the sea surface elevation at the current iteration.

Definition at line 646 of file cell.cpp.

◆ dGetThisIterTotWaterLevel()

double CGeomCell::dGetThisIterTotWaterLevel ( void ) const

Returns the total water level for the current iteration TODO 007 Finish surge and runup stuff.

Definition at line 652 of file cell.cpp.

◆ dGetTopElevIncSea()

double CGeomCell::dGetTopElevIncSea ( void )

Returns the topmost elevation of the cell, including sea (sediment top elevation (both consolidated and unconsolidated), plus the depth of any talus, plus the height of any intervention, plus the sea depth)

Definition at line 634 of file cell.cpp.

◆ dGetTotActualBeachErosion()

double CGeomCell::dGetTotActualBeachErosion ( void ) const

Get total actual (supply-constrained) beach erosion.

Definition at line 1176 of file cell.cpp.

◆ dGetTotActualPlatformErosion()

double CGeomCell::dGetTotActualPlatformErosion ( void ) const

Get total actual (constrained) shore platform erosion.

Definition at line 855 of file cell.cpp.

◆ dGetTotBeachDeposition()

double CGeomCell::dGetTotBeachDeposition ( void ) const

Get beach erosion.

Definition at line 1201 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 1062 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 1050 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 1056 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 1100 of file cell.cpp.

◆ dGetTotCoarseTalusToUncons()

double CGeomCell::dGetTotCoarseTalusToUncons ( void )

Returns the grand total of coarse-sized talus moved to unconsolidated sediment on this cell.

Definition at line 1138 of file cell.cpp.

◆ dGetTotPotentialBeachErosion()

double CGeomCell::dGetTotPotentialBeachErosion ( void ) const

Get total potential (supply-unconstrained) beach erosion.

Definition at line 1157 of file cell.cpp.

◆ dGetTotPotentialPlatformErosion()

double CGeomCell::dGetTotPotentialPlatformErosion ( void ) const

Get total potential (unconstrained) shore platform erosion.

Definition at line 836 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 1094 of file cell.cpp.

◆ dGetTotSandTalusToUncons()

double CGeomCell::dGetTotSandTalusToUncons ( void )

Returns the grand total of sand-sized talus moved to unconsolidated sediment on this cell.

Definition at line 1119 of file cell.cpp.

◆ dGetTotSeaDepth()

double CGeomCell::dGetTotSeaDepth ( void ) const

Returns the total depth of seawater on this cell.

Definition at line 519 of file cell.cpp.

◆ dGetTotSuspendedSediment()

double CGeomCell::dGetTotSuspendedSediment ( void ) const

Returns the total suspended sediment depth equivalent on this cell.

Definition at line 547 of file cell.cpp.

◆ dGetTotWaveAngle()

double CGeomCell::dGetTotWaveAngle ( void ) const

Returns the total wave orientation on this cell.

Definition at line 958 of file cell.cpp.

◆ dGetTotWaveHeight()

double CGeomCell::dGetTotWaveHeight ( void ) const

Returns the total wave height on this cell.

Definition at line 939 of file cell.cpp.

◆ dGetUnconsCoarseDepthAllLayers()

double CGeomCell::dGetUnconsCoarseDepthAllLayers ( void ) const

Returns the total (all layers) depth (in external CRS units) of coarse unconsolidated sediment on this cell.

Definition at line 713 of file cell.cpp.

◆ dGetUnconsD50()

double CGeomCell::dGetUnconsD50 ( void ) const

Returns the D50 of unconsolidated sediment on this cell.

Definition at line 1222 of file cell.cpp.

◆ dGetUnconsFineDepthAllLayers()

double CGeomCell::dGetUnconsFineDepthAllLayers ( void ) const

Returns the total (all layers) depth (in external CRS units) of fine unconsolidated sediment on this cell.

Definition at line 669 of file cell.cpp.

◆ dGetUnconsSandDepthAllLayers()

double CGeomCell::dGetUnconsSandDepthAllLayers ( void ) const

Returns the total (all layers) depth (in external CRS units) of sand-sized unconsolidated sediment on this cell.

Definition at line 691 of file cell.cpp.

◆ dGetWaveAngle()

double CGeomCell::dGetWaveAngle ( void ) const

Returns the wave orientation on this cell.

Definition at line 952 of file cell.cpp.

◆ dGetWaveHeight()

double CGeomCell::dGetWaveHeight ( void ) const

Returns the wave height on this cell.

Definition at line 933 of file cell.cpp.

◆ IncrBeachDeposition()

void CGeomCell::IncrBeachDeposition ( double const dThisDeposition )

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

Definition at line 1188 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 1020 of file cell.cpp.

◆ InitCell()

void CGeomCell::InitCell ( void )

Initialise values for this cell.

Definition at line 867 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 111 of file cell.cpp.

◆ nGetCoastline()

int CGeomCell::nGetCoastline ( void ) const

Returns the ID of the coastline, or INT_NODATA if not a coastline.

Definition at line 252 of file cell.cpp.

◆ nGetDownDriftZoneNumber()

int CGeomCell::nGetDownDriftZoneNumber ( void ) const

Gets the down drift zone number.

Definition at line 456 of file cell.cpp.

◆ nGetInterventionClass()

int CGeomCell::nGetInterventionClass ( void ) const

Gets the intervention class for this cell, or returns INT_NODATA if there is not an intervention here.

Definition at line 1228 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.

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

Definition at line 794 of file cell.cpp.

◆ nGetNumLayers()

int CGeomCell::nGetNumLayers ( void ) const

Returns the number of sediment layers on the cell (some could have zero thickness)

Definition at line 553 of file cell.cpp.

◆ nGetNumOfTopLayerAboveBasement()

int CGeomCell::nGetNumOfTopLayerAboveBasement ( void ) const

Returns the index of the topmost sediment layer (layer 0 being the one just above basement). Note that this layer could have zero thickness.

Definition at line 577 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 316 of file cell.cpp.

◆ nGetPolygonID()

int CGeomCell::nGetPolygonID ( void ) const

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

Definition at line 310 of file cell.cpp.

◆ nGetProfileCoastID()

int CGeomCell::nGetProfileCoastID ( void ) const

Gets the coast ID number of the coast-normal profile which this cell is 'under', or returns INT_NODATA.

Definition at line 297 of file cell.cpp.

◆ nGetProfileID()

int CGeomCell::nGetProfileID ( void ) const

Gets the ID number of the coast-normal profile which this cell is 'under', or returns INT_NODATA.

Definition at line 282 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 335 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 560 of file cell.cpp.

Referenced by InitCell().

◆ pGetLandform()

CRWCellLandform * CGeomCell::pGetLandform ( void )

Returns a pointer to this cell's CRWCellLandform object.

Definition at line 462 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 603 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 1163 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 842 of file cell.cpp.

◆ SetAsCliffToe()

void CGeomCell::SetAsCliffToe ( bool const bNewFlag )

Marks this cell as a cliff toe cell.

Definition at line 258 of file cell.cpp.

◆ SetAsCoastline()

void CGeomCell::SetAsCoastline ( int const nCoast )

Marks this cell with a coastline ID nunber.

Definition at line 237 of file cell.cpp.

◆ SetAsFloodline()

void CGeomCell::SetAsFloodline ( bool const bNewFlag )

Marks this cell as a flood line.

Definition at line 270 of file cell.cpp.

◆ SetBasementElev()

void CGeomCell::SetBasementElev ( double const dNewElev )

Sets this cell's basement elevation.

Definition at line 480 of file cell.cpp.

◆ SetBeachProtectionFactor()

void CGeomCell::SetBeachProtectionFactor ( double const dFactor )

Definition at line 1008 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 105 of file cell.cpp.

◆ SetCellDeepWaterWaveAngle()

void CGeomCell::SetCellDeepWaterWaveAngle ( double const dWaveAngle )

Sets the deep water wave orientation on this cell.

Definition at line 976 of file cell.cpp.

◆ SetCellDeepWaterWaveHeight()

void CGeomCell::SetCellDeepWaterWaveHeight ( double const dWaveHeight )

Sets the deep water wave height on this cell.

Definition at line 964 of file cell.cpp.

◆ SetCellDeepWaterWavePeriod()

void CGeomCell::SetCellDeepWaterWavePeriod ( double const dWavePeriod )

Sets the deep water wave Period on this cell.

Definition at line 988 of file cell.cpp.

◆ SetCheckCell()

void CGeomCell::SetCheckCell ( void )

◆ SetCheckFloodCell()

void CGeomCell::SetCheckFloodCell ( void )

Set this cell as checked (flood switch)

Definition at line 432 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 322 of file cell.cpp.

◆ SetCoastAndProfileID()

void CGeomCell::SetCoastAndProfileID	(	int const	nProfileCoastID,
		int const	nProfile )

Sets the coast ID number, and the profile ID number, of the coast-normal profile which this cell is 'under'.

Definition at line 303 of file cell.cpp.

◆ SetDownDriftZoneNumber()

void CGeomCell::SetDownDriftZoneNumber ( int const nCode )

Sets the down drift zone number.

Definition at line 450 of file cell.cpp.

◆ SetFloodBySetupSurge()

void CGeomCell::SetFloodBySetupSurge ( void )

Set this cell as flooded by setup surge.

Definition at line 147 of file cell.cpp.

◆ SetFloodBySetupSurgeRunup()

void CGeomCell::SetFloodBySetupSurgeRunup ( void )

Set this cell as flooded by setup surge runup.

Definition at line 159 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 177 of file cell.cpp.

◆ SetInContiguousFlood()

void CGeomCell::SetInContiguousFlood ( void )

Set this cell as in the contiguous runup flood area.

Definition at line 135 of file cell.cpp.

◆ SetInContiguousSea()

void CGeomCell::SetInContiguousSea ( void )

Set this cell to be a sea cell.

Definition at line 123 of file cell.cpp.

◆ SetInterventionHeight()

void CGeomCell::SetInterventionHeight ( double const dHeight )

Sets the intervention height.

Definition at line 1238 of file cell.cpp.

◆ SetLocalConsSlope()

void CGeomCell::SetLocalConsSlope ( double const dNewSlope )

Sets the local slope of the consolidated sediment only.

Definition at line 468 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 201 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 213 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 1144 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 823 of file cell.cpp.

◆ SetSeaDepth()

void CGeomCell::SetSeaDepth ( void )

Returns the depth of seawater on this cell if the sediment top (including talus and intervention) is < SWL, or zero.

Definition at line 861 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 189 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 329 of file cell.cpp.

◆ SetSlopeForCliffToe()

void CGeomCell::SetSlopeForCliffToe ( double const dNewSlope )

Sets this cell's slope for cliff toe locating.

Definition at line 492 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 525 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 945 of file cell.cpp.

◆ SetWaveFlood()

void CGeomCell::SetWaveFlood ( void )

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

Definition at line 378 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 923 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 1000 of file cell.cpp.

◆ UnSetCheckFloodCell()

void CGeomCell::UnSetCheckFloodCell ( void )

Set the cell as not checked (flood switch)

Definition at line 438 of file cell.cpp.

◆ UnSetInContiguousFlood()

void CGeomCell::UnSetInContiguousFlood ( void )

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

Definition at line 141 of file cell.cpp.

Friends And Related Symbol Documentation

◆ CSimulation

friend class CSimulation

friend

Definition at line 37 of file cell.h.

Referenced by CSimulation.

Field Documentation

◆ m_bCheckFloodCell

bool CGeomCell::m_bCheckFloodCell

private

TODO 007 Finish surge and runup stuff.

Definition at line 62 of file cell.h.

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

◆ m_bCliffToe

bool CGeomCell::m_bCliffToe

private

Is this cell a cliff toe?

Definition at line 50 of file cell.h.

Referenced by bIsCliffToe(), CGeomCell(), and SetAsCliffToe().

◆ m_bFloodBySetupSurge

bool CGeomCell::m_bFloodBySetupSurge

private

TODO 007 Finish surge and runup stuff.

Definition at line 74 of file cell.h.

Referenced by bIsFloodBySetupSurge(), and SetFloodBySetupSurge().

◆ m_bFloodBySetupSurgeRunup

bool CGeomCell::m_bFloodBySetupSurgeRunup

private

TODO 007 Finish surge and runup stuff.

Definition at line 77 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 TODO 007 Finish surge and runup stuff.

Definition at line 53 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 44 of file cell.h.

Referenced by bIsInContiguousSeaFlood(), 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 41 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 47 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 68 of file cell.h.

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

◆ m_bPossibleFloodStartCell

bool CGeomCell::m_bPossibleFloodStartCell

private

TODO 007 Finish surge and runup stuff.

Definition at line 71 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 boundary.

Definition at line 65 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 TODO 007 Finish surge and runup stuff.

Definition at line 56 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 215 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 161 of file cell.h.

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

◆ m_dBasementElevation

double CGeomCell::m_dBasementElevation

private

Elevation of basement surface (m)

Definition at line 110 of file cell.h.

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

◆ m_dBeachDepositionThisIter

double CGeomCell::m_dBeachDepositionThisIter

private

Depth of unconsolidated beach sediment deposited this timestep.

Definition at line 221 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 = fully protected; 1 = ! no protection.

Definition at line 146 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 173 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 167 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 170 of file cell.h.

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

◆ m_dCoarseTalusToUnconsThisIter

double CGeomCell::m_dCoarseTalusToUnconsThisIter

private

Depth of coarse-sized cliff collapse talus moved to unconsolidated sediment this timestep.

Definition at line 203 of file cell.h.

Referenced by AddCoarseTalusToUncons(), CGeomCell(), dGetThisIterCoarseTalusToUncons(), and InitCell().

◆ m_dDeepWaterWaveAngle

double CGeomCell::m_dDeepWaterWaveAngle

private

Wave orientation if this is a deep water cell.

Definition at line 140 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 137 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 143 of file cell.h.

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

◆ m_dInterventionHeight

double CGeomCell::m_dInterventionHeight

private

Height of intervention structure.

Definition at line 230 of file cell.h.

Referenced by bElevLessThanSWL(), bIsInundated(), CGeomCell(), dGetInterventionHeight(), dGetInterventionTopElev(), dGetTopElevIncSea(), SetInterventionHeight(), and SetSeaDepth().

◆ m_dLocalConsSlope

double CGeomCell::m_dLocalConsSlope

private

Used in erosion calculations, stored here for display purposes.

Definition at line 107 of file cell.h.

Referenced by CGeomCell(), dGetConsSedSlope(), 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 209 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 155 of file cell.h.

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

◆ m_dSandTalusToUnconsThisIter

double CGeomCell::m_dSandTalusToUnconsThisIter

private

Depth of sand-sized cliff collapse talus moved to unconsolidated sediment this timestep.

Definition at line 197 of file cell.h.

Referenced by AddSandTalusToUncons(), CGeomCell(), dGetThisIterSandTalusToUncons(), and InitCell().

◆ m_dSeaDepth

double CGeomCell::m_dSeaDepth

private

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

Definition at line 116 of file cell.h.

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

◆ m_dSlopeForCliffToe

double CGeomCell::m_dSlopeForCliffToe

private

Slope at this cell (degrees or unitless)

Definition at line 113 of file cell.h.

Referenced by dGetSlopeForCliffToe(), and SetSlopeForCliffToe().

◆ m_dSuspendedSediment

double CGeomCell::m_dSuspendedSediment

private

Suspended sediment as depth equivalent (m)

Definition at line 149 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 191 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 185 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 218 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 164 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 224 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 182 of file cell.h.

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

◆ m_dTotCoarseTalusToUncons

double CGeomCell::m_dTotCoarseTalusToUncons

private

Total depth of coarse-sized cliff collapse talus moved to unconsolidated sediment.

Definition at line 206 of file cell.h.

Referenced by AddCoarseTalusToUncons(), CGeomCell(), and dGetTotCoarseTalusToUncons().

◆ m_dTotFineCliffCollapse

double CGeomCell::m_dTotFineCliffCollapse

private

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

Definition at line 176 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 212 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 158 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 179 of file cell.h.

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

◆ m_dTotSandTalusToUncons

double CGeomCell::m_dTotSandTalusToUncons

private

Total depth of sand-sized cliff collapse talus moved to unconsolidated sediment.

Definition at line 200 of file cell.h.

Referenced by AddSandTalusToUncons(), CGeomCell(), and dGetTotSandTalusToUncons().

◆ m_dTotSeaDepth

double CGeomCell::m_dTotSeaDepth

private

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

Definition at line 119 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 152 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 194 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 188 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 134 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 125 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 227 of file cell.h.

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

◆ m_dWaveAngle

double CGeomCell::m_dWaveAngle

private

Wave orientation.

Definition at line 128 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 122 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 131 of file cell.h.

Referenced by SetWaveValuesToDeepWaterWaveValues().

◆ m_Landform

CRWCellLandform CGeomCell::m_Landform

private

This cell's landform data.

Definition at line 233 of file cell.h.

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

◆ m_nBoundingBoxEdge

int CGeomCell::m_nBoundingBoxEdge

private

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

Definition at line 80 of file cell.h.

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

◆ m_nCoastlineID

int CGeomCell::m_nCoastlineID

private

If this cell is 'under' a coastline, this is the ID number of the coast.

Definition at line 83 of file cell.h.

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

◆ 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 98 of file cell.h.

◆ m_nDownDriftZoneNumber

int CGeomCell::m_nDownDriftZoneNumber

private

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

Definition at line 104 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 number of the polygon's coast.

Definition at line 95 of file cell.h.

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

◆ m_nPolygonID

int CGeomCell::m_nPolygonID

private

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

Definition at line 92 of file cell.h.

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

◆ m_nProfileCoastID

int CGeomCell::m_nProfileCoastID

private

If this cell is 'under' a coast-normal profile, this is the ID number of the profile's coast.

Definition at line 89 of file cell.h.

Referenced by CGeomCell(), nGetProfileCoastID(), and SetCoastAndProfileID().

◆ m_nProfileID

int CGeomCell::m_nProfileID

private

If this cell is 'under' a coast-normal profile, this is the ID number of the profile.

Definition at line 86 of file cell.h.

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

◆ m_nShadowZoneNumber

int CGeomCell::m_nShadowZoneNumber

private

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

Definition at line 101 of file cell.h.

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

◆ m_pGrid

CGeomRasterGrid * CGeomCell::m_pGrid = NULL

static

Definition at line 245 of file cell.h.

Referenced by bBasementElevIsMissingValue(), bElevLessThanSWL(), 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 241 of file cell.h.

Referenced by bElevLessThanSWL(), bIsInundated(), CalcAllLayerElevsAndD50(), dGetAllSedTopElevOmitTalus(), dGetInterventionTopElev(), dGetTopElevIncSea(), nGetLayerAtElev(), and SetSeaDepth().

◆ m_VLayerAboveBasement

vector<CRWCellLayer> CGeomCell::m_VLayerAboveBasement

private

Cell sediment layers NOT including the basement. Layer 0 is the lowest.

Definition at line 238 of file cell.h.

Referenced by AppendLayers(), CalcAllLayerElevsAndD50(), dCalcLayerElev(), dGetAllConsDepthAllLayers(), dGetAllUnconsDepthAllLayers(), dGetConsCoarseDepthAllLayers(), dGetConsFineDepthAllLayers(), dGetConsSandDepthAllLayers(), dGetConsSedTopElevForLayerAboveBasement(), dGetTalusDepth(), dGetUnconsCoarseDepthAllLayers(), dGetUnconsFineDepthAllLayers(), dGetUnconsSandDepthAllLayers(), InitCell(), nGetLayerAtElev(), nGetNumLayers(), nGetNumOfTopLayerAboveBasement(), 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()

◆ AddCoarseTalusToUncons()

◆ AddSandTalusDeposition()

◆ AddSandTalusToUncons()

◆ AddSuspendedSediment()

◆ AppendLayers()

◆ bActualPlatformErosion()

◆ bBasementElevIsMissingValue()

◆ bBeachErosionOrDepositionThisIter()

◆ bElevLessThanSWL()

◆ bIsBoundingBoxEdge()

◆ bIsCellCheck()

◆ bIsCellFloodCheck()

◆ bIsCliffToe()

◆ bIsCoastline()

◆ bIsFloodBySetupSurge()

◆ bIsFloodBySetupSurgeRunup()

◆ bIsFloodline()

◆ bIsInActiveZone()

◆ bIsinAnyShadowZone()

◆ bIsInContiguousSea()

◆ bIsInContiguousSeaFlood()

◆ bIsinThisShadowZone()

◆ bIsInundated()

◆ bIsPossibleCoastStartCell()

◆ bIsPossibleFloodStartCell()

◆ bIsProfile()

◆ bIsShadowZoneBoundary()

◆ bPotentialPlatformErosion()

◆ CalcAllLayerElevsAndD50()

◆ dCalcLayerElev()

◆ dGetActualBeachErosion()

◆ dGetActualPlatformErosion()

◆ dGetAllConsDepthAllLayers()

◆ dGetAllSedDepthAllLayers()

◆ dGetAllSedTopElevIncTalus()

◆ dGetAllSedTopElevOmitTalus()

◆ dGetAllUnconsDepthAllLayers()

◆ dGetBasementElev()

◆ dGetBeachDeposition()

◆ dGetBeachProtectionFactor()

◆ dGetCellDeepWaterWaveAngle()

◆ dGetCellDeepWaterWaveHeight()

◆ dGetCellDeepWaterWavePeriod()

◆ dGetConsCoarseDepthAllLayers()

◆ dGetConsFineDepthAllLayers()

◆ dGetConsSandDepthAllLayers()

◆ dGetConsSedSlope()

◆ dGetConsSedTopElevForLayerAboveBasement()

◆ dGetConsSedTopElevIncTalus()

◆ dGetConsSedTopElevOmitTalus()

◆ dGetInterventionHeight()

◆ dGetInterventionTopElev()

◆ dGetPotentialBeachErosion()

◆ dGetPotentialPlatformErosion()

◆ dGetSeaDepth()

◆ dGetSlopeForCliffToe()

◆ dGetSuspendedSediment()

◆ dGetTalusDepth()

◆ dGetThisIterCliffCollapseCoarseTalusDeposition()

◆ dGetThisIterCliffCollapseErosionCoarse()

◆ dGetThisIterCliffCollapseErosionFine()

◆ dGetThisIterCliffCollapseErosionSand()

◆ dGetThisIterCliffCollapseSandTalusDeposition()

◆ dGetThisIterCoarseTalusToUncons()

◆ dGetThisIterSandTalusToUncons()

◆ dGetThisIterSWL()

◆ dGetThisIterTotWaterLevel()

◆ dGetTopElevIncSea()

◆ dGetTotActualBeachErosion()

◆ dGetTotActualPlatformErosion()