Back to home page

MITgcm

 
 

    


File indexing completed on 2026-10-08 05:08:24 UTC

view on githubraw file Latest commit 27256b2d on 2026-10-07 21:35:21 UTC
52dd931a85 Timo*0001 #include "AUTODIFF_OPTIONS.h"
                0002 #ifdef ALLOW_CTRL
                0003 # include "CTRL_OPTIONS.h"
                0004 #endif
                0005 #include "AD_CONFIG.h"
                0006 
                0007 CBOP
                0008 C     !ROUTINE: ADDUMMY_FOR_ETAN
                0009 C     !INTERFACE:
                0010       SUBROUTINE ADDUMMY_FOR_ETAN( myTime, myIter, myThid )
                0011 
                0012 C     !DESCRIPTION: \bv
                0013 C     *==========================================================*
a10c595eb6 Timo*0014 C     | SUBROUTINE ADDUMMY_FOR_ETAN                              |
52dd931a85 Timo*0015 C     *==========================================================*
                0016 C     Extract adjoint variable for sea level height
b7b61e618a Mart*0017 C     from TAF-generated
52dd931a85 Timo*0018 C     adjoint common blocks, contained in adcommon.h
                0019 C     and write fields to file;
                0020 C     Make sure common blocks in adcommon.h are up-to-date
                0021 C     w.r.t. current adjoint code.
                0022 C
                0023 C     This dummy routine is located inside integr_continuity
                0024 C     to get the impact of rstar or surf_dr adjoint
                0025 C     variables on adEtaN.
                0026 C
                0027 C     This does not use the diagnostics package because adEtaN is a
                0028 C     "half" time step away from the other adjoint variables, but would
                0029 C     have to be written at the same time.
                0030 C
                0031 C     Created: Tim Smith, tsmith@ices.utexas.edu, Sept 12 2018
                0032 C     *==========================================================*
a10c595eb6 Timo*0033 C     | SUBROUTINE ADDUMMY_FOR_ETAN                              |
52dd931a85 Timo*0034 C     *==========================================================*
                0035 C     \ev
                0036 
                0037 C     !USES:
                0038       IMPLICIT NONE
                0039 
                0040 C     == Global variables ===
                0041 #include "SIZE.h"
                0042 #include "EEPARAMS.h"
                0043 #include "PARAMS.h"
                0044 #ifdef ALLOW_AUTODIFF_MONITOR
a10c595eb6 Timo*0045 # include "AUTODIFF_PARAMS.h"
52dd931a85 Timo*0046 # include "AUTODIFF.h"
27256b2d6a Jean*0047 # include "adcommon.h"
52dd931a85 Timo*0048 # ifdef ALLOW_MNC
                0049 #  include "MNC_PARAMS.h"
                0050 # endif
                0051 #endif /* ALLOW_AUTODIFF_MONITOR */
                0052 
                0053 C     !INPUT/OUTPUT PARAMETERS:
                0054 C     myTime  :: time counter for this thread
                0055 C     myIter  :: iteration counter for this thread
                0056 C     myThid  :: Thread number for this instance of the routine.
                0057       _RL myTime
                0058       INTEGER myIter
                0059       INTEGER myThid
                0060 
                0061 #ifdef ALLOW_AUTODIFF_MONITOR
27256b2d6a Jean*0062 #if (defined (ALLOW_ADJOINT_RUN) || defined (ALLOW_ADMTLM))
52dd931a85 Timo*0063 
                0064 C     !FUNCTIONS:
                0065       LOGICAL  DIFFERENT_MULTIPLE
                0066       EXTERNAL DIFFERENT_MULTIPLE
                0067 
                0068 C     !LOCAL VARIABLES:
                0069 C     suff    :: Hold suffix part of a filename
                0070 C     msgBuf  :: Error message buffer
a10c595eb6 Timo*0071 c     CHARACTER*(10) suff
                0072 c     CHARACTER*(MAX_LEN_MBUF) msgBuf
                0073       _RS dumRS(1)
                0074       LOGICAL doDump
52dd931a85 Timo*0075 CEOP
                0076 
a10c595eb6 Timo*0077       doDump = DIFFERENT_MULTIPLE(adjDumpFreq,myTime,deltaTClock)
52dd931a85 Timo*0078 
a10c595eb6 Timo*0079       IF ( doDump ) THEN
                0080 C increment ad dump record number (used only if dumpAdByRec is true)
                0081 C could be just dumpAdRecEt=dumpAdRecMn+1 ????
                0082        dumpAdRecEt = dumpAdRecEt + 1
                0083        CALL TIMER_START('I/O (WRITE)        [ADJOINT LOOP]', myThid )
                0084       ENDIF
52dd931a85 Timo*0085 
a10c595eb6 Timo*0086       CALL DUMP_ADJ_XY(dumRS, adetan, 'ADJetan ', 'ADJetan.',
                0087      &                 12, doDump, dumpAdRecEt, myTime, myIter,myThid)
52dd931a85 Timo*0088 
a10c595eb6 Timo*0089       IF ( doDump ) THEN
52dd931a85 Timo*0090 
a10c595eb6 Timo*0091 C-- NOW NMC output
52dd931a85 Timo*0092 #ifdef ALLOW_MNC
                0093         IF ( useMNC .AND. autodiff_mnc ) THEN
                0094          CALL MNC_CW_SET_UDIM('adstate', -1, myThid)
                0095          CALL MNC_CW_RL_W_S('D','adstate',0,0,'T',myTime,myThid)
                0096          CALL MNC_CW_SET_UDIM('adstate', 0, myThid)
                0097          CALL MNC_CW_I_W_S('I','adstate',0,0,'iter',myIter,myThid)
                0098          CALL MNC_CW_RL_W_S('D','adstate',0,0,'model_time',myTime,
                0099      &        myThid)
                0100          CALL MNC_CW_RL_W('D','adstate',0,0,'adEta', adEtaN, myThid)
                0101 C     endif mnc
                0102         ENDIF
                0103 #endif /* ALLOW_MNC */
                0104 
                0105         CALL TIMER_STOP( 'I/O (WRITE)        [ADJOINT LOOP]', myThid )
                0106 
                0107       ENDIF
                0108 
27256b2d6a Jean*0109 #endif /* ALLOW_ADJOINT_RUN or ALLOW_ADMTLM */
52dd931a85 Timo*0110 #endif /* ALLOW_AUTODIFF_MONITOR */
                0111 
                0112       RETURN
                0113       END