model/src/external_forcing.F

C $Header: /u/gcmpack/MITgcm/model/src/external_forcing.F,v 1.43 2007/07/22 23:51:16 dimitri Exp $
C $Name:  $

#include "PACKAGES_CONFIG.h"
#include "CPP_OPTIONS.h"

CBOP
C     !ROUTINE: EXTERNAL_FORCING_U
C     !INTERFACE:
      SUBROUTINE EXTERNAL_FORCING_U(
     I           iMin,iMax, jMin,jMax, bi,bj, kLev,
     I           myTime, myThid )
C     !DESCRIPTION: \bv
C     *==========================================================*
C     | S/R EXTERNAL_FORCING_U
C     | o Contains problem specific forcing for zonal velocity.
C     *==========================================================*
C     | Adds terms to gU for forcing by external sources
C     | e.g. wind stress, bottom friction etc ...
C     *==========================================================*
C     \ev

C     !USES:
      IMPLICIT NONE
C     == Global data ==
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "GRID.h"
#include "DYNVARS.h"
#include "FFIELDS.h"

C     !INPUT/OUTPUT PARAMETERS:
C     == Routine arguments ==
C     iMin,iMax :: Working range of x-index for applying forcing.
C     jMin,jMax :: Working range of y-index for applying forcing.
C     bi,bj     :: Current tile indices
C     kLev      :: Current vertical level index
C     myTime    :: Current time in simulation
C     myThid    :: Thread Id number
      INTEGER iMin, iMax, jMin, jMax, kLev, bi, bj
      _RL myTime
      INTEGER myThid

C     !LOCAL VARIABLES:
C     == Local variables ==
C     i,j       :: Loop counters
C     kSurface  :: index of surface layer
      INTEGER i, j
      INTEGER kSurface
CEOP

      IF ( fluidIsAir ) THEN
       kSurface = 0
      ELSEIF ( usingPCoords ) THEN
       kSurface = Nr
      ELSE
       kSurface = 1
      ENDIF

C--   Forcing term
#ifdef ALLOW_AIM
      IF ( useAIM ) CALL AIM_TENDENCY_APPLY_U(
     &                      iMin,iMax, jMin,jMax, bi,bj, kLev,
     &                      myTime, myThid )
#endif /* ALLOW_AIM */

#ifdef ALLOW_FIZHI
      IF ( useFIZHI ) CALL FIZHI_TENDENCY_APPLY_U(
     &                      iMin,iMax, jMin,jMax, bi,bj, kLev,
     &                      myTime, myThid )
#endif /* ALLOW_FIZHI */

#ifdef ALLOW_MYPACKAGE
      IF ( useMYPACKAGE ) CALL MYPACKAGE_TENDENCY_APPLY_U(
     &                      iMin,iMax, jMin,jMax, bi,bj, kLev,
     &                      myTime, myThid )
#endif /* ALLOW_MYPACKAGE */

C     Add windstress momentum impulse into the top-layer
      IF ( kLev .EQ. kSurface ) THEN
c      DO j=1,sNy
C-jmc: Without CD-scheme, this is OK ; but with CD-scheme, needs to cover [0:sNy+1]
       DO j=0,sNy+1
        DO i=1,sNx+1
         gU(i,j,kLev,bi,bj) = gU(i,j,kLev,bi,bj)
     &   +foFacMom*surfaceForcingU(i,j,bi,bj)
     &   *recip_drF(kLev)*_recip_hFacW(i,j,kLev,bi,bj)
        ENDDO
       ENDDO
      ENDIF

#if (defined (ALLOW_TAU_EDDY))
       CALL TAUEDDY_EXTERNAL_FORCING_U(
     I           iMin,iMax, jMin,jMax, bi,bj, kLev,
     I           myTime, myThid )
#endif

#ifdef ALLOW_OBCS
      IF (useOBCS) THEN
       CALL OBCS_SPONGE_U(
     I           iMin,iMax, jMin,jMax, bi,bj, kLev,
     I           myTime, myThid )
      ENDIF
#endif

      RETURN
      END

C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C     !ROUTINE: EXTERNAL_FORCING_V
C     !INTERFACE:
      SUBROUTINE EXTERNAL_FORCING_V(
     I           iMin,iMax, jMin,jMax, bi,bj, kLev,
     I           myTime, myThid )
C     !DESCRIPTION: \bv
C     *==========================================================*
C     | S/R EXTERNAL_FORCING_V
C     | o Contains problem specific forcing for merid velocity.
C     *==========================================================*
C     | Adds terms to gV for forcing by external sources
C     | e.g. wind stress, bottom friction etc ...
C     *==========================================================*
C     \ev

C     !USES:
      IMPLICIT NONE
C     == Global data ==
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "GRID.h"
#include "DYNVARS.h"
#include "FFIELDS.h"

C     !INPUT/OUTPUT PARAMETERS:
C     == Routine arguments ==
C     iMin,iMax :: Working range of x-index for applying forcing.
C     jMin,jMax :: Working range of y-index for applying forcing.
C     bi,bj     :: Current tile indices
C     kLev      :: Current vertical level index
C     myTime    :: Current time in simulation
C     myThid    :: Thread Id number
      INTEGER iMin, iMax, jMin, jMax, kLev, bi, bj
      _RL myTime
      INTEGER myThid

C     !LOCAL VARIABLES:
C     == Local variables ==
C     i,j       :: Loop counters
C     kSurface  :: index of surface layer
      INTEGER i, j
      INTEGER kSurface
CEOP

      IF ( fluidIsAir ) THEN
       kSurface = 0
      ELSEIF ( usingPCoords ) THEN
       kSurface = Nr
      ELSE
       kSurface = 1
      ENDIF

C--   Forcing term
#ifdef ALLOW_AIM
      IF ( useAIM ) CALL AIM_TENDENCY_APPLY_V(
     &                      iMin,iMax, jMin,jMax, bi,bj, kLev,
     &                      myTime, myThid )
