CoastalME (Coastal Modelling Environment)
Simulates the long-term behaviour of complex coastlines
Loading...
Searching...
No Matches
cell_talus.h
Go to the documentation of this file.
1
12
13#ifndef TALUS_H
14#define TALUS_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===============================================================================================================================*/
25{
26 private:
28 double m_dSand;
29
31 double m_dCoarse;
32
35
38
41
44
47
50
53
56
57 protected:
58 public:
59 CRWCellTalus(void);
60
61 void SetSandDepth(double const);
62 double dGetSandDepth(void) const;
63 void AddSandDepth(double const);
64
65 void SetCoarseDepth(double const);
66 double dGetCoarseDepth(void) const;
67 void AddCoarseDepth(double const);
68
69 double dGetSandAddedThisIter(void) const;
70 double dGetTotSandAdded(void) const;
71 double dGetSandLostThisIter(void) const;
72 double dGetTotSandLost(void) const;
73
74 double dGetCoarseAddedThisIter(void) const;
75 double dGetTotCoarseAdded(void) const;
76 double dGetCoarseLostThisIter(void) const;
77 double dGetTotCoarseLost(void) const;
78};
79#endif // TALUS_H
CRWCellTalus(void)
CRWCellTalus constructor with initialisation list.
double dGetTotCoarseLost(void) const
Returns the value for total coarse talus lost.
double m_dCoarse
Current depth equivalent of talus coarse sediment in m.
Definition cell_talus.h:31
double m_dCoarseInputThisIter
Depth equivalent (m) of talus coarse sediment added this iteration.
Definition cell_talus.h:43
double m_dCoarseLostThisIter
Depth equivalent (m) of talus coarse sediment lost this iteration.
Definition cell_talus.h:37
double dGetSandLostThisIter(void) const
Returns the value for sand talus lost during this iteration.
double dGetCoarseDepth(void) const
Returns the coarse sediment depth equivalent for this talus object object.
double m_dSand
Current depth equivalent of talus sand sediment in m.
Definition cell_talus.h:28
double dGetTotCoarseAdded(void) const
Returns the value for total coarse talus added.
double dGetCoarseAddedThisIter(void) const
Returns the value for coarse talus added during this iteration.
double dGetSandAddedThisIter(void) const
Returns the value for sand talus added during this iteration.
double dGetTotSandLost(void) const
Returns the value for total sand talus lost.
double m_dTotCoarseInput
Depth equivalent (m) of talus coarse sediment added since start of simulation.
Definition cell_talus.h:49
double m_dTotSandInput
Depth equivalent (m) of talus sand sediment added since start of simulation.
Definition cell_talus.h:46
double dGetSandDepth(void) const
Returns the sand sediment depth equivalent for this talus object.
double m_dTotSandLost
Depth equivalent (m) of talus sand sediment lost since start of simulation.
Definition cell_talus.h:52
double dGetCoarseLostThisIter(void) const
Returns the value for coarse talus lost during this iteration.
double m_dSandLostThisIter
Depth equivalent (m) of talus sand sediment lost this iteration.
Definition cell_talus.h:34
void AddCoarseDepth(double const)
Adds coarse sediment (depth equivalent) to this talus object object's coarse sediment.
void SetSandDepth(double const)
Sets this talus object's sand sediment depth equivalent. Note no checks here to see if new equiv dept...
double m_dTotCoarseLost
Depth equivalent (m) of talus coarse sediment lost since start of simulation.
Definition cell_talus.h:55
double dGetTotSandAdded(void) const
Returns the value for total sand talus added.
void SetCoarseDepth(double const)
Sets this talus object object's coarse sediment depth equivalent. Note no checks here to see if new e...
void AddSandDepth(double const)
Adds sand sediment (depth equivalent) to this talus object object's sand sediment.
double m_dSandInputThisIter
Depth equivalent (m) of talus sand sediment added this iteration.
Definition cell_talus.h:40