Real-world class used to represent the sediment (either consolidated or unconsolidated) associated with a cell layer object. More...

#include <cell_sediment.h>

Public Member Functions
	CRWCellSediment (void)
	CRWCellSediment constructor, initialisation list sets all internal values to zero.

	CRWCellSediment (CRWCellSediment const &)
	CRWCellSediment copy constructor.

CRWCellSediment &	operator= (const CRWCellSediment &)
	Sets one CRWCellSediment object equal to another.

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

double	dGetFineDepth (void) const
	Returns the fine sediment depth equivalent for this sediment layer object.

void	SetSandDepth (double const)
	Sets this sediment layer 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 sediment layer.

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

void	SetCoarseDepth (double const)
	Sets this sediment layer 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 sediment layer object.

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

void	SetNotchFineLost (double const)
	Sets the depth equivalent of fine sediment lost by notch incision.

double	dGetNotchFineLost (void) const
	Gets the depth equivalent of fine sediment lost by notch incision.

void	SetNotchSandLost (double const)
	Sets the depth equivalent of sand sediment lost by notch incision.

double	dGetNotchSandLost (void) const
	Gets the depth equivalent of sand sediment lost by notch incision.

void	SetNotchCoarseLost (double const)
	Sets the depth equivalent of coarse sediment lost by notch incision.

double	dGetNotchCoarseLost (void) const
	Gets the depth equivalent of coarse sediment lost by notch incision.

void	AddFineSedimentInputDepth (double const)
	Adds to the this-iteration total depth of fine sediment input, and to the since-start-of-simulation total depth of fine sediment input (m)

void	AddSandSedimentInputDepth (double const)
	Adds to the this-iteration total depth of sand sediment input, and to the since-start-of-simulation total depth of sand sediment input (m)

void	AddCoarseSedimentInputDepth (double const)
	Adds to the this-iteration total depth of coarse sediment input, and to the since-start-of-simulation total depth of coarse sediment input (m)

double	dGetFineSedimentInputDepth (void) const
	Returns the this-iteration total depth of fine sediment input (m)

double	dGetSandSedimentInputDepth (void) const
	Returns the this-iteration total depth of sand sediment input (m)

double	dGetCoarseSedimentInputDepth (void) const
	Returns the this-iteration total depth of coarse sediment input (m)

double	dGetTotAllSedimentInputDepth (void) const
	Returns the total (since the start of simulation) depth of sediment input (m, all size classes)

void	InitThisIterSedimentInputAll (void)
	Intializes the this-iteration total depth of sediment input for all size classes (m)

Private Attributes
double	m_dFine
	Depth equivalent of fine sediment in m.

double	m_dNotchFineLost
	Depth equivalent (m) of fine sediment lost via notch incision.

double	m_dSand
	Depth equivalent of sand sediment in m.

double	m_dNotchSandLost
	Depth equivalent (m) of sand sediment lost via notch incision.

double	m_dCoarse
	Depth equivalent of coarse sediment in m.

double	m_dNotchCoarseLost
	Depth equivalent (m) of coarse sediment lost via notch incision.

double	m_dFineSedimentInputThisIter
	Depth equivalent (m) of fine sediment added via sediment input events, this iteration.

double	m_dSandSedimentInputThisIter
	Depth equivalent (m) of sand sediment added via sediment input events, this iteration.

double	m_dCoarseSedimentInputThisIter
	Depth equivalent (m) of coarse sediment added via sediment input events, this iteration.

double	m_dTotFineSedimentInput
	Depth equivalent (m) of fine sediment added via sediment input events, since start of simulation.

double	m_dTotSandSedimentInput
	Depth equivalent (m) of sand sediment added via sediment input events, since start of simulation.

double	m_dTotCoarseSedimentInput
	Depth equivalent (m) of coarse sediment added via sediment input events, since start of simulation.

Detailed Description

Real-world class used to represent the sediment (either consolidated or unconsolidated) associated with a cell layer object.

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

Author: David Favis-Mortlock; Andres Payo

Date: 2025

Copyright: GNU General Public License

Definition at line 24 of file cell_sediment.h.

