Subroutines/functions list. More...

Data Types
type	vbal_type

Functions/Subroutines
subroutine	vbal_alloc (vbal, mpl, nam, geom, bpar, samp, nsub)
	Allocation. More...

subroutine	vbal_partial_dealloc (vbal)
	Release memory (partial) More...

subroutine	vbal_dealloc (vbal)
	Release memory (full) More...

subroutine	vbal_cov_read_local (vbal, mpl, nam, geom, bpar, samp, nsub)
	Read local full covariances. More...

subroutine	vbal_cov_write_local (vbal, mpl, nam, geom, samp)
	Write local full covariances. More...

subroutine	vbal_cov_read_global (vbal, mpl, nam, geom, bpar, samp, nsub)
	Read local full covariances. More...

subroutine	vbal_cov_write_global (vbal, mpl, nam, geom, samp)
	Write local full covariances. More...

subroutine	vbal_cov_run (vbal, mpl, nam, geom, bpar, samp, ens)
	Compute vertical covariance. More...

subroutine	vbal_cov_update (vbal, mpl, nam, geom, bpar, samp, fld_c0a, ie)
	Update vertical covariance. More...

subroutine	vbal_read_local (vbal, mpl, nam, geom, bpar, samp)
	Read local data. More...

subroutine	vbal_write_local (vbal, mpl, nam, geom, bpar, samp)
	Write local data. More...

subroutine	vbal_read_global (vbal, mpl, nam, geom, bpar, samp)
	Read global data. More...

subroutine	vbal_write_global (vbal, mpl, nam, geom, bpar, samp)
	Write global data. More...

subroutine	vbal_run_vbal (vbal, mpl, nam, geom, bpar, samp, ens, ensu)
	Compute vertical balance. More...

subroutine	vbal_run_vbal_tests (vbal, mpl, rng, nam, geom, bpar)
	Compute vertical balance tests. More...

subroutine	vbal_apply (vbal, nam, geom, bpar, fld)
	Apply vertical balance. More...

subroutine	vbal_apply_inv (vbal, nam, geom, bpar, fld)
	Apply inverse vertical balance. More...

subroutine	vbal_apply_ad (vbal, nam, geom, bpar, fld)
	Apply adjoint vertical balance. More...

subroutine	vbal_apply_inv_ad (vbal, nam, geom, bpar, fld)
	Apply inverse adjoint vertical balance. More...

subroutine	vbal_test_inverse (vbal, mpl, rng, nam, geom, bpar)
	Test vertical balance inverse. More...

subroutine	vbal_test_adjoint (vbal, mpl, rng, nam, geom, bpar)
	Test vertical balance adjoint. More...

subroutine	vbal_test_dirac (vbal, mpl, nam, geom, bpar)
	Apply vertical balance to diracs. More...

Detailed Description

Subroutines/functions list.

Instrumentation functions Vertical balance derived type

Function/Subroutine Documentation

◆ vbal_alloc()

subroutine type_vbal::vbal_alloc	(	class(vbal_type), intent(inout)	vbal,
		type(mpl_type), intent(inout)	mpl,
		type(nam_type), intent(in)	nam,
		type(geom_type), intent(in)	geom,
		type(bpar_type), intent(in)	bpar,
		type(samp_type), intent(in)	samp,
		integer, intent(in), optional	nsub
	)

private

Allocation.

Parameters

[in,out]	vbal	Vertical balance
[in,out]	mpl	MPI data
[in]	nam	Namelist
[in]	geom	Geometry
[in]	bpar	Block parameters
[in]	samp	Sampling
[in]	nsub	Number of sub-ensembles

Definition at line 94 of file type_vbal.F90.

◆ vbal_apply()

subroutine type_vbal::vbal_apply	(	class(vbal_type), intent(in)	vbal,
		type(nam_type), intent(in)	nam,
		type(geom_type), intent(in)	geom,
		type(bpar_type), intent(in)	bpar,
		real(kind_real), dimension(geom%nc0a,geom%nl0,nam%nv), intent(inout)	fld
	)

private

Apply vertical balance.

Parameters

[in]	vbal	Vertical balance
[in]	nam	Namelist
[in]	geom	Geometry
[in]	bpar	Block parameters
[in,out]	fld	Source/destination vector

Definition at line 1356 of file type_vbal.F90.

◆ vbal_apply_ad()

subroutine type_vbal::vbal_apply_ad	(	class(vbal_type), intent(in)	vbal,
		type(nam_type), intent(in)	nam,
		type(geom_type), intent(in)	geom,
		type(bpar_type), intent(in)	bpar,
		real(kind_real), dimension(geom%nc0a,geom%nl0,nam%nv), intent(inout)	fld
	)