#endif /* ALLOW_AIM */

#ifdef ALLOW_FIZHI
      IF ( useFIZHI ) CALL FIZHI_TENDENCY_APPLY_V(
     &                      iMin,iMax, jMin,jMax, bi,bj, kLev,
     &                      myTime, myThid )
#endif /* ALLOW_FIZHI */

#ifdef ALLOW_MYPACKAGE
      IF ( useMYPACKAGE ) CALL MYPACKAGE_TENDENCY_APPLY_V(
     &                      iMin,iMax, jMin,jMax, bi,bj, kLev,
     &                      myTime, myThid )
#endif /* ALLOW_MYPACKAGE */

C     Add windstress momentum impulse into the top-layer
      IF ( kLev .EQ. kSurface ) THEN
       DO j=1,sNy+1
c       DO i=1,sNx
C-jmc: Without CD-scheme, this is OK ; but with CD-scheme, needs to cover [0:sNx+1]
        DO i=0,sNx+1
         gV(i,j,kLev,bi,bj) = gV(i,j,kLev,bi,bj)
     &   +foFacMom*surfaceForcingV(i,j,bi,bj)
     &   *recip_drF(kLev)*_recip_hFacS(i,j,kLev,bi,bj)
        ENDDO
       ENDDO
      ENDIF

#if (defined (ALLOW_TAU_EDDY))
       CALL TAUEDDY_EXTERNAL_FORCING_V(
     I           iMin,iMax, jMin,jMax, bi,bj, kLev,
     I           myTime, myThid )
#endif

#ifdef ALLOW_OBCS
      IF (useOBCS) THEN
       CALL OBCS_SPONGE_V(
     I           iMin,iMax, jMin,jMax, bi,bj, kLev,
     I           myTime, myThid )
      ENDIF
#endif

      RETURN
      END

C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C     !ROUTINE: EXTERNAL_FORCING_T
C     !INTERFACE:
      SUBROUTINE EXTERNAL_FORCING_T(
     I           iMin,iMax, jMin,jMax, bi,bj, kLev,
     I           myTime, myThid )
C     !DESCRIPTION: \bv
C     *==========================================================*
C     | S/R EXTERNAL_FORCING_T
C     | o Contains problem specific forcing for temperature.
C     *==========================================================*
C     | Adds terms to gT for forcing by external sources
C     | e.g. heat flux, climatalogical relaxation, etc ...
C     *==========================================================*
C     \ev

C     !USES:
      IMPLICIT NONE
C     == Global data ==
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "GRID.h"
#include "DYNVARS.h"
#include "FFIELDS.h"
#include "SURFACE.h"

C     !INPUT/OUTPUT PARAMETERS:
C     == Routine arguments ==
C     iMin,iMax :: Working range of x-index for applying forcing.
C     jMin,jMax :: Working range of y-index for applying forcing.
C     bi,bj     :: Current tile indices
C     kLev      :: Current vertical level index
C     myTime    :: Current time in simulation
C     myThid    :: Thread Id number
      INTEGER iMin, iMax, jMin, jMax, kLev, bi, bj
      _RL myTime
      INTEGER myThid

C     !LOCAL VARIABLES:
C     == Local variables ==
C     i,j       :: Loop counters
C     kSurface  :: index of surface layer
      INTEGER i, j
      INTEGER kSurface
CEOP
#ifdef SHORTWAVE_HEATING
      integer two
      _RL minusone
      parameter (two=2,minusone=-1.)
      _RL swfracb(two)
      INTEGER kp1
#endif

      IF ( fluidIsAir ) THEN
       kSurface = 0
      ELSEIF ( usingPCoords ) THEN
       kSurface = Nr
      ELSE
       kSurface = 1
      ENDIF

C--   Forcing term
#ifdef ALLOW_AIM
      IF ( useAIM ) CALL AIM_TENDENCY_APPLY_T(
     &                      iMin,iMax, jMin,jMax, bi,bj, kLev,
     &                      myTime, myThid )
#endif /* ALLOW_AIM */

#ifdef ALLOW_FIZHI
      IF ( useFIZHI ) CALL FIZHI_TENDENCY_APPLY_T(
     &                      iMin,iMax, jMin,jMax, bi,bj, kLev,
     &                      myTime, myThid )
#endif /* ALLOW_FIZHI */

#ifdef ALLOW_MYPACKAGE
      IF ( useMYPACKAGE ) CALL MYPACKAGE_TENDENCY_APPLY_T(
     &                      iMin,iMax, jMin,jMax, bi,bj, kLev,
     &                      myTime, myThid )
#endif /* ALLOW_MYPACKAGE */

C     Add heat in top-layer
      IF ( kLev .EQ. kSurface ) THEN
       DO j=1,sNy
        DO i=1,sNx
         gT(i,j,kLev,bi,bj)=gT(i,j,kLev,bi,bj)
     &     +surfaceForcingT(i,j,bi,bj)
     &     *recip_drF(kLev)*_recip_hFacC(i,j,kLev,bi,bj)
        ENDDO
       ENDDO
      ENDIF

#ifndef ALLOW_AUTODIFF_TAMC
      IF (linFSConserveTr) THEN
       DO j=1,sNy
        DO i=1,sNx
          IF (kLev .EQ. ksurfC(i,j,bi,bj)) THEN
            gT(i,j,kLev,bi,bj)=gT(i,j,kLev,bi,bj)
     &        +TsurfCor*recip_drF(kLev)*_recip_hFacC(i,j,kLev,bi,bj)
          ENDIF
        ENDDO
       ENDDO
      ENDIF
#endif /* ndfef ALLOW_AUTODIFF_TAMC */

#ifdef ALLOW_SHELFICE
      IF ( useShelfIce )
     &     CALL SHELFICE_FORCING_T(
     I     iMin,iMax, jMin,jMax, bi,bj, kLev,
     I     myTime, myThid )
