Subroutines/functions list. More...

Data Types
interface	c_fletcher32

interface	fletcher32

interface	lonlatmod

interface	gridhash

interface	independent_levels

interface	sphere_dist

interface	cart_dist

interface	lonlat2xyz

interface	xyz2lonlat

interface	vector_product

interface	det

interface	inside

interface	order_cc

interface	add

interface	divide

interface	vert_interp_size

interface	vert_interp_setup

interface	vert_interp

interface	fit_diag

interface	gc99

interface	fit_func

interface	fit_lct

interface	lct_d2h

interface	lct_h2r

interface	lct_r2d

interface	check_cond

interface	matern

interface	cholesky

interface	syminv

interface	histogram

interface	cx_to_cxa

interface	cx_to_proc

interface	cx_to_cxu

interface	convert_i2l

interface	convert_l2i

interface	zss_maxval

interface	zss_minval

interface	zss_sum

interface	zss_count

Functions/Subroutines
integer function	func_fletcher32 (var)
	Fletcher-32 checksum algorithm. More...

subroutine	func_lonlatmod (lon, lat)
	Set latitude between -pi/2 and pi/2 and longitude between -pi and pi. More...

subroutine	func_gridhash (ncx, nlx, lon_cx, lat_cx, mask_cx, grid_hash)
	Compute grid hash profile. More...

subroutine	func_independent_levels (mpl, nlx, grid_hash, nlxi, lx_to_lxi, lxi_to_lx, ifmt)
	Compute independent levels. More...

subroutine	func_cart_dist (x_i, y_i, z_i, x_f, y_f, z_f, dist)
	Compute the cartesian distance between two points. More...

subroutine	func_sphere_dist (lon_i, lat_i, lon_f, lat_f, dist)
	Compute the great-circle distance between two points. More...

subroutine	func_lonlat2xyz (mpl, lon, lat, x, y, z)
	Convert longitude/latitude to cartesian coordinates. More...

subroutine	func_xyz2lonlat (mpl, x, y, z, lon, lat)
	Convert longitude/latitude to cartesian coordinates. More...

subroutine	func_vector_product (v1, v2, vp)
	Compute normalized vector product. More...

subroutine	func_det (v1, v2, v3, p, cflag)
	Compute determinant (vector triple product) More...

subroutine	func_inside (mpl, vbnd, lon, lat, inside_hull)
	Find whether a point is inside the hull boundaries or not. More...

subroutine	func_order_cc (mpl, lon, lat, n, x, y, z, order, diff)
	Order points in counter-clockwise order with respect to a central point. More...

subroutine	func_add (mpl, val, cumul, num, wgt)
	Check if value missing and add if not missing. More...

subroutine	func_divide (mpl, val, num)
	Check if value missing and divide if not missing. More...

subroutine	func_vert_interp_size (nl0, dl0, nl1)
	Count vertical interpolation levels. More...

subroutine	func_vert_interp_setup (nl0, dl0, nl1, il0_interp, il1inf, il1sup, rinf, rsup)
	Setup vertical interpolation levels and weights. More...

subroutine	func_vert_interp (mpl, nl1, var_l1, nl0, il1inf, il1sup, rinf, rsup, var_l0)
	Apply vertical interpolation. More...

subroutine	func_fit_diag (mpl, nc3, nl0r, disth, distv, coef, rh, rv, fit)
	Compute diagnostic fit function. More...

real(kind_real) function	func_gc99 (distnorm)
	Gaspari and Cohn (1999) function, with the support radius as a parameter. More...

real(kind_real) function	func_fit_func (mpl, distnorm)
	Fit_function. More...

subroutine	func_fit_lct (mpl, nc3, nl0r, dxsq, dysq, dxdy, dzsq, dmask, nscales, D, coef, fit)
	LCT fit. More...

subroutine	func_lct_d2h (mpl, D11, D22, D33, D12, H11, H22, H33, H12)
	From D (Daley tensor) to H (local correlation tensor) More...

subroutine	func_lct_h2r (mpl, H11, H22, H33, H12, rh, rv)
	From H (local correlation tensor) to support radii. More...

subroutine	func_lct_r2d (r, D)
	From support radius to Daley tensor diagonal element. More...

subroutine	func_check_cond (d1, d2, nod, valid)
	Check tensor conditioning. More...

real(kind_real) function	func_matern (mpl, M, x)
	Compute the normalized diffusion function from eq. (55) of Mirouze and Weaver (2013), for the 3d case (d = 3) More...

subroutine	func_cholesky (mpl, n, a, u)
	Compute cholesky decomposition. More...

subroutine	func_syminv (mpl, n, a, c)
	Compute inverse of a symmetric matrix. More...

subroutine	func_histogram (mpl, nlist, list, nbins, histmin, histmax, bins, hist)
	Compute bins and histogram from a list of values. More...

integer function	func_cx_to_cxa (nproc, proc_to_cx_offset, icx)
	Conversion from global to halo A on subset Scx. More...

integer function	func_cx_to_proc (nproc, proc_to_cx_offset, icx)
	Conversion from global to processor on subset Scx. More...

integer function	func_cx_to_cxu (nproc, proc_to_cx_offset, proc_to_ncxa, myuniverse, icx)
	Conversion from global to universe on subset Scx. More...