private

Apply adjoint vertical balance.

Parameters

[in]	vbal	Vertical balance
[in]	nam	Namelist
[in]	geom	Geometry
[in]	bpar	Block parameters
[in,out]	fld	Source/destination vector

Definition at line 1450 of file type_vbal.F90.

◆ vbal_apply_inv()

subroutine type_vbal::vbal_apply_inv	(	class(vbal_type), intent(in)	vbal,
		type(nam_type), intent(in)	nam,
		type(geom_type), intent(in)	geom,
		type(bpar_type), intent(in)	bpar,
		real(kind_real), dimension(geom%nc0a,geom%nl0,nam%nv), intent(inout)	fld
	)

private

Apply inverse vertical balance.

Parameters

[in]	vbal	Vertical balance
[in]	nam	Namelist
[in]	geom	Geometry
[in]	bpar	Block parameters
[in,out]	fld	Source/destination vector

Definition at line 1403 of file type_vbal.F90.

◆ vbal_apply_inv_ad()

subroutine type_vbal::vbal_apply_inv_ad	(	class(vbal_type), intent(in)	vbal,
		type(nam_type), intent(in)	nam,
		type(geom_type), intent(in)	geom,
		type(bpar_type), intent(in)	bpar,
		real(kind_real), dimension(geom%nc0a,geom%nl0,nam%nv), intent(inout)	fld
	)

private

Apply inverse adjoint vertical balance.

Parameters

[in]	vbal	Vertical balance
[in]	nam	Namelist
[in]	geom	Geometry
[in]	bpar	Block parameters
[in,out]	fld	Source/destination vector

Definition at line 1497 of file type_vbal.F90.

◆ vbal_cov_read_global()

subroutine type_vbal::vbal_cov_read_global	(	class(vbal_type), intent(inout)	vbal,
		type(mpl_type), intent(inout)	mpl,
		type(nam_type), intent(inout)	nam,
		type(geom_type), intent(in)	geom,
		type(bpar_type), intent(in)	bpar,
		type(samp_type), intent(in)	samp,
		integer, intent(in)	nsub
	)

private

Read local full covariances.

Parameters

[in,out]	vbal	Vertical balance
[in,out]	mpl	MPI data
[in,out]	nam	Namelist
[in]	geom	Geometry
[in]	bpar	Block parameters
[in]	samp	Sampling
[in]	nsub	Number of sub-ensembles

Definition at line 362 of file type_vbal.F90.

◆ vbal_cov_read_local()

subroutine type_vbal::vbal_cov_read_local	(	class(vbal_type), intent(inout)	vbal,
		type(mpl_type), intent(inout)	mpl,
		type(nam_type), intent(inout)	nam,
		type(geom_type), intent(in)	geom,
		type(bpar_type), intent(in)	bpar,
		type(samp_type), intent(in)	samp,
		integer, intent(in)	nsub
	)

private

Read local full covariances.

Parameters

[in,out]	vbal	Vertical balance
[in,out]	mpl	MPI data
[in,out]	nam	Namelist
[in]	geom	Geometry
[in]	bpar	Block parameters
[in]	samp	Sampling
[in]	nsub	Number of sub-ensembles

Definition at line 214 of file type_vbal.F90.

◆ vbal_cov_run()

subroutine type_vbal::vbal_cov_run	(	class(vbal_type), intent(inout)	vbal,
		type(mpl_type), intent(inout)	mpl,
		type(nam_type), intent(inout)	nam,
		type(geom_type), intent(in)	geom,
		type(bpar_type), intent(in)	bpar,
		type(samp_type), intent(in)	samp,
		type(ens_type), intent(inout)	ens
	)

private

Compute vertical covariance.

Parameters

[in,out]	vbal	Vertical balance
[in,out]	mpl	MPI data
[in,out]	nam	Namelist
[in]	geom	Geometry
[in]	bpar	Block parameters
[in]	samp	Sampling
[in,out]	ens	Ensemble

Definition at line 510 of file type_vbal.F90.

◆ vbal_cov_update()

subroutine type_vbal::vbal_cov_update	(	class(vbal_type), intent(inout)	vbal,
		type(mpl_type), intent(inout)	mpl,
		type(nam_type), intent(inout)	nam,
		type(geom_type), intent(in)	geom,
		type(bpar_type), intent(in)	bpar,
		type(samp_type), intent(inout)	samp,
		real(kind_real), dimension(geom%nc0a,geom%nl0,nam%nv), intent(in)	fld_c0a,
		integer, intent(in)	ie
	)

private

