ESMF_GridCompMod Module


Uses


Variables

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

Interfaces

private interface ESMF_GridCompSetServices

  • private interface ESMF_GridCompSetServices()

    Arguments

    None

  • private recursive subroutine ESMF_GridCompSetServicesShObj(gridcomp, userRoutine, keywordEnforcer, sharedObj, userRoutineFound, userRc, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_GridComp), intent(inout) :: gridcomp
    character(len=*), intent(in) :: userRoutine
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    character(len=*), intent(in), optional :: sharedObj
    logical, intent(out), optional :: userRoutineFound
    integer, intent(out), optional :: userRc
    integer, intent(out), optional :: rc

  • private recursive subroutine ESMF_GridCompSetServicesComp(gridcomp, actualGridcomp, keywordEnforcer, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_GridComp), intent(inout) :: gridcomp
    type(ESMF_GridComp), intent(in) :: actualGridcomp
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    integer, intent(out), optional :: rc

  • private recursive subroutine ESMF_GridCompSetServicesSock(gridcomp, port, keywordEnforcer, server, timeout, timeoutFlag, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_GridComp), intent(inout) :: gridcomp
    integer, intent(in) :: port
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    character(len=*), intent(in), optional :: server
    integer, intent(in), optional :: timeout
    logical, intent(out), optional :: timeoutFlag
    integer, intent(out), optional :: rc

private interface ESMF_GridCompSetVM

  • private interface ESMF_GridCompSetVM()

    Arguments

    None

  • private recursive subroutine ESMF_GridCompSetVMShObj(gridcomp, userRoutine, keywordEnforcer, sharedObj, userRoutineFound, userRc, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_GridComp), intent(inout) :: gridcomp
    character(len=*), intent(in) :: userRoutine
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    character(len=*), intent(in), optional :: sharedObj
    logical, intent(out), optional :: userRoutineFound
    integer, intent(out), optional :: userRc
    integer, intent(out), optional :: rc

public interface operator(/=)

  • private impure elemental function ESMF_GridCompNE(gridcomp1, gridcomp2)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_GridComp), intent(in) :: gridcomp1
    type(ESMF_GridComp), intent(in) :: gridcomp2

    Return Value logical

public interface operator(==)

  • private impure elemental function ESMF_GridCompEQ(gridcomp1, gridcomp2)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_GridComp), intent(in) :: gridcomp1
    type(ESMF_GridComp), intent(in) :: gridcomp2

    Return Value logical


Functions

public recursive function ESMF_GridCompGetInit(d) result(GridCompGetInit)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(in), optional :: d

Return Value integer(kind=ESMF_KIND_I8)

private impure elemental function ESMF_GridCompEQ(gridcomp1, gridcomp2)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(in) :: gridcomp1
type(ESMF_GridComp), intent(in) :: gridcomp2

Return Value logical