subroutine	func_convert_i2l_r0 (mpl, fldi, fldl)
	Convert integer to logical. More...

subroutine	func_convert_i2l_r1 (mpl, fldi, fldl)
	Convert integer to logical. More...

subroutine	func_convert_i2l_r2 (mpl, fldi, fldl)
	Convert integer to logical. More...

subroutine	func_convert_i2l_r3 (mpl, fldi, fldl)
	Convert integer to logical. More...

subroutine	func_convert_i2l_r4 (mpl, fldi, fldl)
	Convert integer to logical. More...

subroutine	func_convert_l2i_r0 (fldl, fldi)
	Convert logical to integer. More...

subroutine	func_convert_l2i_r1 (fldl, fldi)
	Convert logical to integer. More...

subroutine	func_convert_l2i_r2 (fldl, fldi)
	Convert logical to integer. More...

subroutine	func_convert_l2i_r3 (fldl, fldi)
	Convert logical to integer. More...

subroutine	func_convert_l2i_r4 (fldl, fldi)
	Convert logical to integer. More...

integer(kind_int) function	func_zss_maxval_int_r1 (array, mask)
	Zero-size-safe maxval function. More...

integer(kind_int) function	func_zss_maxval_int_r2 (array, mask)
	Zero-size-safe maxval function. More...

integer(kind_int) function	func_zss_maxval_int_r3 (array, mask)
	Zero-size-safe maxval function. More...

integer(kind_int) function	func_zss_maxval_int_r4 (array, mask)
	Zero-size-safe maxval function. More...

integer(kind_int) function	func_zss_maxval_int_r5 (array, mask)
	Zero-size-safe maxval function. More...

integer(kind_int) function	func_zss_maxval_int_r6 (array, mask)
	Zero-size-safe maxval function. More...

real(kind_real) function	func_zss_maxval_real_r1 (array, mask)
	Zero-size-safe maxval function. More...

real(kind_real) function	func_zss_maxval_real_r2 (array, mask)
	Zero-size-safe maxval function. More...

real(kind_real) function	func_zss_maxval_real_r3 (array, mask)
	Zero-size-safe maxval function. More...

real(kind_real) function	func_zss_maxval_real_r4 (array, mask)
	Zero-size-safe maxval function. More...

real(kind_real) function	func_zss_maxval_real_r5 (array, mask)
	Zero-size-safe maxval function. More...

real(kind_real) function	func_zss_maxval_real_r6 (array, mask)
	Zero-size-safe maxval function. More...

integer(kind_int) function	func_zss_minval_int_r1 (array, mask)
	Zero-size-safe minval function. More...

integer(kind_int) function	func_zss_minval_int_r2 (array, mask)
	Zero-size-safe minval function. More...

integer(kind_int) function	func_zss_minval_int_r3 (array, mask)
	Zero-size-safe minval function. More...

integer(kind_int) function	func_zss_minval_int_r4 (array, mask)
	Zero-size-safe minval function. More...

integer(kind_int) function	func_zss_minval_int_r5 (array, mask)
	Zero-size-safe minval function. More...

integer(kind_int) function	func_zss_minval_int_r6 (array, mask)
	Zero-size-safe minval function. More...

real(kind_real) function	func_zss_minval_real_r1 (array, mask)
	Zero-size-safe minval function. More...

real(kind_real) function	func_zss_minval_real_r2 (array, mask)
	Zero-size-safe minval function. More...

real(kind_real) function	func_zss_minval_real_r3 (array, mask)
	Zero-size-safe minval function. More...

real(kind_real) function	func_zss_minval_real_r4 (array, mask)
	Zero-size-safe minval function. More...

real(kind_real) function	func_zss_minval_real_r5 (array, mask)
	Zero-size-safe minval function. More...

real(kind_real) function	func_zss_minval_real_r6 (array, mask)
	Zero-size-safe minval function. More...

integer(kind_int) function	func_zss_sum_int_r1 (array, mask)
	Zero-size-safe sum function. More...

integer(kind_int) function	func_zss_sum_int_r2 (array, mask)
	Zero-size-safe sum function. More...

integer(kind_int) function	func_zss_sum_int_r3 (array, mask)
	Zero-size-safe sum function. More...

integer(kind_int) function	func_zss_sum_int_r4 (array, mask)
	Zero-size-safe sum function. More...

integer(kind_int) function	func_zss_sum_int_r5 (array, mask)
	Zero-size-safe sum function. More...

integer(kind_int) function	func_zss_sum_int_r6 (array, mask)
	Zero-size-safe sum function. More...

real(kind_real) function	func_zss_sum_real_r1 (array, mask)
	Zero-size-safe sum function. More...

real(kind_real) function	func_zss_sum_real_r2 (array, mask)
	Zero-size-safe sum function. More...

real(kind_real) function	func_zss_sum_real_r3 (array, mask)
	Zero-size-safe sum function. More...

real(kind_real) function	func_zss_sum_real_r4 (array, mask)
	Zero-size-safe sum function. More...

real(kind_real) function	func_zss_sum_real_r5 (array, mask)
	Zero-size-safe sum function. More...

real(kind_real) function	func_zss_sum_real_r6 (array, mask)
	Zero-size-safe sum function. More...

integer function	func_zss_count_r1 (array)
	Zero-size-safe count function. More...

