CoastalME (Coastal Modelling Environment)
Simulates the long-term behaviour of complex coastlines
Loading...
Searching...
No Matches
sediment_input_event.h
Go to the documentation of this file.
1
14
15#ifndef CSEDINPUT_H
16#define CSEDINPUT_H
17/*===============================================================================================================================
18
19This file is part of CoastalME, the Coastal Modelling Environment.
20
21CoastalME 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
23This 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
25You 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===============================================================================================================================*/
29{
30private:
33
35 unsigned long m_ulEventTimeStep;
36
39
42
45
47 double m_dLen;
48
50 double m_dWidth;
51
52public:
53 CSedInputEvent(int const, unsigned long const, double const, double const, double const, double const, double const); //, double const);
54 ~CSedInputEvent(void);
55
56 int nGetLocationID(void) const;
57 unsigned long ulGetEventTimeStep(void) const;
58 double dGetFineSedVol(void) const;
59 double dGetSandSedVol(void) const;
60 double dGetCoarseSedVol(void) const;
61 double dGetLen(void) const;
62 double dGetWidth(void) const;
63 // double dGetThick(void);
64};
65#endif // CSEDINPUT_H
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.