ad_initial.F

Go to the documentation of this file.

#include "cppdefs.h"
#ifdef ADJOINT
      SUBROUTINE ad_initial (ng)
!
!git $Id$
!================================================== Hernan G. Arango ===
!  Copyright (c) 2002-2025 The ROMS Group                              !
!    Licensed under a MIT/X style license                              !
!    See License_ROMS.md                                               !
!=======================================================================
!                                                                      !
!  This routine initializes all adjoint model variables.               !
!                                                                      !
!=======================================================================
!
      USE mod_param
      USE mod_parallel
# ifdef BBL_MODEL_NOT_YET
      USE mod_bbl
# endif
# ifdef ADJUST_BOUNDARY
      USE mod_boundary
# endif
# ifdef SOLVE3D
      USE mod_coupling
# endif
      USE mod_forces
# ifdef FOUR_DVAR
      USE mod_fourdvar
# endif
      USE mod_grid
      USE mod_iounits
# ifdef SOLVE3D
      USE mod_mixing
# endif
      USE mod_ncparam
      USE mod_ocean
      USE mod_scalars
      USE mod_stepping
!
      USE analytical_mod
# if defined AD_SENSITIVITY   || defined I4DVAR_ANA_SENSITIVITY || \
     defined opt_observations || defined sensitivity_4dvar      || \
     defined so_semi
      USE adsen_initial_mod, ONLY : adsen_initial
# endif
# if defined STEP2D_FB_AB3_AM4 || defined STEP2D_FB_LF_AM3
!!    USE ad_load_sol_mod,   ONLY : ad_load_sol
# endif
      USE close_io_mod,      ONLY : close_inp
      USE dateclock_mod,     ONLY : time_string
# ifdef DISTRIBUTE
      USE distribute_mod,    ONLY : mp_bcasti
# endif
# ifdef WET_DRY
      USE get_wetdry_mod,    ONLY : get_wetdry
# endif
      USE get_state_mod,     ONLY : get_state
# if defined SOLVE3D && defined NONLINEAR
      USE ini_fields_mod,    ONLY : set_zeta_timeavg
# endif
      USE ini_hmixcoef_mod,  ONLY : ini_hmixcoef
# if defined WAV_COUPLING_NOT_YET && defined MCT_LIB
      USE mct_coupler_mod,   ONLY : ocn2wav_coupling
# endif
# ifdef SOLVE3D
      USE set_depth_mod,     ONLY : set_depth
      USE omega_mod,         ONLY : omega
      USE rho_eos_mod,       ONLY : rho_eos
      USE set_massflux_mod,  ONLY : set_massflux
# endif
# ifdef OBSERVATIONS
      USE obs_initial_mod,   ONLY : obs_initial
# endif
# ifdef MASKING
      USE set_masks_mod,     ONLY : set_masks
# endif
      USE stiffness_mod,     ONLY : stiffness
      USE strings_mod,       ONLY : founderror
# ifdef WET_DRY
      USE wetdry_mod,        ONLY : wetdry
# endif
# if defined PROPAGATOR || \
    (defined masking    && (defined read_water || defined write_water))
      USE wpoints_mod,       ONLY : wpoints
# endif
!
      implicit none
!
!  Imported variable declarations.
!
      integer, intent(in) :: ng
!
!  Local variable declarations.
!
      logical :: update = .false.
!
      integer :: Fcount, IniRec, Tindex
      integer :: thread, tile
!
      real(dp) :: my_dstart
!
      character (len=*), parameter :: MyFile =                          &
     &  __FILE__
!
!=======================================================================
!   Initialize model variables.
!=======================================================================
!
      IF (master) THEN
# if defined PERTURBATION
        WRITE (stdout,10) nrun
 10     FORMAT (/,' <<<< Ensemble/Perturbation Run: ',i5.5,' >>>>',/)