integer function	func_zss_count_r2 (array)
	Zero-size-safe count function. More...

integer function	func_zss_count_r3 (array)
	Zero-size-safe count function. More...

integer function	func_zss_count_r4 (array)
	Zero-size-safe count function. More...

integer function	func_zss_count_r5 (array)
	Zero-size-safe count function. More...

integer function	func_zss_count_r6 (array)
	Zero-size-safe count function. More...

Variables
real(kind_real), parameter, public	gc2gau = 0.28_kind_real
	GC99 support radius to Gaussian Daley length-scale (empirical) More...

real(kind_real), parameter, public	gau2gc = one/gc2gau
	Gaussian Daley length-scale to GC99 support radius (empirical) More...

real(kind_real), parameter, public	dmin = 1.0e-12_kind_real
	Minimum tensor diagonal value. More...

real(kind_real), parameter	condmax = thousand
	Maximum tensor conditioning number. More...

integer, parameter, public	m = 0
	Number of implicit iteration for the Matern function (-1: GC99, 0: Gaussian, >0: Matern) More...

Detailed Description

Subroutines/functions list.

Instrumentation functions Generic ranks, dimensions and types Usual functions

Function/Subroutine Documentation

◆ func_add()

subroutine tools_func::func_add	(	type(mpl_type), intent(in)	mpl,
		real(kind_real), intent(in)	val,
		real(kind_real), intent(inout)	cumul,
		real(kind_real), intent(inout)	num,
		real(kind_real), intent(in), optional	wgt
	)

private

Check if value missing and add if not missing.

Parameters

[in]	mpl	MPI data
[in]	val	Value to add
[in,out]	num	Number of values
[in]	wgt	Weight

Definition at line 926 of file tools_func.F90.

◆ func_cart_dist()

subroutine tools_func::func_cart_dist	(	real(kind_real), intent(in)	x_i,
		real(kind_real), intent(in)	y_i,
		real(kind_real), intent(in)	z_i,
		real(kind_real), intent(in)	x_f,
		real(kind_real), intent(in)	y_f,
		real(kind_real), intent(in)	z_f,
		real(kind_real), intent(out)	dist
	)

private

Compute the cartesian distance between two points.

Parameters

[in]	x_i	Initial point X coordinate
[in]	y_i	Initial point Y coordinate
[in]	z_i	Initial point Z coordinate
[in]	x_f	Final point X coordinate
[in]	y_f	Final point Y coordinate
[in]	z_f	Final point Z coordinate
[out]	dist	Great-circle distance

Definition at line 550 of file tools_func.F90.

◆ func_check_cond()

subroutine tools_func::func_check_cond	(	real(kind_real), intent(in)	d1,
		real(kind_real), intent(in)	d2,
		real(kind_real), intent(in)	nod,
		logical, intent(out)	valid
	)

private

Check tensor conditioning.

Parameters

[in]	d1	First diagonal coefficient
[in]	d2	Second diagonal coefficient
[in]	nod	Normalized off-diagonal coefficient
[out]	valid	Conditioning validity

Definition at line 1538 of file tools_func.F90.

◆ func_cholesky()

subroutine tools_func::func_cholesky	(	type(mpl_type), intent(inout)	mpl,
		integer, intent(in)	n,
		real(kind_real), dimension(n,n), intent(in)	a,
		real(kind_real), dimension(n,n), intent(out)	u
	)

private

Compute cholesky decomposition.

Parameters

[in,out]	mpl	MPI data
[in]	n	Matrix rank
[in]	a	Matrix
[out]	u	Matrix square-root

Definition at line 1643 of file tools_func.F90.

◆ func_convert_i2l_r0()

subroutine tools_func::func_convert_i2l_r0	(	type(mpl_type), intent(inout)	mpl,
		integer, intent(in)	fldi,
		logical, intent(out)	fldl
	)

private

Convert integer to logical.

Parameters

[in,out]	mpl	MPI data
[in]	fldi	Integer field
[out]	fldl	Logical field

Definition at line 1962 of file tools_func.F90.

◆ func_convert_i2l_r1()

subroutine tools_func::func_convert_i2l_r1	(	type(mpl_type), intent(inout)	mpl,
		integer, dimension(:), intent(in)	fldi,
		logical, dimension(:), intent(out)	fldl
	)

private

Convert integer to logical.

Parameters

[in,out]	mpl	MPI data
[in]	fldi	Integer field
[out]	fldl	Logical field

Definition at line 1995 of file tools_func.F90.

◆ func_convert_i2l_r2()

subroutine tools_func::func_convert_i2l_r2	(	type(mpl_type), intent(inout)	mpl,
		integer, dimension(:,:), intent(in)	fldi,
		logical, dimension(:,:), intent(out)	fldl
	)

private

Convert integer to logical.

Parameters

[in,out]	mpl	MPI data
[in]	fldi	Integer field
[out]	fldl	Logical field

Definition at line 2036 of file tools_func.F90.

◆ func_convert_i2l_r3()

subroutine tools_func::func_convert_i2l_r3	(	type(mpl_type), intent(inout)	mpl,
		integer, dimension(:,:,:), intent(in)	fldi,
		logical, dimension(:,:,:), intent(out)	fldl
	)

private

Convert integer to logical.

Parameters

[in,out]	mpl	MPI data
[in]	fldi	Integer field
[out]	fldl	Logical field

