ESMF_XGridGeomBaseMod Module

Uses

Variables

Type	Visibility	Attributes		Name		Initial
character(len=*),	private,	parameter	::	version	=	'$Id$'
type(ESMF_XGridGeomType_Flag),	public,	parameter	::	ESMF_XGridGEOMTYPE_GRID	=	ESMF_XGridGeomType_Flag(1)
type(ESMF_XGridGeomType_Flag),	public,	parameter	::	ESMF_XGridGEOMTYPE_INVALID	=	ESMF_XGridGeomType_Flag(-1)
type(ESMF_XGridGeomType_Flag),	public,	parameter	::	ESMF_XGridGEOMTYPE_MESH	=	ESMF_XGridGeomType_Flag(2)
type(ESMF_XGridGeomType_Flag),	public,	parameter	::	ESMF_XGridGEOMTYPE_UNINIT	=	ESMF_XGridGeomType_Flag(0)

Interfaces

public interface ESMF_XGridGeomBaseCreate

private function ESMF_XGridGeomBaseCreateGrid(grid, staggerloc, rc)

Arguments

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

Return Value type(ESMF_XGridGeomBase)

private function ESMF_XGridGeomBaseCreateMesh(mesh, loc, rc)

Arguments

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

Return Value type(ESMF_XGridGeomBase)

private interface operator (/=)

private impure elemental function ESMF_XGridGeomTypeNotEqual(GeomType1, GeomType2)

Arguments

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

Return Value logical

private interface operator (==)

private impure elemental function ESMF_XGridGeomTypeEqual(GeomType1, GeomType2)

Arguments

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

Return Value logical

Derived Types

type, public, sequence :: ESMF_XGridGeomBase

Components

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

type, public, sequence :: ESMF_XGridGeomBaseClass

Components

Type	Visibility	Attributes		Name		Initial
type(ESMF_Grid),	public		::	grid
type(ESMF_Mesh),	public		::	mesh
type(ESMF_MeshLoc),	public		::	meshloc
type(ESMF_StaggerLoc),	public		::	staggerloc
type(ESMF_XGridGeomType_Flag),	public		::	type

type, public, sequence :: ESMF_XGridGeomType_Flag

Components

Type	Visibility	Attributes		Name		Initial
integer,	public		::	type

Functions

public function ESMF_XGridGeomBaseGetInit(gridbase)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_XGridGeomBase),	intent(in),	optional		::	gridbase

Return Value integer(kind=ESMF_KIND_I8)

public function ESMF_XGridGeomBaseMatch(xgb1, xgb2, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_XGridGeomBase),	intent(in)			::	xgb1
type(ESMF_XGridGeomBase),	intent(in)			::	xgb2
integer,	intent(out),	optional		::	rc

Return Value logical

private impure elemental function ESMF_XGridGeomTypeEqual(GeomType1, GeomType2)

Arguments

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

Return Value logical

private impure elemental function ESMF_XGridGeomTypeNotEqual(GeomType1, GeomType2)

Arguments

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

Return Value logical

private function ESMF_XGridGeomBaseCreateGrid(grid, staggerloc, rc)

Arguments

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

Return Value type(ESMF_XGridGeomBase)

private function ESMF_XGridGeomBaseCreateMesh(mesh, loc, rc)

Arguments

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

Return Value type(ESMF_XGridGeomBase)

public function ESMF_XGridGeomBaseDeserialize(buffer, offset, attreconflag, rc)

Arguments

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

Return Value type(ESMF_XGridGeomBase)

Subroutines

public subroutine ESMF_XGridGeomBaseDestroy(gridbase, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_XGridGeomBase)				::	gridbase
integer,	intent(out),	optional		::	rc

public subroutine ESMF_XGridGeomBaseGet(gridbase, dimCount, localDECount, distgrid, distgridToGridMap, indexflag, geomtype, grid, staggerloc, mesh, meshloc, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_XGridGeomBase),	intent(in)			::	gridbase
integer,	intent(out),	optional		::	dimCount
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_XGridGeomType_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
integer,	intent(out),	optional		::	rc

public subroutine ESMF_XGridGeomBaseGetArrayInfo(gridbase, gridToFieldMap, ungriddedLBound, ungriddedUBound, distgrid, distgridToArrayMap, undistLBound, undistUBound, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_XGridGeomBase),	intent(in)			::	gridbase
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)			::	undistLBound(:)
integer,	intent(out)			::	undistUBound(:)
integer,	intent(out),	optional		::	rc

public subroutine ESMF_XGridGeomBaseGetPLocalDe(gridbase, localDe, exclusiveLBound, exclusiveUBound, exclusiveCount, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_XGridGeomBase),	intent(in)			::	gridbase
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_XGridGeomBaseSerialize(gridbase, buffer, length, offset, attreconflag, inquireflag, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_XGridGeomBase),	intent(inout)			::	gridbase
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
integer,	intent(out),	optional		::	rc

public subroutine ESMF_XGridGeomBaseValidate(gridbase, rc)

Arguments

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