ACRUSalinity.Processes.ChannelSaltMovement
Class PCatchmentSalinity

java.lang.Object
  ACRU.Components.CNode
      ACRU.Processes.PProcess
          ACRUSalinity.Processes.ChannelSaltMovement.PChannelSaltMovement
              ACRUSalinity.Processes.ChannelSaltMovement.PCatchmentSalinity

All Implemented Interfaces:

ACRU.Interfaces.ISaltFlow

public class PCatchmentSalinity

extends PChannelSaltMovement

This process calculates the salt load and salinity of the water flowing out of a particular channe as done in PCalcOldAcruCELRUN for the hydrological component.

Version:

-

Author:

Aynom Teweldebrhan

Field Summary

protected ACRU.Components.CAdjunctImperviousArea	adjunctImperviousArea
protected ACRU.Components.CChannel	channel The channel for which outflow salinity and salt load are being calculated.
protected ACRU.Components.CReach	CReachOutflow The reach to which outflow salt load is being transported.
protected ACRU.Components.CDam	dam The dam, if one exists, that is associated with the land segment and the channel.
protected ACRU.Components.CDisjunctImperviousArea	disjunctImperviousArea
protected ACRU.Components.CLandSegment	inflowLandSegment The land segment contributing runoff and salt load to the channel.
protected ACRU.Components.CIrrigatedArea	irrigatedArea The irrigated area within the land segment, if one exists, contributing runoff and salt load to the channel.
protected ACRU.Components.CGroundwater	irrigGroundwater The groundwater subcomponent of the irrigated area, this contributes baseflow and salt load to the channel.
protected ACRU.Components.CGroundwater	landSegGroundwater The groundwater subcomponent of the land segment, this contributes baseflow and associated salt load to the channel.

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

PCatchmentSalinity(ACRU.Components.CChannel channel)
Constructor that takes a CChannel object as an argument.

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

Method Summary

void	calcCatchmentSalinity() Calculates the Salinity level and salt load of the flow leaving the catchment outlet
void	flowSalt() Calls the calcCatchmentSalinity() method.
private void	setRequiredData() Sets the DData objects required from the CComponent objects associated with this process.

Methods inherited from class ACRUSalinity.Processes.ChannelSaltMovement.PChannelSaltMovement

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

channel

protected ACRU.Components.CChannel channel

The channel for which outflow salinity and salt load are being calculated.

inflowLandSegment

protected ACRU.Components.CLandSegment inflowLandSegment

The land segment contributing runoff and salt load to the channel.

landSegGroundwater

protected ACRU.Components.CGroundwater landSegGroundwater

The groundwater subcomponent of the land segment, this contributes baseflow and associated salt load to the channel.

irrigatedArea

protected ACRU.Components.CIrrigatedArea irrigatedArea

The irrigated area within the land segment, if one exists, contributing runoff and salt load to the channel.

irrigGroundwater

protected ACRU.Components.CGroundwater irrigGroundwater

The groundwater subcomponent of the irrigated area, this contributes baseflow and salt load to the channel.

dam

protected ACRU.Components.CDam dam

The dam, if one exists, that is associated with the land segment and the channel.

CReachOutflow

protected ACRU.Components.CReach CReachOutflow

The reach to which outflow salt load is being transported.

adjunctImperviousArea

protected ACRU.Components.CAdjunctImperviousArea adjunctImperviousArea

disjunctImperviousArea

protected ACRU.Components.CDisjunctImperviousArea disjunctImperviousArea

Constructor Detail

PCatchmentSalinity

public PCatchmentSalinity(ACRU.Components.CChannel channel)
                   throws java.lang.Exception

Constructor that takes a CChannel object as an argument.

Parameters:

channel - The channel for which the salt load and outflow salinity are to be calculated.

Throws:

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

PCatchmentSalinity

public PCatchmentSalinity(ACRU.Components.CComponent component)
                   throws java.lang.Exception,
                          ACRU.Exceptions.EIllegalComponentTypeException

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

Parameters:

component - The channel for which the Salt load and outflow salinity are being calculated.

Throws:

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

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

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

Calls the calcCatchmentSalinity() method.

Specified by:

flowSalt in interface ACRU.Interfaces.ISaltFlow

Specified by:

flowSalt in class PChannelSaltMovement

Throws:

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

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

calcCatchmentSalinity

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

Calculates the Salinity level and salt load of the flow leaving the catchment outlet

Throws:

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

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