public function ESMF_GridCompIsCreated(gridcomp, keywordEnforcer, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(in) :: gridcomp
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(out), optional :: rc

Return Value logical

public recursive function ESMF_GridCompIsPetLocal(gridcomp, keywordEnforcer, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(in) :: gridcomp
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(out), optional :: rc

Return Value logical

private impure elemental function ESMF_GridCompNE(gridcomp1, gridcomp2)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(in) :: gridcomp1
type(ESMF_GridComp), intent(in) :: gridcomp2

Return Value logical

public recursive function ESMF_GridCompCreate(keywordEnforcer, grid, gridList, mesh, meshList, locstream, locstreamList, xgrid, xgridList, config, configFile, clock, petList, devList, contextflag, name, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_Grid), intent(in), optional :: grid
type(ESMF_Grid), intent(in), optional :: gridList(:)
type(ESMF_Mesh), intent(in), optional :: mesh
type(ESMF_Mesh), intent(in), optional :: meshList(:)
type(ESMF_LocStream), intent(in), optional :: locstream
type(ESMF_LocStream), intent(in), optional :: locstreamList(:)
type(ESMF_XGrid), intent(in), optional :: xgrid
type(ESMF_XGrid), intent(in), optional :: xgridList(:)
type(ESMF_Config), intent(in), optional :: config
character(len=*), intent(in), optional :: configFile
type(ESMF_Clock), intent(in), optional :: clock
integer, intent(in), optional :: petList(:)
integer, intent(in), optional :: devList(:)
type(ESMF_Context_Flag), intent(in), optional :: contextflag
character(len=*), intent(in), optional :: name
integer, intent(out), optional :: rc

Return Value type(ESMF_GridComp)


Subroutines

public recursive subroutine ESMF_GridCompDestroy(gridcomp, keywordEnforcer, timeout, timeoutFlag, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(inout) :: gridcomp
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(in), optional :: timeout
logical, intent(out), optional :: timeoutFlag
integer, intent(out), optional :: rc

public recursive subroutine ESMF_GridCompFinalize(gridcomp, keywordEnforcer, importState, exportState, clock, syncflag, phase, timeout, timeoutFlag, userRc, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(inout) :: gridcomp
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_State), intent(inout), optional :: importState
type(ESMF_State), intent(inout), optional :: exportState
type(ESMF_Clock), intent(inout), optional :: clock
type(ESMF_Sync_Flag), intent(in), optional :: syncflag
integer, intent(in), optional :: phase
integer, intent(in), optional :: timeout
logical, intent(out), optional :: timeoutFlag
integer, intent(out), optional :: userRc
integer, intent(out), optional :: rc

public recursive subroutine ESMF_GridCompFinalizeAct(gridcomp, importState, exportState, clock, syncflag, phase, userRc, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(inout) :: gridcomp
type(ESMF_State), intent(inout), optional :: importState
type(ESMF_State), intent(inout), optional :: exportState
type(ESMF_Clock), intent(inout), optional :: clock
type(ESMF_Sync_Flag), intent(in), optional :: syncflag
integer, intent(in), optional :: phase
integer, intent(out), optional :: userRc
integer, intent(out), optional :: rc

public recursive subroutine ESMF_GridCompGet(gridcomp, keywordEnforcer, gridIsPresent, grid, gridList, meshIsPresent, mesh, meshList, locstreamIsPresent, locstream, locstreamList, xgridIsPresent, xgrid, xgridList, importStateIsPresent, importState, exportStateIsPresent, exportState, configIsPresent, config, configFileIsPresent, configFile, clockIsPresent, clock, localPet, petCount, contextflag, currentMethod, currentPhase, comptype, vmIsPresent, vm, name, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(in) :: gridcomp
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
logical, intent(out), optional :: gridIsPresent
type(ESMF_Grid), intent(out), optional :: grid
type(ESMF_Grid), intent(out), optional, allocatable :: gridList(:)
logical, intent(out), optional :: meshIsPresent
type(ESMF_Mesh), intent(out), optional :: mesh
type(ESMF_Mesh), intent(out), optional, allocatable :: meshList(:)
logical, intent(out), optional :: locstreamIsPresent
type(ESMF_LocStream), intent(out), optional :: locstream
type(ESMF_LocStream), intent(out), optional, allocatable :: locstreamList(:)
logical, intent(out), optional :: xgridIsPresent
type(ESMF_XGrid), intent(out), optional :: xgrid
type(ESMF_XGrid), intent(out), optional, allocatable :: xgridList(:)
logical, intent(out), optional :: importStateIsPresent
type(ESMF_State), intent(out), optional :: importState
logical, intent(out), optional :: exportStateIsPresent
type(ESMF_State), intent(out), optional :: exportState
logical, intent(out), optional :: configIsPresent
type(ESMF_Config), intent(out), optional :: config
logical, intent(out), optional :: configFileIsPresent
character(len=*), intent(out), optional :: configFile
logical, intent(out), optional :: clockIsPresent
type(ESMF_Clock), intent(out), optional :: clock
integer, intent(out), optional :: localPet
integer, intent(out), optional :: petCount
type(ESMF_Context_Flag), intent(out), optional :: contextflag
type(ESMF_Method_Flag), intent(out), optional :: currentMethod
integer, intent(out), optional :: currentPhase
type(ESMF_CompType_Flag), intent(out), optional :: comptype
logical, intent(out), optional :: vmIsPresent
type(ESMF_VM), intent(out), optional :: vm
character(len=*), intent(out), optional :: name
integer, intent(out), optional :: rc

public subroutine ESMF_GridCompGetEPPhaseCount(gridcomp, methodflag, phaseCount, phaseZeroFlag, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(in) :: gridcomp
type(ESMF_Method_Flag), intent(in) :: methodflag
integer, intent(out) :: phaseCount
logical, intent(out), optional :: phaseZeroFlag
integer, intent(out), optional :: rc

public recursive subroutine ESMF_GridCompInitialize(gridcomp, keywordEnforcer, importState, exportState, clock, syncflag, phase, timeout, timeoutFlag, userRc, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(inout) :: gridcomp
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_State), intent(inout), optional :: importState
type(ESMF_State), intent(inout), optional :: exportState
type(ESMF_Clock), intent(inout), optional :: clock
type(ESMF_Sync_Flag), intent(in), optional :: syncflag
integer, intent(in), optional :: phase
integer, intent(in), optional :: timeout
logical, intent(out), optional :: timeoutFlag
integer, intent(out), optional :: userRc
integer, intent(out), optional :: rc

public recursive subroutine ESMF_GridCompInitializeAct(gridcomp, importState, exportState, clock, syncflag, phase, userRc, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(inout) :: gridcomp
type(ESMF_State), intent(inout), optional :: importState
type(ESMF_State), intent(inout), optional :: exportState
type(ESMF_Clock), intent(inout), optional :: clock
type(ESMF_Sync_Flag), intent(in), optional :: syncflag
integer, intent(in), optional :: phase
integer, intent(out), optional :: userRc
integer, intent(out), optional :: rc

public subroutine ESMF_GridCompPrint(gridcomp, keywordEnforcer, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(in) :: gridcomp
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(out), optional :: rc

public recursive subroutine ESMF_GridCompReadRestart(gridcomp, keywordEnforcer, importState, exportState, clock, syncflag, phase, timeout, timeoutFlag, userRc, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(inout) :: gridcomp
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_State), intent(inout), optional :: importState
type(ESMF_State), intent(inout), optional :: exportState
type(ESMF_Clock), intent(inout), optional :: clock
type(ESMF_Sync_Flag), intent(in), optional :: syncflag
integer, intent(in), optional :: phase
integer, intent(in), optional :: timeout
logical, intent(out), optional :: timeoutFlag
integer, intent(out), optional :: userRc
integer, intent(out), optional :: rc

public recursive subroutine ESMF_GridCompRun(gridcomp, keywordEnforcer, importState, exportState, clock, syncflag, phase, timeout, timeoutFlag, userRc, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(inout) :: gridcomp
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_State), intent(inout), optional :: importState
type(ESMF_State), intent(inout), optional :: exportState
type(ESMF_Clock), intent(inout), optional :: clock
type(ESMF_Sync_Flag), intent(in), optional :: syncflag
integer, intent(in), optional :: phase
integer, intent(in), optional :: timeout
logical, intent(out), optional :: timeoutFlag
integer, intent(out), optional :: userRc
integer, intent(out), optional :: rc

public recursive subroutine ESMF_GridCompRunAct(gridcomp, importState, exportState, clock, syncflag, phase, userRc, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(inout) :: gridcomp
type(ESMF_State), intent(inout), optional :: importState
type(ESMF_State), intent(inout), optional :: exportState
type(ESMF_Clock), intent(inout), optional :: clock
type(ESMF_Sync_Flag), intent(in), optional :: syncflag
integer, intent(in), optional :: phase
integer, intent(out), optional :: userRc
integer, intent(out), optional :: rc

public recursive subroutine ESMF_GridCompServiceLoop(gridcomp, keywordEnforcer, importState, exportState, clock, syncflag, port, timeout, timeoutFlag, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(inout) :: gridcomp
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_State), intent(inout), optional :: importState
type(ESMF_State), intent(inout), optional :: exportState
type(ESMF_Clock), intent(inout), optional :: clock
type(ESMF_Sync_Flag), intent(in), optional :: syncflag
integer, intent(in), optional :: port
integer, intent(in), optional :: timeout
logical, intent(out), optional :: timeoutFlag
integer, intent(out), optional :: rc

public subroutine ESMF_GridCompSet(gridcomp, keywordEnforcer, grid, gridList, mesh, meshList, locstream, locstreamList, xgrid, xgridList, config, configFile, clock, name, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(inout) :: gridcomp
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_Grid), intent(in), optional :: grid
type(ESMF_Grid), intent(in), optional :: gridList(:)
type(ESMF_Mesh), intent(in), optional :: mesh
type(ESMF_Mesh), intent(in), optional :: meshList(:)
type(ESMF_LocStream), intent(in), optional :: locstream
type(ESMF_LocStream), intent(in), optional :: locstreamList(:)
type(ESMF_XGrid), intent(in), optional :: xgrid
type(ESMF_XGrid), intent(in), optional :: xgridList(:)
type(ESMF_Config), intent(in), optional :: config
character(len=*), intent(in), optional :: configFile
type(ESMF_Clock), intent(in), optional :: clock
character(len=*), intent(in), optional :: name
integer, intent(out), optional :: rc

public recursive subroutine ESMF_GridCompSetEntryPoint(gridcomp, methodflag, userRoutine, keywordEnforcer, phase, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(inout) :: gridcomp
type(ESMF_Method_Flag), intent(in) :: methodflag
private subroutine userRoutine(gridcomp, importState, exportState, clock, rc)
Arguments
Type IntentOptional Attributes Name
type(ESMF_GridComp) :: gridcomp
type(ESMF_State) :: importState
type(ESMF_State) :: exportState
type(ESMF_Clock) :: clock
integer, intent(out) :: rc
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(in), optional :: phase
integer, intent(out), optional :: rc

public recursive subroutine ESMF_GridCompSetServices(gridcomp, userRoutine, keywordEnforcer, userRc, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(inout) :: gridcomp
private subroutine userRoutine(gridcomp, rc)
Arguments
Type IntentOptional Attributes Name
type(ESMF_GridComp) :: gridcomp
integer, intent(out) :: rc
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(out), optional :: userRc
integer, intent(out), optional :: rc

private recursive subroutine ESMF_GridCompSetServicesComp(gridcomp, actualGridcomp, keywordEnforcer, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(inout) :: gridcomp
type(ESMF_GridComp), intent(in) :: actualGridcomp
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(out), optional :: rc

private recursive subroutine ESMF_GridCompSetServicesShObj(gridcomp, userRoutine, keywordEnforcer, sharedObj, userRoutineFound, userRc, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(inout) :: gridcomp
character(len=*), intent(in) :: userRoutine
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
character(len=*), intent(in), optional :: sharedObj
logical, intent(out), optional :: userRoutineFound
integer, intent(out), optional :: userRc
integer, intent(out), optional :: rc

private recursive subroutine ESMF_GridCompSetServicesSock(gridcomp, port, keywordEnforcer, server, timeout, timeoutFlag, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(inout) :: gridcomp
integer, intent(in) :: port
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
character(len=*), intent(in), optional :: server
integer, intent(in), optional :: timeout
logical, intent(out), optional :: timeoutFlag
integer, intent(out), optional :: rc

public recursive subroutine ESMF_GridCompSetVM(gridcomp, userRoutine, keywordEnforcer, userRc, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(inout) :: gridcomp
private subroutine userRoutine(gridcomp, rc)
Arguments
Type IntentOptional Attributes Name
type(ESMF_GridComp) :: gridcomp
integer, intent(out) :: rc
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(out), optional :: userRc
integer, intent(out), optional :: rc

public subroutine ESMF_GridCompSetVMMaxPEs(gridcomp, keywordEnforcer, maxPeCountPerPet, prefIntraProcess, prefIntraSsi, prefInterSsi, pthreadMinStackSize, openMpHandling, openMpNumThreads, forceChildPthreads, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(inout) :: gridcomp
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(in), optional :: maxPeCountPerPet
integer, intent(in), optional :: prefIntraProcess
integer, intent(in), optional :: prefIntraSsi
integer, intent(in), optional :: prefInterSsi
integer, intent(in), optional :: pthreadMinStackSize
character(len=*), intent(in), optional :: openMpHandling
integer, intent(in), optional :: openMpNumThreads
logical, intent(in), optional :: forceChildPthreads
integer, intent(out), optional :: rc

public subroutine ESMF_GridCompSetVMMaxThreads(gridcomp, keywordEnforcer, maxPetCountPerVas, prefIntraProcess, prefIntraSsi, prefInterSsi, pthreadMinStackSize, forceChildPthreads, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(inout) :: gridcomp
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(in), optional :: maxPetCountPerVas
integer, intent(in), optional :: prefIntraProcess
integer, intent(in), optional :: prefIntraSsi
integer, intent(in), optional :: prefInterSsi
integer, intent(in), optional :: pthreadMinStackSize
logical, intent(in), optional :: forceChildPthreads
integer, intent(out), optional :: rc

public subroutine ESMF_GridCompSetVMMinThreads(gridcomp, keywordEnforcer, maxPeCountPerPet, prefIntraProcess, prefIntraSsi, prefInterSsi, pthreadMinStackSize, forceChildPthreads, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(inout) :: gridcomp
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(in), optional :: maxPeCountPerPet
integer, intent(in), optional :: prefIntraProcess
integer, intent(in), optional :: prefIntraSsi
integer, intent(in), optional :: prefInterSsi
integer, intent(in), optional :: pthreadMinStackSize
logical, intent(in), optional :: forceChildPthreads
integer, intent(out), optional :: rc

private recursive subroutine ESMF_GridCompSetVMShObj(gridcomp, userRoutine, keywordEnforcer, sharedObj, userRoutineFound, userRc, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(inout) :: gridcomp
character(len=*), intent(in) :: userRoutine
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
character(len=*), intent(in), optional :: sharedObj
logical, intent(out), optional :: userRoutineFound
integer, intent(out), optional :: userRc
integer, intent(out), optional :: rc

public subroutine ESMF_GridCompValidate(gridcomp, keywordEnforcer, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(in) :: gridcomp
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(out), optional :: rc

public subroutine ESMF_GridCompWait(gridcomp, keywordEnforcer, syncflag, timeout, timeoutFlag, userRc, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(inout) :: gridcomp
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_Sync_Flag), intent(in), optional :: syncflag
integer, intent(in), optional :: timeout
logical, intent(out), optional :: timeoutFlag
integer, intent(out), optional :: userRc
integer, intent(out), optional :: rc

public recursive subroutine ESMF_GridCompWriteRestart(gridcomp, keywordEnforcer, importState, exportState, clock, syncflag, phase, timeout, timeoutFlag, userRc, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_GridComp), intent(inout) :: gridcomp
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_State), intent(inout), optional :: importState
type(ESMF_State), intent(inout), optional :: exportState
type(ESMF_Clock), intent(inout), optional :: clock
type(ESMF_Sync_Flag), intent(in), optional :: syncflag
integer, intent(in), optional :: phase
integer, intent(in), optional :: timeout
logical, intent(out), optional :: timeoutFlag
integer, intent(out), optional :: userRc
integer, intent(out), optional :: rc