ACRUSalinity.Processes.SurfaceSaltMovement
Class PIrrigAreaSaltMovement

java.lang.Object
  ACRU.Components.CNode
      ACRU.Processes.PProcess
          ACRUSalinity.Processes.SurfaceSaltMovement.PSurfaceSaltMovement
              ACRUSalinity.Processes.SurfaceSaltMovement.PIrrigAreaSaltMovement

All Implemented Interfaces:

ACRU.Interfaces.ISaltFlow

public class PIrrigAreaSaltMovement

extends PSurfaceSaltMovement

This process is responsible to transport salt carried along with the runoff water from an irrigated area to either a reservoir or an out let of the catchment depending on the location of the reservoir if one exists.

Author:

Aynom Teweldebrhan

Field Summary

protected ACRU.Components.CGroundwater	groundwaterStore The groundwater store of the irrigated area.
protected ACRU.Components.CIrrigatedArea	irrigatedArea The irrigated area from which salt load is to be distributed.
protected ACRU.Components.CComponent	outflowComponent The component receiving outflowing water and salt load from the irrigated area.

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

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

PIrrigAreaSaltMovement(ACRU.Components.CIrrigatedArea irrigatedArea)
Constructor that takes a CIrrigatedArea object as an argument.

Method Summary

void	flowSalt() Distributes salt load from an irrigated area to the appropriate outflow components as specified in the model input.
private void	setRequiredData() Sets the DData objects required from the CComponent objects associated with this process.

Methods inherited from class ACRUSalinity.Processes.SurfaceSaltMovement.PSurfaceSaltMovement

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

irrigatedArea

protected ACRU.Components.CIrrigatedArea irrigatedArea

The irrigated area from which salt load is to be distributed.

groundwaterStore

protected ACRU.Components.CGroundwater groundwaterStore

The groundwater store of the irrigated area.

outflowComponent

protected ACRU.Components.CComponent outflowComponent

The component receiving outflowing water and salt load from the irrigated area.

Constructor Detail

PIrrigAreaSaltMovement

public PIrrigAreaSaltMovement(ACRU.Components.CIrrigatedArea irrigatedArea)
                       throws ACRU.Exceptions.EException

Constructor that takes a CIrrigatedArea object as an argument.

Parameters:

irrigatedArea - The irrigated area from which salt load is to be allocated.

Throws:

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

PIrrigAreaSaltMovement

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

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

Parameters:

component - The irrigated area from which flow and salt load is to be distributed.

Throws:

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

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

Method Detail

setRequiredData

private void setRequiredData()

Sets the DData objects required from the CComponent objects associated with this process.

flowSalt

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

Distributes salt load from an irrigated area to the appropriate outflow components as specified in the model input.

Specified by:

flowSalt in interface ACRU.Interfaces.ISaltFlow

Specified by:

flowSalt in class PSurfaceSaltMovement

Throws:

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

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