#endif /* ALLOW_SHELFICE */

#ifdef SHORTWAVE_HEATING
C Penetrating SW radiation
c     IF ( usePenetratingSW ) THEN
       swfracb(1)=abs(rF(klev))
       swfracb(2)=abs(rF(klev+1))
       CALL SWFRAC(
     I             two, minusone,
     U             swfracb,
     I             myTime, 1, myThid )
       kp1 = klev+1
       IF (klev.EQ.Nr) THEN
        kp1 = klev
        swfracb(2)=0. _d 0
       ENDIF
       DO j=1,sNy
        DO i=1,sNx
         gT(i,j,klev,bi,bj) = gT(i,j,klev,bi,bj)
     &   -Qsw(i,j,bi,bj)*(swfracb(1)*maskC(i,j,klev,bi,bj)
     &                   -swfracb(2)*maskC(i,j,kp1, bi,bj))
     &    *recip_Cp*recip_rhoConst
     &    *recip_drF(klev)*_recip_hFacC(i,j,kLev,bi,bj)
        ENDDO
       ENDDO
c     ENDIF
#endif

#ifdef ALLOW_RBCS
       if (useRBCS) then
          call RBCS_ADD_TENDENCY(bi,bj,klev, 1,
     &                            myTime, myThid )
       endif
#endif

#ifdef ALLOW_OBCS
      IF (useOBCS) THEN
       CALL OBCS_SPONGE_T(
     I           iMin,iMax, jMin,jMax, bi,bj, kLev,
     I           myTime, myThid )
      ENDIF
#endif

      RETURN
      END

C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C     !ROUTINE: EXTERNAL_FORCING_S
C     !INTERFACE:
      SUBROUTINE EXTERNAL_FORCING_S(
     I           iMin,iMax, jMin,jMax, bi,bj, kLev,
     I           myTime, myThid )

C     !DESCRIPTION: \bv
C     *==========================================================*
C     | S/R EXTERNAL_FORCING_S
C     | o Contains problem specific forcing for merid velocity.
C     *==========================================================*
C     | Adds terms to gS for forcing by external sources
C     | e.g. fresh-water flux, climatalogical relaxation, etc ...
C     *==========================================================*
C     \ev

C     !USES:
      IMPLICIT NONE
C     == Global data ==
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "GRID.h"
#include "DYNVARS.h"
#include "FFIELDS.h"
#include "SURFACE.h"
#ifdef ALLOW_SALT_PLUME
#ifdef ALLOW_SEAICE
#include "SEAICE_PARAMS.h"
#endif /* ALLOW_SEAICE */
#endif /* ALLOW_SALT_PLUME */

C     !INPUT/OUTPUT PARAMETERS:
C     == Routine arguments ==
C     iMin,iMax :: Working range of x-index for applying forcing.
C     jMin,jMax :: Working range of y-index for applying forcing.
C     bi,bj     :: Current tile indices
C     kLev      :: Current vertical level index
C     myTime    :: Current time in simulation
C     myThid    :: Thread Id number
      INTEGER iMin, iMax, jMin, jMax, kLev, bi, bj
      _RL myTime
      INTEGER myThid

C     !LOCAL VARIABLES:
C     == Local variables ==
C     i,j       :: Loop counters
C     kSurface  :: index of surface layer
      INTEGER i, j
      INTEGER kSurface
CEOP
#ifdef ALLOW_SALT_PLUME
      _RL saltPlume
#endif /* ALLOW_SALT_PLUME */

      IF ( fluidIsAir ) THEN
       kSurface = 0
      ELSEIF ( usingPCoords ) THEN
       kSurface = Nr
      ELSE
       kSurface = 1
      ENDIF

C--   Forcing term
#ifdef ALLOW_AIM
      IF ( useAIM ) CALL AIM_TENDENCY_APPLY_S(
     &                      iMin,iMax, jMin,jMax, bi,bj, kLev,
     &                      myTime, myThid )
#endif /* ALLOW_AIM */

#ifdef ALLOW_FIZHI
      IF ( useFIZHI ) CALL FIZHI_TENDENCY_APPLY_S(
     &                      iMin,iMax, jMin,jMax, bi,bj, kLev,
     &                      myTime, myThid )
#endif /* ALLOW_FIZHI */

#ifdef ALLOW_MYPACKAGE
      IF ( useMYPACKAGE ) CALL MYPACKAGE_TENDENCY_APPLY_S(
     &                      iMin,iMax, jMin,jMax, bi,bj, kLev,
     &                      myTime, myThid )
#endif /* ALLOW_MYPACKAGE */

C     Add fresh-water in top-layer
      IF ( kLev .EQ. kSurface ) THEN
       DO j=1,sNy
        DO i=1,sNx
         gS(i,j,kLev,bi,bj)=gS(i,j,kLev,bi,bj)
     &     +surfaceForcingS(i,j,bi,bj)
     &     *recip_drF(kLev)*_recip_hFacC(i,j,kLev,bi,bj)
        ENDDO
       ENDDO
      ENDIF

#ifndef ALLOW_AUTODIFF_TAMC
      IF (linFSConserveTr) THEN
       DO j=1,sNy
        DO i=1,sNx
          IF (kLev .EQ. ksurfC(i,j,bi,bj)) THEN
            gS(i,j,kLev,bi,bj)=gS(i,j,kLev,bi,bj)
     &        +SsurfCor*recip_drF(kLev)*_recip_hFacC(i,j,kLev,bi,bj)
          ENDIF
        ENDDO
       ENDDO
      ENDIF
#endif /* ndfef ALLOW_AUTODIFF_TAMC */

#ifdef ALLOW_SHELFICE
      IF ( useShelfIce )
     &     CALL SHELFICE_FORCING_S(
     I     iMin,iMax, jMin,jMax, bi,bj, kLev,
     I     myTime, myThid )