# elif defined I4DVAR   || defined SENSITIVITY_4DVAR || \
       defined rbl4dvar || defined r4dvar
        WRITE (stdout,10) outer, inner
 10     FORMAT (/,' <<<< 4D Variational Data Assimilation, ',           &
     &          'Outer = ',i3.3, ', Inner = ',i3.3,' >>>>',/)
# endif
        WRITE (stdout,20) 'AD_INITIAL: Configuring and ',               &
     &                    'initializing adjoint model ...'
 20     FORMAT (/,1x,a,a,/)
      END IF
!
!-----------------------------------------------------------------------
!  Initialize time stepping indices and counters.
!-----------------------------------------------------------------------
!
      iif(ng)=1
      indx1(ng)=1
      next_kstp(ng)=1
# if defined STEP2D_FB_AB3_AM4 || defined STEP2D_FB_LF_AM3
      kstp(ng)=1
      knew(ng)=1
# else
      kstp(ng)=1
      krhs(ng)=3
      knew(ng)=2
# endif
      predictor_2d_step(ng)=.false.
!
      iic(ng)=0
# ifdef SOLVE3D
      nstp(ng)=1
      nnew(ng)=2
      nrhs(ng)=nstp(ng)
# endif
# ifdef FLOATS_NOT_YET
      nf(ng)=0
      nfp1(ng)=1
      nfm1(ng)=4
      nfm2(ng)=3
      nfm3(ng)=2
# endif
!
      synchro_flag(ng)=.true.
      first_time(ng)=0
      ad_ubar_xs=0.0_r8
 
# ifdef GENERIC_DSTART
!
!  Rarely, the adjoint model is initialized from a NetCDF file, so we do
!  not know its actual initialization time. Usually, it is computed from
!  DSTART, implying that its value is correct in the ROMS input script.
!  Therefore, the user needs to check and update its value to every time
!  that ROMS is executed. Alternatively, if available, we can use the
!  initialization time from the nonlinear model, INItime. This variable
!  is assigned when computing or processing the basic state trajectory
!  needed to linearize the adjoint model.
!
      IF (initime(ng).lt.0.0_dp) THEN
        my_dstart=dstart                    ! ROMS input script
      ELSE
        my_dstart=initime(ng)/86400.0_dp    ! NLM IC time is known
      END IF
      tdays(ng)=my_dstart+dt(ng)*real(ntimes(ng),r8)*sec2day
      time(ng)=tdays(ng)*day2sec
      ntstart(ng)=int((time(ng)-dstart*day2sec)/dt(ng))+1
      ntend(ng)=ntstart(ng)-ntimes(ng)
      ntfirst(ng)=ntend(ng)
#else
      tdays(ng)=dstart+dt(ng)*real(ntimes(ng)-ntfirst(ng)+1,r8)*sec2day
      time(ng)=tdays(ng)*day2sec
      ntstart(ng)=ntimes(ng)+1
      ntend(ng)=ntfirst(ng)
      ntfirst(ng)=ntend(ng)
#endif
      step_counter(ng)=0
!
      inirec=nrrec(ng)
      tindex=1
!
!  Initialize global diagnostics variables.
!
      avgke=0.0_dp
      avgpe=0.0_dp
      avgkp=0.0_dp
      volume=0.0_dp
 
# ifdef PROFILE
!
!-----------------------------------------------------------------------
!  Start time wall clocks.
!-----------------------------------------------------------------------
!
      DO thread=thread_range
        CALL wclock_on (ng, iadm, 2, __line__, myfile)
      END DO
# endif
 
# if defined FOUR_DVAR               && \
    !(defined I4DVAR_ANA_SENSITIVITY || defined OPT_OBSERVATIONS)
!
!-----------------------------------------------------------------------
!  If variational data assimilation, reset several IO switches and
!  variables.
!-----------------------------------------------------------------------
!
!  Set switch to create adjoint NetCDF file or append to an existing
!  adjoint NetCDF file.
!
      IF (nrun.eq.erstr) THEN
        ldefadj(ng)=.true.
      END IF
