Real-world class used to represent the talus (unconsolidated sediment resulting from cliff collapse) on a cell layer object. More...

#include <cell_talus.h>

Public Member Functions
	CRWCellTalus (void)
	CRWCellTalus constructor with initialisation list.

void	SetSandDepth (double const)
	Sets this talus object's sand sediment depth equivalent. Note no checks here to see if new equiv depth is sensible (e.g. non-negative)

double	dGetSandDepth (void) const
	Returns the sand sediment depth equivalent for this talus object.

void	AddSandDepth (double const)
	Adds sand sediment (depth equivalent) to this talus object object's sand sediment.

void	SetCoarseDepth (double const)
	Sets this talus object object's coarse sediment depth equivalent. Note no checks here to see if new equiv depth is sensible (e.g. non-negative)

double	dGetCoarseDepth (void) const
	Returns the coarse sediment depth equivalent for this talus object object.

void	AddCoarseDepth (double const)
	Adds coarse sediment (depth equivalent) to this talus object object's coarse sediment.

double	dGetSandAddedThisIter (void) const
	Returns the value for sand talus added during this iteration.

double	dGetTotSandAdded (void) const
	Returns the value for total sand talus added.

double	dGetSandLostThisIter (void) const
	Returns the value for sand talus lost during this iteration.

double	dGetTotSandLost (void) const
	Returns the value for total sand talus lost.

double	dGetCoarseAddedThisIter (void) const
	Returns the value for coarse talus added during this iteration.

double	dGetTotCoarseAdded (void) const
	Returns the value for total coarse talus added.

double	dGetCoarseLostThisIter (void) const
	Returns the value for coarse talus lost during this iteration.

double	dGetTotCoarseLost (void) const
	Returns the value for total coarse talus lost.

Private Attributes
double	m_dSand
	Current depth equivalent of talus sand sediment in m.

double	m_dCoarse
	Current depth equivalent of talus coarse sediment in m.

double	m_dSandLostThisIter
	Depth equivalent (m) of talus sand sediment lost this iteration.

double	m_dCoarseLostThisIter
	Depth equivalent (m) of talus coarse sediment lost this iteration.

double	m_dSandInputThisIter
	Depth equivalent (m) of talus sand sediment added this iteration.

double	m_dCoarseInputThisIter
	Depth equivalent (m) of talus coarse sediment added this iteration.

double	m_dTotSandInput
	Depth equivalent (m) of talus sand sediment added since start of simulation.

double	m_dTotCoarseInput
	Depth equivalent (m) of talus coarse sediment added since start of simulation.

double	m_dTotSandLost
	Depth equivalent (m) of talus sand sediment lost since start of simulation.

double	m_dTotCoarseLost
	Depth equivalent (m) of talus coarse sediment lost since start of simulation.

Detailed Description

Real-world class used to represent the talus (unconsolidated sediment resulting from cliff collapse) on a cell layer object.

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

Author: David Favis-Mortlock; Andres Payo

Date: 2025

Copyright: GNU General Public License

Definition at line 24 of file cell_talus.h.

Constructor & Destructor Documentation

◆ CRWCellTalus()

CRWCellTalus::CRWCellTalus ( void )

CRWCellTalus constructor with initialisation list.

Definition at line 25 of file cell_talus.cpp.

Member Function Documentation

◆ AddCoarseDepth()

void CRWCellTalus::AddCoarseDepth ( double const dSedDepthToAdd )

Adds coarse sediment (depth equivalent) to this talus object object's coarse sediment.

Definition at line 70 of file cell_talus.cpp.

Referenced by CSimulation::DoCliffCollapseTalusDeposition().

◆ AddSandDepth()

void CRWCellTalus::AddSandDepth ( double const dSedDepthToAdd )

Adds sand sediment (depth equivalent) to this talus object object's sand sediment.

Definition at line 52 of file cell_talus.cpp.

Referenced by CSimulation::DoCliffCollapseTalusDeposition().

◆ dGetCoarseAddedThisIter()

double CRWCellTalus::dGetCoarseAddedThisIter ( void ) const

Returns the value for coarse talus added during this iteration.

Definition at line 100 of file cell_talus.cpp.

◆ dGetCoarseDepth()

double CRWCellTalus::dGetCoarseDepth ( void ) const

Returns the coarse sediment depth equivalent for this talus object object.

Definition at line 64 of file cell_talus.cpp.

Referenced by CGeomCell::dGetTalusDepth(), and CSimulation::nMoveCliffTalusToUnconsolidated().

◆ dGetCoarseLostThisIter()

double CRWCellTalus::dGetCoarseLostThisIter ( void ) const

Returns the value for coarse talus lost during this iteration.

Definition at line 106 of file cell_talus.cpp.

◆ dGetSandAddedThisIter()

double CRWCellTalus::dGetSandAddedThisIter ( void ) const

Returns the value for sand talus added during this iteration.

Definition at line 76 of file cell_talus.cpp.

◆ dGetSandDepth()

double CRWCellTalus::dGetSandDepth ( void ) const

Returns the sand sediment depth equivalent for this talus object.

Definition at line 46 of file cell_talus.cpp.

Referenced by CGeomCell::dGetTalusDepth(), and CSimulation::nMoveCliffTalusToUnconsolidated().

◆ dGetSandLostThisIter()

double CRWCellTalus::dGetSandLostThisIter ( void ) const

Returns the value for sand talus lost during this iteration.

