Package ucar.unidata.geoloc.vertical

Class WRFEta

java.lang.Object

ucar.unidata.geoloc.vertical.VerticalTransformImpl

ucar.unidata.geoloc.vertical.WRFEta

All Implemented Interfaces:

VerticalTransform

public class WRFEta
extends VerticalTransformImpl

Models the vertical coordinate for the Weather Research and Forecast (WRF) model's vertical Eta coordinate

Field Summary

Fields

Modifier and Type	Field	Description
static String	BaseGeopotentialVariable
static String	BasePressureVariable
static String	IsStaggeredX
static String	IsStaggeredY
static String	IsStaggeredZ
static String	PerturbationGeopotentialVariable
static String	PerturbationPressureVariable

Fields inherited from class ucar.unidata.geoloc.vertical.VerticalTransformImpl

units

Constructor Summary

Constructors

Constructor	Description
WRFEta(NetcdfFile ds, Dimension timeDim, List<Parameter> params)	Construct a vertical coordinate for the Weather Research and Forecast (WRF) model's vertical Eta coordinate

Method Summary

Modifier and Type	Method	Description
ArrayDouble.D3	getCoordinateArray(int timeIndex)	Get the 3D vertical coordinate array for this time step.
ArrayDouble.D1	getCoordinateArray1D(int timeIndex, int xIndex, int yIndex)	Get the 1D vertical coordinate array for this time step and point

Methods inherited from class ucar.unidata.geoloc.vertical.VerticalTransformImpl

getParameterBooleanValue, getParameterStringValue, getTimeDimension, getUnitString, isTimeDependent, readArray, subset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BasePressureVariable

public static final String BasePressureVariable

See Also:

Constant Field Values

PerturbationPressureVariable

public static final String PerturbationPressureVariable

See Also:

Constant Field Values

BaseGeopotentialVariable

public static final String BaseGeopotentialVariable

See Also:

Constant Field Values

PerturbationGeopotentialVariable

public static final String PerturbationGeopotentialVariable

See Also:

Constant Field Values

IsStaggeredX

public static final String IsStaggeredX

See Also:

Constant Field Values

IsStaggeredY

public static final String IsStaggeredY

See Also:

Constant Field Values

IsStaggeredZ

public static final String IsStaggeredZ

See Also:

Constant Field Values

Constructor Detail

WRFEta

public WRFEta(NetcdfFile ds,
              Dimension timeDim,
              List<Parameter> params)

Construct a vertical coordinate for the Weather Research and Forecast (WRF) model's vertical Eta coordinate

Parameters:

ds - netCDF dataset

timeDim - time dimension

params - list of transformation Parameters

Method Detail

getCoordinateArray

public ArrayDouble.D3 getCoordinateArray(int timeIndex)
                                  throws IOException

Get the 3D vertical coordinate array for this time step.

Specified by:

getCoordinateArray in interface VerticalTransform

Specified by:

getCoordinateArray in class VerticalTransformImpl

Parameters:

timeIndex - the time index. Ignored if !isTimeDependent().

Returns:

vertical coordinate array

Throws:

IOException - problem reading data

getCoordinateArray1D

public ArrayDouble.D1 getCoordinateArray1D(int timeIndex,
                                           int xIndex,
                                           int yIndex)
                                    throws IOException,
                                           InvalidRangeException

Get the 1D vertical coordinate array for this time step and point

Specified by:

getCoordinateArray1D in interface VerticalTransform

Specified by:

getCoordinateArray1D in class VerticalTransformImpl

Parameters:

timeIndex - the time index. Ignored if !isTimeDependent().

xIndex - the x index

yIndex - the y index

Returns:

vertical coordinate array

Throws:

IOException - problem reading data

InvalidRangeException - _more_