!
!  Activate switch to write adjoint NetCDF file.
!
      lwrtadj(ng)=.true.
 
#  ifdef ADJUST_BOUNDARY
!
!  Initialize open boundary counter for storage arrays.
!
      obccount(ng)=0
#  endif
#  if defined ADJUST_STFLUX || defined ADJUST_WSTRESS
!
!  Initialize surface forcing counter for storage arrays.
!
      sfcount(ng)=nfrec(ng)+1
#  endif
# endif
!
!-----------------------------------------------------------------------
!  Set application grid, metrics, and associated variables and
!  parameters.
!-----------------------------------------------------------------------
!
      IF (setgridconfig(ng)) THEN
        CALL set_grid (ng, itlm)
        setgridconfig(ng)=.false.
      END IF
!
!-----------------------------------------------------------------------
!  Initialize horizontal mixing coefficients. If applicable, scale
!  mixing coefficients according to the grid size (smallest area).
# ifndef ANA_SPONGE
!  Also increase their values in sponge areas using the "visc_factor"
!  and/or "diff_factor" read from input Grid NetCDF file.
# endif
!-----------------------------------------------------------------------
!
      DO tile=first_tile(ng),last_tile(ng),+1
        CALL ini_hmixcoef (ng, tile, iadm)
      END DO
 
# ifdef ANA_SPONGE
!
!-----------------------------------------------------------------------
!  Increase horizontal mixing coefficients in sponge areas using
!  analytical functions.
!-----------------------------------------------------------------------
!
      IF (lsponge(ng)) THEN
        DO tile=first_tile(ng),last_tile(ng),+1
          CALL ana_sponge (ng, tile, iadm)
        END DO
      END IF
# endif
!
!=======================================================================
!  Initialize model state variables and forcing.  This part is
!  executed for each ensemble/perturbation/iteration pass.
!=======================================================================
 
# if defined AD_SENSITIVITY   || defined I4DVAR_ANA_SENSITIVITY || \
     defined opt_observations || defined so_semi
!
!-----------------------------------------------------------------------
!  Clear all adjoint and nonlinear variables.
!-----------------------------------------------------------------------
!
      DO tile=first_tile(ng),last_tile(ng),+1
        CALL initialize_ocean (ng, tile, inlm)
        CALL initialize_ocean (ng, tile, iadm)
#  if defined SOLVE3D
        CALL initialize_coupling (ng, tile, iadm)
        CALL initialize_mixing (ng, tile, iadm)
#  endif
        CALL initialize_forces (ng, tile, iadm)
        CALL initialize_grid (ng, tile, iadm)
#  ifdef ADJUST_BOUNDARY
        CALL initialize_boundary (ng, tile, iadm)
#  endif
      END DO
 
# elif defined FOUR_DVAR && !defined I4DVAR_ANA_SENSITIVITY
!
!-----------------------------------------------------------------------
!  Clear all adjoint variables.  In variational data assimilation the
!  initial condition are always zero and the forcing is only via the
!  (model-observations) misfit terms.
!-----------------------------------------------------------------------
!
      DO tile=first_tile(ng),last_tile(ng),+1
        CALL initialize_ocean (ng, tile, inlm)
        CALL initialize_forces (ng, tile, inlm)
        CALL initialize_ocean (ng, tile, iadm)
#  if defined SOLVE3D
        CALL initialize_coupling (ng, tile, iadm)
        CALL initialize_mixing (ng, tile, iadm)
#  endif
        CALL initialize_forces (ng, tile, iadm)
        CALL initialize_grid (ng, tile, iadm)
#  ifdef ADJUST_BOUNDARY
        CALL initialize_boundary (ng, tile, iadm)
#  endif
      END DO
 
# else
 
