ESMF_CompSetVMMaxPEs Subroutine

public subroutine ESMF_CompSetVMMaxPEs(compp, max, pref_intra_process, pref_intra_ssi, pref_inter_ssi, pthreadMinStackSize, openMpHandling, openMpNumThreads, forceChildPthreads, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_CompClass), pointer :: compp
integer, intent(in), optional :: max
integer, intent(in), optional :: pref_intra_process
integer, intent(in), optional :: pref_intra_ssi
integer, intent(in), optional :: pref_inter_ssi
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

Calls

proc~~esmf_compsetvmmaxpes~~CallsGraph proc~esmf_compsetvmmaxpes ESMF_CompSetVMMaxPEs proc~esmf_compclassgetinit ESMF_CompClassGetInit proc~esmf_compsetvmmaxpes->proc~esmf_compclassgetinit proc~esmf_imerr ESMF_IMErr proc~esmf_compsetvmmaxpes->proc~esmf_imerr proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_compsetvmmaxpes->proc~esmf_logfounderror proc~esmf_logseterror ESMF_LogSetError proc~esmf_compsetvmmaxpes->proc~esmf_logseterror proc~esmf_utilstringlowercase ESMF_UtilStringLowerCase proc~esmf_compsetvmmaxpes->proc~esmf_utilstringlowercase proc~esmf_vmplanmaxpes ESMF_VMPlanMaxPEs proc~esmf_compsetvmmaxpes->proc~esmf_vmplanmaxpes proc~esmf_vmplansetminstacksize ESMF_VMPlanSetMinStackSize proc~esmf_compsetvmmaxpes->proc~esmf_vmplansetminstacksize proc~esmf_vmplansetopenmp ESMF_VMPlanSetOpenMP proc~esmf_compsetvmmaxpes->proc~esmf_vmplansetopenmp 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 proc~esmf_logseterror->esmf_breakpoint proc~esmf_logseterror->proc~esmf_logrc2msg proc~esmf_logseterror->proc~esmf_logwrite proc~esmf_vmplanmaxpes->proc~esmf_imerr proc~esmf_vmplanmaxpes->proc~esmf_logfounderror c_esmc_vmplanmaxpes c_esmc_vmplanmaxpes proc~esmf_vmplanmaxpes->c_esmc_vmplanmaxpes proc~esmf_vmgetinit ESMF_VMGetInit proc~esmf_vmplanmaxpes->proc~esmf_vmgetinit proc~esmf_vmplangetinit ESMF_VMPlanGetInit proc~esmf_vmplanmaxpes->proc~esmf_vmplangetinit proc~esmf_vmplansetminstacksize->proc~esmf_imerr proc~esmf_vmplansetminstacksize->proc~esmf_logfounderror c_esmc_vmplansetminstacksize c_esmc_vmplansetminstacksize proc~esmf_vmplansetminstacksize->c_esmc_vmplansetminstacksize proc~esmf_vmplansetminstacksize->proc~esmf_vmplangetinit proc~esmf_vmplansetopenmp->proc~esmf_imerr proc~esmf_vmplansetopenmp->proc~esmf_logfounderror c_esmc_vmplansetopenmp c_esmc_vmplansetopenmp proc~esmf_vmplansetopenmp->c_esmc_vmplansetopenmp proc~esmf_vmplansetopenmp->proc~esmf_vmplangetinit 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_compsetvmmaxpes~~CalledByGraph proc~esmf_compsetvmmaxpes ESMF_CompSetVMMaxPEs proc~esmf_cplcompsetvmmaxpes ESMF_CplCompSetVMMaxPEs proc~esmf_cplcompsetvmmaxpes->proc~esmf_compsetvmmaxpes proc~esmf_gridcompsetvmmaxpes ESMF_GridCompSetVMMaxPEs proc~esmf_gridcompsetvmmaxpes->proc~esmf_compsetvmmaxpes proc~nuopc_setvm NUOPC_SetVM proc~nuopc_setvm->proc~esmf_gridcompsetvmmaxpes proc~userm2_setvm~11 userm2_setvm proc~userm2_setvm~11->proc~esmf_gridcompsetvmmaxpes proc~userm2_setvm~31 userm2_setvm proc~userm2_setvm~31->proc~esmf_gridcompsetvmmaxpes

Source Code

  subroutine ESMF_CompSetVMMaxPEs(compp, max, pref_intra_process, &
    pref_intra_ssi, pref_inter_ssi, pthreadMinStackSize, openMpHandling, &
    openMpNumThreads, forceChildPthreads, rc)
!
! !ARGUMENTS:
    type(ESMF_CompClass), pointer               :: compp
    integer,              intent(in),  optional :: max
    integer,              intent(in),  optional :: pref_intra_process
    integer,              intent(in),  optional :: pref_intra_ssi
    integer,              intent(in),  optional :: pref_inter_ssi
    integer,              intent(in),  optional :: pthreadMinStackSize
    character(*),         intent(in),  optional :: openMpHandling
    integer,              intent(in),  optional :: openMpNumThreads
    logical,              intent(in),  optional :: forceChildPthreads
    integer,              intent(out), optional :: rc
