ESMF_DELayoutCreateFromPetMap Function

private recursive function ESMF_DELayoutCreateFromPetMap(petMap, keywordEnforcer, pinflag, vm, rc)

Arguments

Type IntentOptional Attributes Name
integer, intent(in) :: petMap(:)
type(ESMF_KeywordEnforcer), optional :: keywordEnforcer
type(ESMF_Pin_Flag), intent(in), optional :: pinflag
type(ESMF_VM), intent(in), optional :: vm
integer, intent(out), optional :: rc

Return Value type(ESMF_DELayout)


Calls

proc~~esmf_delayoutcreatefrompetmap~~CallsGraph proc~esmf_delayoutcreatefrompetmap ESMF_DELayoutCreateFromPetMap c_esmc_delayoutcreatefrompetmap c_esmc_delayoutcreatefrompetmap proc~esmf_delayoutcreatefrompetmap->c_esmc_delayoutcreatefrompetmap proc~esmf_imerr ESMF_IMErr proc~esmf_delayoutcreatefrompetmap->proc~esmf_imerr proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_delayoutcreatefrompetmap->proc~esmf_logfounderror proc~esmf_vmgetinit ESMF_VMGetInit proc~esmf_delayoutcreatefrompetmap->proc~esmf_vmgetinit proc~esmf_imerr->proc~esmf_logfounderror proc~esmf_initcheckdeep ESMF_InitCheckDeep proc~esmf_imerr->proc~esmf_initcheckdeep esmf_breakpoint esmf_breakpoint proc~esmf_logfounderror->esmf_breakpoint proc~esmf_logrc2msg ESMF_LogRc2Msg proc~esmf_logfounderror->proc~esmf_logrc2msg proc~esmf_logwrite ESMF_LogWrite proc~esmf_logfounderror->proc~esmf_logwrite c_esmc_loggeterrormsg c_esmc_loggeterrormsg proc~esmf_logrc2msg->c_esmc_loggeterrormsg c_esmc_vmwtime c_esmc_vmwtime proc~esmf_logwrite->c_esmc_vmwtime proc~esmf_logclose ESMF_LogClose proc~esmf_logwrite->proc~esmf_logclose proc~esmf_logflush ESMF_LogFlush proc~esmf_logwrite->proc~esmf_logflush proc~esmf_logopenfile ESMF_LogOpenFile proc~esmf_logwrite->proc~esmf_logopenfile proc~esmf_utiliounitflush ESMF_UtilIOUnitFlush proc~esmf_logwrite->proc~esmf_utiliounitflush proc~esmf_utilstring2array ESMF_UtilString2Array proc~esmf_logwrite->proc~esmf_utilstring2array proc~esmf_logclose->proc~esmf_logflush proc~esmf_logflush->proc~esmf_utiliounitflush proc~esmf_utilarray2string ESMF_UtilArray2String proc~esmf_logflush->proc~esmf_utilarray2string proc~esmf_logopenfile->proc~esmf_utiliounitflush proc~esmf_utiliounitget ESMF_UtilIOUnitGet proc~esmf_logopenfile->proc~esmf_utiliounitget

Called by

proc~~esmf_delayoutcreatefrompetmap~~CalledByGraph proc~esmf_delayoutcreatefrompetmap ESMF_DELayoutCreateFromPetMap interface~esmf_delayoutcreate ESMF_DELayoutCreate interface~esmf_delayoutcreate->proc~esmf_delayoutcreatefrompetmap proc~createfields createFields proc~createfields->interface~esmf_delayoutcreate proc~esmf_distgridcreatedbai1d ESMF_DistGridCreateDBAI1D proc~esmf_distgridcreatedbai1d->interface~esmf_delayoutcreate proc~esmf_gridcreatecopyfromreg ESMF_GridCreateCopyFromReg proc~esmf_gridcreatecopyfromreg->interface~esmf_delayoutcreate proc~esmf_gridcreatecubedsphereireg ESMF_GridCreateCubedSphereIReg proc~esmf_gridcreatecubedsphereireg->interface~esmf_delayoutcreate proc~esmf_gridcreatecubedspherereg ESMF_GridCreateCubedSphereReg proc~esmf_gridcreatecubedspherereg->interface~esmf_delayoutcreate proc~esmf_gridcreatedistgridirreg ESMF_GridCreateDistgridIrreg proc~esmf_gridcreatedistgridirreg->interface~esmf_delayoutcreate proc~esmf_gridcreatedistgridreg ESMF_GridCreateDistgridReg proc~esmf_gridcreatedistgridreg->interface~esmf_delayoutcreate proc~esmf_gridcreatemosaicireg ESMF_GridCreateMosaicIReg proc~esmf_gridcreatemosaicireg->interface~esmf_delayoutcreate proc~esmf_gridcreatemosaicreg ESMF_GridCreateMosaicReg proc~esmf_gridcreatemosaicreg->interface~esmf_delayoutcreate proc~esmf_gridcreateshapetileirreg ESMF_GridCreateShapeTileIrreg proc~esmf_gridcreateshapetileirreg->interface~esmf_delayoutcreate proc~esmf_gridcreateshapetilereg ESMF_GridCreateShapeTileReg proc~esmf_gridcreateshapetilereg->interface~esmf_delayoutcreate proc~esmf_gridsetcmmitshapetileirreg ESMF_GridSetCmmitShapeTileIrreg proc~esmf_gridsetcmmitshapetileirreg->interface~esmf_delayoutcreate proc~esmf_gridsetcmmitshapetilereg ESMF_GridSetCmmitShapeTileReg proc~esmf_gridsetcmmitshapetilereg->interface~esmf_delayoutcreate proc~mygcomp_run~3 mygcomp_run proc~mygcomp_run~3->interface~esmf_delayoutcreate proc~test_smm test_smm proc~test_smm->interface~esmf_delayoutcreate proc~user2_run~2 user2_run proc~user2_run~2->interface~esmf_delayoutcreate proc~user_init~29 user_init proc~user_init~29->interface~esmf_delayoutcreate proc~user_init~43 user_init proc~user_init~43->interface~esmf_delayoutcreate proc~user_init~56 user_init proc~user_init~56->interface~esmf_delayoutcreate program~esmf_arraycreategetutest ESMF_ArrayCreateGetUTest program~esmf_arraycreategetutest->interface~esmf_delayoutcreate program~esmf_arrayex ESMF_ArrayEx program~esmf_arrayex->interface~esmf_delayoutcreate program~esmf_arrayhaloutest ESMF_ArrayHaloUTest program~esmf_arrayhaloutest->interface~esmf_delayoutcreate program~esmf_delayoutex ESMF_DELayoutEx program~esmf_delayoutex->interface~esmf_delayoutcreate program~esmf_delayoututest ESMF_DELayoutUTest program~esmf_delayoututest->interface~esmf_delayoutcreate program~esmf_distgridcreategetutest ESMF_DistGridCreateGetUTest program~esmf_distgridcreategetutest->interface~esmf_delayoutcreate program~esmf_distgridex ESMF_DistGridEx program~esmf_distgridex->interface~esmf_delayoutcreate program~esmf_regridex ESMF_RegridEx program~esmf_regridex->interface~esmf_delayoutcreate program~esmf_rhandlevmepochex ESMF_RHandleVMEpochEx program~esmf_rhandlevmepochex->interface~esmf_delayoutcreate

