ucar.visad.quantities
Class PotentialTemperature

java.lang.Object
  ucar.visad.quantities.Quantity
      ucar.visad.quantities.ScalarQuantity
          ucar.visad.quantities.Temperature
              ucar.visad.quantities.AirTemperature
                  ucar.visad.quantities.PotentialTemperature

Direct Known Subclasses:

EquivalentPotentialTemperature, SaturationWetBulbPotentialTemperature

public class PotentialTemperature
extends AirTemperature

Provides support for the quantity of potential temperature.

An instance of this class is immutable.

Version:

$Id: PotentialTemperature.java,v 1.13 2005/05/13 18:35:41 jeffmc Exp $

Author:

Steven R. Emmerson

Constructor Summary

protected

PotentialTemperature(String name) Constructs an instance from a name.

Method Summary

static Data	create(Data pressure, Data temperature) Creates a potential temperature data object from data objects for pressure and air temperature.
static Data	createAirTemperature(Data pressure, Data theta) Creates an air temperature data object from data objects for pressure and potential temperature.
protected static Data	factor(Data pressure) Compute the factor for use in the potential temperature equation.
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

PotentialTemperature

protected PotentialTemperature(String name)
                        throws VisADException

Constructs an instance from a name.

Parameters:

name - The name for the 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)
                   throws TypeException,
                          VisADException,
                          RemoteException

Creates a potential temperature data object from data objects for pressure and air temperature.

Parameters:

pressure - The air pressure data object.

temperature - The temperature data object.

Returns:

The 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.

factor

protected static final Data factor(Data pressure)
                            throws TypeException,
                                   UnimplementedException,
                                   VisADException,
                                   RemoteException

Compute the factor for use in the potential temperature equation.

Parameters:

pressure - The air pressure data object.

Returns:

The factor for use in the potential temperature equation corresponding to the input air pressure.

Throws:

TypeException - Input argument has wrong type.

UnimplementedException - Necessary operation not yet implemented.

VisADException - Couldn't create necessary VisAD object.

RemoteException - Java RMI failure.

createAirTemperature

public static Data createAirTemperature(Data pressure,
                                        Data theta)
                                 throws TypeException,
                                        VisADException,
                                        RemoteException

Creates an air temperature data object from data objects for pressure and potential temperature.

Parameters:

pressure - The air pressure data object.

theta - The potential temperature data object.

Returns:

The air 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.