Definition at line 82 of file cell_talus.cpp.

◆ dGetTotCoarseAdded()

double CRWCellTalus::dGetTotCoarseAdded ( void ) const

Returns the value for total coarse talus added.

Definition at line 112 of file cell_talus.cpp.

◆ dGetTotCoarseLost()

double CRWCellTalus::dGetTotCoarseLost ( void ) const

Returns the value for total coarse talus lost.

Definition at line 118 of file cell_talus.cpp.

◆ dGetTotSandAdded()

double CRWCellTalus::dGetTotSandAdded ( void ) const

Returns the value for total sand talus added.

Definition at line 88 of file cell_talus.cpp.

◆ dGetTotSandLost()

double CRWCellTalus::dGetTotSandLost ( void ) const

Returns the value for total sand talus lost.

Definition at line 94 of file cell_talus.cpp.

◆ SetCoarseDepth()

void CRWCellTalus::SetCoarseDepth ( double const dNewSedDepth )

Sets this talus object object's coarse sediment depth equivalent. Note no checks here to see if new equiv depth is sensible (e.g. non-negative)

Definition at line 58 of file cell_talus.cpp.

Referenced by CSimulation::nMoveCliffTalusToUnconsolidated().

◆ SetSandDepth()

void CRWCellTalus::SetSandDepth ( double const dNewSedDepth )

Sets this talus object's sand sediment depth equivalent. Note no checks here to see if new equiv depth is sensible (e.g. non-negative)

Definition at line 40 of file cell_talus.cpp.

Referenced by CSimulation::nMoveCliffTalusToUnconsolidated().

Field Documentation

◆ m_dCoarse

double CRWCellTalus::m_dCoarse

private

Current depth equivalent of talus coarse sediment in m.

Definition at line 31 of file cell_talus.h.

Referenced by AddCoarseDepth(), CRWCellTalus(), dGetCoarseDepth(), and SetCoarseDepth().

◆ m_dCoarseInputThisIter

double CRWCellTalus::m_dCoarseInputThisIter

private

Depth equivalent (m) of talus coarse sediment added this iteration.

Definition at line 43 of file cell_talus.h.

Referenced by CRWCellTalus(), and dGetCoarseAddedThisIter().

◆ m_dCoarseLostThisIter

double CRWCellTalus::m_dCoarseLostThisIter

private

Depth equivalent (m) of talus coarse sediment lost this iteration.

Definition at line 37 of file cell_talus.h.

Referenced by CRWCellTalus(), and dGetCoarseLostThisIter().

◆ m_dSand

double CRWCellTalus::m_dSand

private

Current depth equivalent of talus sand sediment in m.

Definition at line 28 of file cell_talus.h.

Referenced by AddSandDepth(), CRWCellTalus(), dGetSandDepth(), and SetSandDepth().

◆ m_dSandInputThisIter

double CRWCellTalus::m_dSandInputThisIter

private

Depth equivalent (m) of talus sand sediment added this iteration.

Definition at line 40 of file cell_talus.h.

Referenced by CRWCellTalus(), and dGetSandAddedThisIter().

◆ m_dSandLostThisIter

double CRWCellTalus::m_dSandLostThisIter

private

Depth equivalent (m) of talus sand sediment lost this iteration.

Definition at line 34 of file cell_talus.h.

Referenced by CRWCellTalus(), and dGetSandLostThisIter().

◆ m_dTotCoarseInput

double CRWCellTalus::m_dTotCoarseInput

private

Depth equivalent (m) of talus coarse sediment added since start of simulation.

Definition at line 49 of file cell_talus.h.

Referenced by CRWCellTalus(), and dGetTotCoarseAdded().

◆ m_dTotCoarseLost

double CRWCellTalus::m_dTotCoarseLost

private

Depth equivalent (m) of talus coarse sediment lost since start of simulation.

Definition at line 55 of file cell_talus.h.

Referenced by CRWCellTalus(), and dGetTotCoarseLost().

◆ m_dTotSandInput

double CRWCellTalus::m_dTotSandInput

private

Depth equivalent (m) of talus sand sediment added since start of simulation.

Definition at line 46 of file cell_talus.h.

Referenced by CRWCellTalus(), and dGetTotSandAdded().

◆ m_dTotSandLost

double CRWCellTalus::m_dTotSandLost

private

Depth equivalent (m) of talus sand sediment lost since start of simulation.

Definition at line 52 of file cell_talus.h.

Referenced by CRWCellTalus(), and dGetTotSandLost().

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CRWCellTalus()

Member Function Documentation

◆ AddCoarseDepth()

◆ AddSandDepth()

◆ dGetCoarseAddedThisIter()

◆ dGetCoarseDepth()

◆ dGetCoarseLostThisIter()

◆ dGetSandAddedThisIter()

◆ dGetSandDepth()

◆ dGetSandLostThisIter()

◆ dGetTotCoarseAdded()

◆ dGetTotCoarseLost()

◆ dGetTotSandAdded()

◆ dGetTotSandLost()

◆ SetCoarseDepth()

◆ SetSandDepth()

Field Documentation

◆ m_dCoarse

◆ m_dCoarseInputThisIter

◆ m_dCoarseLostThisIter

◆ m_dSand

◆ m_dSandInputThisIter

◆ m_dSandLostThisIter

◆ m_dTotCoarseInput

◆ m_dTotCoarseLost

◆ m_dTotSandInput

◆ m_dTotSandLost