| 1 | MODULE dynspg_exp |
|---|
| 2 | !!====================================================================== |
|---|
| 3 | !! *** MODULE dynspg_exp *** |
|---|
| 4 | !! Ocean dynamics: surface pressure gradient trend |
|---|
| 5 | !!====================================================================== |
|---|
| 6 | !! History : 2.0 ! 2005-11 (V. Garnier, G. Madec, L. Bessieres) Original code |
|---|
| 7 | !! 3.2 ! 2009-06 (G. Madec, M. Leclair, R. Benshila) introduce sshwzv module |
|---|
| 8 | !!---------------------------------------------------------------------- |
|---|
| 9 | #if defined key_dynspg_exp || defined key_esopa |
|---|
| 10 | !!---------------------------------------------------------------------- |
|---|
| 11 | !! 'key_dynspg_exp' explicit free surface |
|---|
| 12 | !!---------------------------------------------------------------------- |
|---|
| 13 | !! dyn_spg_exp : update the momentum trend with the surface |
|---|
| 14 | !! pressure gradient in the free surface constant |
|---|
| 15 | !! volume case with vector optimization |
|---|
| 16 | !!---------------------------------------------------------------------- |
|---|
| 17 | USE oce ! ocean dynamics and tracers |
|---|
| 18 | USE dom_oce ! ocean space and time domain |
|---|
| 19 | USE sbc_oce ! surface boundary condition: ocean |
|---|
| 20 | USE phycst ! physical constants |
|---|
| 21 | USE in_out_manager ! I/O manager |
|---|
| 22 | USE lib_mpp ! distributed memory computing library |
|---|
| 23 | USE lbclnk ! ocean lateral boundary conditions (or mpp link) |
|---|
| 24 | USE prtctl ! Print control |
|---|
| 25 | USE iom ! I/O library |
|---|
| 26 | USE timing ! Timing |
|---|
| 27 | |
|---|
| 28 | IMPLICIT NONE |
|---|
| 29 | PRIVATE |
|---|
| 30 | |
|---|
| 31 | PUBLIC dyn_spg_exp ! routine called by step.F90 |
|---|
| 32 | |
|---|
| 33 | !! * Substitutions |
|---|
| 34 | # include "domzgr_substitute.h90" |
|---|
| 35 | # include "vectopt_loop_substitute.h90" |
|---|
| 36 | !!---------------------------------------------------------------------- |
|---|
| 37 | !! NEMO/OPA 3.3 , NEMO Consortium (2010) |
|---|
| 38 | !! $Id$ |
|---|
| 39 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
|---|
| 40 | !!---------------------------------------------------------------------- |
|---|
| 41 | CONTAINS |
|---|
| 42 | |
|---|
| 43 | SUBROUTINE dyn_spg_exp( kt ) |
|---|
| 44 | !!---------------------------------------------------------------------- |
|---|
| 45 | !! *** routine dyn_spg_exp *** |
|---|
| 46 | !! |
|---|
| 47 | !! ** Purpose : Compute the now trend due to the surface pressure |
|---|
| 48 | !! gradient in case of explicit free surface formulation and |
|---|
| 49 | !! add it to the general trend of momentum equation. |
|---|
| 50 | !! |
|---|
| 51 | !! ** Method : Explicit free surface formulation. Add to the general |
|---|
| 52 | !! momentum trend the surface pressure gradient : |
|---|
| 53 | !! (ua,va) = (ua,va) + (spgu,spgv) |
|---|
| 54 | !! where spgu = -1/rau0 d/dx(ps) = -g/e1u di( sshn ) |
|---|
| 55 | !! spgv = -1/rau0 d/dy(ps) = -g/e2v dj( sshn ) |
|---|
| 56 | !! |
|---|
| 57 | !! ** Action : (ua,va) trend of horizontal velocity increased by |
|---|
| 58 | !! the surf. pressure gradient trend |
|---|
| 59 | !!--------------------------------------------------------------------- |
|---|
| 60 | INTEGER, INTENT(in) :: kt ! ocean time-step index |
|---|
| 61 | !! |
|---|
| 62 | INTEGER :: ji, jj, jk ! dummy loop indices |
|---|
| 63 | !!---------------------------------------------------------------------- |
|---|
| 64 | ! |
|---|
| 65 | IF( nn_timing == 1 ) CALL timing_start('dyn_spg_exp') |
|---|
| 66 | ! |
|---|
| 67 | IF( kt == nit000 ) THEN |
|---|
| 68 | IF(lwp) WRITE(numout,*) |
|---|
| 69 | IF(lwp) WRITE(numout,*) 'dyn_spg_exp : surface pressure gradient trend' |
|---|
| 70 | IF(lwp) WRITE(numout,*) '~~~~~~~~~~~ (explicit free surface)' |
|---|
| 71 | ! |
|---|
| 72 | spgu(:,:) = 0._wp ; spgv(:,:) = 0._wp |
|---|
| 73 | ! |
|---|
| 74 | IF( lk_vvl .AND. lwp ) WRITE(numout,*) ' lk_vvl=T : spg is included in dynhpg' |
|---|
| 75 | ENDIF |
|---|
| 76 | |
|---|
| 77 | IF( .NOT. lk_vvl ) THEN !* fixed volume : add the surface pressure gradient trend |
|---|
| 78 | ! |
|---|
| 79 | DO jj = 2, jpjm1 ! now surface pressure gradient |
|---|
| 80 | DO ji = fs_2, fs_jpim1 ! vector opt. |
|---|
| 81 | spgu(ji,jj) = - grav * ( sshn(ji+1,jj) - sshn(ji,jj) ) * r1_e1u(ji,jj) |
|---|
| 82 | spgv(ji,jj) = - grav * ( sshn(ji,jj+1) - sshn(ji,jj) ) * r1_e2v(ji,jj) |
|---|
| 83 | END DO |
|---|
| 84 | END DO |
|---|
| 85 | ! |
|---|
| 86 | DO jk = 1, jpkm1 ! Add it to the general trend |
|---|
| 87 | DO jj = 2, jpjm1 |
|---|
| 88 | DO ji = fs_2, fs_jpim1 ! vector opt. |
|---|
| 89 | ua(ji,jj,jk) = ua(ji,jj,jk) + spgu(ji,jj) |
|---|
| 90 | va(ji,jj,jk) = va(ji,jj,jk) + spgv(ji,jj) |
|---|
| 91 | END DO |
|---|
| 92 | END DO |
|---|
| 93 | END DO |
|---|
| 94 | ! |
|---|
| 95 | ENDIF |
|---|
| 96 | ! |
|---|
| 97 | IF( nn_timing == 1 ) CALL timing_stop('dyn_spg_exp') |
|---|
| 98 | ! |
|---|
| 99 | END SUBROUTINE dyn_spg_exp |
|---|
| 100 | |
|---|
| 101 | #else |
|---|
| 102 | !!---------------------------------------------------------------------- |
|---|
| 103 | !! Default case : Empty module No standart explicit free surface |
|---|
| 104 | !!---------------------------------------------------------------------- |
|---|
| 105 | CONTAINS |
|---|
| 106 | SUBROUTINE dyn_spg_exp( kt ) ! Empty routine |
|---|
| 107 | WRITE(*,*) 'dyn_spg_exp: You should not have seen this print! error?', kt |
|---|
| 108 | END SUBROUTINE dyn_spg_exp |
|---|
| 109 | #endif |
|---|
| 110 | |
|---|
| 111 | !!====================================================================== |
|---|
| 112 | END MODULE dynspg_exp |
|---|
