ucar.visad.quantities
Class EquivalentPotentialTemperature

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.PotentialTemperature
                      extended by ucar.visad.quantities.EquivalentPotentialTemperature
Direct Known Subclasses:
SaturationEquivalentPotentialTemperature

public class EquivalentPotentialTemperature
extends PotentialTemperature

Provides support for the quantity of equivalent potential temperature.

An instance of this class is immutable.

Version:
$Id: EquivalentPotentialTemperature.java,v 1.10 2005/05/13 18:35:39 jeffmc Exp $
Author:
Steven R. Emmerson

Constructor Summary
protected EquivalentPotentialTemperature(String name)
          Constructs from a name.
 
Method Summary
static Data create(Data pressure, Data temperature, Data mixingRatio)
          Creates an equivalent potential temperature data object.
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.PotentialTemperature
create, createAirTemperature, factor
 
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

EquivalentPotentialTemperature

protected EquivalentPotentialTemperature(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.

create

public static Data create(Data pressure,
                          Data temperature,
                          Data mixingRatio)
                   throws TypeException,
                          VisADException,
                          RemoteException
Creates an equivalent potential temperature data object.

Parameters:
pressure - The air pressure data object.
temperature - The temperature data object.
mixingRatio - The water-vapor mixing-ratio data object.
Returns:
The equivalent potential temperature data object corresponding to the input arguments.
Throws:
TypeException - An input argument has wrong type.
VisADException - Couldn't create necessary VisAD object.
RemoteException - Java RMI failure.