! $Id$ ! ! Example/test code which shows User Component calls. !-------------------------------------------------------------------------------- !-------------------------------------------------------------------------------- ! ! !DESCRIPTION: ! User-supplied Component ! ! !\begin{verbatim} module user_model2 ! ESMF Framework module use ESMF implicit none public userm2_register ! variable data arrays integer(ESMF_KIND_I4), allocatable, save :: tmp_data(:,:,:) integer(ESMF_KIND_I4), allocatable, save :: hum_data(:,:,:) integer(ESMF_KIND_I4), allocatable, save :: prs_data(:,:,:) ! index lists integer :: index_list0(6) = (/1,7,3,8,5,6/) integer :: index_list1(10) = (/2,4,9,10,11,12,13,14,15,18/) ! integer :: index_list0(6) = (/1,2,3,5,5,6/) ! integer :: index_list1(10) = (/7,8,9,10,11,12,13,14,15,16/) contains subroutine userm2_register(comp, rc) type(ESMF_GridComp) :: comp integer, intent(out) :: rc ! Initialize return code rc = ESMF_SUCCESS print *, "User Comp2 Register starting" ! Register the callback routines. call ESMF_GridCompSetEntryPoint(comp, ESMF_METHOD_INITIALIZE, userRoutine=user_init, & rc=rc) if (rc/=ESMF_SUCCESS) return call ESMF_GridCompSetEntryPoint(comp, ESMF_METHOD_RUN, userRoutine=user_run, & rc=rc) if (rc/=ESMF_SUCCESS) return call ESMF_GridCompSetEntryPoint(comp, ESMF_METHOD_FINALIZE, userRoutine=user_final, & rc=rc) if (rc/=ESMF_SUCCESS) return print *, "Registered Initialize, Run, and Finalize routines" print *, "User Comp2 Register returning" end subroutine !-------------------------------------------------------------------------------- ! ! User Comp Component created by higher level calls, here is the ! ! Initialization routine. subroutine user_init(comp, importState, exportState, clock, rc) type(ESMF_GridComp) :: comp type(ESMF_State) :: importState, exportState type(ESMF_Clock) :: clock integer, intent(out) :: rc ! Local variables type(ESMF_VM) :: vm integer :: de_id, npets integer, allocatable :: indexList(:) type(ESMF_DistGrid) :: distgrid type(ESMF_LocStream) :: locs type(ESMF_Field) :: field(3) type(ESMF_FieldBundle) :: fieldbundle integer :: icount ! Initialize return code rc = ESMF_SUCCESS ! Query component for VM and create a layout with the right breakdown call ESMF_GridCompGet(comp, vm=vm, rc=rc) if(rc/=ESMF_SUCCESS) return call ESMF_VMGet(vm, localPet=de_id, petCount=npets, rc=rc) if(rc/=ESMF_SUCCESS) return print *, de_id, "User Comp 2 Init starting" ! Check for correct number of PETs if ( npets .ne. 2 ) then call ESMF_LogSetError(ESMF_RC_ARG_BAD,& msg="This component must run on 2 PETs.",& line=__LINE__, file=__FILE__, rcToReturn=rc) return endif if ( de_id .eq. 0 ) then icount = size(index_list0) allocate(indexList(icount)) allocate(tmp_data(2,icount,4)) allocate(hum_data(1,icount,4)) allocate(prs_data(2,icount,4)) ! indexList = (/1,2,3,4,5,6/) indexList = index_list0 elseif ( de_id .eq. 1 ) then icount = size(index_list1) allocate(indexList(icount)) allocate(tmp_data(2,icount,4)) allocate(hum_data(1,icount,4)) allocate(prs_data(2,icount,4)) ! indexList = (/7,8,9,10,11,12,13,14,15,16/) indexList = index_list1 endif print *, de_id, "indexList = ", indexList if (icount .gt. 0) then tmp_data(:,:,:) = 0 hum_data(:,:,:) = 0 prs_data(:,:,:) = 0 endif ! Add "temperature" "humidity" "pressure" fields to the export state. distgrid = ESMF_DistGridCreate(arbSeqIndexList=indexList, rc=rc) if (rc .ne. ESMF_SUCCESS) return deallocate(indexList) locs = ESMF_LocStreamCreate(distgrid=distgrid, & indexflag=ESMF_INDEX_DELOCAL, coordSys=ESMF_COORDSYS_CART, & name="Test LocStream", rc=rc) if (rc .ne. ESMF_SUCCESS) return field(1) = ESMF_FieldCreate(locs, tmp_data, & indexflag=ESMF_INDEX_DELOCAL, gridToFieldMap=(/2/), & name="temperature", rc=rc) if (rc .ne. ESMF_SUCCESS) return field(2) = ESMF_FieldCreate(locs, hum_data, & indexflag=ESMF_INDEX_DELOCAL, gridToFieldMap=(/2/), & name="humidity", rc=rc) if (rc .ne. ESMF_SUCCESS) return field(3) = ESMF_FieldCreate(locs, prs_data, & indexflag=ESMF_INDEX_DELOCAL, gridToFieldMap=(/2/), & name="pressure", rc=rc) if (rc .ne. ESMF_SUCCESS) return fieldbundle = ESMF_FieldBundleCreate(fieldList=field, & name="fieldbundle data", rc=rc) if (rc/=ESMF_SUCCESS) return call ESMF_StateAdd(importState, fieldbundleList=(/fieldbundle/), rc=rc) if (rc/=ESMF_SUCCESS) return print *, de_id, "User Comp2 Init returning" end subroutine user_init !-------------------------------------------------------------------------------- ! ! The Run routine where data is validated. ! ! subroutine user_run(comp, importState, exportState, clock, rc) type(ESMF_GridComp) :: comp type(ESMF_State) :: importState, exportState type(ESMF_Clock) :: clock integer, intent(out) :: rc ! Local variables type(ESMF_VM) :: vm integer :: de_id type(ESMF_FieldBundle) :: fieldbundle type(ESMF_LocStream) :: locs type(ESMF_DistGrid) :: distgrid logical :: arbIndex integer :: elementCount integer, allocatable :: indexList(:) type(ESMF_Field) :: field integer(ESMF_KIND_I4), pointer :: fptr(:,:,:) integer :: i integer :: exlb(3), exub(3) ! Initialize return code rc = ESMF_SUCCESS call ESMF_GridCompGet(comp, vm=vm, rc=rc) if(rc/=ESMF_SUCCESS) return call ESMF_VMGet(vm, localPet=de_id, rc=rc) if(rc/=ESMF_SUCCESS) return print *, de_id, "User Comp2 Run starting" ! Get the destination Field from the import State call ESMF_StateGet(importState, itemName="fieldbundle data", fieldbundle=fieldbundle, rc=rc) if (rc/=ESMF_SUCCESS) return ! Get the LocStream from the FieldBundle call ESMF_FieldBundleGet(fieldbundle, locstream=locs, rc=rc) if (rc/=ESMF_SUCCESS) return call ESMF_LocStreamGet(locs, distgrid=distgrid, rc=rc) if(rc/=ESMF_SUCCESS) return call ESMF_DistGridGet(distgrid, localDe=0, arbSeqIndexFlag=arbIndex, & elementCount=elementCount, rc=rc) if(rc/=ESMF_SUCCESS) return allocate(indexList(elementCount)) call ESMF_DistGridGet(distgrid, localDe=0, seqIndexList=indexList, rc=rc) if(rc/=ESMF_SUCCESS) return nullify(fptr) call ESMF_FieldBundleGet(fieldbundle, fieldName="temperature", & field=field, rc=rc) if (rc/=ESMF_SUCCESS) return call ESMF_FieldGet(field, localDe=0, farrayPtr=fptr, & exclusiveLBound=exlb, exclusiveUBound=exub, rc=rc) if(rc/=ESMF_SUCCESS) return do i = exlb(2), exub(2) if(fptr(1,i,1) .ne. indexList(i)*1*1) then print *, de_id, "ERROR temp ", indexList(i), " val(1,i,1) =", fptr(1,i,1) rc = ESMF_FAILURE endif if(fptr(1,i,2) .ne. indexList(i)*1*2) then print *, de_id, "ERROR temp ", indexList(i), " val(1,i,2) =", fptr(1,i,2) rc = ESMF_FAILURE endif if(fptr(1,i,3) .ne. indexList(i)*1*3) then print *, de_id, "ERROR temp ", indexList(i), " val(1,i,3) =", fptr(1,i,3) rc = ESMF_FAILURE endif if(fptr(1,i,4) .ne. indexList(i)*1*4) then print *, de_id, "ERROR temp ", indexList(i), " val(1,i,4) =", fptr(1,i,4) rc = ESMF_FAILURE endif if(fptr(2,i,1) .ne. 1*1) then print *, de_id, "ERROR temp ", indexList(i), " val(2,i,1) =", fptr(2,i,1) rc = ESMF_FAILURE endif if(fptr(2,i,2) .ne. 1*2) then print *, de_id, "ERROR temp ", indexList(i), " val(2,i,2) =", fptr(2,i,2) rc = ESMF_FAILURE endif if(fptr(2,i,3) .ne. 1*3) then print *, de_id, "ERROR temp ", indexList(i), " val(2,i,3) =", fptr(2,i,3) rc = ESMF_FAILURE endif if(fptr(2,i,4) .ne. 1*4) then print *, de_id, "ERROR temp ", indexList(i), " val(2,i,4) =", fptr(2,i,4) rc = ESMF_FAILURE endif enddo nullify(fptr) call ESMF_FieldBundleGet(fieldbundle, fieldName="humidity", & field=field, rc=rc) if (rc/=ESMF_SUCCESS) return call ESMF_FieldGet(field, localDe=0, farrayPtr=fptr, & exclusiveLBound=exlb, exclusiveUBound=exub, rc=rc) if(rc/=ESMF_SUCCESS) return do i = exlb(2), exub(2) if(fptr(1,i,1) .ne. indexList(i)*10*1) then print *, de_id, "ERROR humd ", indexList(i), " val(1,i,1) =", fptr(1,i,1) rc = ESMF_FAILURE endif if(fptr(1,i,2) .ne. indexList(i)*10*2) then print *, de_id, "ERROR humd ", indexList(i), " val(1,i,2) =", fptr(1,i,2) rc = ESMF_FAILURE endif if(fptr(1,i,3) .ne. indexList(i)*10*3) then print *, de_id, "ERROR humd ", indexList(i), " val(1,i,3) =", fptr(1,i,3) rc = ESMF_FAILURE endif if(fptr(1,i,4) .ne. indexList(i)*10*4) then print *, de_id, "ERROR humd ", indexList(i), " val(1,i,4) =", fptr(1,i,4) rc = ESMF_FAILURE endif enddo nullify(fptr) call ESMF_FieldBundleGet(fieldbundle, fieldName="pressure", & field=field, rc=rc) if (rc/=ESMF_SUCCESS) return call ESMF_FieldGet(field, localDe=0, farrayPtr=fptr, & exclusiveLBound=exlb, exclusiveUBound=exub, rc=rc) if(rc/=ESMF_SUCCESS) return do i = exlb(2), exub(2) if(fptr(1,i,1) .ne. indexList(i)*100*1) then print *, de_id, "ERROR pres ", indexList(i), " val(1,i,1) =", fptr(1,i,1) rc = ESMF_FAILURE endif if(fptr(1,i,2) .ne. indexList(i)*100*2) then print *, de_id, "ERROR pres ", indexList(i), " val(1,i,2) =", fptr(1,i,2) rc = ESMF_FAILURE endif if(fptr(1,i,3) .ne. indexList(i)*100*3) then print *, de_id, "ERROR pres ", indexList(i), " val(1,i,3) =", fptr(1,i,3) rc = ESMF_FAILURE endif if(fptr(1,i,4) .ne. indexList(i)*100*4) then print *, de_id, "ERROR pres ", indexList(i), " val(1,i,4) =", fptr(1,i,4) rc = ESMF_FAILURE endif if(fptr(2,i,1) .ne. 100*1) then print *, de_id, "ERROR pres ", indexList(i), " val(2,i,1) =", fptr(2,i,1) rc = ESMF_FAILURE endif if(fptr(2,i,2) .ne. 100*2) then print *, de_id, "ERROR pres ", indexList(i), " val(2,i,2) =", fptr(2,i,2) rc = ESMF_FAILURE endif if(fptr(2,i,3) .ne. 100*3) then print *, de_id, "ERROR pres ", indexList(i), " val(2,i,3) =", fptr(2,i,3) rc = ESMF_FAILURE endif if(fptr(2,i,4) .ne. 100*4) then print *, de_id, "ERROR pres ", indexList(i), " val(2,i,4) =", fptr(2,i,4) rc = ESMF_FAILURE endif enddo deallocate(indexList) print *, de_id, "User Comp2 Run returning" end subroutine user_run !-------------------------------------------------------------------------------- ! ! The Finalization routine where things are deleted and cleaned up. ! ! subroutine user_final(comp, importState, exportState, clock, rc) type(ESMF_GridComp) :: comp type(ESMF_State) :: importState, exportState type(ESMF_Clock) :: clock integer, intent(out) :: rc ! Local variables type(ESMF_VM) :: vm integer :: de_id type(ESMF_Field) :: field type(ESMF_FieldBundle) :: fieldbundle type(ESMF_LocStream) :: locs integer :: k ! Initialize return code rc = ESMF_SUCCESS call ESMF_GridCompGet(comp, vm=vm, rc=rc) if(rc/=ESMF_SUCCESS) return call ESMF_VMGet(vm, localPet=de_id, rc=rc) if(rc/=ESMF_SUCCESS) return print *, de_id, "User Comp2 Final starting" call ESMF_StateGet(importState, "fieldbundle data", fieldbundle, rc=rc) if (rc/=ESMF_SUCCESS) return call ESMF_FieldBundleGet(fieldbundle, locstream=locs, rc=rc) if (rc/=ESMF_SUCCESS) return do k = 1, 3 call ESMF_FieldBundleGet(fieldbundle, fieldIndex=k, field=field, rc=rc) if (rc/=ESMF_SUCCESS) return call ESMF_FieldDestroy(field, rc=rc) if (rc/=ESMF_SUCCESS) return enddo call ESMF_FieldBundleDestroy(fieldbundle, rc=rc) if (rc/=ESMF_SUCCESS) return call ESMF_LocStreamDestroy(locs, rc=rc) if(rc/=ESMF_SUCCESS) return deallocate(tmp_data) deallocate(hum_data) deallocate(prs_data) print *, de_id, "User Comp2 Final returning" end subroutine user_final end module user_model2 !\end{verbatim}