ESMF_GeomMod Module

Uses

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
character(len=*),	private,	parameter	::	version	=	'$Id$'
type(ESMF_GeomMatch_Flag),	public,	parameter	::	ESMF_GEOMMATCH_ALIAS	=	ESMF_GeomMatch_Flag(2)
type(ESMF_GeomMatch_Flag),	public,	parameter	::	ESMF_GEOMMATCH_GEOMALIAS	=	ESMF_GeomMatch_Flag(3)
type(ESMF_GeomMatch_Flag),	public,	parameter	::	ESMF_GEOMMATCH_INVALID	=	ESMF_GeomMatch_Flag(0)
type(ESMF_GeomMatch_Flag),	public,	parameter	::	ESMF_GEOMMATCH_NONE	=	ESMF_GeomMatch_Flag(1)
type(ESMF_GeomType_Flag),	public,	parameter	::	ESMF_GEOMTYPE_GRID	=	ESMF_GeomType_Flag(1)
type(ESMF_GeomType_Flag),	public,	parameter	::	ESMF_GEOMTYPE_INVALID	=	ESMF_GeomType_Flag(-1)
type(ESMF_GeomType_Flag),	public,	parameter	::	ESMF_GEOMTYPE_LOCSTREAM	=	ESMF_GeomType_Flag(3)
type(ESMF_GeomType_Flag),	public,	parameter	::	ESMF_GEOMTYPE_MESH	=	ESMF_GeomType_Flag(2)
type(ESMF_GeomType_Flag),	public,	parameter	::	ESMF_GEOMTYPE_UNINIT	=	ESMF_GeomType_Flag(0)
type(ESMF_GeomType_Flag),	public,	parameter	::	ESMF_GEOMTYPE_XGRID	=	ESMF_GeomType_Flag(4)

Interfaces

public interface ESMF_GeomCreate

private function ESMF_GeomCreateGrid(grid, staggerloc, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Grid),	intent(in)			::	grid
type(ESMF_StaggerLoc),	intent(in),	optional		::	staggerloc
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_Geom)

private function ESMF_GeomCreateMesh(mesh, meshLoc, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Mesh),	intent(in)			::	mesh
type(ESMF_MeshLoc),	intent(in),	optional		::	meshLoc
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_Geom)

private function ESMF_GeomCreateLocStream(locstream, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_LocStream),	intent(in)			::	locstream
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_Geom)

private function ESMF_GeomCreateXGrid(xgrid, xgridSide, gridIndex, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_XGrid),	intent(in)			::	xgrid
type(ESMF_XGridSide_Flag),	intent(in),	optional		::	xgridSide
integer,	intent(in),	optional		::	gridIndex
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_Geom)

private interface operator (/=)

private impure elemental function ESMF_GeomMatchNotEqual(GeomMatch1, GeomMatch2)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GeomMatch_Flag),	intent(in)			::	GeomMatch1
type(ESMF_GeomMatch_Flag),	intent(in)			::	GeomMatch2

Return Value logical

private interface operator (/=)

private impure elemental function ESMF_GeomTypeNotEqual(GeomType1, GeomType2)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GeomType_Flag),	intent(in)			::	GeomType1
type(ESMF_GeomType_Flag),	intent(in)			::	GeomType2

Return Value logical

private interface operator (==)

private impure elemental function ESMF_GeomMatchEqual(GeomMatch1, GeomMatch2)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GeomMatch_Flag),	intent(in)			::	GeomMatch1
type(ESMF_GeomMatch_Flag),	intent(in)			::	GeomMatch2

Return Value logical

private interface operator (==)

private impure elemental function ESMF_GeomTypeEqual(GeomType1, GeomType2)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GeomType_Flag),	intent(in)			::	GeomType1
type(ESMF_GeomType_Flag),	intent(in)			::	GeomType2

Return Value logical

public interface operator(/=)

private impure elemental function ESMF_GeomNE(geom1, geom2)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Geom),	intent(in)			::	geom1
type(ESMF_Geom),	intent(in)			::	geom2

