CRWCellLayer Class Reference

Real-world class used to represent the sediment layers associated with a cell object. More...

#include <cell_layer.h>

Public Member Functions
	CRWCellLayer (void)
	Constructor.
	~CRWCellLayer (void)
	Destructor.
CRWCellSediment *	pGetUnconsolidatedSediment (void)
	Returns a pointer to the cell's unconsolidated sediment object.
CRWCellSediment *	pGetConsolidatedSediment (void)
	Returns a pointer to the cell's consolidated sediment object.
bool	bHasUncons (void)
	Return true if the layer has unconsolidated sediment, false otherwise.
double	dGetUnconsFineDepth (void) const
	Returns the thickness of this cell's fine unconsolidated sediment.
double	dGetConsFineDepth (void) const
	Returns the thickness of this cell's fine consolidated sediment.
double	dGetUnconsSandDepth (void) const
	Returns the thickness of this cell's sand unconsolidated sediment.
double	dGetConsSandDepth (void) const
	Returns the thickness of this cell's sand consolidated sediment.
double	dGetUnconsCoarseDepth (void) const
	Returns the thickness of this cell's coarse unconsolidated sediment.
double	dGetConsCoarseDepth (void) const
	Returns the thickness of this cell's coarse consolidated sediment.
double	dGetAllUnconsDepth (void) const
	Returns the thickness of this cell's unconsolidated sediment (total for all size classes)
double	dGetAllConsDepth (void) const
	Returns the thickness of this cell's consolidated sediment (total for all size classes)
double	dGetTotalThickness (void) const
	Returns the thickness of this cell's sediment (total for all size classes, both consolidated and unconsolidated)
void	SetVolSedFraction (double const)
bool	bHasTalus (void)
	Returns true if the layer has talus, false otherwise.
CRWCellTalus *	pGetTalus (void) const
	Returns a pointer to the layer's talus object, or NULL if there is no talus object.
CRWCellTalus *	pGetOrCreateTalus (void)
	Returns a pointer to the layer's talus object. If there is no talus object, then create one.
void	DeleteTalus (void)

Private Attributes
CRWCellSediment	m_UnconsolidatedSediment
	This cell's unconsolidated sediment object.
CRWCellSediment	m_ConsolidatedSediment
	This cell's consolidated sediment object.
CRWCellTalus *	m_pTalus
	Pointer to this cell layer's talus (unconsolidated sediment derived from cliff collapse), if any.

Detailed Description

Real-world class used to represent the sediment layers associated with a cell object.

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

Author

David Favis-Mortlock

Andres Payo

Date

2025

Copyright

GNU General Public License

Definition at line 27 of file cell_layer.h.

Constructor & Destructor Documentation

CRWCellLayer()

CRWCellLayer::CRWCellLayer

(

void

)

Constructor.

Definition at line 28 of file cell_layer.cpp.

~CRWCellLayer()

CRWCellLayer::~CRWCellLayer

(

void

)

Destructor.

Definition at line 34 of file cell_layer.cpp.

Member Function Documentation

bHasTalus()

bool CRWCellLayer::bHasTalus

(

void

)

Returns true if the layer has talus, false otherwise.

Definition at line 158 of file cell_layer.cpp.

Referenced by CSimulation::FillInBeachProtectionHolesAndRemoveLegacyCliffs(), CSimulation::nAssignLandformsForAllCells(), and CSimulation::nAssignLandformsForAllCoasts().

bHasUncons()

bool CRWCellLayer::bHasUncons

(

void

)

Return true if the layer has unconsolidated sediment, false otherwise.

Definition at line 53 of file cell_layer.cpp.

Referenced by CSimulation::FillInBeachProtectionHolesAndRemoveLegacyCliffs(), and CSimulation::nAssignLandformsForAllCells().

DeleteTalus()

void CRWCellLayer::DeleteTalus

(

void

)

Definition at line 185 of file cell_layer.cpp.

dGetAllConsDepth()

double CRWCellLayer::dGetAllConsDepth

(

void

)

const

Returns the thickness of this cell's consolidated sediment (total for all size classes)

Definition at line 104 of file cell_layer.cpp.

dGetAllUnconsDepth()

double CRWCellLayer::dGetAllUnconsDepth

