NUOPC_Connector Module


Uses

  • module~~nuopc_connector~~UsesGraph module~nuopc_connector NUOPC_Connector module~esmf ESMF module~nuopc_connector->module~esmf module~nuopc NUOPC module~nuopc_connector->module~nuopc

Used by

  • module~~nuopc_connector~~UsedByGraph module~nuopc_connector NUOPC_Connector module~driver DRIVER module~driver->module~nuopc_connector module~nuopc_driver NUOPC_Driver module~driver->module~nuopc_driver module~esmf_nuopc_utest_mod ESMF_NUOPC_UTest_Mod module~esmf_nuopc_utest_mod->module~nuopc_connector module~esmf_nuopc_utest_mod->module~nuopc_driver module~nuopc_driver->module~nuopc_connector program~esmf_nuopc_utest ESMF_NUOPC_UTest program~esmf_nuopc_utest->module~nuopc_connector program~esmf_nuopc_utest->module~esmf_nuopc_utest_mod program~esmf_nuopc_utest->module~nuopc_driver module~driver~2 DRIVER module~driver~2->module~nuopc_driver program~esmf_nuopcatmmodelex ESMF_NUOPCAtmModelEx program~esmf_nuopcatmmodelex->module~driver program~esmf_nuopcbasicmodelex ESMF_NUOPCBasicModelEx program~esmf_nuopcbasicmodelex->module~driver

Variables

Type Visibility Attributes Name Initial
character(len=*), public, parameter :: label_ComputeRouteHandle = "Connector_ComputeRH"
character(len=*), public, parameter :: label_ExecuteRouteHandle = "Connector_ExecuteRH"
character(len=*), public, parameter :: label_Finalize = "Connector_Finalize"
character(len=*), private, parameter :: label_InternalState = "Connector_InternalState"
character(len=*), public, parameter :: label_ReleaseRouteHandle = "Connector_ReleaseRH"

Derived Types

type, private ::  GridL

Components

Type Visibility Attributes Name Initial
type(ESMF_Grid), public :: acceptorGrid
type(ESMF_Grid), public :: keyGrid
type(GridL), public, pointer :: prev

type, private ::  MeshL

Components

Type Visibility Attributes Name Initial
type(ESMF_Mesh), public :: acceptorMesh
type(ESMF_Mesh), public :: keyMesh
type(MeshL), public, pointer :: prev

type, private ::  type_CplSet

Components

Type Visibility Attributes Name Initial
integer, public :: count
type(ESMF_Field), public, pointer :: dstFieldList(:)
type(ESMF_Field), public, pointer :: srcFieldList(:)
type(ESMF_FieldBundle), public :: dstFields
type(ESMF_FieldBundle), public :: srcFields
type(ESMF_Region_Flag), public, pointer :: zeroRegions(:)
type(ESMF_RouteHandle), public :: rh
type(ESMF_State), public :: state
type(ESMF_TermOrder_Flag), public, pointer :: termOrders(:)

type, private ::  type_InternalState

Components

Type Visibility Attributes Name Initial
type(type_InternalStateStruct), public, pointer :: wrap

type, private ::  type_InternalStateStruct

Components

Type Visibility Attributes Name Initial
character(len=ESMF_MAXSTR), public, pointer :: cplSetList(:)
integer, public :: cplSetCount
integer, public :: epochThrottle
logical, public :: dstFlag
logical, public :: epochEnable
logical, public :: epochEnterKeepAlloc
logical, public :: epochExitKeepAlloc
logical, public :: srcDstOverlap
logical, public :: srcFlag
type(ESMF_Clock), public :: driverClock
type(ESMF_Field), public, pointer :: dstFieldList(:)
type(ESMF_Field), public, pointer :: srcFieldList(:)
type(ESMF_FieldBundle), public :: dstFields
type(ESMF_FieldBundle), public :: srcFields
type(ESMF_Region_Flag), public, pointer :: zeroRegions(:)
type(ESMF_RouteHandle), public :: rh
type(ESMF_State), public :: state
type(ESMF_TermOrder_Flag), public, pointer :: termOrders(:)
type(ESMF_VM), public :: dstVM
type(ESMF_VM), public :: srcVM
type(type_CplSet), public, allocatable :: cplSet(:)
type(type_UpdatePacket), public, pointer :: updatePackets

type, private ::  type_UpdatePacket

Components

