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
14
15#ifndef CLIFF_H
16#define CLIFF_H
17/* ===============================================================================================================================
18
19 This file is part of CoastalME, the Coastal Modelling Environment.
20
21 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.
22
23 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.
24
25 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.
26
27===============================================================================================================================*/
28
29#include "coast.h"
30#include "coast_landform.h"
31
33{
34 private:
37
40
43
46
47 protected:
48 public:
49 CRWCliff(CRWCoast *, int const, int const, double const, double const, double const, double const);
50 ~CRWCliff(void) override;
51
52 void SetCliffCollapsed(void);
53 bool bHasCollapsed(void) const;
54
55 void SetNotchBaseElev(double const);
56 double dGetNotchBaseElev(void) const;
57 double dGetRemaining(void) const;
58 // void SetNotchDepth(double const);
59 double dGetNotchDepth(void) const;
60
61 bool bReadyToCollapse(double const) const;
62 void DeepenErosionalNotch(double const);
63
64 void Display(void) override;
65};
66#endif // CLIFF_H
CACoastLandform(void)
Constructor with initialization list.
bool bHasCollapsed(void) const
Returns the value of the cliff collapse switch.
Definition cliff.cpp:60
bool bReadyToCollapse(double const) const
Returns true if the horizontal depth of the erosional notch exceeds the critical notch overhang.
Definition cliff.cpp:102
double m_dNotchDepth
The horizontal depth (in external CRS units) of the erosional notch, measured inland from the side of...
Definition cliff.h:42
~CRWCliff(void) override
Destructor.
Definition cliff.cpp:55
void Display(void) override
Instantiates the pure virtual function in the abstract parent class, so that CRWCliff is not an abstr...
Definition cliff.cpp:123
void DeepenErosionalNotch(double const)
Increases the XY-plane length (in external CRS units) of the erosional notch, measured inland from th...
Definition cliff.cpp:112
CRWCliff(CRWCoast *, int const, int const, double const, double const, double const, double const)
Constructor with seven parameters and an intialization list.
Definition cliff.cpp:37
double dGetNotchBaseElev(void) const
Returns the elevation of the base of the erosional notch.
Definition cliff.cpp:72
double m_dMaxDepth
The maximum depth (in external CRS units) of an erosional notch, this is equal to the grid's m_dCellS...
Definition cliff.h:39
double m_dNotchBaseElev
Z-plane elevation (in external CRS units) of the base of the erosional notch. The notch is assumed to...
Definition cliff.h:45
void SetNotchBaseElev(double const)
Sets the elevation of the base of the erosional notch.
Definition cliff.cpp:78
bool m_bCliffHasCollapsed
Switch to say whether the cliff has just collapsed, earlier in this timestep.
Definition cliff.h:36
double dGetNotchDepth(void) const
Returns the horizontal depth of the cliff's erosional notch (the 'overhang')
Definition cliff.cpp:96
void SetCliffCollapsed(void)
Flags the cliff as having collapsed.
Definition cliff.cpp:66
double dGetRemaining(void) const
Returns the length (in external CRS units) of the cliff's remaining sediment 'behind' the erosional n...
Definition cliff.cpp:84
Real-world class used to represent coastline objects.
Definition coast.h:43
Contains CRWCoast definitions.
Contains CACoastLandform definitions.