- Generated on Tue Mar 11 2025 15:31:30 for CoastalME (Coastal Modelling Environment) by
1.13.2
|
CoastalME (Coastal Modelling Environment)
Simulates the long-term behaviour of complex coastlines
|
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) |
| TODO 007 What do this do? Does it duplicate SetInContiguousSea()? | |
| void | UnSetInContiguousFlood (void) |
| TODO 007 What does this do? Is it just the inverse of SetInContiguousSea()? | |
| void | SetFloodBySetupSurge (void) |
| TODO 007 What does this do? Set this cell as flood by setup surger. | |
| bool | bIsFloodBySetupSurge (void) const |
| TODO 007 What does this do? Is this cell flood by setup surge? | |
| void | SetFloodBySetupSurgeRunup (void) |
| TODO 007 What does this do? Set this cell as flood by setup surge runup. | |
| bool | bIsFloodBySetupSurgeRunup (void) const |
| TODO 007 What does this do? Is this cell flood by setup surge runup? | |
| bool | bIsInContiguousFlood (void) const |
| TODO 007 What does this do? Does it just duplicate bIsInContiguousSea()? | |
| 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 | SetProfileID (int const) |
| Marks this cell as 'under' a coastline-normal profile. | |
| int | nGetProfileID (void) const |
| If this cell is 'under' a coastline-normal profile, returns the number of the profile. Otherwise it returns INT_NODATA. | |
| 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) |
| 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) |
| TODO 007 What is this for? Sets a flag to show that this cell has been flagged as a possible start-point for a coastline. | |
| void | SetPolygonID (int const) |
| Sets the global ID number of the polygon which 'contains' this cell. | |
| int | 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) | |
| CRWCellLandform * | pGetLandform (void) |
| Returns a pointer to this cell's CRWCellLandform object. | |
| void | SetWaveFlood (void) |
| bool | 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. | |
| 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 |
| Returns true if this cells's basement data is NODATA, is needed for irregularly-shaped DEMs. | |
| double | 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) | |
| double | 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. | |
| double | 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. | |
| bool | 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. | |
| 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) |
| Returns the depth of seawater on this cell if the sediment top 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 | nGetTopLayerAboveBasement (void) const |
| Returns the index of the topmost sediment layer (layer 0 being the one just above basement), which could have zero thickness. | |
| double | dGetConsSedTopForLayerAboveBasement (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 (this causes problems with e.g. cliff notches, which extend above this elevation) | |
| double | dCalcLayerElev (const int) |
| For this cell, calculates the elevation of the top of a given layer. | |
| double | dGetTotConsFineThickConsiderNotch (void) const |
| Returns the total thickness of fine consolidated sediment on this cell, minus the depth-equivalent of any cliff notch. | |
| double | dGetTotUnconsFine (void) const |
| Returns the total thickness of fine unconsolidated sediment on this cell. | |
| double | dGetTotConsSandThickConsiderNotch (void) const |
| Returns the total thickness of sand-sized consolidated sediment on this cell, minus the depth-equivalent of any cliff notch. | |
| double | dGetTotUnconsSand (void) const |
| Returns the total thickness of sand-sized unconsolidated sediment on this cell. | |
| double | dGetTotConsCoarseThickConsiderNotch (void) const |
| Returns the total thickness of coarse consolidated sediment on this cell, minus the depth-equivalent of any cliff notch. | |
| double | dGetTotUnconsCoarse (void) const |
| Returns the total thickness of coarse unconsolidated sediment on this cell. | |
| double | dGetTotConsThickness (void) const |
| Returns the total thickness of consolidated sediment (all size classes) on this cell. | |
| double | dGetTotUnconsThickness (void) const |
| Returns the total thickness of unconsolidated sediment (all size classes) on this cell. | |
| double | dGetTotAllSedThickness (void) const |
| Returns the total thickness of all sediment (all size classes) on this cell. | |
| 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 talus from cliff collapse 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 talus from cliff collapse 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 | 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. | |
| 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 |
| 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 |
| TODO 007 What is this? | |
| 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_bFloodLine |
| TODO 007 What is this used for? Switch to indicate that this cell is 'under' a flood line. | |
| bool | m_bWaveFlood |
| TODO 007 What is this used for? Switch to indicate that this cell is 'under' a 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_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 number of the shadow zone. | |
| int | m_nDownDriftZoneNumber |
| If this cell is within a downdrift zone, this is the 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_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 is 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_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 |
| Number of 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 |
Geometry class for the cell objects which comprise the raster grid.
TODO 001 This is a more detailed description of the CGeomCell class.
| CGeomCell::CGeomCell | ( | ) |
| void CGeomCell::AddCoarseTalusDeposition | ( | double const | dDepth | ) |
| void CGeomCell::AddSandTalusDeposition | ( | double const | dDepth | ) |
| void CGeomCell::AddSuspendedSediment | ( | double const | dIncSedDepth | ) |
| void CGeomCell::AppendLayers | ( | int const | nLayer | ) |
| bool CGeomCell::bBasementElevIsMissingValue | ( | void | ) | const |
| bool CGeomCell::bBeachErosionOrDepositionThisIter | ( | void | ) | const |
| bool CGeomCell::bIsBoundingBoxEdge | ( | void | ) | const |
| bool CGeomCell::bIsCellCheck | ( | void | ) | const |
| bool CGeomCell::bIsCellFloodCheck | ( | void | ) | const |
| bool CGeomCell::bIsCoastline | ( | void | ) | const |
| bool CGeomCell::bIsElevLessThanWaterLevel | ( | void | ) | const |
| bool CGeomCell::bIsFloodBySetupSurge | ( | void | ) | const |
| bool CGeomCell::bIsFloodBySetupSurgeRunup | ( | void | ) | const |
| bool CGeomCell::bIsFloodLine | ( | void | ) | const |
| bool CGeomCell::bIsInActiveZone | ( | void | ) | const |
| bool CGeomCell::bIsinAnyShadowZone | ( | void | ) | const |
| bool CGeomCell::bIsInContiguousFlood | ( | void | ) | const |
TODO 007 What does this do? Does it just duplicate bIsInContiguousSea()?
| bool CGeomCell::bIsInContiguousSea | ( | void | ) | const |
| bool CGeomCell::bIsinThisShadowZone | ( | int const | nZone | ) | const |
| bool CGeomCell::bIsInundated | ( | void | ) | const |
| bool CGeomCell::bIsPossibleCoastStartCell | ( | void | ) | const |
| bool CGeomCell::bIsProfile | ( | void | ) | const |
| bool CGeomCell::bIsShadowZoneBoundary | ( | void | ) | const |
| bool CGeomCell::bPotentialPlatformErosion | ( | void | ) | const |
| void CGeomCell::CalcAllLayerElevsAndD50 | ( | void | ) |
| double CGeomCell::dCalcLayerElev | ( | const int | nLayer | ) |
| double CGeomCell::dGetActualBeachErosion | ( | void | ) | const |
| double CGeomCell::dGetActualPlatformErosion | ( | void | ) | const |
| double CGeomCell::dGetBasementElev | ( | void | ) | const |
| double CGeomCell::dGetBeachDeposition | ( | void | ) | const |
| double CGeomCell::dGetBeachProtectionFactor | ( | void | ) | const |
| double CGeomCell::dGetCellDeepWaterWaveAngle | ( | void | ) | const |
| double CGeomCell::dGetCellDeepWaterWaveHeight | ( | void | ) | const |
| double CGeomCell::dGetCellDeepWaterWavePeriod | ( | void | ) | const |
| double CGeomCell::dGetConsSedTopForLayerAboveBasement | ( | int const | nLayer | ) | const |
| double CGeomCell::dGetInterventionHeight | ( | void | ) | const |
| double CGeomCell::dGetInterventionTopElev | ( | void | ) | const |
| double CGeomCell::dGetLocalConsSlope | ( | void | ) | const |
| double CGeomCell::dGetOverallTopElev | ( | void | ) | const |
| double CGeomCell::dGetPotentialBeachErosion | ( | void | ) | const |
| double CGeomCell::dGetPotentialPlatformErosion | ( | void | ) | const |
| double CGeomCell::dGetSeaDepth | ( | void | ) | const |
Returns the depth of seawater on this cell.
Definition at line 427 of file cell.cpp.
Referenced by CGeomProfile::nGetCellGivenDepth().
| double CGeomCell::dGetSedimentPlusInterventionTopElev | ( | void | ) | const |
| double CGeomCell::dGetSedimentTopElev | ( | void | ) | const |
| double CGeomCell::dGetSuspendedSediment | ( | void | ) | const |
| double CGeomCell::dGetThisIterCliffCollapseCoarseTalusDeposition | ( | void | ) | const |
| double CGeomCell::dGetThisIterCliffCollapseErosionCoarse | ( | void | ) | const |
| double CGeomCell::dGetThisIterCliffCollapseErosionFine | ( | void | ) | const |
| double CGeomCell::dGetThisIterCliffCollapseErosionSand | ( | void | ) | const |
| double CGeomCell::dGetThisIterCliffCollapseSandTalusDeposition | ( | void | ) | const |
| double CGeomCell::dGetThisIterSWL | ( | void | ) | const |
| double CGeomCell::dGetThisIterTotWaterLevel | ( | void | ) | const |
| double CGeomCell::dGetTotActualBeachErosion | ( | void | ) | const |
| double CGeomCell::dGetTotActualPlatformErosion | ( | void | ) | const |
| double CGeomCell::dGetTotAllSedThickness | ( | void | ) | const |
| double CGeomCell::dGetTotBeachDeposition | ( | void | ) | const |
| double CGeomCell::dGetTotCliffCollapseCoarse | ( | void | ) | const |
| double CGeomCell::dGetTotCliffCollapseFine | ( | void | ) | const |
| double CGeomCell::dGetTotCliffCollapseSand | ( | void | ) | const |
| double CGeomCell::dGetTotCoarseTalusDeposition | ( | void | ) | const |
| double CGeomCell::dGetTotConsCoarseThickConsiderNotch | ( | void | ) | const |
| double CGeomCell::dGetTotConsFineThickConsiderNotch | ( | void | ) | const |
| double CGeomCell::dGetTotConsSandThickConsiderNotch | ( | void | ) | const |
| double CGeomCell::dGetTotConsThickness | ( | void | ) | const |
Returns the total thickness of consolidated sediment (all size classes) on this cell.
Definition at line 661 of file cell.cpp.
Referenced by dGetTotAllSedThickness().
| double CGeomCell::dGetTotPotentialBeachErosion | ( | void | ) | const |
| double CGeomCell::dGetTotPotentialPlatformErosion | ( | void | ) | const |
| double CGeomCell::dGetTotSandTalusDeposition | ( | void | ) | const |
| double CGeomCell::dGetTotSeaDepth | ( | void | ) | const |
| double CGeomCell::dGetTotSuspendedSediment | ( | void | ) | const |
| double CGeomCell::dGetTotUnconsCoarse | ( | void | ) | const |
| double CGeomCell::dGetTotUnconsFine | ( | void | ) | const |
| double CGeomCell::dGetTotUnconsSand | ( | void | ) | const |
| double CGeomCell::dGetTotUnconsThickness | ( | void | ) | const |
Returns the total thickness of unconsolidated sediment (all size classes) on this cell.
Definition at line 671 of file cell.cpp.
Referenced by dGetTotAllSedThickness().
| double CGeomCell::dGetTotWaveAngle | ( | void | ) | const |
| double CGeomCell::dGetTotWaveHeight | ( | void | ) | const |
| double CGeomCell::dGetUnconsD50 | ( | void | ) | const |
| double CGeomCell::dGetWaveAngle | ( | void | ) | const |
| double CGeomCell::dGetWaveHeight | ( | void | ) | const |
| void CGeomCell::IncrBeachDeposition | ( | double const | dThisDeposition | ) |
| void CGeomCell::IncrCliffCollapseErosion | ( | double const | dFineDepth, |
| double const | dSandDepth, | ||
| double const | dCoarseDepth ) |
| void CGeomCell::InitCell | ( | void | ) |
| int CGeomCell::nGetBoundingBoxEdge | ( | void | ) | const |
| int CGeomCell::nGetDownDriftZoneNumber | ( | void | ) | const |
| int CGeomCell::nGetInterventionClass | ( | void | ) | const |
| 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),
| int CGeomCell::nGetPolygonID | ( | void | ) | const |
| int CGeomCell::nGetProfileID | ( | void | ) | const |
| int CGeomCell::nGetShadowZoneNumber | ( | void | ) | const |
| int CGeomCell::nGetTopLayerAboveBasement | ( | void | ) | const |
| 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 467 of file cell.cpp.
Referenced by InitCell().
| CRWCellLandform * CGeomCell::pGetLandform | ( | void | ) |
Returns a pointer to this cell's CRWCellLandform object.
| CRWCellLayer * CGeomCell::pGetLayerAboveBasement | ( | int const | nLayer | ) |
| void CGeomCell::SetActualBeachErosion | ( | double const | dThisActualErosion | ) |
| void CGeomCell::SetActualPlatformErosion | ( | double const | dThisActualErosion | ) |
| void CGeomCell::SetAsCoastline | ( | bool const | bNewFlag | ) |
| void CGeomCell::SetAsFloodLine | ( | bool const | bNewFlag | ) |
| void CGeomCell::SetBasementElev | ( | double const | dNewElev | ) |
| void CGeomCell::SetBeachProtectionFactor | ( | double const | dFactor | ) |
| void CGeomCell::SetBoundingBoxEdge | ( | int const | nDirection | ) |
| void CGeomCell::SetCellDeepWaterWaveAngle | ( | double const | dWaveAngle | ) |
| void CGeomCell::SetCellDeepWaterWaveHeight | ( | double const | dWaveHeight | ) |
| void CGeomCell::SetCellDeepWaterWavePeriod | ( | double const | dWavePeriod | ) |
| void CGeomCell::SetCheckCell | ( | void | ) |
| void CGeomCell::SetCheckFloodCell | ( | void | ) |
| void CGeomCell::SetDownDriftZoneNumber | ( | int const | nCode | ) |
| void CGeomCell::SetFloodBySetupSurge | ( | void | ) |
| void CGeomCell::SetFloodBySetupSurgeRunup | ( | void | ) |
| void CGeomCell::SetInActiveZone | ( | bool const | bFlag | ) |
| void CGeomCell::SetInContiguousFlood | ( | void | ) |
TODO 007 What do this do? Does it duplicate SetInContiguousSea()?
| void CGeomCell::SetInContiguousSea | ( | void | ) |
| void CGeomCell::SetInterventionClass | ( | int const | nSubCatCode | ) |
| void CGeomCell::SetInterventionHeight | ( | double const | dHeight | ) |
| void CGeomCell::SetLocalConsSlope | ( | double const | dNewSlope | ) |
| void CGeomCell::SetPolygonID | ( | int const | nPolyID | ) |
| void CGeomCell::SetPossibleCoastStartCell | ( | void | ) |
| void CGeomCell::SetPossibleFloodStartCell | ( | void | ) |
| void CGeomCell::SetPotentialBeachErosion | ( | double const | dPotentialIn | ) |
| void CGeomCell::SetPotentialPlatformErosion | ( | double const | dPotentialIn | ) |
| void CGeomCell::SetProfileID | ( | int const | nNormal | ) |
| void CGeomCell::SetSeaDepth | ( | void | ) |
| void CGeomCell::SetShadowZoneBoundary | ( | void | ) |
| void CGeomCell::SetShadowZoneNumber | ( | int const | nCode | ) |
| void CGeomCell::SetSuspendedSediment | ( | double const | dNewSedDepth | ) |
| void CGeomCell::SetWaveAngle | ( | double const | dWaveAngle | ) |
| void CGeomCell::SetWaveFlood | ( | void | ) |
| void CGeomCell::SetWaveHeight | ( | double const | dWaveHeight | ) |
| void CGeomCell::SetWaveValuesToDeepWaterWaveValues | ( | void | ) |
| void CGeomCell::UnSetCheckFloodCell | ( | void | ) |
| void CGeomCell::UnSetInContiguousFlood | ( | void | ) |
TODO 007 What does this do? Is it just the inverse of SetInContiguousSea()?
|
friend |
Definition at line 34 of file cell.h.
Referenced by CSimulation.
|
private |
TODO 007 What is this used for?
Definition at line 59 of file cell.h.
Referenced by bIsCellFloodCheck(), CGeomCell(), InitCell(), SetCheckFloodCell(), and UnSetCheckFloodCell().
|
private |
Switch to indicate that this cell is 'under' a coastline.
Definition at line 47 of file cell.h.
Referenced by bIsCoastline(), CGeomCell(), InitCell(), and SetAsCoastline().
|
private |
TODO 007 What is this used for?
Definition at line 71 of file cell.h.
Referenced by bIsFloodBySetupSurge(), and SetFloodBySetupSurge().
|
private |
TODO 007 What is this used for?
Definition at line 74 of file cell.h.
Referenced by bIsFloodBySetupSurgeRunup(), and SetFloodBySetupSurgeRunup().
|
private |
TODO 007 What is this used for? Switch to indicate that this cell is 'under' a flood line.
Definition at line 50 of file cell.h.
Referenced by bIsFloodLine(), CGeomCell(), InitCell(), and SetAsFloodLine().
|
private |
TODO 007 What is this?
Definition at line 41 of file cell.h.
Referenced by bIsInContiguousFlood(), CGeomCell(), InitCell(), SetInContiguousFlood(), and UnSetInContiguousFlood().
|
private |
Switch to indicate if this is a sea cell, contiguous with other sea cells.
Definition at line 38 of file cell.h.
Referenced by bIsInContiguousSea(), CGeomCell(), InitCell(), and SetInContiguousSea().
|
private |
Switch to indicate that this cell is in the active zone.
Definition at line 44 of file cell.h.
Referenced by bIsInActiveZone(), CGeomCell(), InitCell(), and SetInActiveZone().
|
private |
Switch to show that this cell could be the start of a coastline.
Definition at line 65 of file cell.h.
Referenced by bIsPossibleCoastStartCell(), CGeomCell(), InitCell(), and SetPossibleCoastStartCell().
|
private |
TODO 007 What is this used for?
Definition at line 68 of file cell.h.
Referenced by CGeomCell(), InitCell(), and SetPossibleFloodStartCell().
|
private |
Switch to show this cell is 'under' a shadow boundaryu.
Definition at line 62 of file cell.h.
Referenced by bIsShadowZoneBoundary(), CGeomCell(), InitCell(), and SetShadowZoneBoundary().
|
private |
TODO 007 What is this used for? Switch to indicate that this cell is 'under' a wave flood line.
Definition at line 53 of file cell.h.
Referenced by CGeomCell(), and InitCell().
|
private |
Depth of unconsolidated beach sediment actually eroded this timestep.
Definition at line 185 of file cell.h.
Referenced by bBeachErosionOrDepositionThisIter(), CGeomCell(), dGetActualBeachErosion(), InitCell(), and SetActualBeachErosion().
|
private |
Depth of sediment actually eroded from the shore platform this timestep.
Definition at line 143 of file cell.h.
Referenced by CGeomCell(), dGetActualPlatformErosion(), InitCell(), and SetActualPlatformErosion().
|
private |
Elevation of basement surface (m)
Definition at line 95 of file cell.h.
Referenced by bBasementElevIsMissingValue(), CalcAllLayerElevsAndD50(), CGeomCell(), dCalcLayerElev(), dGetBasementElev(), dGetConsSedTopForLayerAboveBasement(), and SetBasementElev().
|
private |
Depth of unconsolidated beach sediment deposited this timestep.
Definition at line 191 of file cell.h.
Referenced by bBeachErosionOrDepositionThisIter(), CGeomCell(), dGetBeachDeposition(), IncrBeachDeposition(), and InitCell().
|
private |
Only meaningful if in zone of platform erosion. 0 is fully protected; 1 = no protection.
Definition at line 128 of file cell.h.
Referenced by CGeomCell(), dGetBeachProtectionFactor(), InitCell(), and SetBeachProtectionFactor().
|
private |
Depth of coarse sediment (consolidated and unconsolidated) removed via cliff collapse this timestep.
Definition at line 155 of file cell.h.
Referenced by CGeomCell(), dGetThisIterCliffCollapseErosionCoarse(), IncrCliffCollapseErosion(), and InitCell().
|
private |
Depth of fine sediment (consolidated and unconsolidated) removed via cliff collapse this timestep.
Definition at line 149 of file cell.h.
Referenced by CGeomCell(), dGetThisIterCliffCollapseErosionFine(), IncrCliffCollapseErosion(), and InitCell().
|
private |
Depth of sand sediment (consolidated and unconsolidated) removed via cliff collapse this timestep.
Definition at line 152 of file cell.h.
Referenced by CGeomCell(), dGetThisIterCliffCollapseErosionSand(), IncrCliffCollapseErosion(), and InitCell().
|
private |
Wave orientation if this is a deep water cell.
Definition at line 122 of file cell.h.
Referenced by CGeomCell(), dGetCellDeepWaterWaveAngle(), SetCellDeepWaterWaveAngle(), and SetWaveValuesToDeepWaterWaveValues().
|
private |
Wave height if this is a deep water cell.
Definition at line 119 of file cell.h.
Referenced by CGeomCell(), dGetCellDeepWaterWaveHeight(), SetCellDeepWaterWaveHeight(), and SetWaveValuesToDeepWaterWaveValues().
|
private |
Wave period if this is a deep water cell.
Definition at line 125 of file cell.h.
Referenced by dGetCellDeepWaterWavePeriod(), SetCellDeepWaterWavePeriod(), and SetWaveValuesToDeepWaterWaveValues().
|
private |
Height of intervention structure.
Definition at line 200 of file cell.h.
Referenced by bIsElevLessThanWaterLevel(), bIsInundated(), CGeomCell(), dGetInterventionHeight(), dGetInterventionTopElev(), dGetOverallTopElev(), dGetSedimentPlusInterventionTopElev(), SetInterventionHeight(), and SetSeaDepth().
|
private |
Used in erosion calculations, stored here for display purposes.
Definition at line 92 of file cell.h.
Referenced by CGeomCell(), dGetLocalConsSlope(), InitCell(), and SetLocalConsSlope().
|
private |
Depth of unconsolidated beach sediment that could be eroded this timestep, if no supply-limitation.
Definition at line 179 of file cell.h.
Referenced by CGeomCell(), dGetPotentialBeachErosion(), InitCell(), and SetPotentialBeachErosion().
|
private |
Depth of sediment on the shore platform that could be eroded this timestep, if no supply-limitation.
Definition at line 137 of file cell.h.
Referenced by bPotentialPlatformErosion(), CGeomCell(), dGetPotentialPlatformErosion(), InitCell(), and SetPotentialPlatformErosion().
|
private |
Depth of still water (m), is zero if not inundated.
Definition at line 98 of file cell.h.
Referenced by CGeomCell(), dGetOverallTopElev(), dGetSeaDepth(), InitCell(), and SetSeaDepth().
|
private |
Suspended sediment as depth equivalent (m)
Definition at line 131 of file cell.h.
Referenced by AddSuspendedSediment(), CGeomCell(), dGetSuspendedSediment(), and SetSuspendedSediment().
|
private |
Depth of unconsolidated coarse sediment deposited as a result of cliff collapse this timestep.
Definition at line 173 of file cell.h.
Referenced by AddCoarseTalusDeposition(), CGeomCell(), dGetThisIterCliffCollapseCoarseTalusDeposition(), and InitCell().
|
private |
Depth of unconsolidated sand sediment deposited as a result of cliff collapse this timestep.
Definition at line 167 of file cell.h.
Referenced by AddSandTalusDeposition(), CGeomCell(), dGetThisIterCliffCollapseSandTalusDeposition(), and InitCell().
|
private |
Total depth of unconsolidated beach sediment actually eroded.
Definition at line 188 of file cell.h.
Referenced by CGeomCell(), dGetTotActualBeachErosion(), and SetActualBeachErosion().
|
private |
Total depth of sediment actually eroded from the shore platform.
Definition at line 146 of file cell.h.
Referenced by CGeomCell(), dGetTotActualPlatformErosion(), and SetActualPlatformErosion().
|
private |
Total depth of unconsolidated beach sediment deposited.
Definition at line 194 of file cell.h.
Referenced by CGeomCell(), dGetTotBeachDeposition(), and IncrBeachDeposition().
|
private |
Total depth of coarse sediment (consolidated and unconsolidated) removed via cliff collapse.
Definition at line 164 of file cell.h.
Referenced by CGeomCell(), dGetTotCliffCollapseCoarse(), and IncrCliffCollapseErosion().
|
private |
Total depth of fine sediment (consolidated and unconsolidated) removed via cliff collapse.
Definition at line 158 of file cell.h.
Referenced by CGeomCell(), dGetTotCliffCollapseFine(), and IncrCliffCollapseErosion().
|
private |
Total depth of unconsolidated beach sediment eroded; if no supply-limitation.
Definition at line 182 of file cell.h.
Referenced by CGeomCell(), dGetTotPotentialBeachErosion(), and SetPotentialBeachErosion().
|
private |
Total depth of sediment eroded from the shore platform, if no supply-limitation.
Definition at line 140 of file cell.h.
Referenced by CGeomCell(), dGetTotPotentialPlatformErosion(), and SetPotentialPlatformErosion().
|
private |
Total depth of sand sediment (consolidated and unconsolidated) removed via cliff collapse.
Definition at line 161 of file cell.h.
Referenced by CGeomCell(), dGetTotCliffCollapseSand(), and IncrCliffCollapseErosion().
|
private |
Total depth of still water (m) since beginning of simulation (used to calc average)
Definition at line 101 of file cell.h.
Referenced by CGeomCell(), and dGetTotSeaDepth().
|
private |
Total depth of suspended sediment (m) since simulation start (used to calc average)
Definition at line 134 of file cell.h.
Referenced by AddSuspendedSediment(), CGeomCell(), dGetTotSuspendedSediment(), and SetSuspendedSediment().
|
private |
Total depth of unconsolidated coarse sediment deposited as a result of cliff collapse.
Definition at line 176 of file cell.h.
Referenced by AddCoarseTalusDeposition(), CGeomCell(), dGetTotCoarseTalusDeposition(), and InitCell().
|
private |
Total depth of unconsolidated sand sediment deposited as a result of cliff collapse.
Definition at line 170 of file cell.h.
Referenced by AddSandTalusDeposition(), CGeomCell(), dGetTotSandTalusDeposition(), and InitCell().
|
private |
Total wave orientation (used to calc average)
Definition at line 116 of file cell.h.
Referenced by CGeomCell(), dGetTotWaveAngle(), and SetWaveAngle().
|
private |
Total wave height (m) (used to calc average)
Definition at line 107 of file cell.h.
Referenced by CGeomCell(), dGetTotWaveHeight(), and SetWaveHeight().
|
private |
d50 of unconsolidated sediment on top layer with unconsolidated sediment depth > 0
Definition at line 197 of file cell.h.
Referenced by CalcAllLayerElevsAndD50(), CGeomCell(), and dGetUnconsD50().
|
private |
Wave orientation.
Definition at line 110 of file cell.h.
Referenced by CGeomCell(), dGetWaveAngle(), InitCell(), SetWaveAngle(), and SetWaveValuesToDeepWaterWaveValues().
|
private |
Wave height (m)
Definition at line 104 of file cell.h.
Referenced by CGeomCell(), dGetWaveHeight(), InitCell(), SetWaveHeight(), and SetWaveValuesToDeepWaterWaveValues().
|
private |
Wave period (s)
Definition at line 113 of file cell.h.
Referenced by SetWaveValuesToDeepWaterWaveValues().
|
private |
This cell's landform data.
Definition at line 203 of file cell.h.
Referenced by CGeomCell(), nGetInterventionClass(), pGetLandform(), and SetInterventionClass().
|
private |
If this cell is an edge (or bounding box) cell, this specifies the edge.
Definition at line 77 of file cell.h.
Referenced by bIsBoundingBoxEdge(), CGeomCell(), nGetBoundingBoxEdge(), and SetBoundingBoxEdge().
|
private |
If this cell is 'under' a coastline normal, this is the number of the normal.
Definition at line 83 of file cell.h.
Referenced by bIsProfile(), CGeomCell(), InitCell(), nGetProfileID(), and SetProfileID().
|
private |
If this cell is within a downdrift zone, this is the number of the downdrift zone.
Definition at line 89 of file cell.h.
Referenced by CGeomCell(), InitCell(), nGetDownDriftZoneNumber(), and SetDownDriftZoneNumber().
|
private |
If this cell is within a polygon, this is the ID of the polygon.
Definition at line 80 of file cell.h.
Referenced by CGeomCell(), InitCell(), nGetPolygonID(), and SetPolygonID().
|
private |
If this cell is within a shadow zone, this is the number of the shadow zone.
Definition at line 86 of file cell.h.
Referenced by bIsinAnyShadowZone(), bIsinThisShadowZone(), CGeomCell(), InitCell(), nGetShadowZoneNumber(), and SetShadowZoneNumber().
|
static |
Definition at line 215 of file cell.h.
Referenced by bBasementElevIsMissingValue(), bIsElevLessThanWaterLevel(), bIsInundated(), CalcAllLayerElevsAndD50(), dGetThisIterSWL(), dGetThisIterTotWaterLevel(), CGeomRasterGrid::nCreateGrid(), and SetSeaDepth().
|
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 210 of file cell.h.
Referenced by bIsElevLessThanWaterLevel(), bIsInundated(), CalcAllLayerElevsAndD50(), dGetInterventionTopElev(), dGetOverallTopElev(), dGetSedimentPlusInterventionTopElev(), dGetSedimentTopElev(), nGetLayerAtElev(), and SetSeaDepth().
|
private |
Number of layers NOT including the basement. Layer 0 is the lowest.
Definition at line 207 of file cell.h.
Referenced by AppendLayers(), CalcAllLayerElevsAndD50(), dCalcLayerElev(), dGetConsSedTopForLayerAboveBasement(), dGetTotConsCoarseThickConsiderNotch(), dGetTotConsFineThickConsiderNotch(), dGetTotConsSandThickConsiderNotch(), dGetTotConsThickness(), dGetTotUnconsCoarse(), dGetTotUnconsFine(), dGetTotUnconsSand(), dGetTotUnconsThickness(), InitCell(), nGetLayerAtElev(), nGetTopLayerAboveBasement(), nGetTopNonZeroLayerAboveBasement(), and pGetLayerAboveBasement().
1.13.2