Package hec.rss.model

Class MuskingumCunge8ptRouting

java.lang.Object
java.util.Observable
hec.lang.NamedType
hec.rss.model.RssTSLocationObject
hec.rss.model.Function
hec.rss.model.Routing
hec.rss.model.MuskingumCunge8ptRouting
All Implemented Interfaces:
AsciiSerializable, FieldAccessor, TSLocation, AltInputReportInfc, RssModelVariableConstants, RssReturnStatusConstants, RssTSLocation, Serializable, Cloneable, Comparable, Observer, rma.lang.Modifiable
public class MuskingumCunge8ptRouting extends Routing
See Also:

  • Constructor Details

    • MuskingumCunge8ptRouting

      public MuskingumCunge8ptRouting()

    • MuskingumCunge8ptRouting

      public MuskingumCunge8ptRouting(Element elem)

  • Method Details

    • clone

      public Object clone()
      Description copied from class: Function
      clone method
      Overrides:
      clone in class Function

    • computeRouting

      public int computeRouting(RunTimeStep rts)
      Deprecated.
      12/04
      old method relying on native code - no longer used
      Overrides:
      computeRouting in class Routing
      Parameters:
      rts -
      Returns:

    • getForecastEquation

      public boolean getForecastEquation(RunTime runtime)
      Deprecated.
      12/04
      old method relying on native code - no longer used
      Overrides:
      getForecastEquation in class Function
      Parameters:
      runtime -
      Returns:

    • initialize

      public boolean initialize()
      Description copied from class: Routing
      initialize prior to a compute
      Overrides:
      initialize in class Routing

    • readData

      public boolean readData(BufferedReader input)
      Retrieves the MuskingumCunge8ptRouting data from the specified BufferedReader. This method is called by Element.readData after encountering an Element Function line type with parameter of MuskingumCunge8ptRouting. Control of the file processing is passed back to the Element object once an Element MuskingumCunge8ptRouting End line type is found or if "Element MuskingumCunge8ptRouting" is not contained in the line type. The later case is an error condition.

      The data stream must have type=param formatting. The following types and parameters are defined.

      Element MuskingumCunge8ptRouting Name= (String) name of the function
      Element MuskingumCunge8ptRouting channelLength= (double) channel length
      Element MuskingumCunge8ptRouting channelSlope= (double) channel slope
      Element MuskingumCunge8ptRouting xsDistance= (double) horizontal distance for each point of cross section
      Element MuskingumCunge8ptRouting xsElevation= (double) verticalal distance for each point of cross section
      Element MuskingumCunge8ptRouting xsManningsN= (double) Manning's n for (1)left overbank (2)main channel (3)right overbank
      Element MuskingumCunge8ptRouting End

      Overrides:
      readData in class Function
      Parameters:
      input - BufferedReader connected to the ASCII file containing the RssSystem data.
      See Also:

    • writeData

      public boolean writeData(BufferedWriter out)
      Writes the MuskingumCunge8ptRouting data to the specified BufferedWriter. This method is called by Element.writeData after encountering an Element Function line type with parameter of MuskingumCunge8ptRouting. Control of the file processing is passed back to the Element object once an it is finished writing Element MuskingumCunge8ptRouting End

      The data stream must have type=param formatting. The following types and parameters are defined.

      Element MuskingumCunge8ptRouting Name= (String) name of the function
      Element MuskingumCunge8ptRouting channelLength= (double) channel length
      Element MuskingumCunge8ptRouting channelSlope= (double) channel slope
      Element MuskingumCunge8ptRouting xsDistance= (double) horizontal distance for each point of cross section
      Element MuskingumCunge8ptRouting xsElevation= (double) verticalal distance for each point of cross section
      Element MuskingumCunge8ptRouting xsManningsN= (double) Manning's n for (1)left overbank (2)main channel (3)right overbank
      Element MuskingumCunge8ptRouting End

      Overrides:
      writeData in class Function
      Parameters:
      input - BufferedReader connected to the ASCII file containing the RssSystem data.
      See Also:

    • setchannelLength

      public void setchannelLength(hec.data.ParamDouble pd)
      This method sets the channel length. The parameters ParamDouble wrapps around the channel length value and is extracted and set in the object.

    • setchannelLength

      public void setchannelLength(double[] channelLength)

    • setchannelSlope

      public void setchannelSlope(double[] channelSlope)

    • setxsDistance

      public void setxsDistance(double[] xsDistance)

    • setxsElevation

      public void setxsElevation(double[] xsElevation)

    • setxsManningsN

      public void setxsManningsN(double[] xsManningsN)

    • setnumberNodes

      public void setnumberNodes(int numberNodes)

    • setuseNumberNodes

      public void setuseNumberNodes(boolean a)

    • getchannelLength

      public void getchannelLength(hec.data.ParamDouble pd)
      This method gets the channel length by filling ParamDouble
      Parameters:
      pd - this value is filled with the correct data, paramater, precision etc.

    • getchannelLength

      public double[] getchannelLength()

    • getchannelSlope

      public double[] getchannelSlope()

    • getxsDistance

      public double[] getxsDistance()

    • getxsElevation

      public double[] getxsElevation()

    • getxsManningsN

      public double[] getxsManningsN()

    • getnumberNodes

      public int getnumberNodes()

    • getuseNumberNodes

      public boolean getuseNumberNodes()

    • setIsSI

      public void setIsSI(boolean isSI)
      This method is old, and should not be used anymore.

    • convertToWatershedUnits

      public void convertToWatershedUnits()
      This method converts the metric data to watershed units. This should only be called by the RssSystem object when updates occur. The old storage system always stored in metric

    • getFieldObject

      public Object getFieldObject(Field fld)
      Description copied from interface: FieldAccessor
      This method allows access to java.lang.reflect.Field objects within the implementing class.
      Specified by:
      getFieldObject in interface FieldAccessor
      Overrides:
      getFieldObject in class Routing
      Parameters:
      fld - The field to get.
      Returns:
      The data object that is stored in the given field

    • setFieldObject

      public boolean setFieldObject(Field fld, Object fobj)
      Description copied from interface: FieldAccessor
      This allows access to fields withing the implementing object to set there data.
      Specified by:
      setFieldObject in interface FieldAccessor
      Overrides:
      setFieldObject in class Routing
      Parameters:
      fld - The java field object representing the member field to be set
      fobj - The data to set in that field
      Returns:
      returns true if successful

    • initializeStandalone

      public boolean initializeStandalone()
      Description copied from class: Routing
      Initialize routing object for standalone compute in offline WQ simulation Default method - implemented in individual subclasses
      Overrides:
      initializeStandalone in class Routing
      Returns:
      true if initialization successful, false o.w.