CoastalME (Coastal Modelling Environment)
Simulates the long-term behaviour of complex coastlines
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes
CRWCellLandform Class Reference

Real-world class used to represent the landform of a cell. More...

#include <cell_landform.h>

Public Member Functions

 CRWCellLandform ()
 Constructor.
 
 ~CRWCellLandform (void)
 Destructor.
 
void SetLFCategory (int const)
 Set the landform category.
 
int nGetLFCategory (void) const
 Get the landform category.
 
void SetLFSubCategory (int const)
 Set the both the landform sub-category, and the landform category.
 
int nGetLFSubCategory (void) const
 Get the landform sub-category.
 
void SetCoast (int const)
 Set the coast number.
 
int nGetCoast (void) const
 Get the coast number.
 
void SetPointOnCoast (int const)
 Set the number of the point on the coastline.
 
int nGetPointOnCoast (void) const
 Set the number of the point on the coastline.
 
void SetAccumWaveEnergy (double const)
 Set accumulated wave energy.
 
double dGetAccumWaveEnergy (void) const
 Get accumulated wave energy.
 
void SetCliffNotchBaseElev (double const)
 Set cliff notch base elevation.
 
double dGetCliffNotchBaseElev (void) const
 Get cliff notch base elevation.
 
void SetCliffNotchDepth (double const)
 Set the cliff notch overhang which remains on this cell.
 
double dGetCliffNotchDepth (void) const
 Get the cliff notch overhang which remains on this cell.
 
void SetCliffRemaining (double const)
 Set the cliff depth remaining on this cell.
 

Private Attributes

int m_nCategory
 Landform category for this cell.
 
int m_nSubCategory
 Landform subcategory for this cell.
 
int m_nCoast
 Coast on which this landform sits (if any)
 
int m_nPointOnCoast
 Point on coast on which this landform sits (if any)
 
double m_dAccumWaveEnergy
 Accumulate wave energy for this landform on this cell.
 
union { 
 
   struct { 
 
      int   m_nDummy 
 Currently unused for all landforms except cliffs. More...
 
   }   m_sBeachData 
 
   struct { 
 
      double   m_dNotchBaseElev 
 Cliff notch base elevation. More...
 
      double   m_dNotchDepth 
 Cliff notch incised depth. More...
 
      double   m_dRemaining 
 Cliff notch depth remaining. More...
 
   }   m_sCliffData 
 
} m_uLFData 
 The m_uLFData will hold landform data: currently, only cliffs are considered.
 

Detailed Description

Real-world class used to represent the landform of a cell.

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

Author
David Favis-Mortlock
Andres Payo
Date
2025
Copyright
GNU General Public License *

Definition at line 28 of file cell_landform.h.

Constructor & Destructor Documentation

◆ CRWCellLandform()

CRWCellLandform::CRWCellLandform ( )

Constructor.

Definition at line 28 of file cell_landform.cpp.

◆ ~CRWCellLandform()

CRWCellLandform::~CRWCellLandform ( void )

Destructor.

Definition at line 38 of file cell_landform.cpp.

Member Function Documentation

◆ dGetAccumWaveEnergy()

double CRWCellLandform::dGetAccumWaveEnergy ( void ) const

Get accumulated wave energy.

Definition at line 103 of file cell_landform.cpp.

◆ dGetCliffNotchBaseElev()

double CRWCellLandform::dGetCliffNotchBaseElev ( void ) const

Get cliff notch base elevation.

Definition at line 115 of file cell_landform.cpp.

◆ dGetCliffNotchDepth()

double CRWCellLandform::dGetCliffNotchDepth ( void ) const

Get the cliff notch overhang which remains on this cell.

Definition at line 127 of file cell_landform.cpp.

◆ nGetCoast()

int CRWCellLandform::nGetCoast ( void ) const

Get the coast number.

Definition at line 79 of file cell_landform.cpp.

◆ nGetLFCategory()

int CRWCellLandform::nGetLFCategory ( void ) const

Get the landform category.

Definition at line 49 of file cell_landform.cpp.

Referenced by CSimulation::bElevAboveDeanElev(), CSimulation::bSurroundedByDriftCells(), CSimulation::FloodFillSea(), CSimulation::nAssignLandformsForAllCells(), CSimulation::nDoCliffCollapseDeposition(), CSimulation::nDoParallelProfileUnconsErosion(), and CSimulation::nDoUnconsDepositionOnPolygon().

◆ nGetLFSubCategory()

int CRWCellLandform::nGetLFSubCategory ( void ) const

Get the landform sub-category.

Definition at line 67 of file cell_landform.cpp.

◆ nGetPointOnCoast()

int CRWCellLandform::nGetPointOnCoast ( void ) const

