cell_sediment.h

Go to the documentation of this file.

 
#ifndef SEDIMENT_H
#define SEDIMENT_H
/*===============================================================================================================================
 
This file is part of CoastalME, the Coastal Modelling Environment.
 
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.
 
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.
 
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.
 
===============================================================================================================================*/
class CRWCellSediment
{
private:
   double m_dFine;

   double m_dNotchFineLost;

   double m_dSand;

   double m_dNotchSandLost;

   double m_dCoarse;

   double m_dNotchCoarseLost;

   double m_dFineSedimentInputThisIter;

   double m_dSandSedimentInputThisIter;

   double m_dCoarseSedimentInputThisIter;

   double m_dTotFineSedimentInput;

   double m_dTotSandSedimentInput;

   double m_dTotCoarseSedimentInput;
 
protected:
 
public:
   CRWCellSediment(void);
   CRWCellSediment(CRWCellSediment const&);           // Copy constructor defined explicitly, to stop cppcheck from complaining
 
   CRWCellSediment& operator= (const CRWCellSediment&);
 
   void SetFineDepth(double const);
   double dGetFineDepth(void) const;
   void AddFineDepth(double const);
 
   void SetSandDepth(double const);
   double dGetSandDepth(void) const;
   void AddSandDepth(double const);
 
   void SetCoarseDepth(double const);
   double dGetCoarseDepth(void) const;
   void AddCoarseDepth(double const);
 
   void SetNotchFineLost(double const);
   // void IncrNotchFineLost(double const);
   double dGetNotchFineLost(void) const;
 
   void SetNotchSandLost(double const);
   // void IncrNotchSandLost(double const);
   double dGetNotchSandLost(void) const;
 
   void SetNotchCoarseLost(double const);
   // void IncrNotchCoarseLost(double const);
   double dGetNotchCoarseLost(void) const;
 
   void AddFineSedimentInputDepth(double const);
   void AddSandSedimentInputDepth(double const);
   void AddCoarseSedimentInputDepth(double const);
   double dGetFineSedimentInputDepth(void) const;
   double dGetSandSedimentInputDepth(void) const;
   double dGetCoarseSedimentInputDepth(void) const;
   double dGetTotAllSedimentInputDepth(void) const;
   void InitThisIterSedimentInputAll(void);
};
#endif // SEDIMENT_H