Skip to content

Commit

Permalink
Start to deprecate the "accDeviceCount" argument in VMGet() API.
Browse files Browse the repository at this point in the history
  • Loading branch information
theurich committed Oct 19, 2023
1 parent 3a1ad6f commit 4d194ba
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions src/Infrastructure/VM/interface/ESMF_VM.F90
Original file line number Diff line number Diff line change
Expand Up @@ -5169,7 +5169,7 @@ end subroutine ESMF_VMGatherVR8
#undef ESMF_METHOD
#define ESMF_METHOD "ESMF_VMGetDefault()"
!BOP
! !IROUTINE: ESMF_VMGet - Get information from a VM
! !IROUTINE: ESMF_VMGet - Get general information from a VM

! !INTERFACE:
! Private name; call using ESMF_VMGet()
Expand Down Expand Up @@ -5416,19 +5416,20 @@ end subroutine ESMF_VMGetDefault
#undef ESMF_METHOD
#define ESMF_METHOD "ESMF_VMGetPetSpecific()"
!BOP
! !IROUTINE: ESMF_VMGet - Get PET specific VM information
! !IROUTINE: ESMF_VMGet - Get PET specific information from a VM

! !INTERFACE:
! Private name; call using ESMF_VMGet()
subroutine ESMF_VMGetPetSpecific(vm, pet, keywordEnforcer, peCount, &
accDeviceCount, ssiId, threadCount, threadId, vas, rc)
accDeviceCount, & ! DEPRECATED ARGUMENT
ssiId, threadCount, threadId, vas, rc)
!
! !ARGUMENTS:
type(ESMF_VM), intent(in) :: vm
integer, intent(in) :: pet
type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
integer, intent(out), optional :: peCount
integer, intent(out), optional :: accDeviceCount
integer, intent(out), optional :: accDeviceCount ! DEPRECATED ARGUMENT
integer, intent(out), optional :: ssiId
integer, intent(out), optional :: threadCount
integer, intent(out), optional :: threadId
Expand All @@ -5442,6 +5443,9 @@ subroutine ESMF_VMGetPetSpecific(vm, pet, keywordEnforcer, peCount, &
! \begin{description}
! \item[7.0.0] Added argument {\tt accDeviceCount}.
! The argument provides access to the number of available accelerator devices.
! \item[8.6.0] Started deprecation of argument {\tt accDeviceCount} in favor of
! the new arguments {\tt ssiLocalDevCount} and {\tt ssiLocalDevList} offered
! by the general {\tt ESMF\_VMGet()} method.
! \end{description}
! \end{itemize}
!
Expand All @@ -5461,6 +5465,7 @@ subroutine ESMF_VMGetPetSpecific(vm, pet, keywordEnforcer, peCount, &
! \item[{[accDeviceCount]}]
! Upon return this holds the number of accelerated devices accessible
! from the specified PET in the {\tt ESMF\_VM} object.
! \apiDeprecatedArgWithReplacement{ssiLocalDevCount}
! \item[{[ssiId]}]
! Upon return this holds the id of the single-system image (SSI) the
! specified PET is running on.
Expand Down

0 comments on commit 4d194ba

Please sign in to comment.