ESMF_XGridCreateMod Module

Uses

Variables

Type	Visibility	Attributes		Name		Initial
character(len=*),	private,	parameter	::	version	=	'$Id$'

Interfaces

private interface ESMF_XGridGetFrac2Int

private subroutine ESMF_XGridGetFrac2IntGrid(Grid, Mesh, Array, staggerLoc, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Grid),	intent(in)			::	Grid
type(ESMF_Mesh),	intent(inout)			::	Mesh
type(ESMF_Array),	intent(inout)			::	Array
type(ESMF_StaggerLoc),	intent(in)			::	staggerLoc
integer,	intent(out),	optional		::	rc

private subroutine ESMF_XGridGetFrac2IntMesh(Mesh, Array, meshloc, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Mesh),	intent(inout)			::	Mesh
type(ESMF_Array),	intent(inout)			::	Array
type(ESMF_MeshLoc),	intent(in)			::	meshloc
integer,	intent(out),	optional		::	rc

private interface ESMF_XGridGetFracInt

private subroutine ESMF_XGridGetFracIntGrid(Grid, Mesh, Array, staggerLoc, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Grid),	intent(in)			::	Grid
type(ESMF_Mesh),	intent(inout)			::	Mesh
type(ESMF_Array),	intent(inout)			::	Array
type(ESMF_StaggerLoc),	intent(in)			::	staggerLoc
integer,	intent(out),	optional		::	rc

private subroutine ESMF_XGridGetFracIntMesh(Mesh, Array, meshloc, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Mesh),	intent(inout)			::	Mesh
type(ESMF_Array),	intent(inout)			::	Array
type(ESMF_MeshLoc),	intent(in)			::	meshloc
integer,	intent(out),	optional		::	rc

Derived Types

type, private, sequence :: ESMF_TempWeights

Components

Type	Visibility	Attributes		Name		Initial
type(ESMF_Pointer),	public		::	this

Functions

public function ESMF_XGridIsCreated(xgrid, keywordEnforcer, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_XGrid),	intent(in)			::	xgrid
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
integer,	intent(out),	optional		::	rc

Return Value logical

private function ESMF_XGridDGOverlay(sparseMat, dim, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_XGridSpec),			pointer	::	sparseMat(:)
integer,	intent(in)			::	dim
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_DistGrid)

public function ESMF_XGridCreate(keywordEnforcer, sideAGrid, sideAMesh, sideBGrid, sideBMesh, sideAGridPriority, sideAMeshPriority, sideBGridPriority, sideBMeshPriority, sideAMaskValues, sideBMaskValues, storeOverlay, name, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
type(ESMF_Grid),	intent(in),	optional		::	sideAGrid(:)
type(ESMF_Mesh),	intent(in),	optional		::	sideAMesh(:)
type(ESMF_Grid),	intent(in),	optional		::	sideBGrid(:)
type(ESMF_Mesh),	intent(in),	optional		::	sideBMesh(:)
integer,	intent(in),	optional		::	sideAGridPriority(:)
integer,	intent(in),	optional		::	sideAMeshPriority(:)
integer,	intent(in),	optional		::	sideBGridPriority(:)
integer,	intent(in),	optional		::	sideBMeshPriority(:)
integer(kind=ESMF_KIND_I4),	intent(in),	optional		::	sideAMaskValues(:)
integer(kind=ESMF_KIND_I4),	intent(in),	optional		::	sideBMaskValues(:)
logical,	intent(in),	optional		::	storeOverlay
character(len=*),	intent(in),	optional		::	name
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_XGrid)