#endif /* ALLOW_SHELFICE */

#ifdef ALLOW_SALT_PLUME
C saltPlume is the amount of salt rejected by ice while freezing;
C it is here redistributed to multiple vertical levels as per
C Duffy et al. (GRL 1999)
       DO j=1,sNy
        DO i=1,sNx
          saltPlume = 0.
#ifdef ALLOW_SEAICE
          IF ( saltFlux(i,j,bi,bj) .GT. 0. .AND.
     &         salt(i,j,kSurface,bi,bj)  .GT. SEAICE_salinity ) THEN
           saltPlume = (salt(i,j,kSurface,bi,bj)-SEAICE_salinity) *
     &          saltFlux(i,j,bi,bj) / salt(i,j,kSurface,bi,bj)
          ENDIF
#endif /* ALLOW_SEAICE */
          IF ( SaltPlumeDepth(i,j,bi,bj) .GT. -rF(kLev) ) THEN
           gS(i,j,kLev,bi,bj)=gS(i,j,kLev,bi,bj)
     &          +saltPlume*horiVertRatio*recip_rhoConst
     &          *recip_drF(kLev)*_recip_hFacC(i,j,kLev,bi,bj)
     &          *max(drF(kLev),SaltPlumeDepth(i,j,bi,bj)+rF(kLev))
     &          /SaltPlumeDepth(i,j,bi,bj)
          ENDIF
        ENDDO
       ENDDO
#endif /* ALLOW_SALT_PLUME */

#ifdef ALLOW_RBCS
       if (useRBCS) then
          call RBCS_ADD_TENDENCY(bi,bj,klev, 2,
     &                            myTime, myThid )
       endif
#endif /* ALLOW_RBCS */

#ifdef ALLOW_OBCS
      IF (useOBCS) THEN
       CALL OBCS_SPONGE_S(
     I           iMin,iMax, jMin,jMax, bi,bj, kLev,
     I           myTime, myThid )
      ENDIF
#endif /* ALLOW_OBCS */

      RETURN
      END