!
! !DESCRIPTION:
!     Configure VM for this component.
!
!     The arguments are:
!     \begin{description}
!     \item[compp] 
!          component object
!     \item[{[max]}] 
!          Maximum number of PEs per PET
!     \item[{[pref\_intra\_process]}] 
!          Intra process communication preference
!     \item[{[pref\_intra\_ssi]}] 
!          Intra SSI communication preference
!     \item[{[pref\_inter\_ssi]}] 
!          Inter process communication preference
!     \item[{[pthreadMinStackSize]}] 
!          Minimum stack size for child PETs executing as Pthreads.
!     \item[{[openMpHandling]}] 
!          Handling of OpenMP threads. Supported: "none", "set", "init", "pin"
!          (default).
!     \item[{[openMpNumThreads]}] 
!          Number of OpenMP threads under each PET. By default each PET uses
!          its local peCount.
!     \item[{[forceChildPthreads]}] 
!          For {\tt .true.}, force each child PET to execute in its own Pthread.
!          By default, {\tt .false.}, single PETs spawned from a parent PET
!          execute in the same thread (or MPI process) as the parent PET. Multiple
!          child PETs spawned by the same parent PET always execute as their own
!          Pthreads.
!     \item[{[rc]}] 
!          Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!
!EOPI
!------------------------------------------------------------------------------
    integer                 :: localrc      ! local return code
    integer                 :: intOpenMpHandling
    character(len=:), allocatable  :: lowerOpenMpHandling

    ! Initialize return code; assume not implemented until success is certain
    localrc = ESMF_RC_NOT_IMPL
    if (present(rc)) rc = ESMF_RC_NOT_IMPL

    ! Test incoming compp object
    if (.not.associated(compp)) then
      call ESMF_LogSetError(ESMF_RC_OBJ_BAD, &
        msg="Not a valid pointer to ESMF Component object", &
        ESMF_CONTEXT, rcToReturn=rc)
      return
    endif

    ! Check init status of arguments
    ESMF_INIT_CHECK_DEEP(ESMF_CompClassGetInit, compp, rc)

    ! ensure that this is not a child_in_parent_vm plan
    if (compp%contextflag == ESMF_CONTEXT_PARENT_VM) then
      call ESMF_LogSetError(ESMF_RC_NOT_VALID, &
        msg="CompSetVM() calls are incompatible with CHILD_IN_PARENT_VM component", &
        ESMF_CONTEXT, rcToReturn=rc)
      return
    endif
    
    ! ensure that this component's VM wasn't already created
    if (compp%vm_info /= ESMF_NULL_POINTER) then
      call ESMF_LogSetError(ESMF_RC_NOT_VALID, &
        msg="CompSetVM() calls cannot be called on components with existing VM", &
        ESMF_CONTEXT, rcToReturn=rc)
      return
    endif

    ! call CompClass method
    call ESMF_VMPlanMaxPEs(compp%vmplan, compp%vm_parent, max, &
      pref_intra_process, pref_intra_ssi, pref_inter_ssi, &
      compp%npetlist, compp%petlist, forceChildPthreads, rc=localrc)
    if (ESMF_LogFoundError(localrc, &
      ESMF_ERR_PASSTHRU, &
      ESMF_CONTEXT, rcToReturn=rc)) return

    ! set pthreadMinStackSize
    call ESMF_VMPlanSetMinStackSize(compp%vmplan, pthreadMinStackSize, &
      rc=localrc)
    if (ESMF_LogFoundError(localrc, &
      ESMF_ERR_PASSTHRU, &
      ESMF_CONTEXT, rcToReturn=rc)) return

    ! set openMpHandling
    intOpenMpHandling = 3 ! default: pin OpenMP threads to PEs
    if (present(openMpHandling)) then
      lowerOpenMpHandling = ESMF_UtilStringLowerCase(openMpHandling, rc=localrc)
      if (ESMF_LogFoundError(localrc, &
        ESMF_ERR_PASSTHRU, &
        ESMF_CONTEXT, rcToReturn=rc)) return
      if (trim(lowerOpenMpHandling) == "none") then
        intOpenMpHandling = 0
      else if (trim(lowerOpenMpHandling) == "set") then
        intOpenMpHandling = 1
      else if (trim(lowerOpenMpHandling) == "init") then
        intOpenMpHandling = 2
      else if ((trim(lowerOpenMpHandling) == "pin") .or. &
        (trim(lowerOpenMpHandling) == "")) then
        intOpenMpHandling = 3 ! default
      else
        ! not a supported option -> error out
        deallocate(lowerOpenMpHandling)
        call ESMF_LogSetError(ESMF_RC_NOT_VALID, &
          msg="Invalid 'openMpHandling' option provided.", &
          ESMF_CONTEXT, rcToReturn=rc)
        return
      endif
      deallocate(lowerOpenMpHandling)
    endif
    call ESMF_VMPlanSetOpenMP(compp%vmplan, intOpenMpHandling, &
      openMpNumThreads, rc=localrc)
    if (ESMF_LogFoundError(localrc, &
      ESMF_ERR_PASSTHRU, &
      ESMF_CONTEXT, rcToReturn=rc)) return

    ! Return successfully
    if (present(rc)) rc = ESMF_SUCCESS

  end subroutine ESMF_CompSetVMMaxPEs