CRWCliff Class Reference

Real-world class used to represent the 'cliff' category of coastal landform object. More...

#include <cliff.h>

Inherits CACoastLandform.

Public Member Functions
	CRWCliff (CRWCoast *, int const, int const, double const, double const, double const, double const)
	Constructor with seven parameters and an initialization list.
	~CRWCliff (void) override
	Destructor.
void	SetCliffCollapsed (void)
	Flags the cliff as having collapsed.
bool	bHasCollapsed (void) const
	Returns the value of the cliff collapse switch.
void	SetNotchApexElev (double const)
	Sets the elevation of the apex of the erosional notch (in external CRS units)
double	dGetNotchApexElev (void) const
	Returns the elevation of the apex of the erosional notch (in external CRS units)
void	SetNotchIncision (double const)
	Sets the horizontal incision (in external CRS units) of the erosional notch, measured inland from the side of the cell that touches the sea.
double	dGetNotchIncision (void) const
	Returns the horizontal incision (in external CRS units) of the cliff's erosional notch (the 'overhang')
void	IncreaseNotchIncision (double const)
	Increases the horizontal incision (in external CRS units) of the erosional notch, measured inland from the side of the cell that touches the sea.
bool	bReadyToCollapse (double const) const
	Returns true if the horizontal incision of the erosional notch exceeds the critical notch incision.
void	Display (void) override
	Instantiates the pure virtual function in the abstract parent class, so that CRWCliff is not an abstract class.
Public Member Functions inherited from CACoastLandform
	CACoastLandform (void)
	Constructor with initialisation list.
virtual	~CACoastLandform (void)
	Destructor.
int	nGetCoast (void) const
	Get the number of the coast on which this coast landform sits.
int	nGetPointOnCoast (void) const
	Get the point on the coast on which this coast landform sits.
int	nGetLandFormCategory (void) const
	Get the landform category.
CGeom2DIPoint *	pPtiGetCellMarkedAsCliff (void) const
	Get the grid coordinates of the cell on which this cliff sits.
void	IncTotAccumWaveEnergy (double const)
	Increment total accumulated wave energy.
double	dGetTotAccumWaveEnergy (void) const
	Get total accumulated wave energy.

Private Attributes
bool	m_bCliffHasCollapsed
	Switch to say whether the cliff has just collapsed, earlier in this timestep.
double	m_dMaxNotchIncision
	The maximum horizontal incision (in external CRS units) of an erosional notch, this is equal to the grid's m_dCellSide.
double	m_dNotchIncision
	The horizontal depth (in external CRS units) of the erosional notch, measured inland from the side of the cell that touches the sea.
double	m_dNotchApexElev
	Elevation (in external CRS units) of the apex of the notch (in CoastalME, the mid point between the top and bottom of the notch). The notch is assumed to extend across the whole width of the coast cell, along the side of the cell that touches the sea.

Additional Inherited Members
Protected Attributes inherited from CACoastLandform
int	m_nCoast
	The coast number on which this coast landform sits.
int	m_nPointOnCoastline
	The point on the coast on which this coast landform sits.
int	m_nCategory
	Landform category code.
double	m_dTotAccumWaveEnergy
	Total accumulated wave energy since beginning of simulation.
CRWCoast *	pCoast
	Pointer to this landform's coast.

Detailed Description

Real-world class used to represent the 'cliff' category of coastal landform object.

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

Author

David Favis-Mortlock

Andres Payo

Date

2025

Copyright

GNU General Public License

Definition at line 27 of file cliff.h.

Constructor & Destructor Documentation

CRWCliff()

CRWCliff::CRWCliff	(	CRWCoast *	pCoastIn,
		int const	nCoast,
		int const	nPointOnCoast,
		double const	dCellSide,
		double const	dNotchIncisionIn,
		double const	dNotchApexElevIn,
		double const	dAccumWaveEnergyIn )

Constructor with seven parameters and an initialization list.

Definition at line 30 of file cliff.cpp.

~CRWCliff()

CRWCliff::~CRWCliff ( void )

override

Destructor.

Definition at line 47 of file cliff.cpp.

Member Function Documentation

