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::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 dNotchIncisionIn, double const dNotchApexElevIn, double const dAccumWaveEnergyIn)
{
   m_bCliffHasCollapsed = false;
 
   pCoast = pCoastIn;
 
   m_nCoast = nCoast;
   m_nPointOnCoastline = nPointOnCoast;
   m_nCategory = LF_CLIFF_ON_COASTLINE;
 
   m_dMaxNotchIncision = dCellSide;
   m_dNotchIncision = dNotchIncisionIn;
   m_dNotchApexElev = dNotchApexElevIn;
   m_dTotAccumWaveEnergy = dAccumWaveEnergyIn;
}

CRWCliff::~CRWCliff(void)
{
}

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

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

double CRWCliff::dGetNotchApexElev(void) const
{
   return m_dNotchApexElev;
}

void CRWCliff::SetNotchApexElev(double const dNewElev)
{
   m_dNotchApexElev = dNewElev;
}

void CRWCliff::SetNotchIncision(double const dNewIncision)
{
   m_dNotchIncision = dNewIncision;
}

double CRWCliff::dGetNotchIncision(void) const
{
   return m_dNotchIncision;
}

void CRWCliff::IncreaseNotchIncision(double const dLenIn)
{
   m_dNotchIncision += dLenIn;
 
   // Constrain the notch incision, it cannot be greater than the max notch incision
   m_dNotchIncision = tMin(m_dNotchIncision, m_dMaxNotchIncision);
 
   // assert((m_dMaxNotchIncision - m_dNotchIncision) >=0);
}

bool CRWCliff::bReadyToCollapse(double const dThresholdNotchIncision) const
{
   if (m_dNotchIncision > dThresholdNotchIncision)
      return true;
   else
      return false;
}

void CRWCliff::Display(void)
{
}