NCL Website header
NCL Home > Documentation > Functions > Meteorology

zonal_mpsi_Wrap

Computes a zonal mean meridional stream function and retains metadata.

Prototype

load "$NCARG_ROOT/lib/ncarg/nclscripts/csm/contributed.ncl"  ; This library is automatically loaded
                                                             ; from NCL V6.2.0 onward.
                                                             ; No need for user to explicitly load.

	function zonal_mpsi_Wrap (
		v       : numeric,  
		lat [*] : numeric,  
		p   [*] : numeric,  
		ps      : numeric   
	)

	return_val [(time),lev,lat] :  numeric

Arguments

v

A multi-dimensional array of meridional wind values in which the rightmost three dimensions must be level, latitude, longitude [e.g., v(lev,lat,lon), v(time,lev,lat,lon)]. Units must be m/s. The level dimension must be ordered top-to-bottom.

lat

A one-dimensional array of latitudes. The size must be the same as the corresponding dimension of v.

p

A one-dimensional array of pressure level values ordered top-to-bottom. The size must be the same as the corresponding dimension of v. The units must be in Pa. The first value must be greater than 500 Pa (5mb), and the last value must be less than 100500 Pa (1005mb). (e.g., 500 < p(0) < p(1) < ... < 100500.)

ps

A multi-dimensional numeric array of surface pressures. The size must be the same as the corresponding dimensions of v. Usually ps corresponds with v in all but the level dimension. Units must be Pa.

Description

This function is identical to zonal_mpsi, except the return value will have metadata added based on metadata attached to v. See the zonal_mpsi page for full documentation and examples.