ESMF_XGridGetMod Module

Variables

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

Interfaces

public interface ESMF_XGridGet

• private subroutine ESMF_XGridGetEle(xgrid, localDE, keywordEnforcer, elementCount, exclusiveCount, exclusiveLBound, exclusiveUBound, rc)

  Arguments

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

• private subroutine ESMF_XGridGetDefault(xgrid, keywordEnforcer, sideAGridCount, sideBGridCount, sideAMeshCount, sideBMeshCount, coordSys, dimCount, elementCount, sideAGrid, sideBGrid, sideAMesh, sideBMesh, mesh, area, centroid, distgridA, distgridB, distgridM, sparseMatA2X, sparseMatX2A, sparseMatB2X, sparseMatX2B, name, rc)

  Arguments

  Type	Intent	Optional	Attributes		Name
  type(ESMF_XGrid),	intent(in)			::	xgrid
  type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
  integer,	intent(out),	optional		::	sideAGridCount
  integer,	intent(out),	optional		::	sideBGridCount
  integer,	intent(out),	optional		::	sideAMeshCount
  integer,	intent(out),	optional		::	sideBMeshCount
  type(ESMF_CoordSys_Flag),	intent(out),	optional		::	coordSys
  integer,	intent(out),	optional		::	dimCount
  integer,	intent(out),	optional		::	elementCount
  type(ESMF_Grid),	intent(out),	optional		::	sideAGrid(:)
  type(ESMF_Grid),	intent(out),	optional		::	sideBGrid(:)
  type(ESMF_Mesh),	intent(out),	optional		::	sideAMesh(:)
  type(ESMF_Mesh),	intent(out),	optional		::	sideBMesh(:)
  type(ESMF_Mesh),	intent(out),	optional		::	mesh
  real(kind=ESMF_KIND_R8),	intent(out),	optional		::	area(:)
  real(kind=ESMF_KIND_R8),	intent(out),	optional		::	centroid(:,:)
  type(ESMF_DistGrid),	intent(out),	optional		::	distgridA(:)
  type(ESMF_DistGrid),	intent(out),	optional		::	distgridB(:)
  type(ESMF_DistGrid),	intent(out),	optional		::	distgridM
  type(ESMF_XGridSpec),	intent(out),	optional		::	sparseMatA2X(:)
  type(ESMF_XGridSpec),	intent(out),	optional		::	sparseMatX2A(:)
  type(ESMF_XGridSpec),	intent(out),	optional		::	sparseMatB2X(:)
  type(ESMF_XGridSpec),	intent(out),	optional		::	sparseMatX2B(:)
  character(len=*),	intent(out),	optional		::	name
  integer,	intent(out),	optional		::	rc

• private subroutine ESMF_XGridGetDG(xgrid, distgrid, keywordEnforcer, xgridside, gridindex, rc)

  Arguments

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

• private subroutine ESMF_XGridGetGB(xgrid, sideA, sideB, rc)

  Arguments

  Type	Intent	Optional	Attributes		Name
  type(ESMF_XGrid),	intent(in)			::	xgrid
  type(ESMF_XGridGeomBase),	intent(out)			::	sideA(:)
  type(ESMF_XGridGeomBase),	intent(out)			::	sideB(:)
  integer,	intent(out),	optional		::	rc

• private subroutine ESMF_XGridGetGeomObj(xgrid, geombase, keywordEnforcer, xgridside, gridindex, rc)

  Arguments

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

• private subroutine ESMF_XGridGetSMMSpecFrac(xgrid, srcSide, srcGridIndex, dstSide, dstGridIndex, keywordEnforcer, sparseMat, srcFracArray, dstFracArray, srcFrac2Array, dstFrac2Array, rc)

  Arguments

  Type	Intent	Optional	Attributes		Name
  type(ESMF_XGrid),	intent(in)			::	xgrid
  type(ESMF_XGridSide_Flag),	intent(in)			::	srcSide
  integer,	intent(in)			::	srcGridIndex
  type(ESMF_XGridSide_Flag),	intent(in)			::	dstSide
  integer,	intent(in)			::	dstGridIndex
  type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
  type(ESMF_XGridSpec),	intent(out),	optional		::	sparseMat
  type(ESMF_Array),	intent(inout),	optional		::	srcFracArray
  type(ESMF_Array),	intent(inout),	optional		::	dstFracArray
  type(ESMF_Array),	intent(inout),	optional		::	srcFrac2Array
  type(ESMF_Array),	intent(inout),	optional		::	dstFrac2Array
  integer,	intent(out),	optional		::	rc

