cell_landform.cpp

Go to the documentation of this file.

 
/*===============================================================================================================================
 
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.
 
===============================================================================================================================*/
#include "cme.h"
#include "cell_landform.h"

CRWCellLandform::CRWCellLandform()
:  m_nCategory(LF_NONE),
   m_nSubCategory(LF_NONE),
   m_nCoast(-1),
   m_nPointOnCoast(-1),
   m_dAccumWaveEnergy(0)
{
}

CRWCellLandform::~CRWCellLandform(void)
{
}

void CRWCellLandform::SetLFCategory(int const nClassIn)
{
    m_nCategory = nClassIn;
}

int CRWCellLandform::nGetLFCategory(void) const
{
   return m_nCategory;
}

void CRWCellLandform::SetLFSubCategory(int const nClassIn)
{
   m_nSubCategory = nClassIn;
 
   if ((nClassIn == LF_SUBCAT_CLIFF_ON_COASTLINE) || (nClassIn == LF_SUBCAT_CLIFF_INLAND))
      m_nCategory = LF_CAT_CLIFF;
 
   else if ((nClassIn == LF_SUBCAT_DRIFT_TALUS) || (nClassIn == LF_SUBCAT_DRIFT_BEACH) || (nClassIn == LF_SUBCAT_DRIFT_MIXED))
      m_nCategory = LF_CAT_DRIFT;
}

int CRWCellLandform::nGetLFSubCategory(void) const
{
   return m_nSubCategory;
}

void CRWCellLandform::SetCoast(int const nCoastIn)
{
   m_nCoast = nCoastIn;
}

int CRWCellLandform::nGetCoast(void) const
{
   return m_nCoast;
}

void CRWCellLandform::SetPointOnCoast(int const nPointOnCoastIn)
{
   m_nPointOnCoast = nPointOnCoastIn;
}

int CRWCellLandform::nGetPointOnCoast(void) const
{
   return m_nPointOnCoast;
}

void CRWCellLandform::SetAccumWaveEnergy(double const dEnergyIn)
{
   m_dAccumWaveEnergy = dEnergyIn;
}

double CRWCellLandform::dGetAccumWaveEnergy(void) const
{
   return m_dAccumWaveEnergy;
}

void CRWCellLandform::SetCliffNotchBaseElev(double const dElevIn)
{
   m_uLFData.m_sCliffData.m_dNotchBaseElev = dElevIn;
}

double CRWCellLandform::dGetCliffNotchBaseElev(void) const
{
   return m_uLFData.m_sCliffData.m_dNotchBaseElev;
}

void CRWCellLandform::SetCliffNotchDepth(double const dLenIn)
{
   m_uLFData.m_sCliffData.m_dNotchDepth = dLenIn;
}

double CRWCellLandform::dGetCliffNotchDepth(void) const
{
   return m_uLFData.m_sCliffData.m_dNotchDepth;
}

void CRWCellLandform::SetCliffRemaining(double const dLenIn)
{
   m_uLFData.m_sCliffData.m_dRemaining = dLenIn;
}
 
// //! Get the cliff depth remaining on this cell
// double CRWCellLandform::dGetCliffRemaining(void) const
// {
//    return m_uLFData.m_sCliffData.m_dRemaining;
// }