ACRUSalinity.Processes.SurfaceSaltMovement
Class PSaltTransport

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

All Implemented Interfaces:

ACRU.Interfaces.ISaltFlow

public abstract class PSaltTransport

extends PSurfaceSaltMovement

This class assists during transport of salt from one sub-component to another in subsurface TDS balance computations.

Field Summary

(package private) double

currentStorage

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

PSaltTransport()
The default constructor.

Method Summary

protected void	subtractFromCurrentStorage(double value)
void	transportSalt(java.lang.Class saltFluxRecordClass, ACRU.Components.CComponent saltSource, double quantity, ACRU.Components.CComponent saltDestination) Transfer specified quantity of salt from storage in saltSource to be stored in saltDestination.

Methods inherited from class ACRUSalinity.Processes.SurfaceSaltMovement.PSurfaceSaltMovement

flowSalt, runProcess

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

currentStorage

double currentStorage

Constructor Detail

PSaltTransport

public PSaltTransport()

The default constructor.

Method Detail

transportSalt

public void transportSalt(java.lang.Class saltFluxRecordClass,
                          ACRU.Components.CComponent saltSource,
                          double quantity,
                          ACRU.Components.CComponent saltDestination)
                   throws java.lang.Exception,
                          ACRU.Exceptions.EException,
                          ACRU.Exceptions.ENullFoundException

Transfer specified quantity of salt from storage in saltSource to be stored in saltDestination.

Overrides:

transportSalt in class PSurfaceSaltMovement

Parameters:

saltFluxRecordClass - The salt flux record class specifying the form of salt to be transported.

saltSource - The source component of the salt to be transported.

quantity - The amount of salt to be transported.

saltDestination - The destination component of the nutrient to be transported.

Throws:

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

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

ACRU.Exceptions.ENullFoundException - If the salt source or destination component cannot be found.

subtractFromCurrentStorage

protected void subtractFromCurrentStorage(double value)
                                   throws ACRU.Exceptions.EException

Throws:

ACRU.Exceptions.EException