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_UNKNOWN),
      m_nCoast(-1),
      m_nPointOnCoastline(-1),
      m_dAccumWaveEnergy(0)
{
   m_uLFData.m_sCliffData.m_dNotchApexElev = DBL_NODATA;
   m_uLFData.m_sCliffData.m_dNotchIncision = DBL_NODATA;
#ifdef _DEBUG
   m_uLFData.m_sCliffData.m_ulCollapseTimestep = UNSIGNED_LONG_NODATA;
#endif
}

CRWCellLandform::~CRWCellLandform(void)
{
}

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

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

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

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

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

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

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

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

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

void CRWCellLandform::SetCliffNotchApexElev(double const dElevIn)
{
   m_uLFData.m_sCliffData.m_dNotchApexElev = dElevIn;
}

double CRWCellLandform::dGetCliffNotchApexElev(void) const
{
   return m_uLFData.m_sCliffData.m_dNotchApexElev;
}

void CRWCellLandform::SetCliffNotchIncisionDepth(double const dLenIn)
{
   m_uLFData.m_sCliffData.m_dNotchIncision = dLenIn;
}

void CRWCellLandform::AddToCliffNotchIncisionDepth(double const dLenIn)
{
   m_uLFData.m_sCliffData.m_dNotchIncision += dLenIn;
}

double CRWCellLandform::dGetCliffNotchIncisionDepth(void) const
{
   return m_uLFData.m_sCliffData.m_dNotchIncision;
}
 
// //! Set the cliff depth remaining on this cell
// void CRWCellLandform::SetCliffRemaining(double const dLenIn)
// {
//    m_uLFData.m_sCliffData.m_dRemaining = dLenIn;
// }
 
#ifdef _DEBUG
void CRWCellLandform::SetCliffCollapseTimestep(unsigned long const ulTimestep)
{
   m_uLFData.m_sCliffData.m_ulCollapseTimestep = ulTimestep;
}

unsigned long CRWCellLandform::ulGetCliffCollapseTimestep(void) const
{
   return m_uLFData.m_sCliffData.m_ulCollapseTimestep;
}
#endif