public function ESMF_XGridCreateFromSparseMat(keywordEnforcer, sideAGrid, sideAMesh, sideBGrid, sideBMesh, sideAGridPriority, sideAMeshPriority, sideBGridPriority, sideBMeshPriority, sparseMatA2X, sparseMatX2A, sparseMatB2X, sparseMatX2B, area, centroid, name, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
type(ESMF_Grid),	intent(in),	optional		::	sideAGrid(:)
type(ESMF_Mesh),	intent(in),	optional		::	sideAMesh(:)
type(ESMF_Grid),	intent(in),	optional		::	sideBGrid(:)
type(ESMF_Mesh),	intent(in),	optional		::	sideBMesh(:)
integer,	intent(in),	optional		::	sideAGridPriority(:)
integer,	intent(in),	optional		::	sideAMeshPriority(:)
integer,	intent(in),	optional		::	sideBGridPriority(:)
integer,	intent(in),	optional		::	sideBMeshPriority(:)
type(ESMF_XGridSpec),	intent(in),	optional		::	sparseMatA2X(:)
type(ESMF_XGridSpec),	intent(in),	optional		::	sparseMatX2A(:)
type(ESMF_XGridSpec),	intent(in),	optional		::	sparseMatB2X(:)
type(ESMF_XGridSpec),	intent(in),	optional		::	sparseMatX2B(:)
real(kind=ESMF_KIND_R8),	intent(in),	optional		::	area(:)
real(kind=ESMF_KIND_R8),	intent(in),	optional		::	centroid(:,:)
character(len=*),	intent(in),	optional		::	name
integer,	intent(out),	optional		::	rc

Return Value type(ESMF_XGrid)

Subroutines

private subroutine ESMF_SparseMatca(sparseMats, sparseMatd, ngrid, tag, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_XGridSpec),	intent(in)			::	sparseMats(:)
type(ESMF_XGridSpec),			pointer	::	sparseMatd(:)
integer,	intent(in)			::	ngrid
character(len=*),	intent(in)			::	tag
integer,	intent(out),	optional		::	rc

private subroutine ESMF_XGridConstruct(xgtype, sideA, sideB, sparseMatA2X, sparseMatX2A, sparseMatB2X, sparseMatX2B, offline, mesh, internal_alloc, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_XGridType),	intent(inout)			::	xgtype
type(ESMF_XGridGeomBase),	intent(in)			::	sideA(:)
type(ESMF_XGridGeomBase),	intent(in)			::	sideB(:)
type(ESMF_XGridSpec),	intent(in),	optional		::	sparseMatA2X(:)
type(ESMF_XGridSpec),	intent(in),	optional		::	sparseMatX2A(:)
type(ESMF_XGridSpec),	intent(in),	optional		::	sparseMatB2X(:)
type(ESMF_XGridSpec),	intent(in),	optional		::	sparseMatX2B(:)
logical,	intent(in),	optional		::	offline
type(ESMF_Mesh),	intent(inout),	optional		::	mesh
logical,	intent(in),	optional		::	internal_alloc
integer,	intent(out),	optional		::	rc

private subroutine ESMF_XGridConstructBaseObj(xgtype, name, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_XGridType),			pointer	::	xgtype
character(len=*),	intent(in),	optional		::	name
integer,	intent(out),	optional		::	rc

private subroutine ESMF_XGridDG(xgridgeombase, distgrid, factorIndexList, dim, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_XGridGeomBase),	intent(in)			::	xgridgeombase
type(ESMF_DistGrid),	intent(inout)			::	distgrid
integer,			pointer	::	factorIndexList(:,:)
integer,	intent(in)			::	dim
integer,	intent(out),	optional		::	rc

public subroutine ESMF_XGridDestroy(xgrid, keywordEnforcer, noGarbage, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_XGrid),	intent(inout)			::	xgrid
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
logical,	intent(in),	optional		::	noGarbage
integer,	intent(out),	optional		::	rc

private subroutine ESMF_XGridDistGrids(xgtype, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_XGridType),	intent(inout)			::	xgtype
integer,	intent(out),	optional		::	rc

private subroutine ESMF_XGridDistGridsOnline(xgtype, mesh, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_XGridType),	intent(inout)			::	xgtype
type(ESMF_Mesh),	intent(inout)			::	mesh
integer,	intent(out),	optional		::	rc

private subroutine ESMF_XGridGetFrac2IntGrid(Grid, Mesh, Array, staggerLoc, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Grid),	intent(in)			::	Grid
type(ESMF_Mesh),	intent(inout)			::	Mesh
type(ESMF_Array),	intent(inout)			::	Array
type(ESMF_StaggerLoc),	intent(in)			::	staggerLoc
integer,	intent(out),	optional		::	rc

private subroutine ESMF_XGridGetFrac2IntMesh(Mesh, Array, meshloc, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Mesh),	intent(inout)			::	Mesh
type(ESMF_Array),	intent(inout)			::	Array
type(ESMF_MeshLoc),	intent(in)			::	meshloc
integer,	intent(out),	optional		::	rc

private subroutine ESMF_XGridGetFracIntGrid(Grid, Mesh, Array, staggerLoc, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Grid),	intent(in)			::	Grid
type(ESMF_Mesh),	intent(inout)			::	Mesh
type(ESMF_Array),	intent(inout)			::	Array
type(ESMF_StaggerLoc),	intent(in)			::	staggerLoc
integer,	intent(out),	optional		::	rc

private subroutine ESMF_XGridGetFracIntMesh(Mesh, Array, meshloc, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Mesh),	intent(inout)			::	Mesh
type(ESMF_Array),	intent(inout)			::	Array
type(ESMF_MeshLoc),	intent(in)			::	meshloc
integer,	intent(out),	optional		::	rc

private subroutine checkGrid(grid, staggerloc, rc)

Arguments

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

private subroutine choose_default_coordsys(sideAGrid, sideAMesh, sideBGrid, sideBMesh, defaultCoordSys, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Grid),	intent(in),	optional		::	sideAGrid(:)
type(ESMF_Mesh),	intent(in),	optional		::	sideAMesh(:)
type(ESMF_Grid),	intent(in),	optional		::	sideBGrid(:)
type(ESMF_Mesh),	intent(in),	optional		::	sideBMesh(:)
type(ESMF_CoordSys_Flag),	intent(out)			::	defaultCoordSys
integer,	intent(out),	optional		::	rc

private subroutine error_check_coordsys(sideAGrid, sideAMesh, sideBGrid, sideBMesh, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_Grid),	intent(in),	optional		::	sideAGrid(:)
type(ESMF_Mesh),	intent(in),	optional		::	sideAMesh(:)
type(ESMF_Grid),	intent(in),	optional		::	sideBGrid(:)
type(ESMF_Mesh),	intent(in),	optional		::	sideBMesh(:)
integer,	intent(out),	optional		::	rc