ESMF_CplCompMod 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_CplCompSetServices

  • private interface ESMF_CplCompSetServices()

    Arguments

    None

  • private recursive subroutine ESMF_CplCompSetServicesShObj(cplcomp, userRoutine, keywordEnforcer, sharedObj, userRoutineFound, userRc, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_CplComp), intent(inout) :: cplcomp
    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_CplCompSetServicesComp(cplcomp, actualCplcomp, keywordEnforcer, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_CplComp), intent(inout) :: cplcomp
    type(ESMF_CplComp), intent(in) :: actualCplcomp
    type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
    integer, intent(out), optional :: rc

  • private recursive subroutine ESMF_CplCompSetServicesSock(cplcomp, port, keywordEnforcer, server, timeout, timeoutFlag, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_CplComp), intent(inout) :: cplcomp
    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_CplCompSetVM

  • private interface ESMF_CplCompSetVM()

    Arguments

    None

  • private recursive subroutine ESMF_CplCompSetVMShObj(cplcomp, userRoutine, keywordEnforcer, sharedObj, userRoutineFound, userRc, rc)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_CplComp), intent(inout) :: cplcomp
    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_CplCompNE(cplcomp1, cplcomp2)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_CplComp), intent(in) :: cplcomp1
    type(ESMF_CplComp), intent(in) :: cplcomp2

    Return Value logical

public interface operator(==)

  • private impure elemental function ESMF_CplCompEQ(cplcomp1, cplcomp2)

    Arguments

    Type IntentOptional Attributes Name
    type(ESMF_CplComp), intent(in) :: cplcomp1
    type(ESMF_CplComp), intent(in) :: cplcomp2

    Return Value logical


Functions

public function ESMF_CplCompGetInit(d)

Arguments

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

Return Value integer(kind=ESMF_KIND_I8)

private impure elemental function ESMF_CplCompEQ(cplcomp1, cplcomp2)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp), intent(in) :: cplcomp1
type(ESMF_CplComp), intent(in) :: cplcomp2

Return Value logical

public function ESMF_CplCompIsCreated(cplcomp, keywordEnforcer, rc)

Arguments

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

Return Value logical

public recursive function ESMF_CplCompIsPetLocal(cplcomp, keywordEnforcer, rc)

Arguments

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

Return Value logical

private impure elemental function ESMF_CplCompNE(cplcomp1, cplcomp2)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp), intent(in) :: cplcomp1
type(ESMF_CplComp), intent(in) :: cplcomp2

Return Value logical

public recursive function ESMF_CplCompCreate(keywordEnforcer, config, configFile, clock, petList, devList, contextflag, name, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
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_CplComp)


Subroutines

public recursive subroutine ESMF_CplCompDestroy(cplcomp, keywordEnforcer, timeout, timeoutFlag, rc)

Arguments

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

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

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp), intent(inout) :: cplcomp
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_CplCompFinalizeAct(cplcomp, importState, exportState, clock, syncflag, phase, userRc, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp), intent(inout) :: cplcomp
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_CplCompGet(cplcomp, keywordEnforcer, configIsPresent, config, configFileIsPresent, configFile, clockIsPresent, clock, localPet, petCount, contextflag, currentMethod, currentPhase, vmIsPresent, vm, name, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp), intent(in) :: cplcomp
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
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
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_CplCompGetEPPhaseCount(cplcomp, methodflag, phaseCount, phaseZeroFlag, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp), intent(in) :: cplcomp
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_CplCompInitialize(cplcomp, keywordEnforcer, importState, exportState, clock, syncflag, phase, timeout, timeoutFlag, userRc, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp), intent(inout) :: cplcomp
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_CplCompInitializeAct(cplcomp, importState, exportState, clock, syncflag, phase, userRc, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp), intent(inout) :: cplcomp
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_CplCompPrint(cplcomp, keywordEnforcer, rc)

Arguments

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

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

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp), intent(inout) :: cplcomp
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_CplCompRun(cplcomp, keywordEnforcer, importState, exportState, clock, syncflag, phase, timeout, timeoutFlag, userRc, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp), intent(inout) :: cplcomp
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_CplCompRunAct(cplcomp, importState, exportState, clock, syncflag, phase, userRc, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp), intent(inout) :: cplcomp
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_CplCompServiceLoop(cplcomp, keywordEnforcer, importState, exportState, clock, syncflag, port, timeout, timeoutFlag, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp), intent(inout) :: cplcomp
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_CplCompSet(cplcomp, keywordEnforcer, config, configFile, clock, name, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp), intent(inout) :: cplcomp
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
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_CplCompSetEntryPoint(cplcomp, methodflag, userRoutine, keywordEnforcer, phase, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp), intent(inout) :: cplcomp
type(ESMF_Method_Flag), intent(in) :: methodflag
private subroutine userRoutine(cplcomp, importState, exportState, clock, rc)
Arguments
Type IntentOptional Attributes Name
type(ESMF_CplComp) :: cplcomp
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_CplCompSetServices(cplcomp, userRoutine, keywordEnforcer, userRc, rc)

Arguments

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

private recursive subroutine ESMF_CplCompSetServicesComp(cplcomp, actualCplcomp, keywordEnforcer, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp), intent(inout) :: cplcomp
type(ESMF_CplComp), intent(in) :: actualCplcomp
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
integer, intent(out), optional :: rc

private recursive subroutine ESMF_CplCompSetServicesShObj(cplcomp, userRoutine, keywordEnforcer, sharedObj, userRoutineFound, userRc, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp), intent(inout) :: cplcomp
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_CplCompSetServicesSock(cplcomp, port, keywordEnforcer, server, timeout, timeoutFlag, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp), intent(inout) :: cplcomp
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_CplCompSetVM(cplcomp, userRoutine, keywordEnforcer, userRc, rc)

Arguments

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

public subroutine ESMF_CplCompSetVMMaxPEs(cplcomp, keywordEnforcer, maxPeCountPerPet, prefIntraProcess, prefIntraSsi, prefInterSsi, pthreadMinStackSize, forceChildPthreads, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp), intent(inout) :: cplcomp
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

public subroutine ESMF_CplCompSetVMMaxThreads(cplcomp, keywordEnforcer, maxPetCountPerVas, prefIntraProcess, prefIntraSsi, prefInterSsi, pthreadMinStackSize, forceChildPthreads, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp), intent(inout) :: cplcomp
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_CplCompSetVMMinThreads(cplcomp, keywordEnforcer, maxPeCountPerPet, prefIntraProcess, prefIntraSsi, prefInterSsi, pthreadMinStackSize, forceChildPthreads, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp), intent(inout) :: cplcomp
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_CplCompSetVMShObj(cplcomp, userRoutine, keywordEnforcer, sharedObj, userRoutineFound, userRc, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp), intent(inout) :: cplcomp
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_CplCompValidate(cplcomp, keywordEnforcer, rc)

Arguments

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

public subroutine ESMF_CplCompWait(cplcomp, keywordEnforcer, syncflag, timeout, timeoutFlag, userRc, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp), intent(inout) :: cplcomp
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_CplCompWriteRestart(cplcomp, keywordEnforcer, importState, exportState, clock, syncflag, phase, timeout, timeoutFlag, userRc, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp), intent(inout) :: cplcomp
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