field_utils_setup Module

Uses

- ESMF
- funit
- MAPL_ExceptionHandling
Help

Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.
Where possible, edges connecting nodes are given different colours to make them easier to distinguish in large graphs.

Used by

Help

Graph Key

Nodes of different colours represent the following:

Solid arrows point from a submodule to the (sub)module which it is descended from. Dashed arrows point from a module or program unit to modules which it uses.
Where possible, edges connecting nodes are given different colours to make them easier to distinguish in large graphs.

Variables

Type	Visibility	Attributes		Name		Initial
integer,	public		::	i
real(kind=ESMF_KIND_R4),	public,	parameter	::	R4_ARRAY_DEFAULT(,)	=	reshape([(i, i=1, 4)], [2, 2])
real(kind=ESMF_KIND_R8),	public,	parameter	::	R8_ARRAY_DEFAULT(,)	=	reshape([(i, i=1, 4)], [2, 2])
real,	public,	parameter	::	undef	=	42.0
type(ESMF_Field),	public		::	XR4
type(ESMF_Field),	public		::	XR4_3D
type(ESMF_Field),	public		::	XR8
type(ESMF_Field),	public		::	XR8_3D
type(ESMF_Field),	public		::	YR4
type(ESMF_Field),	public		::	YR4_3D
type(ESMF_Field),	public		::	YR8
type(ESMF_Field),	public		::	YR8_3D
type(ESMF_Index_Flag),	public,	parameter	::	INDEX_FLAG_DEFAULT	=	ESMF_INDEX_DELOCAL

Interfaces

public interface initialize_array

public subroutine initialize_array_R4(x, xmin, xrange)

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=ESMF_KIND_R4),	intent(inout)			::	x(:,:)
real(kind=ESMF_KIND_R4),	intent(in)			::	xmin
real(kind=ESMF_KIND_R4),	intent(in)			::	xrange

public subroutine initialize_array_R8(x, xmin, xrange)

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=ESMF_KIND_R8),	intent(inout)			::	x(:,:)
real(kind=ESMF_KIND_R8),	intent(in)			::	xmin
real(kind=ESMF_KIND_R8),	intent(in)			::	xrange

public interface mk_field

public function mk_field_r4_2d(farray, name, rc) result(field)

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=ESMF_KIND_R4),	intent(in),		dimension(:,:), target	::	farray
character(len=*),	intent(in)			::	name
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_Field)

public function mk_field_r8_2d(farray, name, rc) result(field)

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=ESMF_KIND_R8),	intent(in),		dimension(:,:), target	::	farray
character(len=*),	intent(in)			::	name
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_Field)

Functions

public elemental function are_almost_equal(x, y) result(almost_equal)

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=ESMF_KIND_R8),	intent(in)			::	x
real(kind=ESMF_KIND_R4),	intent(in)			::	y

Return Value logical

public function mk_field_common(tk, name, ungriddedLBound, ungriddedUBound, rc) result(field)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_TypeKind_Flag),	intent(in)			::	tk
character(len=*),	intent(in)			::	name
integer,	intent(in),	optional		::	ungriddedLBound(:)
integer,	intent(in),	optional		::	ungriddedUBound(:)
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_Field)

public function mk_field_r4_2d(farray, name, rc) result(field)

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=ESMF_KIND_R4),	intent(in),		dimension(:,:), target	::	farray
character(len=*),	intent(in)			::	name
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_Field)

public function mk_field_r4_ungrid(name, ungriddedLBound, ungriddedUBound, rc) result(field)

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	name
integer,	intent(in),	optional		::	ungriddedLBound(:)
integer,	intent(in),	optional		::	ungriddedUBound(:)
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_Field)

public function mk_field_r8_2d(farray, name, rc) result(field)

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=ESMF_KIND_R8),	intent(in),		dimension(:,:), target	::	farray
character(len=*),	intent(in)			::	name
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_Field)

public function mk_r4field(r4array, field_name, rc) result(r4field)

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=ESMF_KIND_R4),	intent(in)			::	r4array(:,:)
character(len=*),	intent(in)			::	field_name
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_Field)

public function mk_r4ungrid_field(field_name, lbound, ubound, rc) result(r4field)

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	field_name
integer,	intent(in)			::	lbound
integer,	intent(in)			::	ubound
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_Field)

public function mk_r8field(r8array, field_name, rc) result(r8field)

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=ESMF_KIND_R8),	intent(in)			::	r8array(:,:)
character(len=*),	intent(in)			::	field_name
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_Field)

public function mk_grid(grid_name, rc) result(grid)

Arguments

Type	Intent	Optional	Attributes		Name
character(len=*),	intent(in)			::	grid_name
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_Grid)

Subroutines

public subroutine initialize_array_R4(x, xmin, xrange)

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=ESMF_KIND_R4),	intent(inout)			::	x(:,:)
real(kind=ESMF_KIND_R4),	intent(in)			::	xmin
real(kind=ESMF_KIND_R4),	intent(in)			::	xrange

public subroutine initialize_array_R8(x, xmin, xrange)

Arguments

Type	Intent	Optional	Attributes		Name
real(kind=ESMF_KIND_R8),	intent(inout)			::	x(:,:)
real(kind=ESMF_KIND_R8),	intent(in)			::	xmin
real(kind=ESMF_KIND_R8),	intent(in)			::	xrange