cliff.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 <assert.h>
 
#include <iostream>
// using std::cout;
// using std::cerr;
// using std::endl;
using std::ios;
 
#include "cme.h"
#include "cliff.h"
#include "coast.h"

CRWCliff::CRWCliff(CRWCoast* pCoastIn, int const nCoast, int const nPointOnCoast, double const dCellSide, double const dNotchDepthIn, double const dNotchElevIn, double const dAccumWaveEnergyIn)
{
   m_bCliffHasCollapsed = false;
 
   pCoast = pCoastIn;
 
   m_nCoast = nCoast;
   m_nPointOnCoast = nPointOnCoast;
   m_nCategory = LF_CAT_CLIFF;
 
   m_dMaxDepth = dCellSide;
   m_dNotchDepth = dNotchDepthIn;
   m_dNotchBaseElev = dNotchElevIn;
   m_dTotAccumWaveEnergy = dAccumWaveEnergyIn;
   // assert(m_dRemaining >=0);
}

CRWCliff::~CRWCliff(void)
{
}

bool CRWCliff::bHasCollapsed(void) const
{
   return m_bCliffHasCollapsed;
}

void CRWCliff::SetCliffCollapsed(void)
{
   m_bCliffHasCollapsed = true;
}

double CRWCliff::dGetNotchBaseElev(void) const
{
   return m_dNotchBaseElev;
}

void CRWCliff::SetNotchBaseElev(double const dNewElev)
{
   m_dNotchBaseElev = dNewElev;
}

double CRWCliff::dGetRemaining(void) const
{
   return (m_dMaxDepth - m_dNotchDepth);
}
 
// //! Sets the horizontal depth of the cliff's erosional notch
// void CRWCliff::SetNotchDepth(double const dLenIn)
// {
// m_dNotchDepth = dLenIn;
// }

double CRWCliff::dGetNotchDepth(void) const
{
   return m_dNotchDepth;
}

bool CRWCliff::bReadyToCollapse(double const dThresholdNotchDepth) const
{
   if (m_dNotchDepth >= dThresholdNotchDepth)
      return true;
 
   else
      return false;
}

void CRWCliff::DeepenErosionalNotch(double const dLenIn)
{
   m_dNotchDepth += dLenIn;
 
   // Constrain the notch depth, it cannot be greater than the max notch depth
   m_dNotchDepth = tMin(m_dNotchDepth, m_dMaxDepth);
 
   // assert((m_dMaxDepth - m_dNotchDepth) >=0);
}

void CRWCliff::Display(void)
{
}