C $Header: /u/gcmpack/MITgcm/pkg/cheapaml/cheapaml_read_pickup.F,v 1.6 2017/03/24 23:34:13 jmc Exp $
C $Name: $
#include "CHEAPAML_OPTIONS.h"
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C !ROUTINE: CHEAPAML_READ_PICKUP
C !INTERFACE:
SUBROUTINE CHEAPAML_READ_PICKUP( myIter, myThid )
C !DESCRIPTION:
C Reads current state of CHEAPAML from a pickup file
C !USES:
IMPLICIT NONE
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "CHEAPAML.h"
C !INPUT PARAMETERS:
C myIter :: time-step number
C myThid :: thread number
INTEGER myIter
INTEGER myThid
#ifdef ALLOW_CHEAPAML
C !LOCAL VARIABLES:
C fn :: character buffer for creating filename
C fp :: precision of pickup files
C filePrec :: pickup-file precision (read from meta file)
C nbFields :: number of fields in pickup file (read from meta file)
C missFldList :: List of missing fields (attempted to read but not found)
C missFldDim :: Dimension of missing fields list array: missFldList
C nMissing :: Number of missing fields (attempted to read but not found)
C j :: loop index
C nj :: record number
C ioUnit :: temp for writing msg unit
C msgBuf :: Informational/error message buffer
LOGICAL stopFlag
INTEGER fp
INTEGER filePrec, nbFields
INTEGER missFldDim, nMissing, warnCnts
INTEGER j, nj, ioUnit
PARAMETER( missFldDim = 12 )
CHARACTER*(10) suff
CHARACTER*(MAX_LEN_FNAM) fn
CHARACTER*(8) missFldList(missFldDim)
CHARACTER*(MAX_LEN_MBUF) msgBuf
CEOP
_BARRIER
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
IF ( pickupSuff.EQ.' ' ) THEN
IF ( rwSuffixType.EQ.0 ) THEN
WRITE(fn,'(A,I10.10)') 'pickup_cheapaml.', myIter
ELSE
CALL RW_GET_SUFFIX( suff, startTime, myIter, myThid )
WRITE(fn,'(A,A)') 'pickup_cheapaml.', myIter
ENDIF
ELSE
WRITE(fn,'(A,A10)') 'pickup_cheapaml.', pickupSuff
ENDIF
fp = precFloat64
CALL READ_MFLDS_SET(
I fn,
O nbFields, filePrec,
I Nr, myIter, myThid )
_BEGIN_MASTER( myThid )
c IF ( filePrec.NE.0 .AND. filePrec.NE.fp ) THEN
IF ( nbFields.GE.0 .AND. filePrec.NE.fp ) THEN
WRITE(msgBuf,'(2A,I4)') 'CHEAPAML_READ_PICKUP: ',
& 'pickup-file binary precision do not match !'
CALL PRINT_ERROR( msgBuf, myThid )
WRITE(msgBuf,'(A,2(A,I4))') 'CHEAPAML_READ_PICKUP: ',
& 'file prec.=', filePrec, ' but expecting prec.=', fp
CALL PRINT_ERROR( msgBuf, myThid )
STOP 'ABNORMAL END: S/R CHEAPAML_READ_PICKUP (data-prec Pb)'
ENDIF
_END_MASTER( myThid )
IF ( nbFields.LE.0 ) THEN
C- No meta-file or old meta-file without List of Fields
ioUnit = errorMessageUnit
IF ( pickupStrictlyMatch ) THEN
WRITE(msgBuf,'(4A)') 'CHEAPAML_READ_PICKUP: ',
& 'no field-list found in meta-file',
& ' => cannot check for strick-matching'
CALL PRINT_ERROR( msgBuf, myThid )
WRITE(msgBuf,'(4A)') 'CHEAPAML_READ_PICKUP: ',
& 'try with " pickupStrictlyMatch=.FALSE.,"',
& ' in file: "data", NameList: "PARM03"'
CALL PRINT_MESSAGE( msgBuf, ioUnit, SQUEEZE_RIGHT, myThid )
STOP 'ABNORMAL END: S/R CHEAPAML_READ_PICKUP'
ELSE
WRITE(msgBuf,'(4A)') 'WARNING >> CHEAPAML_READ_PICKUP: ',
& ' no field-list found'
CALL PRINT_MESSAGE( msgBuf, ioUnit, SQUEEZE_RIGHT, myThid )
IF ( nbFields.EQ.-1 ) THEN
C- No meta-file
WRITE(msgBuf,'(4A)') 'WARNING >> ',
& ' try to read pickup as currently written'
CALL PRINT_MESSAGE( msgBuf, ioUnit, SQUEEZE_RIGHT, myThid )
ELSE
C- Old meta-file without List of Fields
c WRITE(msgBuf,'(4A)') 'WARNING >> ',
c & ' try to read pickup as it used to be written'
c CALL PRINT_MESSAGE( msgBuf, ioUnit, SQUEEZE_RIGHT, myThid )
c WRITE(msgBuf,'(4A)') 'WARNING >> ',
c & ' until checkpoint59l (2007 Dec 17)'
c CALL PRINT_MESSAGE( msgBuf, ioUnit, SQUEEZE_RIGHT, myThid )
WRITE(msgBuf,'(4A)') 'CHEAPAML_READ_PICKUP: ',
& 'no field-list found in meta-file'
CALL PRINT_ERROR( msgBuf, myThid )
STOP 'ABNORMAL END: S/R CHEAPAML_READ_PICKUP'
ENDIF
ENDIF
ENDIF
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
IF ( nbFields.EQ.0 ) THEN
C--- Old way to read pickup:
ELSE
C--- New way to read CHEAPAML pickup:
nj = 0
nj = nj*Nr
C--- read CHEAPAML 2-D fields for restart
CALL READ_MFLDS_3D_RL( 'Tair ', Tair,
& nj, fp, 1 , myIter, myThid )
CALL READ_MFLDS_3D_RL( 'gTairNm1', gTairm,
& nj, fp, 1 , myIter, myThid )
IF(useFreshWaterFlux)THEN
CALL READ_MFLDS_3D_RL( 'Qair ', qair,
& nj, fp, 1 , myIter, myThid )
CALL READ_MFLDS_3D_RL( 'gQairNm1', gqairm,
& nj, fp, 1 , myIter, myThid )
ENDIF
IF(useCheaptracer)THEN
CALL READ_MFLDS_3D_RL( 'cTracer ', Cheaptracer,
& nj, fp, 1 ,myIter, myThid )
CALL READ_MFLDS_3D_RL( 'gTracNm1', Cheaptracer,
& nj, fp, 1 ,myIter, myThid )
ENDIF
C-- end: new way to read pickup file
ENDIF
C-- Check for missing fields:
nMissing = missFldDim
CALL READ_MFLDS_CHECK(
O missFldList,
U nMissing,
I myIter, myThid )
IF ( nMissing.GT.missFldDim ) THEN
WRITE(msgBuf,'(2A,I4)') 'CHEAPAML_READ_PICKUP: ',
& 'missing fields list has been truncated to', missFldDim
CALL PRINT_ERROR( msgBuf, myThid )
STOP 'ABNORMAL END: S/R CHEAPAML_READ_PICKUP (list-size Pb)'
ENDIF
IF ( nMissing.GE.1 ) THEN
_BEGIN_MASTER( myThid )
ioUnit = errorMessageUnit
stopFlag = .FALSE.
warnCnts = nMissing
DO j=1,nMissing
IF ( missFldList(j).EQ.'gTairNm1' ) THEN
cheapTairStartAB = 0
ELSEIF ( missFldList(j).EQ.'gQairNm1' ) THEN
cheapQairStartAB = 0
ELSEIF ( missFldList(j).EQ.'gTracNm1' ) THEN
cheapTracStartAB = 0
ELSE
stopFlag = .TRUE.
WRITE(msgBuf,'(4A)') 'CHEAPAML_READ_PICKUP: ',
& 'cannot restart without field "',missFldList(nj),'"'
CALL PRINT_ERROR( msgBuf, myThid )
ENDIF
ENDDO
IF ( stopFlag ) THEN
STOP 'ABNORMAL END: S/R CHEAPAML_READ_PICKUP'
ELSEIF ( pickupStrictlyMatch ) THEN
WRITE(msgBuf,'(4A)') 'CHEAPAML_READ_PICKUP: ',
& 'try with " pickupStrictlyMatch=.FALSE.,"',
& ' in file: "data", NameList: "PARM03"'
CALL PRINT_ERROR( msgBuf, myThid )
STOP 'ABNORMAL END: S/R CHEAPAML_READ_PICKUP'
ELSEIF ( warnCnts .GT. 0 ) THEN
WRITE(msgBuf,'(4A)') '** WARNING ** CHEAPAML_READ_PICKUP: ',
& 'Will get only an approximated Restart'
CALL PRINT_MESSAGE( msgBuf, ioUnit, SQUEEZE_RIGHT, myThid )
ENDIF
_END_MASTER( myThid )
ENDIF
C-- Update overlap regions:
CALL EXCH_XY_RL( Tair, myThid )
CALL EXCH_XY_RL( qair, myThid )
CALL EXCH_XY_RL( Cheaptracer, myThid )
#endif /* ALLOW_CHEAPAML */
RETURN
END