Type Visibility Attributes Name Initial
integer, public :: dstLocalPet
integer, public :: fieldCount
integer, public, pointer :: fieldIndex(:)
integer, public, pointer :: recvBuffer(:,:)
integer, public :: recvFromPet
integer, public, pointer :: sendBuffer(:,:)
integer, public, pointer :: sendToPets(:)
integer, public :: srcLocalPet
type(type_UpdatePacket), public, pointer :: prev

Functions

private function getBondLevel(imNamespace, exNamespace, imCplSet, exCplSet)

Arguments

Type IntentOptional Attributes Name
character(len=*) :: imNamespace
character(len=*) :: exNamespace
character(len=*) :: imCplSet
character(len=*) :: exCplSet

Return Value integer

private function getCount(value, list)

Arguments

Type IntentOptional Attributes Name
character(len=*) :: value
character(len=*), pointer :: list(:)

Return Value integer

private function getIndex(value, list)

Arguments

Type IntentOptional Attributes Name
character(len=*) :: value
character(len=*), pointer :: list(:)

Return Value integer


Subroutines

private subroutine BuildUpdatePackets(srcFieldList, dstFieldList, updatePackets, verbosity, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Field), pointer :: srcFieldList(:)
type(ESMF_Field), pointer :: dstFieldList(:)
type(type_UpdatePacket), pointer :: updatePackets
integer, intent(in) :: verbosity
integer, intent(out) :: rc

private subroutine DestroyUpdatePackets(updatePackets, rc)

Arguments

Type IntentOptional Attributes Name
type(type_UpdatePacket), pointer :: updatePackets
integer, intent(out) :: rc

private subroutine DetermineSrcDstOverlap(srcFieldList, dstFieldList, srcDstOverlap, srcFlag, dstFlag, verbosity, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Field), pointer :: srcFieldList(:)
type(ESMF_Field), pointer :: dstFieldList(:)
logical, intent(out) :: srcDstOverlap
logical, intent(out) :: srcFlag
logical, intent(out) :: dstFlag
integer, intent(in) :: verbosity
integer, intent(out) :: rc

private subroutine ExecuteUpdatePackets(srcFieldList, dstFieldList, updatePackets, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Field), pointer :: srcFieldList(:)
type(ESMF_Field), pointer :: dstFieldList(:)
type(type_UpdatePacket), pointer :: updatePackets
integer, intent(out) :: rc

private subroutine FieldBundleCplStore(srcFB, dstFB, cplList, rh, zeroRegions, termOrders, name, verbosity, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_FieldBundle), intent(inout) :: srcFB
type(ESMF_FieldBundle), intent(inout) :: dstFB
character(len=*) :: cplList(:)
type(ESMF_RouteHandle), intent(inout) :: rh
type(ESMF_Region_Flag), pointer :: zeroRegions(:)
type(ESMF_TermOrder_Flag), pointer :: termOrders(:)
character(len=*), intent(in) :: name
integer, intent(in) :: verbosity
integer, intent(out), optional :: rc

private subroutine Finalize(connector, importState, exportState, clock, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp) :: connector
type(ESMF_State) :: importState
type(ESMF_State) :: exportState
type(ESMF_Clock) :: clock
integer, intent(out) :: rc

private subroutine InitializeIPDv00p2a(connector, importState, exportState, clock, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp) :: connector
type(ESMF_State) :: importState
type(ESMF_State) :: exportState
type(ESMF_Clock) :: clock
integer, intent(out) :: rc

private subroutine InitializeIPDv00p2b(connector, importState, exportState, clock, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp) :: connector
type(ESMF_State) :: importState
type(ESMF_State) :: exportState
type(ESMF_Clock) :: clock
integer, intent(out) :: rc

private subroutine InitializeIPDv03p1(connector, importState, exportState, clock, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp) :: connector
type(ESMF_State) :: importState
type(ESMF_State) :: exportState
type(ESMF_Clock) :: clock
integer, intent(out) :: rc

private subroutine InitializeIPDv05p1(connector, importState, exportState, clock, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp) :: connector
type(ESMF_State) :: importState
type(ESMF_State) :: exportState
type(ESMF_Clock) :: clock
integer, intent(out) :: rc

private subroutine InitializeIPDv05p2a(connector, importState, exportState, clock, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp) :: connector
type(ESMF_State) :: importState
type(ESMF_State) :: exportState
type(ESMF_Clock) :: clock
integer, intent(out) :: rc