Update vertical covariance.

Parameters

[in,out]	vbal	Vertical balance
[in,out]	mpl	MPI data
[in,out]	nam	Namelist
[in]	geom	Geometry
[in]	bpar	Block parameters
[in,out]	samp	Sampling
[in]	fld_c0a	Field
[in]	ie	Member index

Definition at line 561 of file type_vbal.F90.

◆ vbal_cov_write_global()

subroutine type_vbal::vbal_cov_write_global	(	class(vbal_type), intent(inout)	vbal,
		type(mpl_type), intent(inout)	mpl,
		type(nam_type), intent(in)	nam,
		type(geom_type), intent(in)	geom,
		type(samp_type), intent(in)	samp
	)

private

Write local full covariances.

Parameters

[in,out]	vbal	Vertical balance
[in,out]	mpl	MPI data
[in]	nam	Namelist
[in]	geom	Geometry
[in]	samp	Sampling

Definition at line 447 of file type_vbal.F90.

◆ vbal_cov_write_local()

subroutine type_vbal::vbal_cov_write_local	(	class(vbal_type), intent(inout)	vbal,
		type(mpl_type), intent(inout)	mpl,
		type(nam_type), intent(in)	nam,
		type(geom_type), intent(in)	geom,
		type(samp_type), intent(in)	samp
	)

private

Write local full covariances.

Parameters

[in,out]	vbal	Vertical balance
[in,out]	mpl	MPI data
[in]	nam	Namelist
[in]	geom	Geometry
[in]	samp	Sampling

Definition at line 299 of file type_vbal.F90.

◆ vbal_dealloc()

subroutine type_vbal::vbal_dealloc ( class(vbal_type), intent(inout) vbal )

private

Release memory (full)

Parameters

[in,out] vbal Vertical balance

Definition at line 176 of file type_vbal.F90.

◆ vbal_partial_dealloc()

subroutine type_vbal::vbal_partial_dealloc ( class(vbal_type), intent(inout) vbal )

private

Release memory (partial)

Parameters

[in,out] vbal Vertical balance

Definition at line 142 of file type_vbal.F90.

◆ vbal_read_global()

subroutine type_vbal::vbal_read_global	(	class(vbal_type), intent(inout)	vbal,
		type(mpl_type), intent(inout)	mpl,
		type(nam_type), intent(inout)	nam,
		type(geom_type), intent(in)	geom,
		type(bpar_type), intent(in)	bpar,
		type(samp_type), intent(in)	samp
	)

private

Read global data.

Parameters

[in,out]	vbal	Vertical balance
[in,out]	mpl	MPI data
[in,out]	nam	Namelist
[in]	geom	Geometry
[in]	bpar	Block parameters
[in]	samp	Sampling

Definition at line 858 of file type_vbal.F90.

◆ vbal_read_local()

subroutine type_vbal::vbal_read_local	(	class(vbal_type), intent(inout)	vbal,
		type(mpl_type), intent(inout)	mpl,
		type(nam_type), intent(inout)	nam,
		type(geom_type), intent(in)	geom,
		type(bpar_type), intent(in)	bpar,
		type(samp_type), intent(in)	samp
	)

private

Read local data.

Parameters

[in,out]	vbal	Vertical balance
[in,out]	mpl	MPI data
[in,out]	nam	Namelist
[in]	geom	Geometry
[in]	bpar	Block parameters
[in]	samp	Sampling

Definition at line 615 of file type_vbal.F90.

◆ vbal_run_vbal()

subroutine type_vbal::vbal_run_vbal	(	class(vbal_type), intent(inout)	vbal,
		type(mpl_type), intent(inout)	mpl,
		type(nam_type), intent(inout)	nam,
		type(geom_type), intent(in)	geom,
		type(bpar_type), intent(in)	bpar,
		type(samp_type), intent(in)	samp,
		type(ens_type), intent(inout)	ens,
		type(ens_type), intent(inout)	ensu
	)

private

Compute vertical balance.

Parameters

[in,out]	vbal	Vertical balance
[in,out]	mpl	MPI data
[in,out]	nam	Namelist
[in]	geom	Geometry
[in]	bpar	Block parameters
[in]	samp	Sampling
[in,out]	ens	Ensemble
[in,out]	ensu	Unbalanced ensemble

Definition at line 1101 of file type_vbal.F90.

◆ vbal_run_vbal_tests()

subroutine type_vbal::vbal_run_vbal_tests	(	class(vbal_type), intent(inout)	vbal,
		type(mpl_type), intent(inout)	mpl,
		type(rng_type), intent(inout)	rng,
		type(nam_type), intent(inout)	nam,
		type(geom_type), intent(in)	geom,
		type(bpar_type), intent(in)	bpar
	)

