CoastalME (Coastal Modelling Environment)
Simulates the long-term behaviour of complex coastlines
Loading...
Searching...
No Matches
cliff.h
Go to the documentation of this file.
1
12
13#ifndef CLIFF_H
14#define CLIFF_H
15/* ===============================================================================================================================
16 This file is part of CoastalME, the Coastal Modelling Environment.
17
18 CoastalME 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.
19
20 This 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.
21
22 You 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.
23===============================================================================================================================*/
24#include "coast.h"
25#include "coast_landform.h"
26
28{
29 private:
32
35
38
41
42 protected:
43 public:
44 CRWCliff(CRWCoast *, int const, int const, double const, double const, double const, double const);
45 ~CRWCliff(void) override;
46
47 void SetCliffCollapsed(void);
48 bool bHasCollapsed(void) const;
49
50 void SetNotchApexElev(double const);
51 double dGetNotchApexElev(void) const;
52 void SetNotchIncision(double const);
53 double dGetNotchIncision(void) const;
54 void IncreaseNotchIncision(double const);
55
56 bool bReadyToCollapse(double const) const;
57
58 void Display(void) override;
59};
60#endif // CLIFF_H
CACoastLandform(void)
Constructor with initialisation list.
bool bHasCollapsed(void) const
Returns the value of the cliff collapse switch.
Definition cliff.cpp:52
void SetNotchApexElev(double const)
Sets the elevation of the apex of the erosional notch (in external CRS units)
Definition cliff.cpp:70
double m_dMaxNotchIncision
The maximum horizontal incision (in external CRS units) of an erosional notch, this is equal to the g...
Definition cliff.h:34
double m_dNotchApexElev
Elevation (in external CRS units) of the apex of the notch (in CoastalME, the mid point between the t...
Definition cliff.h:40
double m_dNotchIncision
The horizontal depth (in external CRS units) of the erosional notch, measured inland from the side of...
Definition cliff.h:37
bool bReadyToCollapse(double const) const
Returns true if the horizontal incision of the erosional notch exceeds the critical notch incision.
Definition cliff.cpp:99
double dGetNotchIncision(void) const
Returns the horizontal incision (in external CRS units) of the cliff's erosional notch (the 'overhang...
Definition cliff.cpp:82
~CRWCliff(void) override
Destructor.
Definition cliff.cpp:47
void Display(void) override
Instantiates the pure virtual function in the abstract parent class, so that CRWCliff is not an abstr...
Definition cliff.cpp:108
CRWCliff(CRWCoast *, int const, int const, double const, double const, double const, double const)
Constructor with seven parameters and an initialization list.
Definition cliff.cpp:30
bool m_bCliffHasCollapsed
Switch to say whether the cliff has just collapsed, earlier in this timestep.
Definition cliff.h:31
void IncreaseNotchIncision(double const)
Increases the horizontal incision (in external CRS units) of the erosional notch, measured inland fro...
Definition cliff.cpp:88
void SetCliffCollapsed(void)
Flags the cliff as having collapsed.
Definition cliff.cpp:58
void SetNotchIncision(double const)
Sets the horizontal incision (in external CRS units) of the erosional notch, measured inland from the...
Definition cliff.cpp:76
double dGetNotchApexElev(void) const
Returns the elevation of the apex of the erosional notch (in external CRS units)
Definition cliff.cpp:64
Real-world class used to represent coastline objects.
Definition coast.h:39
Contains CRWCoast definitions.
Contains CACoastLandform definitions.