ucar.visad.quantities
Class VirtualTemperature

java.lang.Object
  extended by ucar.visad.quantities.Quantity
      extended by ucar.visad.quantities.ScalarQuantity
          extended by ucar.visad.quantities.Temperature
              extended by ucar.visad.quantities.AirTemperature
                  extended by ucar.visad.quantities.VirtualTemperature
Direct Known Subclasses:
VirtualPotentialTemperature

public class VirtualTemperature
extends AirTemperature

Provides support for the quantity of atmospheric virtual temperature.

Version:
$Id: VirtualTemperature.java,v 1.13 2005/05/13 18:35:45 jeffmc Exp $
Author:
Steven R. Emmerson

Constructor Summary
protected VirtualTemperature(String name)
          Constructs from a name.
 
Method Summary
static Data createFromDewPoint(Data pressure, Data temperature, Data dewPoint)
          Creates a virtual temperature data object from data objects of air pressure, in situ air temperature, and dew point.
static Data createFromMixingRatio(Data temperature, Data mixingRatio)
          Creates a virtual temperature data object from data objects of in situ air temperature, and water vapor mixing-ratio.
static RealTupleType getRealTupleType()
          Obtains the RealTupleType associated with this class.
static 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

VirtualTemperature

protected VirtualTemperature(String name)
                      throws VisADException
Constructs from a name.

Parameters:
name - The name for this quantity.
Throws:
VisADException - Couldn't create necessary VisAD object.
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.

createFromDewPoint

public static Data createFromDewPoint(Data pressure,
                                      Data temperature,
                                      Data dewPoint)
                               throws TypeException,
                                      UnimplementedException,
                                      VisADException,
                                      RemoteException
Creates a virtual temperature data object from data objects of air pressure, in situ air temperature, and dew point.

Parameters:
pressure - The air pressure data object.
temperature - The in situ air temperature data object.
dewPoint - The dew point data object.
Returns:
The virtual air temperature corresponding to the arguments. The type of the returned object will be that of the arguments after standard promotion.
Throws:
TypeException - At least one argument has the wrong type.
UnimplementedException - Necessary operation not yet implemented.
VisADException - Couldn't create necessary VisAD object.
RemoteException - Java RMI failure.
See Also:
VisADMath

createFromMixingRatio

public static Data createFromMixingRatio(Data temperature,
                                         Data mixingRatio)
                                  throws TypeException,
                                         UnimplementedException,
                                         VisADException,
                                         RemoteException
Creates a virtual temperature data object from data objects of in situ air temperature, and water vapor mixing-ratio.

Parameters:
temperature - The in situ air temperature data object.
mixingRatio - The water vapor mixing-ratio data object.
Returns:
The virtual air temperature corresponding to the arguments. The type of the returned object will be that of the arguments after standard promotion.
Throws:
TypeException - At least one argument has the wrong type.
UnimplementedException - Necessary operation not yet implemented.
VisADException - Couldn't create necessary VisAD object.
RemoteException - Java RMI failure.
See Also:
VisADMath