Definition at line 2087 of file tools_func.F90.

◆ func_convert_i2l_r4()

subroutine tools_func::func_convert_i2l_r4	(	type(mpl_type), intent(inout)	mpl,
		integer, dimension(:,:,:,:), intent(in)	fldi,
		logical, dimension(:,:,:,:), intent(out)	fldl
	)

private

Convert integer to logical.

Parameters

[in,out]	mpl	MPI data
[in]	fldi	Integer field
[out]	fldl	Logical field

Definition at line 2148 of file tools_func.F90.

◆ func_convert_l2i_r0()

subroutine tools_func::func_convert_l2i_r0	(	logical, intent(in)	fldl,
		integer, intent(out)	fldi
	)

private

Convert logical to integer.

Parameters

[in]	fldl	Logical field
[out]	fldi	Integer field

Definition at line 2220 of file tools_func.F90.

◆ func_convert_l2i_r1()

subroutine tools_func::func_convert_l2i_r1	(	logical, dimension(:), intent(in)	fldl,
		integer, dimension(:), intent(out)	fldi
	)

private

Convert logical to integer.

Parameters

[in]	fldl	Logical field
[out]	fldi	Integer field

Definition at line 2250 of file tools_func.F90.

◆ func_convert_l2i_r2()

subroutine tools_func::func_convert_l2i_r2	(	logical, dimension(:,:), intent(in)	fldl,
		integer, dimension(:,:), intent(out)	fldi
	)

private

Convert logical to integer.

Parameters

[in]	fldl	Logical field
[out]	fldi	Integer field

Definition at line 2290 of file tools_func.F90.

◆ func_convert_l2i_r3()

subroutine tools_func::func_convert_l2i_r3	(	logical, dimension(:,:,:), intent(in)	fldl,
		integer, dimension(:,:,:), intent(out)	fldi
	)

private

Convert logical to integer.

Parameters

[in]	fldl	Logical field
[out]	fldi	Integer field

Definition at line 2340 of file tools_func.F90.

◆ func_convert_l2i_r4()

subroutine tools_func::func_convert_l2i_r4	(	logical, dimension(:,:,:,:), intent(in)	fldl,
		integer, dimension(:,:,:,:), intent(out)	fldi
	)

private

Convert logical to integer.

Parameters

[in]	fldl	Logical field
[out]	fldi	Integer field

Definition at line 2400 of file tools_func.F90.

◆ func_cx_to_cxa()

integer function tools_func::func_cx_to_cxa	(	integer, intent(in)	nproc,
		integer, dimension(nproc), intent(in)	proc_to_cx_offset,
		integer, intent(in)	icx
	)

private

Conversion from global to halo A on subset Scx.

Parameters

[in]	nproc	Number of processors
[in]	proc_to_cx_offset	Processor to offset on subset Scx
[in]	icx	Global index

Definition at line 1839 of file tools_func.F90.

◆ func_cx_to_cxu()

integer function tools_func::func_cx_to_cxu	(	integer, intent(in)	nproc,
		integer, dimension(nproc), intent(in)	proc_to_cx_offset,
		integer, dimension(nproc), intent(in)	proc_to_ncxa,
		logical, dimension(nproc), intent(in)	myuniverse,
		integer, intent(in)	icx
	)

private

Conversion from global to universe on subset Scx.

Parameters

[in]	nproc	Number of processors
[in]	proc_to_cx_offset	Processor to offset on subset Scx
[in]	proc_to_ncxa	Processor to halo A size for subset Scx
[in]	myuniverse	Task universe
[in]	icx	Global index

Definition at line 1910 of file tools_func.F90.

◆ func_cx_to_proc()

integer function tools_func::func_cx_to_proc	(	integer, intent(in)	nproc,
		integer, dimension(nproc), intent(in)	proc_to_cx_offset,
		integer, intent(in)	icx
	)

private

Conversion from global to processor on subset Scx.

Parameters

[in]	nproc	Number of processors
[in]	proc_to_cx_offset	Processor to offset on subset Scx
[in]	icx	Global index

Definition at line 1875 of file tools_func.F90.

◆ func_det()

subroutine tools_func::func_det	(	real(kind_real), dimension(3), intent(in)	v1,
		real(kind_real), dimension(3), intent(in)	v2,
		real(kind_real), dimension(3), intent(in)	v3,
		real(kind_real), intent(out)	p,
		logical, intent(out)	cflag
	)

private

Compute determinant (vector triple product)

Parameters

[in]	v1	First vector
[in]	v2	Second vector
[in]	v3	Third vector
[out]	p	Determinant
[out]	cflag	Confidence flag

Definition at line 745 of file tools_func.F90.

◆ func_divide()

subroutine tools_func::func_divide	(	type(mpl_type), intent(in)	mpl,
		real(kind_real), intent(inout)	val,
		real(kind_real), intent(in)	num
	)

private

Check if value missing and divide if not missing.

Parameters

[in]	mpl	MPI data
[in,out]	val	Value to divide
[in]	num	Divider

Definition at line 965 of file tools_func.F90.

◆ func_fit_diag()