private subroutine InitializeIPDv05p2b(connector, importState, exportState, clock, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp) :: connector
type(ESMF_State) :: importState
type(ESMF_State) :: exportState
type(ESMF_Clock) :: clock
integer, intent(out) :: rc

private subroutine InitializeIPDv05p3(connector, importState, exportState, clock, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp) :: connector
type(ESMF_State) :: importState
type(ESMF_State) :: exportState
type(ESMF_Clock) :: clock
integer, intent(out) :: rc

private subroutine InitializeIPDv05p4(connector, importState, exportState, clock, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp) :: connector
type(ESMF_State) :: importState
type(ESMF_State) :: exportState
type(ESMF_Clock) :: clock
integer, intent(out) :: rc

private subroutine InitializeIPDv05p5(connector, importState, exportState, clock, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp) :: connector
type(ESMF_State) :: importState
type(ESMF_State) :: exportState
type(ESMF_Clock) :: clock
integer, intent(out) :: rc

private subroutine InitializeIPDv05p6a(connector, importState, exportState, clock, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp) :: connector
type(ESMF_State) :: importState
type(ESMF_State) :: exportState
type(ESMF_Clock) :: clock
integer, intent(out) :: rc

private subroutine InitializeIPDv05p6b(connector, importState, exportState, clock, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp) :: connector
type(ESMF_State) :: importState
type(ESMF_State) :: exportState
type(ESMF_Clock) :: clock
integer, intent(out) :: rc

private subroutine InitializeP0(connector, importState, exportState, clock, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp) :: connector
type(ESMF_State) :: importState
type(ESMF_State) :: exportState
type(ESMF_Clock) :: clock
integer, intent(out) :: rc

public subroutine NUOPC_ConnectorGet(connector, srcFields, dstFields, rh, state, CplSet, cplSetList, srcVM, dstVM, driverClock, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp) :: connector
type(ESMF_FieldBundle), intent(out), optional :: srcFields
type(ESMF_FieldBundle), intent(out), optional :: dstFields
type(ESMF_RouteHandle), intent(out), optional :: rh
type(ESMF_State), intent(out), optional :: state
character(len=*), intent(in), optional :: CplSet
character(len=ESMF_MAXSTR), optional, pointer :: cplSetList(:)
type(ESMF_VM), intent(out), optional :: srcVM
type(ESMF_VM), intent(out), optional :: dstVM
type(ESMF_Clock), intent(out), optional :: driverClock
integer, intent(out), optional :: rc

public subroutine NUOPC_ConnectorSet(connector, srcFields, dstFields, rh, state, CplSet, srcVM, dstVM, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp) :: connector
type(ESMF_FieldBundle), intent(in), optional :: srcFields
type(ESMF_FieldBundle), intent(in), optional :: dstFields
type(ESMF_RouteHandle), intent(in), optional :: rh
type(ESMF_State), intent(in), optional :: state
character(len=*), intent(in), optional :: CplSet
type(ESMF_VM), intent(in), optional :: srcVM
type(ESMF_VM), intent(in), optional :: dstVM
integer, intent(out), optional :: rc

private subroutine Run(connector, importState, exportState, clock, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp) :: connector
type(ESMF_State) :: importState
type(ESMF_State) :: exportState
type(ESMF_Clock) :: clock
integer, intent(out) :: rc

public subroutine SetServices(connector, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp) :: connector
integer, intent(out) :: rc

public subroutine SetVM(connector, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CplComp) :: connector
integer, intent(out) :: rc

private subroutine ShareFieldWithGrid(acceptorField, providerField, name, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Field), intent(inout) :: acceptorField
type(ESMF_Field), intent(in) :: providerField
character(len=*), intent(in) :: name
integer, intent(out) :: rc

private subroutine ShareFieldWithMesh(acceptorField, providerField, name, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Field), intent(inout) :: acceptorField
type(ESMF_Field), intent(in) :: providerField
character(len=*), intent(in) :: name
integer, intent(out) :: rc

private subroutine getUniqueList(list, uniqueList, uniqueCount, rc)

Arguments

Type IntentOptional Attributes Name
character(len=*), pointer :: list(:)
character(len=*), pointer :: uniqueList(:)
integer, optional :: uniqueCount
integer, optional :: rc

private subroutine printStringList(prefix, stringList)

Arguments

Type IntentOptional Attributes Name
character(len=*) :: prefix
character(len=ESMF_MAXSTR), pointer :: stringList(:)