ucar.visad.quantities
Class SaturationMixingRatio

java.lang.Object
  ucar.visad.quantities.Quantity
      ucar.visad.quantities.ScalarQuantity
          ucar.visad.quantities.WaterVaporMixingRatio
              ucar.visad.quantities.SaturationMixingRatio

public final class SaturationMixingRatio
extends WaterVaporMixingRatio

Provides support for the quantity of saturation mixing-ratio. Instances are immutable.

Version:

$Id: SaturationMixingRatio.java,v 1.15 2005/05/13 18:35:43 jeffmc Exp $

Author:

Steven R. Emmerson

Nested Class Summary

protected static class

SaturationMixingRatio.MyFunction The SaturationMixingRatio(pressure, temperature) function.

Method Summary

static Data	create(Data pressure, Data temperature) Creates a saturation water-vapor mixing-ratio data object from data objects for pressure and in-situ temperature.
static Data	createTemperature(Data pressure, Data rSat) Creates an AirTemperature data object from data objects of pressure and saturation mixing-ratio.
static RealTupleType	getRealTupleType() Obtains the RealTupleType associated with this class.
static RealType	getRealType() Obtains the RealType associated with this class.
static Function	newFunction() Returns a SaturationMixingRatio(pressure, temperature) function.

Methods inherited from class ucar.visad.quantities.WaterVaporMixingRatio

getGasConstantRatio

Methods inherited from class ucar.visad.quantities.ScalarQuantity

getRealType, getRealType, realType

Methods inherited from class ucar.visad.quantities.Quantity

realTupleType, setRealTupleType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getRealType

public static RealType getRealType()
                            throws VisADException

Obtains the RealType associated with this class.

Returns:

The RealType associated with this class.

Throws:

VisADException - Couldn't perform necessary VisAD operation.

getRealTupleType

public static RealTupleType getRealTupleType()
                                      throws VisADException

Obtains the RealTupleType associated with this class.

Returns:

The RealTupleType associated with this class.

Throws:

VisADException - Couldn't perform necessary VisAD operation.

createTemperature

public static Data createTemperature(Data pressure,
                                     Data rSat)
                              throws TypeException,
                                     UnitException,
                                     VisADException,
                                     RemoteException

Creates an AirTemperature data object from data objects of pressure and saturation mixing-ratio.

Parameters:

pressure - The air pressure data object.

rSat - The saturation mixing-ratio data object.

Returns:

The air temperature data object computed from the pressure and temperature data objects. The type of the object will be that of the arguments after standard promotion.

Throws:

TypeException - At least one argument has incorrect type.

UnitException - Inappropriate unit argument.

VisADException - Couldn't create necessary VisAD object.

RemoteException - Java RMI failure.

See Also:

VisADMath

create

public static Data create(Data pressure,
                          Data temperature)
                   throws TypeException,
                          UnitException,
                          UnimplementedException,
                          VisADException,
                          RemoteException

Creates a saturation water-vapor mixing-ratio data object from data objects for pressure and in-situ temperature.

Parameters:

pressure - The pressure data object.

temperature - The in-situ temperature data object.

Returns:

Water vapor mixing-ratio. The type of the object will be that of the arguments after standard promotion.

Throws:

TypeException - At least one argument has incorrect type.

UnitException - Unit convertion failure.

UnimplementedException - Necessary operation not yet implemented.

VisADException - Couldn't create necessary VisAD object.

RemoteException - Java RMI failure.

See Also:

VisADMath

newFunction

public static Function newFunction()

Returns a SaturationMixingRatio(pressure, temperature) function.

Returns:

A SaturationMixingRatio(pressure, temperature) function.