#  if defined SOLVE3D && !defined INI_FILE
!
!-----------------------------------------------------------------------
!  If analytical initial conditions, compute initial time-evolving
!  depths with zero free-surface.
!-----------------------------------------------------------------------
!
      DO tile=first_tile(ng),last_tile(ng),+1
        CALL set_depth (ng, tile, iadm)
      END DO
#  endif
!
!-----------------------------------------------------------------------
!  Set adjoint primitive variables initial conditions.
!-----------------------------------------------------------------------
!
#  ifdef ANA_INITIAL
!
!  Analytical initial conditions for momentum and active tracers.
!
      IF (nrrec(ng).eq.0) THEN
        DO tile=first_tile(ng),last_tile(ng),+1
          CALL ana_initial (ng, tile, iadm)
        END DO
      END IF
#  endif
 
#  if defined ANA_PASSIVE && defined SOLVE3D
!
!  Analytical initial conditions for inert passive tracers
!
      IF (nrrec(ng).eq.0) THEN
        DO tile=first_tile(ng),last_tile(ng),+1
          CALL ana_passive (ng, tile, iadm)
        END DO
      END IF
#  endif
 
#  if defined ANA_BIOLOGY && defined SOLVE3D
!
!  Analytical initial conditions for biology tracers.
!
      IF (nrrec(ng).eq.0) THEN
        DO tile=first_tile(ng),last_tile(ng),+1
          CALL ana_biology (ng, tile, iadm)
        END DO
      END IF
#  endif
 
#  if defined ANA_SEDIMENT_NOT_YET && defined SOLVE3D
!
!  Analytical initial conditions for sediment tracers.
!
      IF (nrrec(ng).eq.0) THEN
        DO tile=first_tile(ng),last_tile(ng),+1
          CALL ana_sediment (ng, tile, iadm)
        END DO
      END IF
#  endif
!
!  Read in initial conditions for initial or restart NetCDF file.
!
#  ifdef INI_FILE
      CALL get_state (ng, iadm, 1, iad(ng), inirec, tindex)
      time(ng)=io_time                       ! needed for shared-memory
#   ifdef DISTRIBUTE
      CALL mp_bcasti (ng, iadm, exit_flag)
#   endif
      IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
#  else
      IF (nrrec(ng).ne.0) THEN
        CALL get_state (ng, iadm, 1, iad(ng), inirec, tindex)
        time(ng)=io_time                     ! needed for shared-memory
#   ifdef DISTRIBUTE
        CALL mp_bcasti (ng, iadm, exit_flag)
#   endif
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
      END IF
#  endif
 
#  ifdef INI_FILE
#   if defined STEP2D_FB_AB3_AM4 || defined STEP2D_FB_LF_AM3
!!
!!  Load initial fields to adjoint solution arrays for I/O purposes.
!!
!!      DO tile=first_tile(ng),last_tile(ng),+1
!!        CALL ad_load_sol (ng, tile, iADM, Tindex)
!!      END DO
#   endif
#  endif
# endif
 
# ifdef WET_DRY
!
!-----------------------------------------------------------------------
!  Process initial wet/dry masks.
!-----------------------------------------------------------------------
!
!  If restart, read in wet/dry masks.
!
      IF (nrrec(ng).ne.0) THEN
#  ifdef DISTRIBUTE
        CALL get_wetdry (ng, myrank, iadm, inirec(ng))
        CALL mp_bcasti (ng, iadm, exit_flag)
#  else
        CALL get_wetdry (ng, -1, iadm, inirec(ng))
#  endif
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
      ELSE
        DO tile=first_tile(ng),last_tile(ng),+1
          CALL wetdry (ng, tile, tindex(ng), .true.)
        END DO
      END IF
# endif
 
