ucar.visad.quantities

Class SpecificHumidity

java.lang.Object

ucar.visad.quantities.Quantity

ucar.visad.quantities.ScalarQuantity

ucar.visad.quantities.SpecificHumidity

public class SpecificHumidity
extends ScalarQuantity

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

Version:

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

Author:

Steven R. Emmerson

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SpecificHumidity(java.lang.String name) Constructs from a name.

Method Summary

Modifier and Type	Method and Description
static visad.Data	create(visad.Data mixingRatio) Create SpecificHumidity from MixingRatio
static visad.Data	create(visad.Data pressure, visad.Data temperature) Creates a water-vapor mixing-ratio data object from data objects for pressure and temperature.
static visad.RealTupleType	getRealTupleType() Obtains the RealTupleType associated with this class.
static visad.RealType	getRealType() Obtains the RealType associated with this class.

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

Constructor Detail

SpecificHumidity

protected SpecificHumidity(java.lang.String name)
                    throws visad.VisADException

Constructs from a name.

Parameters:

name - The name for the instance.

Throws:

visad.VisADException - Couldn't create necessary VisAD object.

Method Detail

getRealType

public static visad.RealType getRealType()
                                  throws visad.VisADException

Obtains the RealType associated with this class.

Returns:

The RealType associated with this class.

Throws:

visad.VisADException - Couldn't perform necessary VisAD operation.

getRealTupleType

public static visad.RealTupleType getRealTupleType()
                                            throws visad.VisADException

Obtains the RealTupleType associated with this class.

Returns:

The RealTupleType associated with this class.

Throws:

visad.VisADException - Couldn't perform necessary VisAD operation.

create

public static visad.Data create(visad.Data pressure,
                                visad.Data temperature)
                         throws visad.TypeException,
                                visad.VisADException,
                                visad.UnitException,
                                java.rmi.RemoteException

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

Parameters:

pressure - The pressure data object.

temperature - The temperature data object. If the in-situ temperature is used, then the returned object is the saturation mixing ratio. If the dew-point temperature is used, then the returned object is the actual mixing-ratio.

Returns:

Water vapor mixing-ratio or saturation mixing-ratio depending on the type of temperature.

Throws:

visad.TypeException - At least one argument has incorrect type.

visad.UnitException - Unit conversion failure.

visad.VisADException - Couldn't create necessary VisAD object.

java.rmi.RemoteException - Java RMI failure.

create

public static visad.Data create(visad.Data mixingRatio)
                         throws visad.TypeException,
                                visad.VisADException,
                                visad.UnitException,
                                java.rmi.RemoteException

Create SpecificHumidity from MixingRatio

Parameters:

mixingRatio - mixing ratio

Returns:

specific humidity

Throws:

java.rmi.RemoteException - Java RMI problem

visad.TypeException - wrong type

visad.UnitException - wrong units

visad.VisADException - Problem creating data object