private

Compute vertical balance tests.

Parameters

[in,out]	vbal	Vertical balance
[in,out]	mpl	MPI data
[in,out]	rng	Random number generator
[in,out]	nam	Namelist
[in]	geom	Geometry
[in]	bpar	Block parameters

Definition at line 1314 of file type_vbal.F90.

◆ vbal_test_adjoint()

subroutine type_vbal::vbal_test_adjoint	(	class(vbal_type), intent(in)	vbal,
		type(mpl_type), intent(inout)	mpl,
		type(rng_type), intent(inout)	rng,
		type(nam_type), intent(in)	nam,
		type(geom_type), intent(in)	geom,
		type(bpar_type), intent(in)	bpar
	)

private

Test vertical balance adjoint.

Parameters

[in]	vbal	Vertical balance
[in,out]	mpl	MPI data
[in,out]	rng	Random number generator
[in]	nam	Namelist
[in]	geom	Geometry
[in]	bpar	Block parameters

Definition at line 1616 of file type_vbal.F90.

◆ vbal_test_dirac()

subroutine type_vbal::vbal_test_dirac	(	class(vbal_type), intent(in)	vbal,
		type(mpl_type), intent(inout)	mpl,
		type(nam_type), intent(in)	nam,
		type(geom_type), intent(in)	geom,
		type(bpar_type), intent(in)	bpar
	)

private

Apply vertical balance to diracs.

Parameters

[in]	vbal	Vertical balance
[in,out]	mpl	MPI data
[in]	nam	Namelist
[in]	geom	Geometry
[in]	bpar	Block parameters

Definition at line 1692 of file type_vbal.F90.

◆ vbal_test_inverse()

subroutine type_vbal::vbal_test_inverse	(	class(vbal_type), intent(in)	vbal,
		type(mpl_type), intent(inout)	mpl,
		type(rng_type), intent(inout)	rng,
		type(nam_type), intent(in)	nam,
		type(geom_type), intent(in)	geom,
		type(bpar_type), intent(in)	bpar
	)

private

Test vertical balance inverse.

Parameters

[in]	vbal	Vertical balance
[in,out]	mpl	MPI data
[in,out]	rng	Random number generator
[in]	nam	Namelist
[in]	geom	Geometry
[in]	bpar	Block parameters

Definition at line 1544 of file type_vbal.F90.

◆ vbal_write_global()

subroutine type_vbal::vbal_write_global	(	class(vbal_type), intent(inout)	vbal,
		type(mpl_type), intent(inout)	mpl,
		type(nam_type), intent(in)	nam,
		type(geom_type), intent(in)	geom,
		type(bpar_type), intent(in)	bpar,
		type(samp_type), intent(in)	samp
	)

private

Write global data.

Parameters

[in,out]	vbal	Vertical balance
[in,out]	mpl	MPI data
[in]	nam	Namelist
[in]	geom	Geometry
[in]	bpar	Block parameters
[in]	samp	Sampling

Definition at line 970 of file type_vbal.F90.

◆ vbal_write_local()

subroutine type_vbal::vbal_write_local	(	class(vbal_type), intent(inout)	vbal,
		type(mpl_type), intent(inout)	mpl,
		type(nam_type), intent(in)	nam,
		type(geom_type), intent(in)	geom,
		type(bpar_type), intent(in)	bpar,
		type(samp_type), intent(in)	samp
	)

private

Write local data.

Parameters

[in,out]	vbal	Vertical balance
[in,out]	mpl	MPI data
[in]	nam	Namelist
[in]	geom	Geometry
[in]	bpar	Block parameters
[in]	samp	Sampling

Definition at line 727 of file type_vbal.F90.

Data Types

Functions/Subroutines

Detailed Description

Function/Subroutine Documentation

◆ vbal_alloc()

◆ vbal_apply()

◆ vbal_apply_ad()

◆ vbal_apply_inv()

◆ vbal_apply_inv_ad()

◆ vbal_cov_read_global()

◆ vbal_cov_read_local()

◆ vbal_cov_run()

◆ vbal_cov_update()

◆ vbal_cov_write_global()

◆ vbal_cov_write_local()

◆ vbal_dealloc()

◆ vbal_partial_dealloc()

◆ vbal_read_global()

◆ vbal_read_local()

◆ vbal_run_vbal()

◆ vbal_run_vbal_tests()

◆ vbal_test_adjoint()

◆ vbal_test_dirac()

◆ vbal_test_inverse()

◆ vbal_write_global()

◆ vbal_write_local()