ESMF_FieldSerialize Subroutine

public subroutine ESMF_FieldSerialize(field, buffer, length, offset, attreconflag, inquireflag, rc)

Arguments

Type IntentOptional Attributes Name
type(ESMF_Field), intent(inout) :: field
character(len=1), pointer, dimension(:) :: buffer
integer, intent(inout) :: length
integer, intent(inout) :: offset
type(ESMF_AttReconcileFlag), intent(in), optional :: attreconflag
type(ESMF_InquireFlag), intent(in), optional :: inquireflag
integer, intent(out), optional :: rc

Calls

proc~~esmf_fieldserialize~~CallsGraph proc~esmf_fieldserialize ESMF_FieldSerialize c_esmc_arrayserialize c_esmc_arrayserialize proc~esmf_fieldserialize->c_esmc_arrayserialize c_esmc_fieldserialize c_esmc_fieldserialize proc~esmf_fieldserialize->c_esmc_fieldserialize proc~esmf_baseserialize ESMF_BaseSerialize proc~esmf_fieldserialize->proc~esmf_baseserialize proc~esmf_fieldgetinit ESMF_FieldGetInit proc~esmf_fieldserialize->proc~esmf_fieldgetinit proc~esmf_fieldgetserializeflag ESMF_FieldGetSerializeFlag proc~esmf_fieldserialize->proc~esmf_fieldgetserializeflag proc~esmf_geomserialize ESMF_GeomSerialize proc~esmf_fieldserialize->proc~esmf_geomserialize proc~esmf_imerr ESMF_IMErr proc~esmf_fieldserialize->proc~esmf_imerr proc~esmf_logfounderror ESMF_LogFoundError proc~esmf_fieldserialize->proc~esmf_logfounderror proc~esmf_baseserialize->proc~esmf_logfounderror c_esmc_baseserialize c_esmc_baseserialize proc~esmf_baseserialize->c_esmc_baseserialize proc~esmf_fieldgetserializeflag->proc~esmf_logfounderror interface~esmf_infoget ESMF_InfoGet proc~esmf_fieldgetserializeflag->interface~esmf_infoget proc~esmf_infogetfrombase ESMF_InfoGetFromBase proc~esmf_fieldgetserializeflag->proc~esmf_infogetfrombase proc~esmf_infoispresent ESMF_InfoIsPresent proc~esmf_fieldgetserializeflag->proc~esmf_infoispresent proc~esmf_geomserialize->proc~esmf_imerr proc~esmf_geomserialize->proc~esmf_logfounderror c_esmc_geomserialize c_esmc_geomserialize proc~esmf_geomserialize->c_esmc_geomserialize proc~esmf_geomgetinit ESMF_GeomGetInit proc~esmf_geomserialize->proc~esmf_geomgetinit proc~esmf_gridserialize ESMF_GridSerialize proc~esmf_geomserialize->proc~esmf_gridserialize proc~esmf_locstreamserialize ESMF_LocStreamSerialize proc~esmf_geomserialize->proc~esmf_locstreamserialize proc~esmf_meshserialize ESMF_MeshSerialize proc~esmf_geomserialize->proc~esmf_meshserialize proc~esmf_xgridserialize ESMF_XGridSerialize proc~esmf_geomserialize->proc~esmf_xgridserialize 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

Called by

proc~~esmf_fieldserialize~~CalledByGraph proc~esmf_fieldserialize ESMF_FieldSerialize proc~esmf_reconcileserialize ESMF_ReconcileSerialize proc~esmf_reconcileserialize->proc~esmf_fieldserialize proc~esmf_reconcileserializeall ESMF_ReconcileSerializeAll proc~esmf_reconcileserializeall->proc~esmf_fieldserialize proc~test7d4_generic test7d4_generic proc~test7d4_generic->proc~esmf_fieldserialize proc~esmf_reconcilebruteforce ESMF_ReconcileBruteForce proc~esmf_reconcilebruteforce->proc~esmf_reconcileserialize proc~esmf_reconcilesinglecompcase ESMF_ReconcileSingleCompCase proc~esmf_reconcilesinglecompcase->proc~esmf_reconcileserializeall proc~esmf_reconcilemulticompcase ESMF_ReconcileMultiCompCase proc~esmf_reconcilemulticompcase->proc~esmf_reconcilesinglecompcase proc~esmf_statereconcile_driver ESMF_StateReconcile_driver proc~esmf_statereconcile_driver->proc~esmf_reconcilemulticompcase

Source Code

      subroutine ESMF_FieldSerialize(field, buffer, length, offset, &
                                    attreconflag, inquireflag, rc) 