bHasCollapsed()

bool CRWCliff::bHasCollapsed

(

void

)

const

Returns the value of the cliff collapse switch.

Definition at line 52 of file cliff.cpp.

Referenced by CSimulation::bWriteVectorGISFile().

bReadyToCollapse()

bool CRWCliff::bReadyToCollapse

(

double const

dThresholdNotchIncision

)

const

Returns true if the horizontal incision of the erosional notch exceeds the critical notch incision.

Definition at line 99 of file cliff.cpp.

Referenced by CSimulation::nDoAllWaveEnergyToCoastLandforms().

dGetNotchApexElev()

double CRWCliff::dGetNotchApexElev

(

void

)

const

Returns the elevation of the apex of the erosional notch (in external CRS units)

Definition at line 64 of file cliff.cpp.

Referenced by CSimulation::bIncreaseCliffNotchIncision(), and CSimulation::nDoCliffCollapse().

dGetNotchIncision()

double CRWCliff::dGetNotchIncision

(

void

)

const

Returns the horizontal incision (in external CRS units) of the cliff's erosional notch (the 'overhang')

Definition at line 82 of file cliff.cpp.

Referenced by CSimulation::bWriteVectorGISFile().

Display()

void CRWCliff::Display ( void )

overridevirtual

Instantiates the pure virtual function in the abstract parent class, so that CRWCliff is not an abstract class.

Implements CACoastLandform.

Definition at line 108 of file cliff.cpp.

IncreaseNotchIncision()

void CRWCliff::IncreaseNotchIncision

(

double const

dLenIn

)

Increases the horizontal incision (in external CRS units) of the erosional notch, measured inland from the side of the cell that touches the sea.

Definition at line 88 of file cliff.cpp.

Referenced by CSimulation::bIncreaseCliffNotchIncision().

SetCliffCollapsed()

void CRWCliff::SetCliffCollapsed

(

void

)

Flags the cliff as having collapsed.

Definition at line 58 of file cliff.cpp.

Referenced by CSimulation::nDoCliffCollapse().

SetNotchApexElev()

void CRWCliff::SetNotchApexElev

(

double const

dNewElev

)

Sets the elevation of the apex of the erosional notch (in external CRS units)

Definition at line 70 of file cliff.cpp.

Referenced by CSimulation::bIncreaseCliffNotchIncision().

SetNotchIncision()

void CRWCliff::SetNotchIncision

(

double const

dNewIncision

)

Sets the horizontal incision (in external CRS units) of the erosional notch, measured inland from the side of the cell that touches the sea.

Definition at line 76 of file cliff.cpp.

Referenced by CSimulation::bIncreaseCliffNotchIncision().

Field Documentation

m_bCliffHasCollapsed

bool CRWCliff::m_bCliffHasCollapsed

private

Switch to say whether the cliff has just collapsed, earlier in this timestep.

Definition at line 31 of file cliff.h.

Referenced by bHasCollapsed(), CRWCliff(), and SetCliffCollapsed().

m_dMaxNotchIncision

double CRWCliff::m_dMaxNotchIncision

private

The maximum horizontal incision (in external CRS units) of an erosional notch, this is equal to the grid's m_dCellSide.

Definition at line 34 of file cliff.h.

Referenced by CRWCliff(), and IncreaseNotchIncision().

m_dNotchApexElev

double CRWCliff::m_dNotchApexElev

private

Elevation (in external CRS units) of the apex of the notch (in CoastalME, the mid point between the top and bottom of the notch). The notch is assumed to extend across the whole width of the coast cell, along the side of the cell that touches the sea.

Definition at line 40 of file cliff.h.

Referenced by CRWCliff(), dGetNotchApexElev(), and SetNotchApexElev().

m_dNotchIncision

double CRWCliff::m_dNotchIncision

private

The horizontal depth (in external CRS units) of the erosional notch, measured inland from the side of the cell that touches the sea.

Definition at line 37 of file cliff.h.

Referenced by bReadyToCollapse(), CRWCliff(), dGetNotchIncision(), IncreaseNotchIncision(), and SetNotchIncision().

---

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

• cliff.h
• cliff.cpp