wrf.tvirtual¶
- wrf.tvirtual(tkel, qv, meta=True, units='K')¶
Return the virtual temperature.
This is the raw computational algorithm and does not extract any variables from WRF output files. Use
wrf.getvar()
to both extract and compute diagnostic variables.- Parameters:
tkel (
xarray.DataArray
ornumpy.ndarray
) –Temperature in [K] with the rightmost dimensions as bottom_top x south_north x west_east.
Note
This variable must be supplied as a
xarray.DataArray
in order to copy the dimension names to the output. Otherwise, default names will be used.qv (
xarray.DataArray
ornumpy.ndarray
) – Water vapor mixing ratio in [kg/kg] with the same dimensionality as tkelmeta (
bool
) – Set to False to disable metadata and returnnumpy.ndarray
instead ofxarray.DataArray
. Default is True.units (
str
) – The desired units. Refer to thegetvar()
product table for a list of available units for ‘tv’. Default is ‘K’.
Warning
The input arrays must not contain any missing/fill values or
numpy.nan
values.- Returns:
The virtual temperature. If xarray is enabled and the meta parameter is True, then the result will be an
xarray.DataArray
object. Otherwise, the result will be anumpy.ndarray
object with no metadata.- Return type:
See also
wrf.getvar()
,wrf.temp()
,wrf.eth()
,wetbulb()