subroutine tools_func::func_fit_diag	(	type(mpl_type), intent(inout)	mpl,
		integer, intent(in)	nc3,
		integer, intent(in)	nl0r,
		real(kind_real), dimension(nc3), intent(in)	disth,
		real(kind_real), dimension(nl0r), intent(in)	distv,
		real(kind_real), intent(in)	coef,
		real(kind_real), intent(in)	rh,
		real(kind_real), intent(in)	rv,
		real(kind_real), dimension(nc3,nl0r), intent(out)	fit
	)

private

Compute diagnostic fit function.

Parameters

[in,out]	mpl	MPI data
[in]	nc3	Number of classes
[in]	nl0r	Effective number of levels
[in]	disth	Horizontal distance
[in]	distv	Vertical distance
[in]	coef	Diagonal coefficient
[in]	rh	Horizontal support radius
[in]	rv	Vertical support radius

Definition at line 1147 of file tools_func.F90.

◆ func_fit_func()

real(kind_real) function tools_func::func_fit_func	(	type(mpl_type), intent(inout)	mpl,
		real(kind_real), intent(in)	distnorm
	)

private

Fit_function.

Parameters

[in,out]	mpl	MPI data
[in]	distnorm	Normalized distance

Definition at line 1273 of file tools_func.F90.

◆ func_fit_lct()

subroutine tools_func::func_fit_lct	(	type(mpl_type), intent(inout)	mpl,
		integer, intent(in)	nc3,
		integer, intent(in)	nl0r,
		real(kind_real), dimension(nc3,nl0r), intent(in)	dxsq,
		real(kind_real), dimension(nc3,nl0r), intent(in)	dysq,
		real(kind_real), dimension(nc3,nl0r), intent(in)	dxdy,
		real(kind_real), dimension(nc3,nl0r), intent(in)	dzsq,
		logical, dimension(nc3,nl0r), intent(in)	dmask,
		integer, intent(in)	nscales,
		real(kind_real), dimension(4,nscales), intent(in)	D,
		real(kind_real), dimension(nscales), intent(in)	coef,
		real(kind_real), dimension(nc3,nl0r), intent(out)	fit
	)

private

LCT fit.

Parameters

[in,out]	mpl	MPI data
[in]	nc3	Number of classes
[in]	nl0r	Number of levels
[in]	dxsq	Zonal separation squared
[in]	dysq	Meridian separation squared
[in]	dxdy	Zonal x meridian separations product
[in]	dzsq	Vertical separation squared
[in]	dmask	Mask
[in]	nscales	Number of LCT scales
[in]	d	LCT components
[in]	coef	LCT coefficients

Definition at line 1306 of file tools_func.F90.

◆ func_fletcher32()

integer function tools_func::func_fletcher32 ( real(kind_real), dimension(:), intent(in) var )

private

Fletcher-32 checksum algorithm.

Parameters

[in] var Variable

Definition at line 312 of file tools_func.F90.

◆ func_gc99()

real(kind_real) function tools_func::func_gc99 ( real(kind_real), intent(in) distnorm )

private

Gaspari and Cohn (1999) function, with the support radius as a parameter.

Parameters

[in] distnorm Normalized distance

Definition at line 1229 of file tools_func.F90.

◆ func_gridhash()

subroutine tools_func::func_gridhash	(	integer, intent(in)	ncx,
		integer, intent(in)	nlx,
		real(kind_real), dimension(ncx), intent(in)	lon_cx,
		real(kind_real), dimension(ncx), intent(in)	lat_cx,
		logical, dimension(ncx,nlx), intent(in)	mask_cx,
		integer, dimension(0:nlx), intent(out)	grid_hash
	)

private

Compute grid hash profile.

Parameters

[in]	ncx	Number of points
[in]	nlx	Number of levels
[in]	lon_cx	Longitude [radians]
[in]	lat_cx	Latitude [radians]
[in]	mask_cx	Mask
[out]	grid_hash	Grid hash profile

Definition at line 396 of file tools_func.F90.

◆ func_histogram()

subroutine tools_func::func_histogram	(	type(mpl_type), intent(inout)	mpl,
		integer, intent(in)	nlist,
		real(kind_real), dimension(nlist), intent(in)	list,
		integer, intent(in)	nbins,
		real(kind_real), intent(in)	histmin,
		real(kind_real), intent(in)	histmax,
		real(kind_real), dimension(nbins+1), intent(out)	bins,
		real(kind_real), dimension(nbins), intent(out)	hist
	)

private

Compute bins and histogram from a list of values.

Parameters

[in,out]	mpl	MPI data
[in]	nlist	List size
[in]	nbins	Number of bins
[in]	histmin	Histogram minimum
[in]	histmax	Histogram maximum
[out]	hist	Histogram

Definition at line 1764 of file tools_func.F90.

◆ func_independent_levels()

subroutine tools_func::func_independent_levels	(	type(mpl_type), intent(inout)	mpl,
		integer, intent(in)	nlx,
		integer, dimension(nlx), intent(in)	grid_hash,
		integer, intent(out)	nlxi,
		integer, dimension(nlx), intent(out)	lx_to_lxi,
		integer, dimension(nlx), intent(out)	lxi_to_lx,
		integer, intent(in)	ifmt
	)

private

Compute independent levels.

Parameters

[in,out]	mpl	MPI data
[in]	nlx	Number of levels
[in]	grid_hash	Grid hash profile
[out]	nlxi	Number of independent levels
[out]	lx_to_lxi	Levels to independent levels
[out]	lxi_to_lx	Independent levels to levels
[in]	ifmt	Indentation

