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