# ifdef OBSERVATIONS
!
!-----------------------------------------------------------------------
!  Initialize various variables needed for processing observations
!  backwards in time. Need to be done after processing initial
!  conditions since the correct initial time is needed to determine
!  the first "ObsTime" to process.
!-----------------------------------------------------------------------
!
# ifdef RBL4DVAR_FCT_SENSITIVITY
      IF (.not.lsen4dvar(ng).and.lsenfct(ng)) THEN
#  ifdef OBS_SPACE
        IF (lobspace(ng)) THEN
#  endif
# endif
          CALL obs_initial (ng, iadm, .true.)
# ifdef OBS_SPACE
        END IF
# endif
# ifdef RBL4DVAR_FCT_SENSITIVITY
      END IF
# endif
      IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
# endif
 
# if defined ANA_PERTURB  && \
    (defined sanity_check || defined r_symmetry)
!
!-----------------------------------------------------------------------
!  Perturb adjoint initial conditions with analitical expressions.
!-----------------------------------------------------------------------
!
      DO tile=first_tile(ng),last_tile(ng),+1
        CALL ana_perturb (ng, tile, iadm)
      END DO
# endif
 
# ifdef SOLVE3D
!!
!!----------------------------------------------------------------------
!!  Compute initial time-evolving depths.
!!----------------------------------------------------------------------
!!
!!    DO tile=first_tile(ng),last_tile(ng),+1
!!      CALL ad_set_depth (ng, tile, iADM)
!!    END DO
!!
!!----------------------------------------------------------------------
!!  Compute initial horizontal mass fluxes, Hz*u/n and Hz*v/m.
!!----------------------------------------------------------------------
!!
!!    DO tile=first_tile(ng),last_tile(ng),+1
!!      CALL ad_set_massflux (ng, tile, iADM)
!!    END DO
!!
!!----------------------------------------------------------------------
!!  Compute initial S-coordinates vertical velocity. Compute initial
!!  density anomaly from potential temperature and salinity via equation
!!  of state for seawater.  Also compute other equation of state related
!!  quatities.
!!----------------------------------------------------------------------
!!
!!    DO tile=first_tile(ng),last_tile(ng),+1
!!      CALL ad_omega (ng, tile, iADM)
!!      CALL ad_rho_eos (ng, tile, iADM)
!!    END DO
# endif
 
#ifdef ANA_PSOURCE
!
!-----------------------------------------------------------------------
!  Set point Sources/Sinks position, direction, special flag, and mass
!  transport nondimensional shape profile with analytcal expressions.
!  Point sources are at U- and V-points. We need to get their positions
!  to process internal Land/Sea masking arrays during initialization.
!-----------------------------------------------------------------------
!
      IF (luvsrc(ng).or.lwsrc(ng).or.any(ltracersrc(:,ng))) THEN
        DO tile=first_tile(ng),last_tile(ng),+1
          CALL ana_psource (ng, tile, iadm)
        END DO
      END IF
#endif
!
!-----------------------------------------------------------------------
!  If applicable, close all input boundary, climatology, and forcing
!  NetCDF files and set associated parameters to the closed state. This
!  step is essential in iterative algorithms that run the full TLM
!  repetitively. Then, Initialize several parameters in their file
!  structure, so the appropriate input single or multi-file is selected
!  during initialization/restart.
!-----------------------------------------------------------------------
!
      CALL close_inp (ng, iadm)
      CALL check_multifile (ng, iadm)
# ifdef DISTRIBUTE
      CALL mp_bcasti (ng, iadm, exit_flag)
# endif
      IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
!
!-----------------------------------------------------------------------
!  Read in initial forcing, climatology and assimilation data from
!  input NetCDF files.  It loads the first relevant data record for
!  the time-interpolation between snapshots.
!-----------------------------------------------------------------------
!
      CALL ad_get_idata (ng)
      CALL ad_get_data (ng)
# ifdef DISTRIBUTE
      CALL mp_bcasti (ng, iadm, exit_flag)
# endif
      IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