Set the number of the point on the coastline.

Definition at line 91 of file cell_landform.cpp.

◆ SetAccumWaveEnergy()

void CRWCellLandform::SetAccumWaveEnergy ( double const dEnergyIn)

Set accumulated wave energy.

Definition at line 97 of file cell_landform.cpp.

◆ SetCliffNotchBaseElev()

void CRWCellLandform::SetCliffNotchBaseElev ( double const dElevIn)

Set cliff notch base elevation.

Definition at line 109 of file cell_landform.cpp.

◆ SetCliffNotchDepth()

void CRWCellLandform::SetCliffNotchDepth ( double const dLenIn)

Set the cliff notch overhang which remains on this cell.

Definition at line 121 of file cell_landform.cpp.

◆ SetCliffRemaining()

void CRWCellLandform::SetCliffRemaining ( double const dLenIn)

Set the cliff depth remaining on this cell.

Definition at line 133 of file cell_landform.cpp.

◆ SetCoast()

void CRWCellLandform::SetCoast ( int const nCoastIn)

Set the coast number.

Definition at line 73 of file cell_landform.cpp.

◆ SetLFCategory()

void CRWCellLandform::SetLFCategory ( int const nClassIn)

Set the landform category.

Definition at line 43 of file cell_landform.cpp.

Referenced by CSimulation::FloodFillSea(), CSimulation::nAssignLandformsForAllCells(), and CSimulation::nDoSedimentInputEvent().

◆ SetLFSubCategory()

void CRWCellLandform::SetLFSubCategory ( int const nClassIn)

Set the both the landform sub-category, and the landform category.

Definition at line 55 of file cell_landform.cpp.

Referenced by CSimulation::nAssignLandformsForAllCells(), CSimulation::nDoCliffCollapseDeposition(), CSimulation::nDoParallelProfileUnconsErosion(), CSimulation::nDoSedimentInputEvent(), and CSimulation::nDoUnconsDepositionOnPolygon().

◆ SetPointOnCoast()

void CRWCellLandform::SetPointOnCoast ( int const nPointOnCoastIn)

Set the number of the point on the coastline.

Definition at line 85 of file cell_landform.cpp.

Field Documentation

◆ m_dAccumWaveEnergy

double CRWCellLandform::m_dAccumWaveEnergy
private

Accumulate wave energy for this landform on this cell.

Definition at line 44 of file cell_landform.h.

Referenced by CRWCellLandform(), dGetAccumWaveEnergy(), and SetAccumWaveEnergy().

◆ m_dNotchBaseElev

double CRWCellLandform::m_dNotchBaseElev

Cliff notch base elevation.

Definition at line 59 of file cell_landform.h.

◆ m_dNotchDepth

double CRWCellLandform::m_dNotchDepth

Cliff notch incised depth.

Definition at line 62 of file cell_landform.h.

◆ m_dRemaining

double CRWCellLandform::m_dRemaining

Cliff notch depth remaining.

Definition at line 65 of file cell_landform.h.

◆ m_nCategory

int CRWCellLandform::m_nCategory
private

Landform category for this cell.

Definition at line 32 of file cell_landform.h.

Referenced by CRWCellLandform(), nGetLFCategory(), SetLFCategory(), and SetLFSubCategory().

◆ m_nCoast

int CRWCellLandform::m_nCoast
private

Coast on which this landform sits (if any)

Definition at line 38 of file cell_landform.h.

Referenced by CRWCellLandform(), nGetCoast(), and SetCoast().

◆ m_nDummy

int CRWCellLandform::m_nDummy

Currently unused for all landforms except cliffs.

Definition at line 52 of file cell_landform.h.

◆ m_nPointOnCoast

int CRWCellLandform::m_nPointOnCoast
private

Point on coast on which this landform sits (if any)

Definition at line 41 of file cell_landform.h.

Referenced by CRWCellLandform(), nGetPointOnCoast(), and SetPointOnCoast().

◆ m_nSubCategory

int CRWCellLandform::m_nSubCategory
private

Landform subcategory for this cell.

Definition at line 35 of file cell_landform.h.

Referenced by CRWCellLandform(), nGetLFSubCategory(), and SetLFSubCategory().

◆ [struct]

struct { ... } CRWCellLandform::m_sBeachData

◆ [struct]

struct { ... } CRWCellLandform::m_sCliffData

◆ [union]

union { ... } CRWCellLandform::m_uLFData

The m_uLFData will hold landform data: currently, only cliffs are considered.

Referenced by dGetCliffNotchBaseElev(), dGetCliffNotchDepth(), SetCliffNotchBaseElev(), SetCliffNotchDepth(), and SetCliffRemaining().

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