Definition at line 459 of file tools_func.F90.

◆ func_inside()

subroutine tools_func::func_inside	(	type(mpl_type), intent(inout)	mpl,
		real(kind_real), dimension(:,:), intent(in)	vbnd,
		real(kind_real), intent(in)	lon,
		real(kind_real), intent(in)	lat,
		logical, intent(out)	inside_hull
	)

private

Find whether a point is inside the hull boundaries or not.

Parameters

[in,out]	mpl	MPI data
[in]	vbnd	Boundary coordinates
[in]	lon	Longitude
[in]	lat	Latitude
[out]	inside_hull	True if the point is inside the hull

Definition at line 792 of file tools_func.F90.

◆ func_lct_d2h()

subroutine tools_func::func_lct_d2h	(	type(mpl_type), intent(inout)	mpl,
		real(kind_real), intent(in)	D11,
		real(kind_real), intent(in)	D22,
		real(kind_real), intent(in)	D33,
		real(kind_real), intent(in)	D12,
		real(kind_real), intent(out)	H11,
		real(kind_real), intent(out)	H22,
		real(kind_real), intent(out)	H33,
		real(kind_real), intent(out)	H12
	)

private

From D (Daley tensor) to H (local correlation tensor)

Parameters

[in,out]	mpl	MPI data
[in]	d11	Daley tensor component 11
[in]	d22	Daley tensor component 22
[in]	d33	Daley tensor component 33
[in]	d12	Daley tensor component 12
[out]	h11	Local correlation tensor component 11
[out]	h22	Local correlation tensor component 22
[out]	h33	Local correlation tensor component 33
[out]	h12	Local correlation tensor component 12

Definition at line 1389 of file tools_func.F90.

◆ func_lct_h2r()

subroutine tools_func::func_lct_h2r	(	type(mpl_type), intent(inout)	mpl,
		real(kind_real), intent(in)	H11,
		real(kind_real), intent(in)	H22,
		real(kind_real), intent(in)	H33,
		real(kind_real), intent(in)	H12,
		real(kind_real), intent(out)	rh,
		real(kind_real), intent(out)	rv
	)

private

From H (local correlation tensor) to support radii.

Parameters

[in,out]	mpl	MPI data
[in]	h11	Local correlation tensor component 11
[in]	h22	Local correlation tensor component 22
[in]	h33	Local correlation tensor component 33
[in]	h12	Local correlation tensor component 12
[out]	rh	Horizontal support radius
[out]	rv	Vertical support radius

Definition at line 1447 of file tools_func.F90.

◆ func_lct_r2d()

subroutine tools_func::func_lct_r2d	(	real(kind_real), intent(in)	r,
		real(kind_real), intent(out)	D
	)

private

From support radius to Daley tensor diagonal element.

Parameters

[in]	r	Support radius
[out]	d	Daley tensor diagonal element

Definition at line 1512 of file tools_func.F90.

◆ func_lonlat2xyz()

subroutine tools_func::func_lonlat2xyz	(	type(mpl_type), intent(inout)	mpl,
		real(kind_real), intent(in)	lon,
		real(kind_real), intent(in)	lat,
		real(kind_real), intent(out)	x,
		real(kind_real), intent(out)	y,
		real(kind_real), intent(out)	z
	)

private

Convert longitude/latitude to cartesian coordinates.

Parameters

[in,out]	mpl	MPI data
[in]	lon	Longitude [radians]
[in]	lat	Latitude [radians]
[out]	x	X coordinate
[out]	y	Y coordinate
[out]	z	Z coordinate

Definition at line 616 of file tools_func.F90.

◆ func_lonlatmod()

subroutine tools_func::func_lonlatmod	(	real(kind_real), intent(inout)	lon,
		real(kind_real), intent(inout)	lat
	)

private

Set latitude between -pi/2 and pi/2 and longitude between -pi and pi.

Parameters

[in,out]	lon	Longitude [radians]
[in,out]	lat	Latitude [radians]

Definition at line 354 of file tools_func.F90.

◆ func_matern()

real(kind_real) function tools_func::func_matern	(	type(mpl_type), intent(inout)	mpl,
		integer, intent(in)	M,
		real(kind_real), intent(in)	x
	)

private

Compute the normalized diffusion function from eq. (55) of Mirouze and Weaver (2013), for the 3d case (d = 3)

Parameters

[in,out]	mpl	MPI data
[in]	m	Matern function order
[in]	x	Argument

Definition at line 1588 of file tools_func.F90.

◆ func_order_cc()

subroutine tools_func::func_order_cc	(	type(mpl_type), intent(inout)	mpl,
		real(kind_real), intent(in)	lon,
		real(kind_real), intent(in)	lat,
		integer	n,
		real(kind_real), dimension(n), intent(in)	x,
		real(kind_real), dimension(n), intent(in)	y,
		real(kind_real), dimension(n), intent(in)	z,
		integer, dimension(n), intent(out)	order,
		real(kind_real), dimension(n), intent(out), optional	diff
	)

private

Order points in counter-clockwise order with respect to a central point.

Parameters

[in,out]	mpl	MPI data
[in]	lon	Longitude of the central point
[in]	lat	Latitude of the central point
	n	Number of points