Constructor & Destructor Documentation

◆ CRWCellSediment() [1/2]

CRWCellSediment::CRWCellSediment ( void )

CRWCellSediment constructor, initialisation list sets all internal values to zero.

Definition at line 25 of file cell_sediment.cpp.

Referenced by CRWCellSediment(), and operator=().

◆ CRWCellSediment() [2/2]

CRWCellSediment::CRWCellSediment ( CRWCellSediment const & OtherSediment )

CRWCellSediment copy constructor.

Definition at line 42 of file cell_sediment.cpp.

Member Function Documentation

◆ AddCoarseDepth()

void CRWCellSediment::AddCoarseDepth ( double const dSedDepthToAdd )

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

Definition at line 127 of file cell_sediment.cpp.

◆ AddCoarseSedimentInputDepth()

void CRWCellSediment::AddCoarseSedimentInputDepth ( double const dDepth )

Adds to the this-iteration total depth of coarse sediment input, and to the since-start-of-simulation total depth of coarse sediment input (m)

Definition at line 208 of file cell_sediment.cpp.

◆ AddFineSedimentInputDepth()

void CRWCellSediment::AddFineSedimentInputDepth ( double const dDepth )

Adds to the this-iteration total depth of fine sediment input, and to the since-start-of-simulation total depth of fine sediment input (m)

Definition at line 190 of file cell_sediment.cpp.

◆ AddSandDepth()

void CRWCellSediment::AddSandDepth ( double const dSedDepthToAdd )

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

Definition at line 109 of file cell_sediment.cpp.

◆ AddSandSedimentInputDepth()

void CRWCellSediment::AddSandSedimentInputDepth ( double const dDepth )

Adds to the this-iteration total depth of sand sediment input, and to the since-start-of-simulation total depth of sand sediment input (m)

Definition at line 199 of file cell_sediment.cpp.

◆ dGetCoarseDepth()

double CRWCellSediment::dGetCoarseDepth ( void ) const

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

Definition at line 121 of file cell_sediment.cpp.

Referenced by CGeomCell::CalcAllLayerElevsAndD50().

◆ dGetCoarseSedimentInputDepth()

double CRWCellSediment::dGetCoarseSedimentInputDepth ( void ) const

Returns the this-iteration total depth of coarse sediment input (m)

Definition at line 229 of file cell_sediment.cpp.

◆ dGetFineDepth()

double CRWCellSediment::dGetFineDepth ( void ) const

Returns the fine sediment depth equivalent for this sediment layer object.

Definition at line 84 of file cell_sediment.cpp.

Referenced by CGeomCell::CalcAllLayerElevsAndD50().

◆ dGetFineSedimentInputDepth()

double CRWCellSediment::dGetFineSedimentInputDepth ( void ) const

Returns the this-iteration total depth of fine sediment input (m)

Definition at line 217 of file cell_sediment.cpp.

◆ dGetNotchCoarseLost()

double CRWCellSediment::dGetNotchCoarseLost ( void ) const

Gets the depth equivalent of coarse sediment lost by notch incision.

Definition at line 184 of file cell_sediment.cpp.

◆ dGetNotchFineLost()

double CRWCellSediment::dGetNotchFineLost ( void ) const

Gets the depth equivalent of fine sediment lost by notch incision.

Definition at line 146 of file cell_sediment.cpp.

◆ dGetNotchSandLost()

double CRWCellSediment::dGetNotchSandLost ( void ) const

Gets the depth equivalent of sand sediment lost by notch incision.

Definition at line 165 of file cell_sediment.cpp.

◆ dGetSandDepth()

double CRWCellSediment::dGetSandDepth ( void ) const

Returns the sand sediment depth equivalent for this sediment layer.

Definition at line 103 of file cell_sediment.cpp.

Referenced by CGeomCell::CalcAllLayerElevsAndD50().

◆ dGetSandSedimentInputDepth()

double CRWCellSediment::dGetSandSedimentInputDepth ( void ) const

Returns the this-iteration total depth of sand sediment input (m)

Definition at line 223 of file cell_sediment.cpp.

