ESMF_FieldRegridMod Module



Variables

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

Interfaces

public interface ESMF_FieldRegridStore

  • private subroutine ESMF_FieldRegridStoreNX(srcField, dstField, keywordEnforcer, srcMaskValues, dstMaskValues, regridmethod, polemethod, regridPoleNPnts, lineType, normType, vectorRegrid, extrapMethod, extrapNumSrcPnts, extrapDistExponent, extrapNumLevels, unmappedaction, ignoreDegenerate, srcTermProcessing, pipeLineDepth, routehandle, factorList, factorIndexList, weights, indices, srcFracField, dstFracField, dstStatusField, unmappedDstList, checkFlag, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_Field), intent(in) :: srcField
    type(ESMF_Field), intent(inout) :: dstField
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    integer(kind=ESMF_KIND_I4), intent(in), optional :: srcMaskValues(:)
    integer(kind=ESMF_KIND_I4), intent(in), optional :: dstMaskValues(:)
    type(ESMF_RegridMethod_Flag), intent(in), optional :: regridmethod
    type(ESMF_PoleMethod_Flag), intent(in), optional :: polemethod
    integer, intent(in), optional :: regridPoleNPnts
    type(ESMF_LineType_Flag), intent(in), optional :: lineType
    type(ESMF_NormType_Flag), intent(in), optional :: normType
    logical, intent(in), optional :: vectorRegrid
    type(ESMF_ExtrapMethod_Flag), intent(in), optional :: extrapMethod
    integer, intent(in), optional :: extrapNumSrcPnts
    real(kind=ESMF_KIND_R4), intent(in), optional :: extrapDistExponent
    integer, intent(in), optional :: extrapNumLevels
    type(ESMF_UnmappedAction_Flag), intent(in), optional :: unmappedaction
    logical, intent(in), optional :: ignoreDegenerate
    integer, intent(inout), optional :: srcTermProcessing
    integer, intent(inout), optional :: pipeLineDepth
    type(ESMF_RouteHandle), intent(inout), optional :: routehandle
    real(kind=ESMF_KIND_R8), optional, pointer :: factorList(:)
    integer(kind=ESMF_KIND_I4), optional, pointer :: factorIndexList(:,:)
    real(kind=ESMF_KIND_R8), optional, pointer :: weights(:)
    integer(kind=ESMF_KIND_I4), optional, pointer :: indices(:,:)
    type(ESMF_Field), intent(inout), optional :: srcFracField
    type(ESMF_Field), intent(inout), optional :: dstFracField
    type(ESMF_Field), intent(inout), optional :: dstStatusField
    integer(kind=ESMF_KIND_I4), optional, pointer :: unmappedDstList(:)
    logical, intent(in), optional :: checkFlag
    integer, intent(out), optional :: rc
  • private subroutine ESMF_FieldRegridStoreX(xgrid, srcField, dstField, keywordEnforcer, regridmethod, srcTermProcessing, pipeLineDepth, routehandle, srcFracField, dstFracField, srcMergeFracField, dstMergeFracField, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_XGrid), intent(in) :: xgrid
    type(ESMF_Field), intent(in) :: srcField
    type(ESMF_Field), intent(inout) :: dstField
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    type(ESMF_RegridMethod_Flag), intent(in), optional :: regridmethod
    integer, intent(inout), optional :: srcTermProcessing
    integer, intent(inout), optional :: pipeLineDepth
    type(ESMF_RouteHandle), intent(inout), optional :: routehandle
    type(ESMF_Field), intent(inout), optional :: srcFracField
    type(ESMF_Field), intent(inout), optional :: dstFracField
    type(ESMF_Field), intent(inout), optional :: srcMergeFracField
    type(ESMF_Field), intent(inout), optional :: dstMergeFracField
    integer, intent(out), optional :: rc

Functions

private function b_or_p_GridToMesh(grid, staggerloc, maskValues, turnedOnMeshNodeMask, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Grid), intent(in) :: grid
type(ESMF_StaggerLoc), intent(in) :: staggerloc
integer(kind=ESMF_KIND_I4), intent(in), optional :: maskValues(:)
logical, intent(out), optional :: turnedOnMeshNodeMask
integer, intent(out), optional :: rc

Return Value type(ESMF_Mesh)

private function conserve_GridToMesh(grid, maskValues, turnedOnMeshElemMask, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Grid), intent(in) :: grid
integer(kind=ESMF_KIND_I4), intent(in), optional :: maskValues(:)
logical, intent(out), optional :: turnedOnMeshElemMask
integer, intent(out), optional :: rc

Return Value type(ESMF_Mesh)


Subroutines

public subroutine ESMF_FieldRegrid(srcField, dstField, routehandle, keywordEnforcer, zeroregion, termorderflag, checkflag, dynamicMask, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Field), intent(in), optional :: srcField
type(ESMF_Field), intent(inout), optional :: dstField
type(ESMF_RouteHandle), intent(inout) :: routehandle
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_Region_Flag), intent(in), optional :: zeroregion
type(ESMF_TermOrder_Flag), intent(in), optional :: termorderflag
logical, intent(in), optional :: checkflag
type(ESMF_DynamicMask), intent(in), optional, target :: dynamicMask
integer, intent(out), optional :: rc

public subroutine ESMF_FieldRegridGetArea(areaField, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Field), intent(inout) :: areaField
integer, intent(out), optional :: rc

public subroutine ESMF_FieldRegridGetIwts(Field, Iwts, MaskValues, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Field), intent(inout) :: Field
type(ESMF_Field), intent(inout) :: Iwts
integer(kind=ESMF_KIND_I4), intent(in), optional :: MaskValues(:)
integer, intent(out), optional :: rc