[in]	x	List of X-coordinates
[in]	y	List of Y-coordinates
[in]	z	List of Z-coordinates
[out]	order	Counter-clockwise order
[out]	diff	Angles differences

Definition at line 851 of file tools_func.F90.

◆ func_sphere_dist()

subroutine tools_func::func_sphere_dist	(	real(kind_real), intent(in)	lon_i,
		real(kind_real), intent(in)	lat_i,
		real(kind_real), intent(in)	lon_f,
		real(kind_real), intent(in)	lat_f,
		real(kind_real), intent(out)	dist
	)

private

Compute the great-circle distance between two points.

Parameters

[in]	lon_i	Initial point longitude [radians]
[in]	lat_i	Initial point latitude [radians]
[in]	lon_f	Final point longitude [radians]
[in]	lat_f	Final point latitude [radians]
[out]	dist	Great-circle distance

Definition at line 581 of file tools_func.F90.

◆ func_syminv()

subroutine tools_func::func_syminv	(	type(mpl_type), intent(inout)	mpl,
		integer, intent(in)	n,
		real(kind_real), dimension(n,n), intent(in)	a,
		real(kind_real), dimension(n,n), intent(out)	c
	)

private

Compute inverse of a symmetric matrix.

Parameters

[in,out]	mpl	MPI data
[in]	n	Matrix rank
[in]	a	Matrix
[out]	c	Matrix inverse

Definition at line 1704 of file tools_func.F90.

◆ func_vector_product()

subroutine tools_func::func_vector_product	(	real(kind_real), dimension(3), intent(in)	v1,
		real(kind_real), dimension(3), intent(in)	v2,
		real(kind_real), dimension(3), intent(out)	vp
	)

private

Compute normalized vector product.

Parameters

[in]	v1	First vector
[in]	v2	Second vector
[out]	vp	Vector product

Definition at line 709 of file tools_func.F90.

◆ func_vert_interp()

subroutine tools_func::func_vert_interp	(	type(mpl_type), intent(inout)	mpl,
		integer, intent(in)	nl1,
		real(kind_real), dimension(nl1), intent(in)	var_l1,
		integer, intent(in)	nl0,
		integer, dimension(nl0), intent(in)	il1inf,
		integer, dimension(nl0), intent(in)	il1sup,
		real(kind_real), dimension(nl0), intent(in)	rinf,
		real(kind_real), dimension(nl0), intent(in)	rsup,
		real(kind_real), dimension(nl0), intent(out)	var_l0
	)

private

Apply vertical interpolation.

Parameters

[in,out]	mpl	MPI data
[in]	nl1	Number of interpolation levels
[in]	var_l1	Input variable
[in]	nl0	Number of levels
[in]	il1inf	Inferior interpolation levels
[in]	il1sup	Superior interpolation levels
[in]	rinf	Inferior interpolation weights
[in]	rsup	Superior interpolation weights
[out]	var_l0	Output variable

Definition at line 1105 of file tools_func.F90.

◆ func_vert_interp_setup()

subroutine tools_func::func_vert_interp_setup	(	integer, intent(in)	nl0,
		integer, intent(in)	dl0,
		integer, intent(in)	nl1,
		integer, dimension(nl1), intent(out)	il0_interp,
		integer, dimension(nl0), intent(out)	il1inf,
		integer, dimension(nl0), intent(out)	il1sup,
		real(kind_real), dimension(nl0), intent(out)	rinf,
		real(kind_real), dimension(nl0), intent(out)	rsup
	)

private

Setup vertical interpolation levels and weights.

Parameters

[in]	nl0	Number of levels
[in]	dl0	Level delta
[in]	nl1	Number of interpolation levels
[out]	il0_interp	Interpolation levels
[out]	il1inf	Inferior interpolation levels
[out]	il1sup	Superior interpolation levels
[out]	rinf	Inferior interpolation weights
[out]	rsup	Superior interpolation weights

Definition at line 1036 of file tools_func.F90.

◆ func_vert_interp_size()

subroutine tools_func::func_vert_interp_size	(	integer, intent(in)	nl0,
		integer, intent(in)	dl0,
		integer, intent(out)	nl1
	)

private

Count vertical interpolation levels.

Parameters

[in]	nl0	Number of levels
[in]	dl0	Level delta
[out]	nl1	Number of interpolation levels

Definition at line 996 of file tools_func.F90.

◆ func_xyz2lonlat()

subroutine tools_func::func_xyz2lonlat	(	type(mpl_type), intent(in)	mpl,
		real(kind_real), intent(in)	x,
		real(kind_real), intent(in)	y,
		real(kind_real), intent(in)	z,
		real(kind_real), intent(out)	lon,
		real(kind_real), intent(out)	lat
	)

private

Convert longitude/latitude to cartesian coordinates.

Parameters

[in]	mpl	MPI data
[in]	x	X coordinate
[in]	y	Y coordinate
[in]	z	Z coordinate
[out]	lon	Longitude [radians]
[out]	lat	Latitude [radians]

Definition at line 663 of file tools_func.F90.

◆ func_zss_count_r1()

integer function tools_func::func_zss_count_r1 ( logical, dimension(:), intent(in) array )

private

Zero-size-safe count function.

Definition at line 3930 of file tools_func.F90.

◆ func_zss_count_r2()