◆ dGetTotAllSedimentInputDepth()

double CRWCellSediment::dGetTotAllSedimentInputDepth ( void ) const

Returns the total (since the start of simulation) depth of sediment input (m, all size classes)

Definition at line 235 of file cell_sediment.cpp.

◆ InitThisIterSedimentInputAll()

void CRWCellSediment::InitThisIterSedimentInputAll ( void )

Intializes the this-iteration total depth of sediment input for all size classes (m)

Definition at line 241 of file cell_sediment.cpp.

◆ operator=()

CRWCellSediment & CRWCellSediment::operator= ( const CRWCellSediment & OtherSediment )

Sets one CRWCellSediment object equal to another.

Definition at line 59 of file cell_sediment.cpp.

◆ SetCoarseDepth()

void CRWCellSediment::SetCoarseDepth ( double const dNewSedDepth )

Sets this sediment layer 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 115 of file cell_sediment.cpp.

◆ SetFineDepth()

void CRWCellSediment::SetFineDepth ( double const dNewSedDepth )

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

Definition at line 78 of file cell_sediment.cpp.

◆ SetNotchCoarseLost()

void CRWCellSediment::SetNotchCoarseLost ( double const dDepthIn )

Sets the depth equivalent of coarse sediment lost by notch incision.

Definition at line 171 of file cell_sediment.cpp.

◆ SetNotchFineLost()

void CRWCellSediment::SetNotchFineLost ( double const dDepthIn )

Sets the depth equivalent of fine sediment lost by notch incision.

Definition at line 133 of file cell_sediment.cpp.

◆ SetNotchSandLost()

void CRWCellSediment::SetNotchSandLost ( double const dDepthIn )

Sets the depth equivalent of sand sediment lost by notch incision.

Definition at line 152 of file cell_sediment.cpp.

◆ SetSandDepth()

void CRWCellSediment::SetSandDepth ( double const dNewSedDepth )

Sets this sediment layer 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 96 of file cell_sediment.cpp.

Field Documentation

◆ m_dCoarse

double CRWCellSediment::m_dCoarse

private

Depth equivalent of coarse sediment in m.

Definition at line 40 of file cell_sediment.h.

Referenced by AddCoarseDepth(), AddCoarseSedimentInputDepth(), CRWCellSediment(), CRWCellSediment(), dGetCoarseDepth(), operator=(), and SetCoarseDepth().

◆ m_dCoarseSedimentInputThisIter

double CRWCellSediment::m_dCoarseSedimentInputThisIter

private

Depth equivalent (m) of coarse sediment added via sediment input events, this iteration.

Definition at line 52 of file cell_sediment.h.

Referenced by AddCoarseSedimentInputDepth(), CRWCellSediment(), CRWCellSediment(), dGetCoarseSedimentInputDepth(), InitThisIterSedimentInputAll(), and operator=().

◆ m_dFine

double CRWCellSediment::m_dFine

private

Depth equivalent of fine sediment in m.

Definition at line 28 of file cell_sediment.h.

Referenced by AddFineSedimentInputDepth(), CRWCellSediment(), CRWCellSediment(), dGetFineDepth(), operator=(), and SetFineDepth().

◆ m_dFineSedimentInputThisIter

double CRWCellSediment::m_dFineSedimentInputThisIter

private

Depth equivalent (m) of fine sediment added via sediment input events, this iteration.

Definition at line 46 of file cell_sediment.h.

Referenced by AddFineSedimentInputDepth(), CRWCellSediment(), CRWCellSediment(), dGetFineSedimentInputDepth(), InitThisIterSedimentInputAll(), and operator=().

◆ m_dNotchCoarseLost

double CRWCellSediment::m_dNotchCoarseLost

private

Depth equivalent (m) of coarse sediment lost via notch incision.

Definition at line 43 of file cell_sediment.h.

Referenced by CRWCellSediment(), CRWCellSediment(), dGetNotchCoarseLost(), operator=(), and SetNotchCoarseLost().

◆ m_dNotchFineLost

double CRWCellSediment::m_dNotchFineLost

private