public subroutine ESMF_FieldRegridRelease(routehandle, keywordEnforcer, noGarbage, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_RouteHandle), intent(inout) :: routehandle
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
logical, intent(in), optional :: noGarbage
integer, intent(out), optional :: rc

private subroutine ESMF_FieldRegridStoreNX(srcField, dstField, keywordEnforcer, srcMaskValues, dstMaskValues, regridmethod, polemethod, regridPoleNPnts, lineType, normType, vectorRegrid, extrapMethod, extrapNumSrcPnts, extrapDistExponent, extrapNumLevels, unmappedaction, ignoreDegenerate, srcTermProcessing, pipeLineDepth, routehandle, factorList, factorIndexList, weights, indices, srcFracField, dstFracField, dstStatusField, unmappedDstList, checkFlag, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Field), intent(in) :: srcField
type(ESMF_Field), intent(inout) :: dstField
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer(kind=ESMF_KIND_I4), intent(in), optional :: srcMaskValues(:)
integer(kind=ESMF_KIND_I4), intent(in), optional :: dstMaskValues(:)
type(ESMF_RegridMethod_Flag), intent(in), optional :: regridmethod
type(ESMF_PoleMethod_Flag), intent(in), optional :: polemethod
integer, intent(in), optional :: regridPoleNPnts
type(ESMF_LineType_Flag), intent(in), optional :: lineType
type(ESMF_NormType_Flag), intent(in), optional :: normType
logical, intent(in), optional :: vectorRegrid
type(ESMF_ExtrapMethod_Flag), intent(in), optional :: extrapMethod
integer, intent(in), optional :: extrapNumSrcPnts
real(kind=ESMF_KIND_R4), intent(in), optional :: extrapDistExponent
integer, intent(in), optional :: extrapNumLevels
type(ESMF_UnmappedAction_Flag), intent(in), optional :: unmappedaction
logical, intent(in), optional :: ignoreDegenerate
integer, intent(inout), optional :: srcTermProcessing
integer, intent(inout), optional :: pipeLineDepth
type(ESMF_RouteHandle), intent(inout), optional :: routehandle
real(kind=ESMF_KIND_R8), optional, pointer :: factorList(:)
integer(kind=ESMF_KIND_I4), optional, pointer :: factorIndexList(:,:)
real(kind=ESMF_KIND_R8), optional, pointer :: weights(:)
integer(kind=ESMF_KIND_I4), optional, pointer :: indices(:,:)
type(ESMF_Field), intent(inout), optional :: srcFracField
type(ESMF_Field), intent(inout), optional :: dstFracField
type(ESMF_Field), intent(inout), optional :: dstStatusField
integer(kind=ESMF_KIND_I4), optional, pointer :: unmappedDstList(:)
logical, intent(in), optional :: checkFlag
integer, intent(out), optional :: rc

private subroutine ESMF_FieldRegridStoreX(xgrid, srcField, dstField, keywordEnforcer, regridmethod, srcTermProcessing, pipeLineDepth, routehandle, srcFracField, dstFracField, srcMergeFracField, dstMergeFracField, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_XGrid), intent(in) :: xgrid
type(ESMF_Field), intent(in) :: srcField
type(ESMF_Field), intent(inout) :: dstField
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_RegridMethod_Flag), intent(in), optional :: regridmethod
integer, intent(inout), optional :: srcTermProcessing
integer, intent(inout), optional :: pipeLineDepth
type(ESMF_RouteHandle), intent(inout), optional :: routehandle
type(ESMF_Field), intent(inout), optional :: srcFracField
type(ESMF_Field), intent(inout), optional :: dstFracField
type(ESMF_Field), intent(inout), optional :: srcMergeFracField
type(ESMF_Field), intent(inout), optional :: dstMergeFracField
integer, intent(out), optional :: rc

private subroutine checkGrid(grid, staggerloc, rc)

Arguments

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

private subroutine checkGridLite(grid, staggerloc, rc)

Arguments

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

private subroutine copyFracsIntoOutputField(regridField, regridMesh, outFracField, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Field), intent(in) :: regridField
type(ESMF_Mesh), intent(inout) :: regridMesh
type(ESMF_Field), intent(inout) :: outFracField
integer, intent(out), optional :: rc

private subroutine getMeshOnCornersWFieldOnCenter(field, maskValues, createdTmpMesh, mesh, turnedOnMeshElemMask, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Field), intent(in) :: field
integer(kind=ESMF_KIND_I4), intent(in), optional :: maskValues(:)
logical, intent(out) :: createdTmpMesh
type(ESMF_Mesh), intent(out) :: mesh
logical, intent(out) :: turnedOnMeshElemMask
integer, intent(out), optional :: rc

private subroutine getMeshWithNodesOnFieldLoc(field, maskValues, createdTmpMesh, mesh, turnedOnMeshNodeMask, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Field), intent(in) :: field
integer(kind=ESMF_KIND_I4), intent(in), optional :: maskValues(:)
logical, intent(out) :: createdTmpMesh
type(ESMF_Mesh), intent(out) :: mesh
logical, intent(out) :: turnedOnMeshNodeMask
integer, intent(out), optional :: rc

private subroutine getPointListOnFieldLoc(field, maskValues, addOrigCoords, createdTmpPointList, pointlist, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Field), intent(in) :: field
integer(kind=ESMF_KIND_I4), intent(in), optional :: maskValues(:)
logical, intent(in), optional :: addOrigCoords
logical, intent(out) :: createdTmpPointList
type(ESMF_PointList), intent(out) :: pointlist
integer, intent(out), optional :: rc