ACRUSalinity.Processes.SaltInput
Class PReservoirSaltInput

java.lang.Object
  ACRU.Components.CNode
      ACRU.Processes.PProcess
          ACRUSalinity.Processes.SaltInput.PSaltInput
              ACRUSalinity.Processes.SaltInput.PReservoirSaltInput

All Implemented Interfaces:

ACRU.Interfaces.ISaltFlow

public class PReservoirSaltInput

extends PSaltInput

calculates the quantity of salt load added to a reservoir based on the volume of rain falling on the reservoir surface as well as its associated salinity.

Author:

Aynom Teweldebrhan

Field Summary

protected ACRU.Components.Climate.CClimate	m_CClimate
protected ACRU.Components.CDam	reservoir
protected ACRU.Components.CLandSegment	saltInflowLandSegment

Fields inherited from class ACRU.Processes.PProcess

CURRENT_DATE, END_SIMULATION_DATE, initialised, START_SIMULATION_DATE

Fields inherited from class ACRU.Components.CNode

Constructor Summary

PReservoirSaltInput(ACRU.Components.CComponent dam)
Constructor that requires a CDam type of CComponent as an argument.

PReservoirSaltInput(ACRU.Components.CDam dam)
Constructor that takes CDam object as an argument.

Method Summary

void	calcSaltInputs()
void	flowSalt() The method in which the salt flow behaviour is implemented .
private void	setRequiredData()

Methods inherited from class ACRUSalinity.Processes.SaltInput.PSaltInput

runProcess, transportSalt

Methods inherited from class ACRU.Processes.PProcess

initialise, isInitialised, setCurrentDate, setEndDate, setStartDate, toString

Methods inherited from class ACRU.Components.CNode

getNext, getNext, getNext, getNext, getNextCount, getNextCount, getNexts, getNexts, getTypeOfNexts, getTypeOfNexts, setNext, setNext, setNext, setNext, setNext, setNexts, setNexts, setNexts

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_CClimate

protected ACRU.Components.Climate.CClimate m_CClimate

saltInflowLandSegment

protected ACRU.Components.CLandSegment saltInflowLandSegment

reservoir

protected ACRU.Components.CDam reservoir

Constructor Detail

PReservoirSaltInput

public PReservoirSaltInput(ACRU.Components.CDam dam)

Constructor that takes CDam object as an argument.

Throws:

java.lang.Exception - Exceptions not dealt with internally.

PReservoirSaltInput

public PReservoirSaltInput(ACRU.Components.CComponent dam)
                    throws ACRU.Exceptions.EIllegalComponentTypeException,
                           ACRU.Exceptions.EException

Constructor that requires a CDam type of CComponent as an argument.

Throws:

java.lang.Exception - Exceptions not dealt with internally.

ACRU.Exceptions.EIllegalComponentTypeException - If the argument CComponent is not an instance of CLandSegment.

ACRU.Exceptions.EException

Method Detail

setRequiredData

private void setRequiredData()

flowSalt

public void flowSalt()
              throws java.lang.Exception,
                     ACRU.Exceptions.EException

Description copied from interface: ACRU.Interfaces.ISaltFlow

The method in which the salt flow behaviour is implemented .

Specified by:

flowSalt in interface ACRU.Interfaces.ISaltFlow

Specified by:

flowSalt in class PSaltInput

Throws:

java.lang.Exception

ACRU.Exceptions.EException

calcSaltInputs

public void calcSaltInputs()
                    throws java.lang.Exception,
                           ACRU.Exceptions.EException

Throws:

java.lang.Exception

ACRU.Exceptions.EException