Return Value logical

public interface operator(==)

private impure elemental function ESMF_GeomEQ(geom1, geom2)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Geom),	intent(in)			::	geom1
type(ESMF_Geom),	intent(in)			::	geom2

Return Value logical

Derived Types

type, public, sequence :: ESMF_Geom

Components

Type	Visibility	Attributes		Name		Initial
integer(kind=ESMF_KIND_I8),	public		::	isInit	=	76838410
type(ESMF_GeomClass),	public,	pointer	::	gbcp

type, public, sequence :: ESMF_GeomClass

Components

Type	Visibility	Attributes		Name		Initial
integer,	public		::	xgridIndex
type(ESMF_GeomType_Flag),	public		::	type
type(ESMF_Grid),	public		::	grid
type(ESMF_LocStream),	public		::	locstream
type(ESMF_Mesh),	public		::	mesh
type(ESMF_MeshLoc),	public		::	meshloc
type(ESMF_StaggerLoc),	public		::	staggerloc
type(ESMF_XGrid),	public		::	xgrid
type(ESMF_XGridSide_Flag),	public		::	xgridside

type, public, sequence :: ESMF_GeomMatch_Flag

Components

Type	Visibility	Attributes		Name		Initial
integer,	public		::	geommatch

type, public, sequence :: ESMF_GeomType_Flag

Components

Type	Visibility	Attributes		Name		Initial
integer,	public		::	type

Functions

public function ESMF_GeomGetInit(geom)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Geom),	intent(in),	optional		::	geom

Return Value integer(kind=ESMF_KIND_I8)

private impure elemental function ESMF_GeomEQ(geom1, geom2)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Geom),	intent(in)			::	geom1
type(ESMF_Geom),	intent(in)			::	geom2

Return Value logical

private impure elemental function ESMF_GeomMatchEqual(GeomMatch1, GeomMatch2)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GeomMatch_Flag),	intent(in)			::	GeomMatch1
type(ESMF_GeomMatch_Flag),	intent(in)			::	GeomMatch2

Return Value logical

private impure elemental function ESMF_GeomMatchNotEqual(GeomMatch1, GeomMatch2)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GeomMatch_Flag),	intent(in)			::	GeomMatch1
type(ESMF_GeomMatch_Flag),	intent(in)			::	GeomMatch2

Return Value logical

private impure elemental function ESMF_GeomNE(geom1, geom2)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Geom),	intent(in)			::	geom1
type(ESMF_Geom),	intent(in)			::	geom2

Return Value logical

private impure elemental function ESMF_GeomTypeEqual(GeomType1, GeomType2)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GeomType_Flag),	intent(in)			::	GeomType1
type(ESMF_GeomType_Flag),	intent(in)			::	GeomType2

Return Value logical

private impure elemental function ESMF_GeomTypeNotEqual(GeomType1, GeomType2)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_GeomType_Flag),	intent(in)			::	GeomType1
type(ESMF_GeomType_Flag),	intent(in)			::	GeomType2

Return Value logical

private function ESMF_GeomCreateGrid(grid, staggerloc, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Grid),	intent(in)			::	grid
type(ESMF_StaggerLoc),	intent(in),	optional		::	staggerloc
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_Geom)

private function ESMF_GeomCreateLocStream(locstream, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_LocStream),	intent(in)			::	locstream
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_Geom)

private function ESMF_GeomCreateMesh(mesh, meshLoc, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Mesh),	intent(in)			::	mesh
type(ESMF_MeshLoc),	intent(in),	optional		::	meshLoc
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_Geom)

private function ESMF_GeomCreateXGrid(xgrid, xgridSide, gridIndex, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_XGrid),	intent(in)			::	xgrid
type(ESMF_XGridSide_Flag),	intent(in),	optional		::	xgridSide
integer,	intent(in),	optional		::	gridIndex
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_Geom)

public function ESMF_GeomDeserialize(buffer, offset, attreconflag, skipGeomObj, rc)