# if defined SOLVE3D && defined ADM_DRIVER
!
!-----------------------------------------------------------------------
!  Compute nonlinear initial time-evolving depths.
!-----------------------------------------------------------------------
!
      DO tile=first_tile(ng),last_tile(ng),+1
#  ifdef NONLINEAR
        CALL set_zeta_timeavg (ng, tile, itlm)
#  endif
        CALL set_depth (ng, tile, itlm)
      END DO
# endif
 
# ifdef MASKING
!
!-----------------------------------------------------------------------
!  Set internal I/O mask arrays.
!-----------------------------------------------------------------------
!
      DO tile=first_tile(ng),last_tile(ng),+1
        CALL set_masks (ng, tile, iadm)
      END DO
# endif
 
# if defined PROPAGATOR || \
    (defined masking    && (defined read_water || defined write_water) )
!
!-----------------------------------------------------------------------
!  Set variables associated with the processing water points and/or
!  size of packed state arrays.
!-----------------------------------------------------------------------
!
      DO tile=first_tile(ng),last_tile(ng),+1
        CALL wpoints (ng, tile, iadm)
      END DO
# endif
 
# if defined AD_SENSITIVITY   || defined I4DVAR_ANA_SENSITIVITY || \
     defined opt_observations || defined sensitivity_4dvar      || \
     defined so_semi
!
!-----------------------------------------------------------------------
!  Initialize adjoint state with the functional whose sensitivity is
!  is required.
!-----------------------------------------------------------------------
!
#  ifdef SENSITIVITY_4DVAR
      IF (lsen4dvar(ng)) THEN
#  endif
#  if !defined AD_IMPULSE
        DO tile=first_tile(ng),last_tile(ng),+1
          CALL adsen_initial (ng, tile)
        END DO
#  endif
#  ifdef SENSITIVITY_4DVAR
      END IF
#  endif
# endif
 
# if defined ANA_DRAG && defined UV_DRAG_GRID
!
!-----------------------------------------------------------------------
!  Set analytical spatially varying bottom friction parameter.
!-----------------------------------------------------------------------
!
      IF (nrun.eq.erstr) THEN
        DO tile=first_tile(ng),last_tile(ng),+1
          CALL ana_drag (ng, tile, iadm)
        END DO
      END IF
# endif
!
!-----------------------------------------------------------------------
!  Compute grid stiffness.
!-----------------------------------------------------------------------
!
      IF (lstiffness) THEN
        lstiffness=.false.
        DO tile=first_tile(ng),last_tile(ng),+1
          CALL stiffness (ng, tile, iadm)
        END DO
      END IF
 
# if defined FLOATS_NOT_YET || defined STATIONS
!
!-----------------------------------------------------------------------
!  If applicable, convert initial locations to fractional grid
!  coordinates.
!-----------------------------------------------------------------------
!
      CALL grid_coords (ng, iadm)
# endif
 
# if defined WAV_COUPLING_NOT_YET && defined MCT_LIB
!
!-----------------------------------------------------------------------
!  Read in initial forcing from coupled wave model.
!-----------------------------------------------------------------------
!
      DO tile=first_tile(ng),last_tile(ng),+1
        CALL ocn2wav_coupling (ng, tile)
      END DO
# endif
!
!-----------------------------------------------------------------------
!  Initialize time-stepping counter.
!-----------------------------------------------------------------------
!
      iic(ng)=ntstart(ng)
      CALL time_string (time(ng), time_code(ng))
 
# ifdef PROFILE
!
!-----------------------------------------------------------------------
!  Turn off initiialization time wall clock.
!-----------------------------------------------------------------------
!
      DO thread=thread_range
        CALL wclock_off (ng, iadm, 2, __line__, myfile)
      END DO
# endif
      RETURN
      END SUBROUTINE ad_initial
#else
      SUBROUTINE ad_initial
      RETURN
      END SUBROUTINE ad_initial
#endif