1	dimitri	1.44	C $Header: /u/gcmpack/MITgcm/model/src/external_forcing.F,v 1.43 2007/07/22 23:51:16 dimitri Exp $
2	adcroft	1.12	C $Name: $
3	cnh	1.1
4	edhill	1.20	#include "PACKAGES_CONFIG.h"
5	cnh	1.1	#include "CPP_OPTIONS.h"
6
7	cnh	1.13	CBOP
8			C !ROUTINE: EXTERNAL_FORCING_U
9			C !INTERFACE:
10	cnh	1.1	SUBROUTINE EXTERNAL_FORCING_U(
11	jmc	1.31	I iMin,iMax, jMin,jMax, bi,bj, kLev,
12			I myTime, myThid )
13	cnh	1.13	C !DESCRIPTION: \bv
14			C ==========================================================
15	jmc	1.31	C \| S/R EXTERNAL_FORCING_U
16			C \| o Contains problem specific forcing for zonal velocity.
17	cnh	1.13	C ==========================================================
18	jmc	1.31	C \| Adds terms to gU for forcing by external sources
19			C \| e.g. wind stress, bottom friction etc ...
20	cnh	1.13	C ==========================================================
21			C \ev
22
23			C !USES:
24	cnh	1.2	IMPLICIT NONE
25	cnh	1.1	C == Global data ==
26			#include "SIZE.h"
27			#include "EEPARAMS.h"
28			#include "PARAMS.h"
29			#include "GRID.h"
30			#include "DYNVARS.h"
31	cnh	1.2	#include "FFIELDS.h"
32	cnh	1.13
33			C !INPUT/OUTPUT PARAMETERS:
34	cnh	1.1	C == Routine arguments ==
35	jmc	1.31	C iMin,iMax :: Working range of x-index for applying forcing.
36			C jMin,jMax :: Working range of y-index for applying forcing.
37			C bi,bj :: Current tile indices
38			C kLev :: Current vertical level index
39			C myTime :: Current time in simulation
40			C myThid :: Thread Id number
41	cnh	1.1	INTEGER iMin, iMax, jMin, jMax, kLev, bi, bj
42	jmc	1.31	_RL myTime
43	adcroft	1.4	INTEGER myThid
44	cnh	1.1
45	cnh	1.13	C !LOCAL VARIABLES:
46	cnh	1.2	C == Local variables ==
47	jmc	1.31	C i,j :: Loop counters
48			C kSurface :: index of surface layer
49			INTEGER i, j
50	mlosch	1.17	INTEGER kSurface
51	cnh	1.13	CEOP
52	cnh	1.2
53	jmc	1.28	IF ( fluidIsAir ) THEN
54	jmc	1.21	kSurface = 0
55	jmc	1.28	ELSEIF ( usingPCoords ) THEN
56	mlosch	1.17	kSurface = Nr
57	jmc	1.28	ELSE
58	mlosch	1.17	kSurface = 1
59	jmc	1.28	ENDIF
60	mlosch	1.17
61	cnh	1.2	C-- Forcing term
62	jmc	1.21	#ifdef ALLOW_AIM
63			IF ( useAIM ) CALL AIM_TENDENCY_APPLY_U(
64			& iMin,iMax, jMin,jMax, bi,bj, kLev,
65	jmc	1.31	& myTime, myThid )
66	jmc	1.21	#endif /* ALLOW_AIM */
67	jmc	1.31
68	molod	1.23	#ifdef ALLOW_FIZHI
69			IF ( useFIZHI ) CALL FIZHI_TENDENCY_APPLY_U(
70			& iMin,iMax, jMin,jMax, bi,bj, kLev,
71	jmc	1.31	& myTime, myThid )
72	molod	1.23	#endif /* ALLOW_FIZHI */
73	jmc	1.21
74	heimbach	1.39	#ifdef ALLOW_MYPACKAGE
75			IF ( useMYPACKAGE ) CALL MYPACKAGE_TENDENCY_APPLY_U(
76			& iMin,iMax, jMin,jMax, bi,bj, kLev,
77			& myTime, myThid )
78			#endif /* ALLOW_MYPACKAGE */
79
80	cnh	1.2	C Add windstress momentum impulse into the top-layer
81	mlosch	1.17	IF ( kLev .EQ. kSurface ) THEN
82	jmc	1.32	c DO j=1,sNy
83			C-jmc: Without CD-scheme, this is OK ; but with CD-scheme, needs to cover [0:sNy+1]
84			DO j=0,sNy+1
85	jmc	1.31	DO i=1,sNx+1
86	cnh	1.2	gU(i,j,kLev,bi,bj) = gU(i,j,kLev,bi,bj)
87	jmc	1.26	& +foFacMom*surfaceForcingU(i,j,bi,bj)
88	heimbach	1.38	& recip_drF(kLev)_recip_hFacW(i,j,kLev,bi,bj)
89	cnh	1.2	ENDDO
90			ENDDO
91			ENDIF
92
93	heimbach	1.30	#if (defined (ALLOW_TAU_EDDY))
94	heimbach	1.29	CALL TAUEDDY_EXTERNAL_FORCING_U(
95	jmc	1.31	I iMin,iMax, jMin,jMax, bi,bj, kLev,
96			I myTime, myThid )
97	heimbach	1.29	#endif
98
99	jmc	1.31	#ifdef ALLOW_OBCS
100	heimbach	1.16	IF (useOBCS) THEN
101			CALL OBCS_SPONGE_U(
102	jmc	1.31	I iMin,iMax, jMin,jMax, bi,bj, kLev,
103			I myTime, myThid )
104	heimbach	1.16	ENDIF
105	heimbach	1.14	#endif
106
107	cnh	1.1	RETURN
108			END
109	jmc	1.31
110			C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|
111	cnh	1.13	CBOP
112			C !ROUTINE: EXTERNAL_FORCING_V
113			C !INTERFACE:
114	cnh	1.1	SUBROUTINE EXTERNAL_FORCING_V(
115	jmc	1.31	I iMin,iMax, jMin,jMax, bi,bj, kLev,
116			I myTime, myThid )
117	cnh	1.13	C !DESCRIPTION: \bv
118			C ==========================================================
119	jmc	1.31	C \| S/R EXTERNAL_FORCING_V
120			C \| o Contains problem specific forcing for merid velocity.
121	cnh	1.13	C ==========================================================
122	jmc	1.31	C \| Adds terms to gV for forcing by external sources
123			C \| e.g. wind stress, bottom friction etc ...
124	cnh	1.13	C ==========================================================
125			C \ev
126
127			C !USES:
128	cnh	1.2	IMPLICIT NONE
129	cnh	1.1	C == Global data ==
130			#include "SIZE.h"
131			#include "EEPARAMS.h"
132			#include "PARAMS.h"
133			#include "GRID.h"
134			#include "DYNVARS.h"
135	cnh	1.2	#include "FFIELDS.h"
136
137	cnh	1.13	C !INPUT/OUTPUT PARAMETERS:
138	cnh	1.1	C == Routine arguments ==
139	jmc	1.31	C iMin,iMax :: Working range of x-index for applying forcing.
140			C jMin,jMax :: Working range of y-index for applying forcing.
141			C bi,bj :: Current tile indices
142			C kLev :: Current vertical level index
143			C myTime :: Current time in simulation
144			C myThid :: Thread Id number
145	cnh	1.1	INTEGER iMin, iMax, jMin, jMax, kLev, bi, bj
146	jmc	1.31	_RL myTime
147	adcroft	1.4	INTEGER myThid
148	cnh	1.13
149			C !LOCAL VARIABLES:
150	cnh	1.2	C == Local variables ==
151	jmc	1.31	C i,j :: Loop counters
152			C kSurface :: index of surface layer
153			INTEGER i, j
154	mlosch	1.17	INTEGER kSurface
155	cnh	1.13	CEOP
156	cnh	1.2
157	jmc	1.28	IF ( fluidIsAir ) THEN
158	jmc	1.21	kSurface = 0
159	jmc	1.28	ELSEIF ( usingPCoords ) THEN
160	mlosch	1.17	kSurface = Nr
161	jmc	1.28	ELSE
162	mlosch	1.17	kSurface = 1
163	jmc	1.28	ENDIF
164	mlosch	1.17
165	cnh	1.2	C-- Forcing term
166	jmc	1.21	#ifdef ALLOW_AIM
167			IF ( useAIM ) CALL AIM_TENDENCY_APPLY_V(
168			& iMin,iMax, jMin,jMax, bi,bj, kLev,
169	jmc	1.31	& myTime, myThid )
170	jmc	1.21	#endif /* ALLOW_AIM */
171
172	molod	1.23	#ifdef ALLOW_FIZHI
173			IF ( useFIZHI ) CALL FIZHI_TENDENCY_APPLY_V(
174			& iMin,iMax, jMin,jMax, bi,bj, kLev,
175	jmc	1.31	& myTime, myThid )
176	molod	1.23	#endif /* ALLOW_FIZHI */
177	jmc	1.31
178	heimbach	1.39	#ifdef ALLOW_MYPACKAGE
179			IF ( useMYPACKAGE ) CALL MYPACKAGE_TENDENCY_APPLY_V(
180			& iMin,iMax, jMin,jMax, bi,bj, kLev,
181			& myTime, myThid )
182			#endif /* ALLOW_MYPACKAGE */
183
184	cnh	1.2	C Add windstress momentum impulse into the top-layer
185	mlosch	1.17	IF ( kLev .EQ. kSurface ) THEN
186	jmc	1.31	DO j=1,sNy+1
187	jmc	1.32	c DO i=1,sNx
188			C-jmc: Without CD-scheme, this is OK ; but with CD-scheme, needs to cover [0:sNx+1]
189			DO i=0,sNx+1
190	cnh	1.2	gV(i,j,kLev,bi,bj) = gV(i,j,kLev,bi,bj)
191	jmc	1.26	& +foFacMom*surfaceForcingV(i,j,bi,bj)
192	heimbach	1.38	& recip_drF(kLev)_recip_hFacS(i,j,kLev,bi,bj)
193	cnh	1.2	ENDDO
194			ENDDO
195			ENDIF
196	cnh	1.1
197	heimbach	1.30	#if (defined (ALLOW_TAU_EDDY))
198	heimbach	1.29	CALL TAUEDDY_EXTERNAL_FORCING_V(
199	jmc	1.31	I iMin,iMax, jMin,jMax, bi,bj, kLev,
200			I myTime, myThid )
201	heimbach	1.29	#endif
202
203	jmc	1.31	#ifdef ALLOW_OBCS
204	heimbach	1.16	IF (useOBCS) THEN
205			CALL OBCS_SPONGE_V(
206	jmc	1.31	I iMin,iMax, jMin,jMax, bi,bj, kLev,
207			I myTime, myThid )
208	heimbach	1.16	ENDIF
209	heimbach	1.14	#endif
210
211	cnh	1.1	RETURN
212			END
213	jmc	1.31
214			C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|
215	cnh	1.13	CBOP
216			C !ROUTINE: EXTERNAL_FORCING_T
217			C !INTERFACE:
218	cnh	1.1	SUBROUTINE EXTERNAL_FORCING_T(
219	jmc	1.31	I iMin,iMax, jMin,jMax, bi,bj, kLev,
220			I myTime, myThid )
221	cnh	1.13	C !DESCRIPTION: \bv
222			C ==========================================================
223	jmc	1.31	C \| S/R EXTERNAL_FORCING_T
224			C \| o Contains problem specific forcing for temperature.
225	cnh	1.13	C ==========================================================
226	jmc	1.31	C \| Adds terms to gT for forcing by external sources
227			C \| e.g. heat flux, climatalogical relaxation, etc ...
228	cnh	1.13	C ==========================================================
229			C \ev
230
231			C !USES:
232	cnh	1.2	IMPLICIT NONE
233	cnh	1.1	C == Global data ==
234			#include "SIZE.h"
235			#include "EEPARAMS.h"
236			#include "PARAMS.h"
237			#include "GRID.h"
238			#include "DYNVARS.h"
239			#include "FFIELDS.h"
240	dfer	1.40	#include "SURFACE.h"
241	heimbach	1.7
242	cnh	1.13	C !INPUT/OUTPUT PARAMETERS:
243	cnh	1.1	C == Routine arguments ==
244	jmc	1.31	C iMin,iMax :: Working range of x-index for applying forcing.
245			C jMin,jMax :: Working range of y-index for applying forcing.
246			C bi,bj :: Current tile indices
247			C kLev :: Current vertical level index
248			C myTime :: Current time in simulation
249			C myThid :: Thread Id number
250	cnh	1.1	INTEGER iMin, iMax, jMin, jMax, kLev, bi, bj
251	jmc	1.31	_RL myTime
252	adcroft	1.4	INTEGER myThid
253	cnh	1.1
254	cnh	1.13	C !LOCAL VARIABLES:
255	cnh	1.2	C == Local variables ==
256	jmc	1.31	C i,j :: Loop counters
257			C kSurface :: index of surface layer
258			INTEGER i, j
259	mlosch	1.17	INTEGER kSurface
260	jmc	1.31	CEOP
261	jmc	1.24	#ifdef SHORTWAVE_HEATING
262			integer two
263			_RL minusone
264			parameter (two=2,minusone=-1.)
265			_RL swfracb(two)
266			INTEGER kp1
267			#endif
268	cnh	1.2
269	jmc	1.28	IF ( fluidIsAir ) THEN
270	jmc	1.21	kSurface = 0
271	jmc	1.28	ELSEIF ( usingPCoords ) THEN
272	mlosch	1.17	kSurface = Nr
273	jmc	1.28	ELSE
274	mlosch	1.17	kSurface = 1
275	jmc	1.28	ENDIF
276	mlosch	1.17
277	cnh	1.2	C-- Forcing term
278	jmc	1.21	#ifdef ALLOW_AIM
279			IF ( useAIM ) CALL AIM_TENDENCY_APPLY_T(
280			& iMin,iMax, jMin,jMax, bi,bj, kLev,
281	jmc	1.31	& myTime, myThid )
282	jmc	1.21	#endif /* ALLOW_AIM */
283
284	molod	1.23	#ifdef ALLOW_FIZHI
285			IF ( useFIZHI ) CALL FIZHI_TENDENCY_APPLY_T(
286			& iMin,iMax, jMin,jMax, bi,bj, kLev,
287	jmc	1.31	& myTime, myThid )
288	molod	1.23	#endif /* ALLOW_FIZHI */
289	heimbach	1.25
290	heimbach	1.39	#ifdef ALLOW_MYPACKAGE
291			IF ( useMYPACKAGE ) CALL MYPACKAGE_TENDENCY_APPLY_T(
292			& iMin,iMax, jMin,jMax, bi,bj, kLev,
293			& myTime, myThid )
294			#endif /* ALLOW_MYPACKAGE */
295
296	cnh	1.2	C Add heat in top-layer
297	mlosch	1.17	IF ( kLev .EQ. kSurface ) THEN
298	jmc	1.31	DO j=1,sNy
299			DO i=1,sNx
300	cnh	1.2	gT(i,j,kLev,bi,bj)=gT(i,j,kLev,bi,bj)
301	jmc	1.26	& +surfaceForcingT(i,j,bi,bj)
302	heimbach	1.38	& recip_drF(kLev)_recip_hFacC(i,j,kLev,bi,bj)
303	cnh	1.2	ENDDO
304			ENDDO
305			ENDIF
306	adcroft	1.5
307	dfer	1.41	#ifndef ALLOW_AUTODIFF_TAMC
308	dfer	1.40	IF (linFSConserveTr) THEN
309			DO j=1,sNy
310			DO i=1,sNx
311			IF (kLev .EQ. ksurfC(i,j,bi,bj)) THEN
312			gT(i,j,kLev,bi,bj)=gT(i,j,kLev,bi,bj)
313			& +TsurfCorrecip_drF(kLev)_recip_hFacC(i,j,kLev,bi,bj)
314			ENDIF
315			ENDDO
316			ENDDO
317			ENDIF
318	dfer	1.41	#endif /* ndfef ALLOW_AUTODIFF_TAMC */
319	dfer	1.40
320	mlosch	1.37	#ifdef ALLOW_SHELFICE
321			IF ( useShelfIce )
322			& CALL SHELFICE_FORCING_T(
323			I iMin,iMax, jMin,jMax, bi,bj, kLev,
324			I myTime, myThid )
325			#endif /* ALLOW_SHELFICE */
326
327	adcroft	1.5	#ifdef SHORTWAVE_HEATING
328			C Penetrating SW radiation
329	jmc	1.31	c IF ( usePenetratingSW ) THEN
330			swfracb(1)=abs(rF(klev))
331			swfracb(2)=abs(rF(klev+1))
332			CALL SWFRAC(
333	jmc	1.42	I two, minusone,
334			U swfracb,
335			I myTime, 1, myThid )
336	jmc	1.31	kp1 = klev+1
337			IF (klev.EQ.Nr) THEN
338	jmc	1.24	kp1 = klev
339			swfracb(2)=0. _d 0
340	jmc	1.31	ENDIF
341			DO j=1,sNy
342			DO i=1,sNx
343			gT(i,j,klev,bi,bj) = gT(i,j,klev,bi,bj)
344	jmc	1.24	& -Qsw(i,j,bi,bj)(swfracb(1)maskC(i,j,klev,bi,bj)
345			& -swfracb(2)*maskC(i,j,kp1, bi,bj))
346	jmc	1.27	& recip_Cprecip_rhoConst
347	heimbach	1.38	& recip_drF(klev)_recip_hFacC(i,j,kLev,bi,bj)
348	jmc	1.31	ENDDO
349	adcroft	1.5	ENDDO
350	jmc	1.31	c ENDIF
351	adcroft	1.5	#endif
352	heimbach	1.14
353	stephd	1.35	#ifdef ALLOW_RBCS
354			if (useRBCS) then
355			call RBCS_ADD_TENDENCY(bi,bj,klev, 1,
356			& myTime, myThid )
357			endif
358			#endif
359
360	jmc	1.31	#ifdef ALLOW_OBCS
361	heimbach	1.16	IF (useOBCS) THEN
362			CALL OBCS_SPONGE_T(
363	jmc	1.31	I iMin,iMax, jMin,jMax, bi,bj, kLev,
364			I myTime, myThid )
365	heimbach	1.16	ENDIF
366	heimbach	1.14	#endif
367
368	cnh	1.1	RETURN
369			END
370	jmc	1.31
371			C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|
372	cnh	1.13	CBOP
373			C !ROUTINE: EXTERNAL_FORCING_S
374			C !INTERFACE:
375	cnh	1.1	SUBROUTINE EXTERNAL_FORCING_S(
376	jmc	1.31	I iMin,iMax, jMin,jMax, bi,bj, kLev,
377			I myTime, myThid )
378	cnh	1.13
379			C !DESCRIPTION: \bv
380			C ==========================================================
381	jmc	1.31	C \| S/R EXTERNAL_FORCING_S
382			C \| o Contains problem specific forcing for merid velocity.
383	cnh	1.13	C ==========================================================
384	jmc	1.31	C \| Adds terms to gS for forcing by external sources
385			C \| e.g. fresh-water flux, climatalogical relaxation, etc ...
386	cnh	1.13	C ==========================================================
387			C \ev
388
389			C !USES:
390	cnh	1.2	IMPLICIT NONE
391	cnh	1.1	C == Global data ==
392			#include "SIZE.h"
393			#include "EEPARAMS.h"
394			#include "PARAMS.h"
395			#include "GRID.h"
396			#include "DYNVARS.h"
397	cnh	1.2	#include "FFIELDS.h"
398	dfer	1.40	#include "SURFACE.h"
399	dimitri	1.43	#ifdef ALLOW_SALT_PLUME
400			#ifdef ALLOW_SEAICE
401	dimitri	1.44	#include "SEAICE_PARAMS.h"
402	dimitri	1.43	#endif /* ALLOW_SEAICE */
403			#endif /* ALLOW_SALT_PLUME */
404	cnh	1.1
405	cnh	1.13	C !INPUT/OUTPUT PARAMETERS:
406	cnh	1.1	C == Routine arguments ==
407	jmc	1.31	C iMin,iMax :: Working range of x-index for applying forcing.
408			C jMin,jMax :: Working range of y-index for applying forcing.
409			C bi,bj :: Current tile indices
410			C kLev :: Current vertical level index
411			C myTime :: Current time in simulation
412			C myThid :: Thread Id number
413	cnh	1.1	INTEGER iMin, iMax, jMin, jMax, kLev, bi, bj
414	jmc	1.31	_RL myTime
415	adcroft	1.4	INTEGER myThid
416	cnh	1.2
417	cnh	1.13	C !LOCAL VARIABLES:
418	cnh	1.2	C == Local variables ==
419	jmc	1.31	C i,j :: Loop counters
420			C kSurface :: index of surface layer
421			INTEGER i, j
422	mlosch	1.17	INTEGER kSurface
423	cnh	1.13	CEOP
424	dimitri	1.43	#ifdef ALLOW_SALT_PLUME
425	dimitri	1.44	_RL saltPlume
426	dimitri	1.43	#endif /* ALLOW_SALT_PLUME */
427	cnh	1.2
428	jmc	1.28	IF ( fluidIsAir ) THEN
429	jmc	1.21	kSurface = 0
430	jmc	1.28	ELSEIF ( usingPCoords ) THEN
431	mlosch	1.17	kSurface = Nr
432	jmc	1.28	ELSE
433	mlosch	1.17	kSurface = 1
434	jmc	1.28	ENDIF
435	mlosch	1.17
436	cnh	1.2	C-- Forcing term
437	jmc	1.21	#ifdef ALLOW_AIM
438			IF ( useAIM ) CALL AIM_TENDENCY_APPLY_S(
439			& iMin,iMax, jMin,jMax, bi,bj, kLev,
440	jmc	1.31	& myTime, myThid )
441	jmc	1.21	#endif /* ALLOW_AIM */
442
443	molod	1.23	#ifdef ALLOW_FIZHI
444			IF ( useFIZHI ) CALL FIZHI_TENDENCY_APPLY_S(
445			& iMin,iMax, jMin,jMax, bi,bj, kLev,
446	jmc	1.31	& myTime, myThid )
447	molod	1.23	#endif /* ALLOW_FIZHI */
448	heimbach	1.25
449	heimbach	1.39	#ifdef ALLOW_MYPACKAGE
450			IF ( useMYPACKAGE ) CALL MYPACKAGE_TENDENCY_APPLY_S(
451			& iMin,iMax, jMin,jMax, bi,bj, kLev,
452			& myTime, myThid )
453			#endif /* ALLOW_MYPACKAGE */
454
455	cnh	1.2	C Add fresh-water in top-layer
456	mlosch	1.17	IF ( kLev .EQ. kSurface ) THEN
457	jmc	1.31	DO j=1,sNy
458			DO i=1,sNx
459	cnh	1.2	gS(i,j,kLev,bi,bj)=gS(i,j,kLev,bi,bj)
460	jmc	1.26	& +surfaceForcingS(i,j,bi,bj)
461	heimbach	1.38	& recip_drF(kLev)_recip_hFacC(i,j,kLev,bi,bj)
462	cnh	1.2	ENDDO
463			ENDDO
464			ENDIF
465	heimbach	1.14
466	dfer	1.41	#ifndef ALLOW_AUTODIFF_TAMC
467	dfer	1.40	IF (linFSConserveTr) THEN
468			DO j=1,sNy
469			DO i=1,sNx
470			IF (kLev .EQ. ksurfC(i,j,bi,bj)) THEN
471			gS(i,j,kLev,bi,bj)=gS(i,j,kLev,bi,bj)
472			& +SsurfCorrecip_drF(kLev)_recip_hFacC(i,j,kLev,bi,bj)
473			ENDIF
474			ENDDO
475			ENDDO
476			ENDIF
477	dfer	1.41	#endif /* ndfef ALLOW_AUTODIFF_TAMC */
478	dfer	1.40
479	mlosch	1.37	#ifdef ALLOW_SHELFICE
480			IF ( useShelfIce )
481			& CALL SHELFICE_FORCING_S(
482			I iMin,iMax, jMin,jMax, bi,bj, kLev,
483			I myTime, myThid )
484			#endif /* ALLOW_SHELFICE */
485
486	dimitri	1.43	#ifdef ALLOW_SALT_PLUME
487			C saltPlume is the amount of salt rejected by ice while freezing;
488			C it is here redistributed to multiple vertical levels as per
489			C Duffy et al. (GRL 1999)
490			DO j=1,sNy
491			DO i=1,sNx
492			saltPlume = 0.
493			#ifdef ALLOW_SEAICE
494			IF ( saltFlux(i,j,bi,bj) .GT. 0. .AND.
495	dimitri	1.44	& salt(i,j,kSurface,bi,bj) .GT. SEAICE_salinity ) THEN
496			saltPlume = (salt(i,j,kSurface,bi,bj)-SEAICE_salinity) *
497			& saltFlux(i,j,bi,bj) / salt(i,j,kSurface,bi,bj)
498	dimitri	1.43	ENDIF
499			#endif /* ALLOW_SEAICE */
500			IF ( SaltPlumeDepth(i,j,bi,bj) .GT. -rF(kLev) ) THEN
501			gS(i,j,kLev,bi,bj)=gS(i,j,kLev,bi,bj)
502			& +saltPlumehoriVertRatiorecip_rhoConst
503			& recip_drF(kLev)_recip_hFacC(i,j,kLev,bi,bj)
504			& *max(drF(kLev),SaltPlumeDepth(i,j,bi,bj)+rF(kLev))
505			& /SaltPlumeDepth(i,j,bi,bj)
506	dimitri	1.44	ENDIF
507	dimitri	1.43	ENDDO
508			ENDDO
509			#endif /* ALLOW_SALT_PLUME */
510
511	stephd	1.35	#ifdef ALLOW_RBCS
512			if (useRBCS) then
513			call RBCS_ADD_TENDENCY(bi,bj,klev, 2,
514			& myTime, myThid )
515			endif
516	dimitri	1.43	#endif /* ALLOW_RBCS */
517	stephd	1.35
518	jmc	1.31	#ifdef ALLOW_OBCS
519	heimbach	1.16	IF (useOBCS) THEN
520			CALL OBCS_SPONGE_S(
521	jmc	1.31	I iMin,iMax, jMin,jMax, bi,bj, kLev,
522			I myTime, myThid )
523	heimbach	1.16	ENDIF
524	dimitri	1.43	#endif /* ALLOW_OBCS */
525	cnh	1.1
526			RETURN
527			END