Functions/Subroutines
pure logical function	field_is_scalar (fieldName)
	Test for a form of water vapor or hydrometeor of interest. More...

pure logical function	match_scalar (scalarName, fieldName)
	Test for a form of water vapor or hydrometeor of interest. More...

subroutine	mpas_pool_demo (block)
	Demonstrate basic usage of MPAS pools. More...

subroutine, public	da_operator_addition (pool_a, pool_b)
	Performs A = A + B for pools A and B. More...

subroutine, public	da_copy_all2sub_fields (domain, pool_a)
	Performs a copy of allfield to a sub pool A. More...

subroutine, public	da_copy_sub2all_fields (domain, pool_a)
	Performs a copy of a sub pool A to allfields. More...

subroutine, public	da_template_pool (geom, templatePool, nf, fieldnames)
	Subset a pool from fields described in geom. More...

subroutine	mpas_pool_template_field (srcFieldName, srcPool, dstFieldName, dstPool)
	Add a field to dstPool that is templated on a srcPool field. More...

integer function	da_common_vars (pool_a, fieldname)

subroutine, public	da_random (pool_a, fld_select)
	Performs random for pool A. More...

subroutine, public	da_operator (kind_op, pool_a, pool_b, pool_c, fld_select)
	Performs A = A 'kind_op' B for pools A and B. More...

subroutine, public	da_self_mult (pool_a, zz)
	Performs A = A * zz for pool A, zz a real number. More...

subroutine, public	da_constant (pool_a, realvalue, fld_select)
	Performs A = constant. for pool A. More...

subroutine, public	da_posdef (pool_a, fld_select)
	Performs A = max(0.,A) for pool A. More...

subroutine, public	da_setval (pool_a, zz)
	Performs A = Val_R. for pool A. More...

subroutine, public	da_axpy (pool_a, pool_b, zz, fld_select)
	Performs A = A + B * zz for pools A and B. More...

subroutine, public	da_gpnorm (pool_a, dminfo, nf, pstat, fld_select)
	Performs basic statistics min/max/norm given a pool. More...

subroutine, public	da_fldrms (pool_a, dminfo, fldrms, fld_select)
	Performs basic statistics min/max/norm given a pool. More...

subroutine, public	da_dot_product (pool_a, pool_b, dminfo, zprod)
	Performs the dot_product given two pools of fields. More...

subroutine, public	cvt_oopsmpas_date (inString2, outString2, iconv)

subroutine, public	uv_cell_to_edges (domain, u_field, v_field, du, lonCell, latCell, nCells, edgeNormalVectors, nEdgesOnCell, edgesOnCell, nVertLevels)

subroutine, public	r3_normalize (ax, ay, az)

Variables
character(len=1024)	message

Function/Subroutine Documentation

◆ cvt_oopsmpas_date()

subroutine, public mpas4da_mod::cvt_oopsmpas_date	(	character (len=*), intent(in)	inString2,
		character (len=*), intent(inout)	outString2,
		integer, intent(in)	iconv
	)

Definition at line 1544 of file mpas4da_mod.F90.

Here is the caller graph for this function:

◆ da_axpy()

subroutine, public mpas4da_mod::da_axpy	(	type (mpas_pool_type), intent(inout), pointer	pool_a,
		type (mpas_pool_type), intent(in), pointer	pool_b,
		real (kind=kind_real), intent(in)	zz,
		character (len=*), dimension(:), intent(in), optional	fld_select
	)

Performs A = A + B * zz for pools A and B.

Author: Gael Descombes

Date: 20 December 2017

Given two pools, A and B, where the fields in B are a subset of the fields in A, this routine adds the fields in B to fields in A with the same name. When A and B contain identical fields, this is equivalent to A = A + B.

Definition at line 1225 of file mpas4da_mod.F90.

Here is the caller graph for this function:

◆ da_common_vars()

integer function mpas4da_mod::da_common_vars	(	type (mpas_pool_type), pointer	pool_a,
		character (len=*), dimension(:)	fieldname
	)

private

Author: Gael Descombes

Date: 26 December 2017

Count the number of fields in a Pool related to a list of fields

Definition at line 689 of file mpas4da_mod.F90.

Here is the call graph for this function:

◆ da_constant()

subroutine, public mpas4da_mod::da_constant	(	type (mpas_pool_type), intent(inout), pointer	pool_a,
		real (kind=kind_real), intent(in)	realvalue,
		character (len=*), dimension(:), intent(in), optional	fld_select
	)

Performs A = constant. for pool A.

Author: Gael Descombes

Date: 22 December 2017

Definition at line 1032 of file mpas4da_mod.F90.

Here is the caller graph for this function:

◆ da_copy_all2sub_fields()

subroutine, public mpas4da_mod::da_copy_all2sub_fields	(	type (domain_type), intent(in), pointer	domain,
		type (mpas_pool_type), intent(inout), pointer	pool_a
	)