Source Code

  recursive function ESMF_DELayoutCreateFromPetMap(petMap, keywordEnforcer, &
    pinflag, vm, rc)
!         
! !RETURN VALUE:
    type(ESMF_DELayout) :: ESMF_DELayoutCreateFromPetMap
!
! !ARGUMENTS:
    integer,                      intent(in)            :: petMap(:)
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
    type(ESMF_Pin_Flag),          intent(in),  optional :: pinflag
    type(ESMF_VM),                intent(in),  optional :: vm
    integer,                      intent(out), optional :: rc
!
! !STATUS:
! \begin{itemize}
! \item\apiStatusCompatibleVersion{5.2.0r}
! \end{itemize}
!
! !DESCRIPTION:
!     Create an {\tt ESMF\_DELayout} with exactly specified DE to PET mapping.
!
!     This ESMF method must be called in unison by all PETs of the VM. Calling
!     this method from a PET not part of the VM or not calling it from a PET
!     that is part of the VM will result in undefined behavior. ESMF does not
!     guard against violation of the unison requirement. The call is not
!     collective, there is no communication between PETs.
!
!     The arguments are:
!     \begin{description}
!     \item[petMap]
!          List specifying the DE-to-PET mapping. The list elements correspond 
!          to DE 0, 1, 2, ... and map against the specified PET of the VM
!          context. The size of the {\tt petMap} 
!          argument determines the number of DEs in the created DELayout. It is
!          erroneous to specify a PET identifier that lies outside the VM 
!          context.
!     \item[{[pinflag]}]
!          This flag specifies which type of resource DEs are pinned to. 
!          The default is to pin DEs to PETs. Alternatively it is
!          also possible to pin DEs to VASs. See section 
!          \ref{const:pin_flag} for a list of valid pinning options.
!     \item[{[vm]}]
!          If present, the DELayout object is created on the specified 
!          {\tt ESMF\_VM} object. The default is to create on the VM of the 
!          current context.
!     \item[{[rc]}]
!          Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!
!EOP
!------------------------------------------------------------------------------
    integer                 :: localrc      ! local return code
    type(ESMF_DELayout)     :: delayout     ! opaque pointer to new C++ DELayout  
    integer                 :: len_petMap   ! number of elements in petMap

    ! initialize return code; assume routine not implemented
    localrc = ESMF_RC_NOT_IMPL
    if (present(rc)) rc = ESMF_RC_NOT_IMPL

    ! Mark this DELayout as invalid
    delayout%this = ESMF_NULL_POINTER
    ESMF_DELayoutCreateFromPetMap = delayout 

    ! Check init status of arguments
    ESMF_INIT_CHECK_DEEP(ESMF_VMGetInit, vm, rc)
    
    ! Set arguments
    len_petMap = size(petMap)

    ! Call into the C++ interface, which will sort out optional arguments
    call c_ESMC_DELayoutCreateFromPetMap(delayout, petMap(1), len_petMap, &
      pinflag, vm, localrc)
    if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, &
      ESMF_CONTEXT, rcToReturn=rc)) return
    
    ! Set return value
    ESMF_DELayoutCreateFromPetMap = delayout 
    
    ! Set init code
    ESMF_INIT_SET_CREATED(ESMF_DELayoutCreateFromPetMap)
 
    ! return successfully
    if (present(rc)) rc = ESMF_SUCCESS
 
  end function ESMF_DELayoutCreateFromPetMap