CACoastLandform Class Reference

Abstract class, used as a base class for landform objects on the coastline. More...

#include <coast_landform.h>

Inherited by CRWCliff, CRWDrift, and CRWIntervention.

Public Member Functions
	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.
virtual void	Display ()=0

Protected Attributes
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

Abstract class, used as a base class for landform objects on the coastline.

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

Author

David Favis-Mortlock

Andres Payo

Date

2025

Copyright

GNU General Public License

Definition at line 30 of file coast_landform.h.

Constructor & Destructor Documentation

CACoastLandform()

CACoastLandform::CACoastLandform

(

void

)

Constructor with initialisation list.

Definition at line 27 of file coast_landform.cpp.

~CACoastLandform()

CACoastLandform::~CACoastLandform ( void )

virtual

Destructor.

Definition at line 37 of file coast_landform.cpp.

Member Function Documentation

dGetTotAccumWaveEnergy()

double CACoastLandform::dGetTotAccumWaveEnergy

(

void

)

const

Get total accumulated wave energy.

Definition at line 82 of file coast_landform.cpp.

Referenced by CSimulation::nLandformToGrid().

Display()

virtual void CACoastLandform::Display ( )

pure virtual

Implemented in CRWCliff, CRWDrift, and CRWIntervention.

IncTotAccumWaveEnergy()

void CACoastLandform::IncTotAccumWaveEnergy

(

double const

dWaveEnergy

)

Increment total accumulated wave energy.

Definition at line 76 of file coast_landform.cpp.

Referenced by CSimulation::nDoAllWaveEnergyToCoastLandforms().

nGetCoast()

int CACoastLandform::nGetCoast

(

void

)

const

Get the number of the coast on which this coast landform sits.

Definition at line 42 of file coast_landform.cpp.

nGetLandFormCategory()

int CACoastLandform::nGetLandFormCategory

(

void

)

const

Get the landform category.

Definition at line 59 of file coast_landform.cpp.

Referenced by CSimulation::bWriteVectorGISFile(), CSimulation::nDoAllWaveEnergyToCoastLandforms(), and CSimulation::nLandformToGrid().

nGetPointOnCoast()

int CACoastLandform::nGetPointOnCoast

(

void

)

const

Get the point on the coast on which this coast landform sits.

Definition at line 48 of file coast_landform.cpp.

Referenced by CSimulation::bIncreaseCliffNotchIncision().

pPtiGetCellMarkedAsCliff()

CGeom2DIPoint * CACoastLandform::pPtiGetCellMarkedAsCliff

(

void

)

const

Get the grid coordinates of the cell on which this cliff sits.

Definition at line 65 of file coast_landform.cpp.

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

Field Documentation

m_dTotAccumWaveEnergy

double CACoastLandform::m_dTotAccumWaveEnergy

protected

Total accumulated wave energy since beginning of simulation.

Definition at line 44 of file coast_landform.h.

Referenced by CACoastLandform(), CRWCliff::CRWCliff(), dGetTotAccumWaveEnergy(), and IncTotAccumWaveEnergy().

m_nCategory

int CACoastLandform::m_nCategory

protected

Landform category code.

Definition at line 41 of file coast_landform.h.

Referenced by CACoastLandform(), CRWCliff::CRWCliff(), CRWDrift::CRWDrift(), CRWIntervention::CRWIntervention(), and nGetLandFormCategory().

m_nCoast

int CACoastLandform::m_nCoast

protected

The coast number on which this coast landform sits.

Definition at line 35 of file coast_landform.h.

Referenced by CACoastLandform(), CRWCliff::CRWCliff(), CRWDrift::CRWDrift(), CRWIntervention::CRWIntervention(), and nGetCoast().

m_nPointOnCoastline

int CACoastLandform::m_nPointOnCoastline

protected

The point on the coast on which this coast landform sits.

Definition at line 38 of file coast_landform.h.

Referenced by CACoastLandform(), CRWCliff::CRWCliff(), CRWDrift::CRWDrift(), CRWIntervention::CRWIntervention(), nGetPointOnCoast(), and pPtiGetCellMarkedAsCliff().

pCoast

CRWCoast* CACoastLandform::pCoast

protected

Pointer to this landform's coast.

Definition at line 47 of file coast_landform.h.

Referenced by CACoastLandform(), CRWCliff::CRWCliff(), CRWDrift::CRWDrift(), CRWIntervention::CRWIntervention(), and pPtiGetCellMarkedAsCliff().

---

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

• coast_landform.h
• coast_landform.cpp