CoastalME (Coastal Modelling Environment)
Simulates the long-term behaviour of complex coastlines
Loading...
Searching...
No Matches
coast_landform.cpp
Go to the documentation of this file.
1
12
13/*===============================================================================================================================
14
15This file is part of CoastalME, the Coastal Modelling Environment.
16
17CoastalME is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
18
19This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
20
21You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22
23===============================================================================================================================*/
24#include "cme.h"
25#include "coast_landform.h"
26
36
41
44{
45 return m_nCoast;
46}
47
50{
51 return m_nPointOnCoast;
52}
53
54// void CACoastLandform::SetLandFormCategory(int const nCategoryIn)
55// {
56// m_nCategory = nCategoryIn;
57// }
58
61{
62 return m_nCategory;
63}
64
67{
68 return pCoast->pPtiGetCellMarkedAsCoastline(m_nPointOnCoast);
69}
70
71// void CACoastLandform::SetTotAccumWaveEnergy(double const dWaveEnergy)
72// {
73// m_dTotAccumWaveEnergy = dWaveEnergy;
74// }
75
77void CACoastLandform::IncTotAccumWaveEnergy(double const dWaveEnergy)
78{
79 m_dTotAccumWaveEnergy += dWaveEnergy;
80}
81
int m_nPointOnCoast
The point on the coast on which this coast landform sits.
CRWCoast * pCoast
Pointer to this landform's coast.
int nGetCoast(void) const
Get the number of the coast on which this coast landform sits.
double dGetTotAccumWaveEnergy(void) const
Get total accumulated wave energy.
int nGetPointOnCoast(void) const
Get the point on the coast on which this coast landform sits.
virtual ~CACoastLandform(void)
Destructor.
int m_nCategory
Landform category code.
int m_nCoast
The coast number on which this coast landform sits.
double m_dTotAccumWaveEnergy
Total accumulated wave energy since beginning of simulation.
CACoastLandform(void)
Constructor with initialization list.
int nGetLandFormCategory(void) const
Get the landform category.
void IncTotAccumWaveEnergy(double const)
Increment total accumulated wave energy.
CGeom2DIPoint * pPtiGetCellMarkedAsLF(void) const
Get the grid coordinates of the cell on which this coast landform sits.
Geometry class used to represent 2D point objects with integer coordinates.
Definition 2di_point.h:29
This file contains global definitions for CoastalME.
int const LF_NONE
Definition cme.h:418
Contains CACoastLandform definitions.