Subroutines

private subroutine ESMF_XGridGetDG(xgrid, distgrid, keywordEnforcer, xgridside, gridindex, rc)

Arguments

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

private subroutine ESMF_XGridGetDefault(xgrid, keywordEnforcer, sideAGridCount, sideBGridCount, sideAMeshCount, sideBMeshCount, coordSys, dimCount, elementCount, sideAGrid, sideBGrid, sideAMesh, sideBMesh, mesh, area, centroid, distgridA, distgridB, distgridM, sparseMatA2X, sparseMatX2A, sparseMatB2X, sparseMatX2B, name, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_XGrid),	intent(in)			::	xgrid
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
integer,	intent(out),	optional		::	sideAGridCount
integer,	intent(out),	optional		::	sideBGridCount
integer,	intent(out),	optional		::	sideAMeshCount
integer,	intent(out),	optional		::	sideBMeshCount
type(ESMF_CoordSys_Flag),	intent(out),	optional		::	coordSys
integer,	intent(out),	optional		::	dimCount
integer,	intent(out),	optional		::	elementCount
type(ESMF_Grid),	intent(out),	optional		::	sideAGrid(:)
type(ESMF_Grid),	intent(out),	optional		::	sideBGrid(:)
type(ESMF_Mesh),	intent(out),	optional		::	sideAMesh(:)
type(ESMF_Mesh),	intent(out),	optional		::	sideBMesh(:)
type(ESMF_Mesh),	intent(out),	optional		::	mesh
real(kind=ESMF_KIND_R8),	intent(out),	optional		::	area(:)
real(kind=ESMF_KIND_R8),	intent(out),	optional		::	centroid(:,:)
type(ESMF_DistGrid),	intent(out),	optional		::	distgridA(:)
type(ESMF_DistGrid),	intent(out),	optional		::	distgridB(:)
type(ESMF_DistGrid),	intent(out),	optional		::	distgridM
type(ESMF_XGridSpec),	intent(out),	optional		::	sparseMatA2X(:)
type(ESMF_XGridSpec),	intent(out),	optional		::	sparseMatX2A(:)
type(ESMF_XGridSpec),	intent(out),	optional		::	sparseMatB2X(:)
type(ESMF_XGridSpec),	intent(out),	optional		::	sparseMatX2B(:)
character(len=*),	intent(out),	optional		::	name
integer,	intent(out),	optional		::	rc

private subroutine ESMF_XGridGetEle(xgrid, localDE, keywordEnforcer, elementCount, exclusiveCount, exclusiveLBound, exclusiveUBound, rc)

Arguments

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

private subroutine ESMF_XGridGetGB(xgrid, sideA, sideB, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_XGrid),	intent(in)			::	xgrid
type(ESMF_XGridGeomBase),	intent(out)			::	sideA(:)
type(ESMF_XGridGeomBase),	intent(out)			::	sideB(:)
integer,	intent(out),	optional		::	rc

private subroutine ESMF_XGridGetGeomObj(xgrid, geombase, keywordEnforcer, xgridside, gridindex, rc)

Arguments

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

private subroutine ESMF_XGridGetSMMSpecFrac(xgrid, srcSide, srcGridIndex, dstSide, dstGridIndex, keywordEnforcer, sparseMat, srcFracArray, dstFracArray, srcFrac2Array, dstFrac2Array, rc)

Arguments

Type	Intent	Optional	Attributes		Name
type(ESMF_XGrid),	intent(in)			::	xgrid
type(ESMF_XGridSide_Flag),	intent(in)			::	srcSide
integer,	intent(in)			::	srcGridIndex
type(ESMF_XGridSide_Flag),	intent(in)			::	dstSide
integer,	intent(in)			::	dstGridIndex
type(ESMF_KeywordEnforcer),		optional		::	keywordEnforcer
type(ESMF_XGridSpec),	intent(out),	optional		::	sparseMat
type(ESMF_Array),	intent(inout),	optional		::	srcFracArray
type(ESMF_Array),	intent(inout),	optional		::	dstFracArray
type(ESMF_Array),	intent(inout),	optional		::	srcFrac2Array
type(ESMF_Array),	intent(inout),	optional		::	dstFrac2Array
integer,	intent(out),	optional		::	rc