Depth equivalent (m) of fine sediment lost via notch incision.

Definition at line 31 of file cell_sediment.h.

Referenced by CRWCellSediment(), CRWCellSediment(), dGetNotchFineLost(), operator=(), and SetNotchFineLost().

◆ m_dNotchSandLost

double CRWCellSediment::m_dNotchSandLost

private

Depth equivalent (m) of sand sediment lost via notch incision.

Definition at line 37 of file cell_sediment.h.

Referenced by CRWCellSediment(), CRWCellSediment(), dGetNotchSandLost(), operator=(), and SetNotchSandLost().

◆ m_dSand

double CRWCellSediment::m_dSand

private

Depth equivalent of sand sediment in m.

Definition at line 34 of file cell_sediment.h.

Referenced by AddSandDepth(), AddSandSedimentInputDepth(), CRWCellSediment(), CRWCellSediment(), dGetSandDepth(), operator=(), and SetSandDepth().

◆ m_dSandSedimentInputThisIter

double CRWCellSediment::m_dSandSedimentInputThisIter

private

Depth equivalent (m) of sand sediment added via sediment input events, this iteration.

Definition at line 49 of file cell_sediment.h.

Referenced by AddSandSedimentInputDepth(), CRWCellSediment(), CRWCellSediment(), dGetSandSedimentInputDepth(), InitThisIterSedimentInputAll(), and operator=().

◆ m_dTotCoarseSedimentInput

double CRWCellSediment::m_dTotCoarseSedimentInput

private

Depth equivalent (m) of coarse sediment added via sediment input events, since start of simulation.

Definition at line 61 of file cell_sediment.h.

Referenced by AddCoarseSedimentInputDepth(), CRWCellSediment(), CRWCellSediment(), dGetTotAllSedimentInputDepth(), and operator=().

◆ m_dTotFineSedimentInput

double CRWCellSediment::m_dTotFineSedimentInput

private

Depth equivalent (m) of fine sediment added via sediment input events, since start of simulation.

Definition at line 55 of file cell_sediment.h.

Referenced by AddFineSedimentInputDepth(), CRWCellSediment(), CRWCellSediment(), dGetTotAllSedimentInputDepth(), and operator=().

◆ m_dTotSandSedimentInput

double CRWCellSediment::m_dTotSandSedimentInput

private

Depth equivalent (m) of sand sediment added via sediment input events, since start of simulation.

Definition at line 58 of file cell_sediment.h.

Referenced by AddSandSedimentInputDepth(), CRWCellSediment(), CRWCellSediment(), dGetTotAllSedimentInputDepth(), and operator=().

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CRWCellSediment() [1/2]

◆ CRWCellSediment() [2/2]

Member Function Documentation

◆ AddCoarseDepth()

◆ AddCoarseSedimentInputDepth()

◆ AddFineSedimentInputDepth()

◆ AddSandDepth()

◆ AddSandSedimentInputDepth()

◆ dGetCoarseDepth()

◆ dGetCoarseSedimentInputDepth()

◆ dGetFineDepth()

◆ dGetFineSedimentInputDepth()

◆ dGetNotchCoarseLost()

◆ dGetNotchFineLost()

◆ dGetNotchSandLost()

◆ dGetSandDepth()

◆ dGetSandSedimentInputDepth()

◆ dGetTotAllSedimentInputDepth()

◆ InitThisIterSedimentInputAll()

◆ operator=()

◆ SetCoarseDepth()

◆ SetFineDepth()

◆ SetNotchCoarseLost()

◆ SetNotchFineLost()

◆ SetNotchSandLost()

◆ SetSandDepth()

Field Documentation

◆ m_dCoarse

◆ m_dCoarseSedimentInputThisIter

◆ m_dFine

◆ m_dFineSedimentInputThisIter

◆ m_dNotchCoarseLost

◆ m_dNotchFineLost

◆ m_dNotchSandLost

◆ m_dSand

◆ m_dSandSedimentInputThisIter

◆ m_dTotCoarseSedimentInput

◆ m_dTotFineSedimentInput

◆ m_dTotSandSedimentInput