cell_sediment.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 "cell_sediment.h"

CRWCellSediment::CRWCellSediment(void)
    : m_dFine(0),
      m_dNotchFineLost(0),
      m_dSand(0),
      m_dNotchSandLost(0),
      m_dCoarse(0),
      m_dNotchCoarseLost(0),
      m_dFineSedimentInputThisIter(0),
      m_dSandSedimentInputThisIter(0),
      m_dCoarseSedimentInputThisIter(0),
      m_dTotFineSedimentInput(0),
      m_dTotSandSedimentInput(0),
      m_dTotCoarseSedimentInput(0)
{
}

CRWCellSediment::CRWCellSediment(CRWCellSediment const &OtherSediment)
{
   m_dFine = OtherSediment.m_dFine;
   m_dNotchFineLost = OtherSediment.m_dNotchFineLost;
   m_dSand = OtherSediment.m_dSand;
   m_dNotchSandLost = OtherSediment.m_dNotchSandLost;
   m_dCoarse = OtherSediment.m_dCoarse;
   m_dNotchCoarseLost = OtherSediment.m_dNotchCoarseLost;
   m_dFineSedimentInputThisIter = OtherSediment.m_dFineSedimentInputThisIter;
   m_dSandSedimentInputThisIter = OtherSediment.m_dSandSedimentInputThisIter;
   m_dCoarseSedimentInputThisIter = OtherSediment.m_dCoarseSedimentInputThisIter;
   m_dTotFineSedimentInput = OtherSediment.m_dTotFineSedimentInput;
   m_dTotSandSedimentInput = OtherSediment.m_dTotSandSedimentInput;
   m_dTotCoarseSedimentInput = OtherSediment.m_dTotCoarseSedimentInput;
}

CRWCellSediment &CRWCellSediment::operator=(const CRWCellSediment &OtherSediment)
{
   // This copies all fields from one object to another
   m_dFine = OtherSediment.m_dFine;
   m_dNotchFineLost = OtherSediment.m_dNotchFineLost;
   m_dSand = OtherSediment.m_dSand;
   m_dNotchSandLost = OtherSediment.m_dNotchSandLost;
   m_dCoarse = OtherSediment.m_dCoarse;
   m_dNotchCoarseLost = OtherSediment.m_dNotchCoarseLost;
   m_dFineSedimentInputThisIter = OtherSediment.m_dFineSedimentInputThisIter;
   m_dSandSedimentInputThisIter = OtherSediment.m_dSandSedimentInputThisIter;
   m_dCoarseSedimentInputThisIter = OtherSediment.m_dCoarseSedimentInputThisIter;
   m_dTotFineSedimentInput = OtherSediment.m_dTotFineSedimentInput;
   m_dTotSandSedimentInput = OtherSediment.m_dTotSandSedimentInput;
   m_dTotCoarseSedimentInput = OtherSediment.m_dTotCoarseSedimentInput;
   return (*this);
}

void CRWCellSediment::SetFineDepth(double const dNewSedDepth)
{
   m_dFine = dNewSedDepth;
}

double CRWCellSediment::dGetFineDepth(void) const
{
   return m_dFine;
}
 
// //! Adds fine sediment (depth equivalent) to this sediment layer object's fine sediment
// void CRWCellSediment::AddFineDepth(double const dSedDepthToAdd)
// {
//    m_dFine += dSedDepthToAdd;
// }

void CRWCellSediment::SetSandDepth(double const dNewSedDepth)
{
   m_dSand = dNewSedDepth;
   // assert(m_dSand >= 0);
}

double CRWCellSediment::dGetSandDepth(void) const
{
   return m_dSand;
}

void CRWCellSediment::AddSandDepth(double const dSedDepthToAdd)
{
   m_dSand += dSedDepthToAdd;
}

void CRWCellSediment::SetCoarseDepth(double const dNewSedDepth)
{
   m_dCoarse = dNewSedDepth;
}

double CRWCellSediment::dGetCoarseDepth(void) const
{
   return m_dCoarse;
}

void CRWCellSediment::AddCoarseDepth(double const dSedDepthToAdd)
{
   m_dCoarse += dSedDepthToAdd;
}

void CRWCellSediment::SetNotchFineLost(double const dDepthIn)
{
   m_dNotchFineLost = dDepthIn;
}
 
// //! Increments the depth equivalent of fine sediment lost by notch incision
// void CRWCellSediment::IncrNotchFineLost(double const dDepthIn)
// {
// m_dNotchFineLost += dDepthIn;
// //    assert(m_dNotchFineLost <= m_dFine);
// }

double CRWCellSediment::dGetNotchFineLost(void) const
{
   return m_dNotchFineLost;
}

void CRWCellSediment::SetNotchSandLost(double const dDepthIn)
{
   m_dNotchSandLost = dDepthIn;
}
 
// //! Increments the depth equivalent of sand sediment lost by notch incision
// void CRWCellSediment::IncrNotchSandLost(double const dDepthIn)
// {
// m_dNotchSandLost += dDepthIn;
// //    assert(m_dNotchSandLost <= m_dSand);
// }

double CRWCellSediment::dGetNotchSandLost(void) const
{
   return m_dNotchSandLost;
}

void CRWCellSediment::SetNotchCoarseLost(double const dDepthIn)
{
   m_dNotchCoarseLost = dDepthIn;
}
 
// //! Increments the depth equivalent of coarse sediment lost by notch incision
// void CRWCellSediment::IncrNotchCoarseLost(double const dDepthIn)
// {
// m_dNotchCoarseLost += dDepthIn;
// //    assert(m_dNotchCoarseLost <= m_dCoarse);
// }

double CRWCellSediment::dGetNotchCoarseLost(void) const
{
   return m_dNotchCoarseLost;
}

void CRWCellSediment::AddFineSedimentInputDepth(double const dDepth)
{
   m_dFine += dDepth;
 
   m_dFineSedimentInputThisIter += dDepth;
   m_dTotFineSedimentInput += dDepth;
}

void CRWCellSediment::AddSandSedimentInputDepth(double const dDepth)
{
   m_dSand += dDepth;
 
   m_dSandSedimentInputThisIter += dDepth;
   m_dTotSandSedimentInput += dDepth;
}

void CRWCellSediment::AddCoarseSedimentInputDepth(double const dDepth)
{
   m_dCoarse += dDepth;
 
   m_dCoarseSedimentInputThisIter += dDepth;
   m_dTotCoarseSedimentInput += dDepth;
}

double CRWCellSediment::dGetFineSedimentInputDepth(void) const
{
   return m_dFineSedimentInputThisIter;
}

double CRWCellSediment::dGetSandSedimentInputDepth(void) const
{
   return m_dSandSedimentInputThisIter;
}

double CRWCellSediment::dGetCoarseSedimentInputDepth(void) const
{
   return m_dCoarseSedimentInputThisIter;
}

double CRWCellSediment::dGetTotAllSedimentInputDepth(void) const
{
   return m_dTotFineSedimentInput + m_dTotSandSedimentInput + m_dTotCoarseSedimentInput;
}

void CRWCellSediment::InitThisIterSedimentInputAll(void)
{
   m_dFineSedimentInputThisIter = 0;
   m_dSandSedimentInputThisIter = 0;
   m_dCoarseSedimentInputThisIter = 0;
}