Arguments

Type	Intent	Optional	Attributes		Name
character(len=1),			pointer, dimension(:)	::	buffer
integer,	intent(inout)			::	offset
type(ESMF_AttReconcileFlag),		optional		::	attreconflag
logical,	intent(in),	optional		::	skipGeomObj
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_Geom)

public function ESMF_GeomMatch(geom1, geom2, keywordEnforcer, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Geom),	intent(in)			::	geom1
type(ESMF_Geom),	intent(in)			::	geom2
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_GeomMatch_Flag)

Subroutines

public subroutine ESMF_GeomDestroy(geom, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Geom)				::	geom
integer,	intent(out),	optional		::	rc

public subroutine ESMF_GeomGet(geom, dimCount, rank, localDECount, distgrid, distgridToGridMap, indexflag, geomtype, grid, staggerloc, mesh, meshloc, locstream, xgrid, xgridside, gridIndex, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Geom),	intent(in)			::	geom
integer,	intent(out),	optional		::	dimCount
integer,	intent(out),	optional		::	rank
integer,	intent(out),	optional		::	localDECount
type(ESMF_DistGrid),	intent(out),	optional		::	distgrid
integer,	intent(out),	optional		::	distgridToGridMap(:)
type(ESMF_Index_Flag),	intent(out),	optional		::	indexflag
type(ESMF_GeomType_Flag),	intent(out),	optional		::	geomtype
type(ESMF_Grid),	intent(out),	optional		::	grid
type(ESMF_StaggerLoc),	intent(out),	optional		::	staggerloc
type(ESMF_Mesh),	intent(out),	optional		::	mesh
type(ESMF_MeshLoc),	intent(out),	optional		::	meshloc
type(ESMF_LocStream),	intent(out),	optional		::	locstream
type(ESMF_XGrid),	intent(out),	optional		::	xgrid
type(ESMF_XGridSide_Flag),	intent(out),	optional		::	xgridside
integer,	intent(out),	optional		::	gridIndex
integer,	intent(out),	optional		::	rc

public subroutine ESMF_GeomGetArrayInfo(geom, gridToFieldMap, ungriddedLBound, ungriddedUBound, distgrid, distgridToArrayMap, undistLBound, undistUBound, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Geom),	intent(in)			::	geom
integer,	intent(in),	optional		::	gridToFieldMap(:)
integer,	intent(in),	optional		::	ungriddedLBound(:)
integer,	intent(in),	optional		::	ungriddedUBound(:)
type(ESMF_DistGrid),	intent(out),	optional		::	distgrid
integer,	intent(out)			::	distgridToArrayMap(:)
integer,	intent(out),	optional		::	undistLBound(:)
integer,	intent(out),	optional		::	undistUBound(:)
integer,	intent(out),	optional		::	rc

public subroutine ESMF_GeomGetPLocalDe(geom, localDe, exclusiveLBound, exclusiveUBound, exclusiveCount, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Geom),	intent(in)			::	geom
integer,	intent(in)			::	localDe
integer,	intent(out),	optional		::	exclusiveLBound(:)
integer,	intent(out),	optional		::	exclusiveUBound(:)
integer,	intent(out),	optional		::	exclusiveCount(:)
integer,	intent(out),	optional		::	rc

public subroutine ESMF_GeomSerialize(geom, buffer, length, offset, attreconflag, inquireflag, skipGeomObj, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Geom),	intent(inout)			::	geom
character(len=1),			pointer, dimension(:)	::	buffer
integer,	intent(inout)			::	length
integer,	intent(inout)			::	offset
type(ESMF_AttReconcileFlag),	intent(in),	optional		::	attreconflag
type(ESMF_InquireFlag),	intent(in),	optional		::	inquireflag
logical,	intent(in),	optional		::	skipGeomObj
integer,	intent(out),	optional		::	rc

public subroutine ESMF_GeomValidate(geom, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Geom),	intent(in)			::	geom
integer,	intent(out),	optional		::	rc