(

void

)

const

Returns the thickness of this cell's unconsolidated sediment (total for all size classes)

Definition at line 98 of file cell_layer.cpp.

Referenced by bHasUncons().

dGetConsCoarseDepth()

double CRWCellLayer::dGetConsCoarseDepth

(

void

)

const

Returns the thickness of this cell's coarse consolidated sediment.

Definition at line 92 of file cell_layer.cpp.

dGetConsFineDepth()

double CRWCellLayer::dGetConsFineDepth

(

void

)

const

Returns the thickness of this cell's fine consolidated sediment.

Definition at line 68 of file cell_layer.cpp.

dGetConsSandDepth()

double CRWCellLayer::dGetConsSandDepth

(

void

)

const

Returns the thickness of this cell's sand consolidated sediment.

Definition at line 80 of file cell_layer.cpp.

dGetTotalThickness()

double CRWCellLayer::dGetTotalThickness

(

void

)

const

Returns the thickness of this cell's sediment (total for all size classes, both consolidated and unconsolidated)

Definition at line 110 of file cell_layer.cpp.

dGetUnconsCoarseDepth()

double CRWCellLayer::dGetUnconsCoarseDepth

(

void

)

const

Returns the thickness of this cell's coarse unconsolidated sediment.

Definition at line 86 of file cell_layer.cpp.

dGetUnconsFineDepth()

double CRWCellLayer::dGetUnconsFineDepth

(

void

)

const

Returns the thickness of this cell's fine unconsolidated sediment.

Definition at line 62 of file cell_layer.cpp.

dGetUnconsSandDepth()

double CRWCellLayer::dGetUnconsSandDepth

(

void

)

const

Returns the thickness of this cell's sand unconsolidated sediment.

Definition at line 74 of file cell_layer.cpp.

pGetConsolidatedSediment()

CRWCellSediment * CRWCellLayer::pGetConsolidatedSediment

(

void

)

Returns a pointer to the cell's consolidated sediment object.

Definition at line 47 of file cell_layer.cpp.

pGetOrCreateTalus()

CRWCellTalus * CRWCellLayer::pGetOrCreateTalus

(

void

)

Returns a pointer to the layer's talus object. If there is no talus object, then create one.

Definition at line 173 of file cell_layer.cpp.

Referenced by CSimulation::DoCliffCollapseTalusDeposition().

pGetTalus()

CRWCellTalus * CRWCellLayer::pGetTalus

(

void

)

const

Returns a pointer to the layer's talus object, or NULL if there is no talus object.

Definition at line 167 of file cell_layer.cpp.

pGetUnconsolidatedSediment()

CRWCellSediment * CRWCellLayer::pGetUnconsolidatedSediment

(

void

)

Returns a pointer to the cell's unconsolidated sediment object.

Definition at line 41 of file cell_layer.cpp.

SetVolSedFraction()

void CRWCellLayer::SetVolSedFraction

(

double const

)

Field Documentation

m_ConsolidatedSediment

CRWCellSediment CRWCellLayer::m_ConsolidatedSediment

private

This cell's consolidated sediment object.

Definition at line 38 of file cell_layer.h.

Referenced by dGetAllConsDepth(), dGetConsCoarseDepth(), dGetConsFineDepth(), dGetConsSandDepth(), dGetTotalThickness(), and pGetConsolidatedSediment().

m_pTalus

CRWCellTalus* CRWCellLayer::m_pTalus

private

Pointer to this cell layer's talus (unconsolidated sediment derived from cliff collapse), if any.

Definition at line 41 of file cell_layer.h.

Referenced by bHasTalus(), CRWCellLayer(), DeleteTalus(), pGetOrCreateTalus(), pGetTalus(), and ~CRWCellLayer().

m_UnconsolidatedSediment

CRWCellSediment CRWCellLayer::m_UnconsolidatedSediment

private

This cell's unconsolidated sediment object.

Definition at line 35 of file cell_layer.h.

Referenced by dGetAllUnconsDepth(), dGetTotalThickness(), dGetUnconsCoarseDepth(), dGetUnconsFineDepth(), dGetUnconsSandDepth(), and pGetUnconsolidatedSediment().

---

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

• cell_layer.h
• cell_layer.cpp