CoastalME (Coastal Modelling Environment)
Simulates the long-term behaviour of complex coastlines
Loading...
Searching...
No Matches
cell_layer.h
Go to the documentation of this file.
1
12
13#ifndef CELL_LAYER_H
14#define CELL_LAYER_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 "cell_sediment.h"
25#include "cell_talus.h"
26
28{
29 private:
30 // double m_VdolSedFraction;
31 // double m_dMechResistance;
32 // double m_dConsolidationStatus;
33
36
39
42
43 protected:
44 public:
45 CRWCellLayer(void);
46 ~CRWCellLayer(void);
47
50
51 bool bHasUncons(void);
52 double dGetUnconsFineDepth(void) const;
53 double dGetConsFineDepth(void) const;
54 double dGetUnconsSandDepth(void) const;
55 double dGetConsSandDepth(void) const;
56 double dGetUnconsCoarseDepth(void) const;
57 double dGetConsCoarseDepth(void) const;
58
59 double dGetAllUnconsDepth(void) const;
60 double dGetAllConsDepth(void) const;
61 double dGetTotalThickness(void) const;
62
63 // double dGetNotchUnconsolidatedLost(void) const;
64 // double dGetNotchConsolidatedLost(void) const;
65
66 // double dGetVolSedFraction(void) const;
67 void SetVolSedFraction(double const);
68 // double dGetMechResistance(void) const;
69 // void SetMechResistance(double const);
70 // double dGetConsolidationStatus(void) const;
71 // void SetConsolidationStatus(double const);
72
73 bool bHasTalus(void);
74 CRWCellTalus* pGetTalus(void) const;
76 void DeleteTalus(void);
77};
78#endif // CELL_LAYER_H
Contains CRWCellSediment definitions.
CRWCellTalus * pGetTalus(void) const
Returns a pointer to the layer's talus object, or NULL if there is no talus object.
CRWCellSediment m_ConsolidatedSediment
This cell's consolidated sediment object.
Definition cell_layer.h:38
double dGetConsSandDepth(void) const
Returns the thickness of this cell's sand consolidated sediment.
bool bHasTalus(void)
Returns true if the layer has talus, false otherwise.
double dGetUnconsCoarseDepth(void) const
Returns the thickness of this cell's coarse unconsolidated sediment.
CRWCellSediment m_UnconsolidatedSediment
This cell's unconsolidated sediment object.
Definition cell_layer.h:35
CRWCellSediment * pGetConsolidatedSediment(void)
Returns a pointer to the cell's consolidated sediment object.
~CRWCellLayer(void)
Destructor.
void DeleteTalus(void)
double dGetUnconsFineDepth(void) const
Returns the thickness of this cell's fine unconsolidated sediment.
CRWCellLayer(void)
Constructor.
double dGetConsCoarseDepth(void) const
Returns the thickness of this cell's coarse consolidated sediment.
CRWCellSediment * pGetUnconsolidatedSediment(void)
Returns a pointer to the cell's unconsolidated sediment object.
CRWCellTalus * pGetOrCreateTalus(void)
Returns a pointer to the layer's talus object. If there is no talus object, then create one.
double dGetAllConsDepth(void) const
Returns the thickness of this cell's consolidated sediment (total for all size classes)
double dGetTotalThickness(void) const
Returns the thickness of this cell's sediment (total for all size classes, both consolidated and unco...
void SetVolSedFraction(double const)
double dGetConsFineDepth(void) const
Returns the thickness of this cell's fine consolidated sediment.
double dGetAllUnconsDepth(void) const
Returns the thickness of this cell's unconsolidated sediment (total for all size classes)
bool bHasUncons(void)
Return true if the layer has unconsolidated sediment, false otherwise.
CRWCellTalus * m_pTalus
Pointer to this cell layer's talus (unconsolidated sediment derived from cliff collapse),...
Definition cell_layer.h:41
double dGetUnconsSandDepth(void) const
Returns the thickness of this cell's sand unconsolidated sediment.
Real-world class used to represent the sediment (either consolidated or unconsolidated) associated wi...
Real-world class used to represent the talus (unconsolidated sediment resulting from cliff collapse) ...
Definition cell_talus.h:25