integer function tools_func::func_zss_count_r2 ( logical, dimension(:,:), intent(in) array )

private

Zero-size-safe count function.

Definition at line 3961 of file tools_func.F90.

◆ func_zss_count_r3()

integer function tools_func::func_zss_count_r3 ( logical, dimension(:,:,:), intent(in) array )

private

Zero-size-safe count function.

Definition at line 3992 of file tools_func.F90.

◆ func_zss_count_r4()

integer function tools_func::func_zss_count_r4 ( logical, dimension(:,:,:,:), intent(in) array )

private

Zero-size-safe count function.

Definition at line 4023 of file tools_func.F90.

◆ func_zss_count_r5()

integer function tools_func::func_zss_count_r5 ( logical, dimension(:,:,:,:,:), intent(in) array )

private

Zero-size-safe count function.

Definition at line 4054 of file tools_func.F90.

◆ func_zss_count_r6()

integer function tools_func::func_zss_count_r6 ( logical, dimension(:,:,:,:,:,:), intent(in) array )

private

Zero-size-safe count function.

Definition at line 4085 of file tools_func.F90.

◆ func_zss_maxval_int_r1()

integer(kind_int) function tools_func::func_zss_maxval_int_r1	(	integer(kind_int), dimension(:), intent(in)	array,
		logical, dimension(:), intent(in), optional	mask
	)

private

Zero-size-safe maxval function.

Definition at line 2473 of file tools_func.F90.

◆ func_zss_maxval_int_r2()

integer(kind_int) function tools_func::func_zss_maxval_int_r2	(	integer(kind_int), dimension(:,:), intent(in)	array,
		logical, dimension(:,:), intent(in), optional	mask
	)

private

Zero-size-safe maxval function.

Definition at line 2513 of file tools_func.F90.

◆ func_zss_maxval_int_r3()

integer(kind_int) function tools_func::func_zss_maxval_int_r3	(	integer(kind_int), dimension(:,:,:), intent(in)	array,
		logical, dimension(:,:,:), intent(in), optional	mask
	)

private

Zero-size-safe maxval function.

Definition at line 2553 of file tools_func.F90.

◆ func_zss_maxval_int_r4()

integer(kind_int) function tools_func::func_zss_maxval_int_r4	(	integer(kind_int), dimension(:,:,:,:), intent(in)	array,
		logical, dimension(:,:,:,:), intent(in), optional	mask
	)

private

Zero-size-safe maxval function.

Definition at line 2593 of file tools_func.F90.

◆ func_zss_maxval_int_r5()

integer(kind_int) function tools_func::func_zss_maxval_int_r5	(	integer(kind_int), dimension(:,:,:,:,:), intent(in)	array,
		logical, dimension(:,:,:,:,:), intent(in), optional	mask
	)

private

Zero-size-safe maxval function.

Definition at line 2633 of file tools_func.F90.

◆ func_zss_maxval_int_r6()

integer(kind_int) function tools_func::func_zss_maxval_int_r6	(	integer(kind_int), dimension(:,:,:,:,:,:), intent(in)	array,
		logical, dimension(:,:,:,:,:,:), intent(in), optional	mask
	)

private

Zero-size-safe maxval function.

Definition at line 2673 of file tools_func.F90.

◆ func_zss_maxval_real_r1()

real(kind_real) function tools_func::func_zss_maxval_real_r1	(	real(kind_real), dimension(:), intent(in)	array,
		logical, dimension(:), intent(in), optional	mask
	)

private

Zero-size-safe maxval function.

Definition at line 2715 of file tools_func.F90.

◆ func_zss_maxval_real_r2()

real(kind_real) function tools_func::func_zss_maxval_real_r2	(	real(kind_real), dimension(:,:), intent(in)	array,
		logical, dimension(:,:), intent(in), optional	mask
	)

private

Zero-size-safe maxval function.

Definition at line 2755 of file tools_func.F90.

◆ func_zss_maxval_real_r3()

real(kind_real) function tools_func::func_zss_maxval_real_r3	(	real(kind_real), dimension(:,:,:), intent(in)	array,
		logical, dimension(:,:,:), intent(in), optional	mask
	)

private

Zero-size-safe maxval function.

Definition at line 2795 of file tools_func.F90.

◆ func_zss_maxval_real_r4()

real(kind_real) function tools_func::func_zss_maxval_real_r4	(	real(kind_real), dimension(:,:,:,:), intent(in)	array,
		logical, dimension(:,:,:,:), intent(in), optional	mask
	)

private

Zero-size-safe maxval function.

Definition at line 2835 of file tools_func.F90.

◆ func_zss_maxval_real_r5()

real(kind_real) function tools_func::func_zss_maxval_real_r5	(	real(kind_real), dimension(:,:,:,:,:), intent(in)	array,
		logical, dimension(:,:,:,:,:), intent(in), optional	mask
	)

private

Zero-size-safe maxval function.

Definition at line 2875 of file tools_func.F90.

◆ func_zss_maxval_real_r6()

real(kind_real) function tools_func::func_zss_maxval_real_r6	(	real(kind_real), dimension(:,:,:,:,:,:), intent(in)	array,
		logical, dimension(:,:,:,:,:,:), intent(in), optional	mask
	)

private

Zero-size-safe maxval function.

Definition at line 2915 of file tools_func.F90.