CoastalME (Coastal Modelling Environment)
Simulates the long-term behaviour of complex coastlines
Loading...
Searching...
No Matches
sediment_input_event.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 <assert.h>
25
26#include "cme.h"
28
30CSedInputEvent::CSedInputEvent(int const nIDIn, unsigned long const ulTimeStepIn, double const dFineIn, double const dSandIn, double const dCoarseIn, double const dLenIn, double const dWidthIn): //, double const dThickIn):
31 m_nLocationID(nIDIn),
32 m_ulEventTimeStep(ulTimeStepIn),
33 m_dFineSedVol(dFineIn),
34 m_dSandSedVol(dSandIn),
35 m_dCoarseSedVol(dCoarseIn),
36 m_dLen(dLenIn),
37 m_dWidth(dWidthIn)
38 // m_dThick(dThickIn)
39{
40}
41
46
49{
50 return m_nLocationID;
51}
52
54unsigned long CSedInputEvent::ulGetEventTimeStep(void) const
55{
56 return m_ulEventTimeStep;
57}
58
61{
62 return m_dFineSedVol;
63}
64
67{
68 return m_dSandSedVol;
69}
70
73{
74 return m_dCoarseSedVol;
75}
76
78double CSedInputEvent::dGetLen(void) const
79{
80 return m_dLen;
81}
82
84double CSedInputEvent::dGetWidth(void) const
85{
86 return m_dWidth;
87}
88
89// double CSedInputEvent::dGetThick(void)
90// {
91// return m_dThick;
92// }
93
double dGetFineSedVol(void) const
Returns the volume of fine sediment in the sediment input event.
unsigned long ulGetEventTimeStep(void) const
Returns the timestep of the sediment input event.
int m_nLocationID
The location ID in the shapefile.
unsigned long m_ulEventTimeStep
The timing of the sediment input event.
CSedInputEvent(int const, unsigned long const, double const, double const, double const, double const, double const)
Constructor with eight parameters and an initialization list.
double dGetLen(void) const
Returns the length (in metres?) of the sediment input event.
double m_dLen
The coast-normal length (m) of the sediment block.
double dGetCoarseSedVol(void) const
Returns the volume of coarse sediment in the sediment input event.
int nGetLocationID(void) const
Returns the location ID.
double dGetWidth(void) const
Returns the width (in metres?) of the sediment input event.
double dGetSandSedVol(void) const
Returns the volume of sand sediment in the sediment input event.
~CSedInputEvent(void)
Destructor.
double m_dSandSedVol
The volume (m3) of sand sediment in the sediment input event.
double m_dFineSedVol
The volume (m3) of fine sediment in the sediment input event.
double m_dCoarseSedVol
The volume (m3) of coarse sediment in the sediment input event.
double m_dWidth
The along-coast width (m) of the sediment block.
This file contains global definitions for CoastalME.
Contains CSedInputEvent definitions.