wrf.tvirtual¶

wrf.tvirtual(tkel, qv, meta=True, units=u'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 or numpy.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 or numpy.ndarray) – Water vapor mixing ratio in [kg/kg] with the same dimensionality as tkel
meta (bool) – Set to False to disable metadata and return numpy.ndarray instead of xarray.DataArray. Default is True.
units (str) – The desired units. Refer to the getvar() 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 a `numpy.ndarray` object with no metadata.
Return type:	`xarray.DataArray` or `numpy.ndarray`