Performs a copy of allfield to a sub pool A.

Author: Gael Desccombes

Date: 5 February 2018

Given two pools, allfields and A, where the fields in A are a subset of the fields in allfields, this routine copy the fields allfields to fields in A with the same name.

Definition at line 297 of file mpas4da_mod.F90.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ da_copy_sub2all_fields()

subroutine, public mpas4da_mod::da_copy_sub2all_fields	(	type (domain_type), intent(inout), pointer	domain,
		type (mpas_pool_type), intent(in), pointer	pool_a
	)

Performs a copy of a sub pool A to allfields.

Author: Gael Desccombes

Date: 5 February 2018

Given two pools, allfields and A, where the fields in A are a subset of the fields in allfields, this routine copy the subfields to allfields with the same name.

Definition at line 396 of file mpas4da_mod.F90.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ da_dot_product()

subroutine, public mpas4da_mod::da_dot_product	(	type (mpas_pool_type), intent(in), pointer	pool_a,
		type (mpas_pool_type), intent(in), pointer	pool_b,
		type (dm_info), intent(in), pointer	dminfo,
		real(kind=kind_real), intent(out)	zprod
	)

Performs the dot_product given two pools of fields.

Author: Gael Descombes

Date: February 2018

Given two pools of fields, compute the dot_product

Definition at line 1479 of file mpas4da_mod.F90.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ da_fldrms()

subroutine, public mpas4da_mod::da_fldrms	(	type (mpas_pool_type), intent(in), pointer	pool_a,
		type (dm_info), intent(in), pointer	dminfo,
		real(kind=kind_real), intent(out)	fldrms,
		character (len=*), dimension(:), intent(in), optional	fld_select
	)

Performs basic statistics min/max/norm given a pool.

Author: Gael Descombes

Date: February 2018

Given a pool of fields, return min/max/norm array

Definition at line 1401 of file mpas4da_mod.F90.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ da_gpnorm()

subroutine, public mpas4da_mod::da_gpnorm	(	type (mpas_pool_type), intent(in), pointer	pool_a,
		type (dm_info), intent(in), pointer	dminfo,
		integer, intent(in)	nf,
		real(kind=kind_real), dimension(3, nf), intent(out)	pstat,
		character (len=*), dimension(nf), intent(in)	fld_select
	)

Performs basic statistics min/max/norm given a pool.

Author: Gael Descombes

Date: February 2018

Given a pool of fields, return min/max/norm array

Definition at line 1299 of file mpas4da_mod.F90.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ da_operator()

subroutine, public mpas4da_mod::da_operator	(	character (len=*)	kind_op,
		type (mpas_pool_type), pointer	pool_a,
		type (mpas_pool_type), pointer	pool_b,
		type (mpas_pool_type), optional, pointer	pool_c,
		character (len=*), dimension(:), optional	fld_select
	)

Performs A = A 'kind_op' B for pools A and B.

Author: Michael Duda

Date: 20 December 2017

Given two pools, A and B, where the fields in B are a subset of the fields in A, this routine adds the fields in B to fields in A with the same name. When A and B contain identical fields, this is equivalent to A = A 'kind_op' B. \modified by Gael DESCOMBES to apply diffferent operator

Definition at line 801 of file mpas4da_mod.F90.

Here is the caller graph for this function:

◆ da_operator_addition()

subroutine, public mpas4da_mod::da_operator_addition	(	type (mpas_pool_type), pointer	pool_a,
		type (mpas_pool_type), pointer	pool_b
	)

Performs A = A + B for pools A and B.

Author: Michael Duda

Date: 20 December 2017

Given two pools, A and B, where the fields in B are a subset of the fields in A, this routine adds the fields in B to fields in A with the same name. When A and B contain identical fields, this is equivalent to A = A + B.

Definition at line 228 of file mpas4da_mod.F90.

Here is the caller graph for this function:

◆ da_posdef()

subroutine, public mpas4da_mod::da_posdef	(	type (mpas_pool_type), intent(inout), pointer	pool_a,
		character (len=*), dimension(:), intent(in), optional	fld_select
	)

Performs A = max(0.,A) for pool A.

Author: JJ Guerrette

Date: 12 July 2019

Definition at line 1093 of file mpas4da_mod.F90.

Here is the caller graph for this function:

◆ da_random()

subroutine, public mpas4da_mod::da_random	(	type (mpas_pool_type), intent(inout), pointer	pool_a,
		character (len=*), dimension(:), intent(in), optional	fld_select
	)

Performs random for pool A.

Author: Gael Descombes

Date: January 2018

Definition at line 732 of file mpas4da_mod.F90.

Here is the caller graph for this function:

◆ da_self_mult()

subroutine, public mpas4da_mod::da_self_mult	(	type (mpas_pool_type), pointer	pool_a,
		real (kind=kind_real)	zz
	)

Performs A = A * zz for pool A, zz a real number.

