ACRUSalinity.Processes.InitialiseSaltLoad
Class PInitialiseReservoirSaltLoad

java.lang.Object
  ACRU.Components.CNode
      ACRU.Processes.PProcess
          ACRUSalinity.Processes.InitialiseSaltLoad.PInitialiseSaltLoad
              ACRUSalinity.Processes.InitialiseSaltLoad.PInitialiseReservoirSaltLoad

All Implemented Interfaces:

ACRU.Interfaces.ISaltFlow

public class PInitialiseReservoirSaltLoad

extends PInitialiseSaltLoad

This process determines the initial salt load stored in a reservoir when the simulation comences.

Author:

Aynom Teweldebrhan

Field Summary

(package private) int	currentDate
protected ACRU.Components.CDam	reservoir
protected ACRU.Components.CLandSegment	saltInflowLandSegment
protected static int	startDay
protected static int	startMonth
protected static int	startYear

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

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

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

Method Summary

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

Methods inherited from class ACRUSalinity.Processes.InitialiseSaltLoad.PInitialiseSaltLoad

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

saltInflowLandSegment

protected ACRU.Components.CLandSegment saltInflowLandSegment

reservoir

protected ACRU.Components.CDam reservoir

startDay

protected static int startDay

startMonth

protected static int startMonth

startYear

protected static int startYear

currentDate

int currentDate

Constructor Detail

PInitialiseReservoirSaltLoad

public PInitialiseReservoirSaltLoad(ACRU.Components.CDam dam)
                             throws java.lang.Exception

Constructor that takes a CDam object as an argument.

Throws:

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

PInitialiseReservoirSaltLoad

public PInitialiseReservoirSaltLoad(ACRU.Components.CComponent component)
                             throws ACRU.Exceptions.EException,
                                    ACRU.Exceptions.EIllegalComponentTypeException

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

Throws:

ACRU.Exceptions.EException - EExceptions not dealt with internally.

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

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 PInitialiseSaltLoad

Throws:

java.lang.Exception

ACRU.Exceptions.EException

initialiseSaltFluxRecord

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

Throws:

java.lang.Exception

ACRU.Exceptions.EException

getCurrentDate

public int getCurrentDate()