!
! !ARGUMENTS:
      type(ESMF_Field), intent(inout) :: field 
      character, pointer, dimension(:) :: buffer
      integer, intent(inout) :: length
      integer, intent(inout) :: offset
      type(ESMF_AttReconcileFlag), intent(in), optional :: attreconflag
      type(ESMF_InquireFlag), intent(in), optional :: inquireflag
      integer, intent(out), optional :: rc 
!
! !DESCRIPTION:
!      Takes an {\tt ESMF\_Field} object and adds all the information needed
!      to save the information to a file or recreate the object based on this
!      information.   Expected to be used by {\tt ESMF\_StateReconcile()}.
!
!     The arguments are:
!     \begin{description}
!     \item [field]
!           {\tt ESMF\_Field} object to be serialized.
!     \item [buffer]
!           Data buffer which will hold the serialized information.
!     \item [length]
!           Current length of buffer, in bytes.  If the serialization
!           process needs more space it will allocate it and update
!           this length.
!     \item [offset]
!           Current write offset in the current buffer.  This will be
!           updated by this routine and return pointing to the next
!           available byte in the buffer.
!     \item[{[attreconflag]}]
!           Flag to tell if Attribute serialization is to be done
!     \item[{[inquireflag]}]
!           Flag to tell if serialization is to be done (ESMF_NOINQUIRE)
!           or if this is simply a size inquiry (ESMF_INQUIREONLY)
!     \item [{[rc]}]
!           Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
!     \end{description}
!
!EOPI

      integer :: localrc
      type(ESMF_FieldType), pointer :: fp    ! field type
      type(ESMF_AttReconcileFlag) :: lattreconflag
      type(ESMF_InquireFlag) :: linquireflag

      type(ESMF_Info) :: infoh
      logical :: should_serialize_geom, skipGeomObj

      ! Initialize
      localrc = ESMF_RC_NOT_IMPL
      if (present(rc)) rc = ESMF_RC_NOT_IMPL

      ! check variables
      ESMF_INIT_CHECK_DEEP(ESMF_FieldGetInit,field,rc)

      ! deal with optional attreconflag and inquireflag
      if (present(attreconflag)) then
        lattreconflag = attreconflag
      else
        lattreconflag = ESMF_ATTRECONCILE_OFF
      endif

      if (present (inquireflag)) then
        linquireflag = inquireflag
      else
        linquireflag = ESMF_NOINQUIRE
      end if

      ! shortcut to internals
      fp => field%ftypep

      call ESMF_BaseSerialize(fp%base, buffer, offset, &
                                 lattreconflag, linquireflag, rc=localrc)
      if (ESMF_LogFoundError(localrc, &
                                 ESMF_ERR_PASSTHRU, &
                                 ESMF_CONTEXT, rcToReturn=rc)) return

      call c_ESMC_FieldSerialize(fp%status, &
                                 fp%iostatus, & 
                                 fp%dimCount, fp%gridToFieldMap, &
                                 fp%ungriddedLBound, fp%ungriddedUBound, &
                                 fp%totalLWidth, fp%totalUWidth, &
                                 buffer, length, offset, linquireflag, localrc)
      if (ESMF_LogFoundError(localrc, &
                                 ESMF_ERR_PASSTHRU, &
                                 ESMF_CONTEXT, rcToReturn=rc)) return

      if (fp%status .eq. ESMF_FIELDSTATUS_GRIDSET .or. &
          fp%status .eq. ESMF_FIELDSTATUS_COMPLETE) then

        call ESMF_FieldGetSerializeFlag(fp, should_serialize_geom, localrc)
        if (ESMF_LogFoundError(localrc, ESMF_ERR_PASSTHRU, ESMF_CONTEXT, rcToReturn=rc)) return

        if (should_serialize_geom) then
          skipGeomObj = .false.
        else
          skipGeomObj = .true.
        end if

        call ESMF_GeomSerialize(fp%geom, buffer, length, offset, &
                                    lattreconflag, linquireflag, skipGeomObj, &
                                    localrc)
        if (ESMF_LogFoundError(localrc, &
                               ESMF_ERR_PASSTHRU, &
                               ESMF_CONTEXT, rcToReturn=rc)) return
      endif

      if (fp%status .eq. ESMF_FIELDSTATUS_COMPLETE) then
          call c_ESMC_ArraySerialize(fp%array, buffer, length, offset, &
                                     lattreconflag, linquireflag, localrc)
          if (ESMF_LogFoundError(localrc, &
                                     ESMF_ERR_PASSTHRU, &
                                     ESMF_CONTEXT, rcToReturn=rc)) return
      endif

      if  (present(rc)) rc = ESMF_SUCCESS

      end subroutine ESMF_FieldSerialize