Author: Gael Descombes

Date: 22 December 2017

Definition at line 971 of file mpas4da_mod.F90.

Here is the caller graph for this function:

◆ da_setval()

subroutine, public mpas4da_mod::da_setval	(	type (mpas_pool_type), pointer	pool_a,
		real (kind=kind_real)	zz
	)

Performs A = Val_R. for pool A.

Author: Gael Descombes

Date: 22 December 2017

Definition at line 1157 of file mpas4da_mod.F90.

◆ da_template_pool()

subroutine, public mpas4da_mod::da_template_pool	(	type (mpas_geom), intent(in)	geom,
		type (mpas_pool_type), intent(out), pointer	templatePool,
		integer, intent(in)	nf,
		character (len=*), dimension(nf), intent(in)	fieldnames
	)

Subset a pool from fields described in geom.

Given an mpas_geom object, create templatePool containing a subset of the fields in the geom % domain's allFields pool and the geom % templated_fields

Definition at line 495 of file mpas4da_mod.F90.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ field_is_scalar()

pure logical function mpas4da_mod::field_is_scalar ( character (len=*), intent(in) fieldName )

private

Test for a form of water vapor or hydrometeor of interest.

At various places in this module we wish to test for the case where a string is one of several 'q?' values. Rather than repeat that logic many times, it is encapsulated here.

Definition at line 82 of file mpas4da_mod.F90.

Here is the caller graph for this function:

◆ match_scalar()

pure logical function mpas4da_mod::match_scalar	(	character (len=*), intent(in)	scalarName,
		character (len=*), intent(in)	fieldName
	)

private

Test for a form of water vapor or hydrometeor of interest.

Author: Steven Vahl

Date: 11 July 2019

Test for the case where one string is 'scalars' and another string matches with available scalar variables.

Definition at line 105 of file mpas4da_mod.F90.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mpas_pool_demo()

subroutine mpas4da_mod::mpas_pool_demo ( type (block_type), pointer block )

private

Demonstrate basic usage of MPAS pools.

Author: Michael Duda

Date: 20 December 2017

This routine provides a simple demonstration of how to construct a new pool at runtime, add members (fields) to the pool, and to perform generic operations on that pool.

Definition at line 132 of file mpas4da_mod.F90.

Here is the call graph for this function:

◆ mpas_pool_template_field()

subroutine mpas4da_mod::mpas_pool_template_field	(	character (len=*), intent(in)	srcFieldName,
		type (mpas_pool_type), intent(in), pointer	srcPool,
		character (len=*), intent(in)	dstFieldName,
		type (mpas_pool_type), intent(inout), pointer	dstPool
	)

private

Add a field to dstPool that is templated on a srcPool field.

Duplicate srcFieldName from srcPool with the name dstFieldName in dstPool

Definition at line 586 of file mpas4da_mod.F90.

Here is the caller graph for this function:

◆ r3_normalize()

subroutine, public mpas4da_mod::r3_normalize	(	real(kind_real), intent(inout)	ax,
		real(kind_real), intent(inout)	ay,
		real(kind_real), intent(inout)	az
	)

Definition at line 1710 of file mpas4da_mod.F90.

Here is the caller graph for this function:

◆ uv_cell_to_edges()

subroutine, public mpas4da_mod::uv_cell_to_edges	(	type (domain_type), intent(inout), pointer	domain,
		type (field2dreal), intent(in), pointer	u_field,
		type (field2dreal), intent(in), pointer	v_field,
		type (field2dreal), intent(inout), pointer	du,
		real(kind_real), dimension(1:ncells), intent(in)	lonCell,
		real(kind_real), dimension(1:ncells), intent(in)	latCell,
		integer, intent(in)	nCells,
		real(kind_real), dimension(:,:), intent(in)	edgeNormalVectors,
		integer, dimension(:), intent(in)	nEdgesOnCell,
		integer, dimension(:,:), intent(in)	edgesOnCell,
		integer, intent(in)	nVertLevels
	)

Definition at line 1638 of file mpas4da_mod.F90.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ message

character(len=1024) mpas4da_mod::message

private

Definition at line 67 of file mpas4da_mod.F90.

Functions/Subroutines

Variables

Function/Subroutine Documentation

◆ cvt_oopsmpas_date()

◆ da_axpy()

◆ da_common_vars()

◆ da_constant()

◆ da_copy_all2sub_fields()

◆ da_copy_sub2all_fields()

◆ da_dot_product()

◆ da_fldrms()

◆ da_gpnorm()

◆ da_operator()

◆ da_operator_addition()

◆ da_posdef()

◆ da_random()

◆ da_self_mult()

◆ da_setval()

◆ da_template_pool()

◆ field_is_scalar()

◆ match_scalar()

◆ mpas_pool_demo()

◆ mpas_pool_template_field()

◆ r3_normalize()

◆ uv_cell_to_edges()

Variable Documentation

◆ message