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

Constructors

Modifier	Constructor and Description
protected	PotentialTemperature(java.lang.String name) Constructs an instance from a name.

Method Summary

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

PotentialTemperature

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

Constructs an instance from a name.

Parameters:

name - The name for the quantity.

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,
                                java.rmi.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:

visad.TypeException - An input argument has wrong type.

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

java.rmi.RemoteException - Java RMI failure.

factor

protected static final visad.Data factor(visad.Data pressure)
                                  throws visad.TypeException,
                                         visad.UnimplementedException,
                                         visad.VisADException,
                                         java.rmi.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:

visad.TypeException - Input argument has wrong type.

visad.UnimplementedException - Necessary operation not yet implemented.

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

java.rmi.RemoteException - Java RMI failure.

createAirTemperature

public static visad.Data createAirTemperature(visad.Data pressure,
                                              visad.Data theta)
                                       throws visad.TypeException,
                                              visad.VisADException,
                                              java.rmi.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:

visad.TypeException - An input argument has wrong type.

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

java.rmi.RemoteException - Java RMI failure.