[911] | 1 | MODULE bdydyn |
---|
[1125] | 2 | !!====================================================================== |
---|
[911] | 3 | !! *** MODULE bdydyn *** |
---|
[3294] | 4 | !! Unstructured Open Boundary Cond. : Apply boundary conditions to velocities |
---|
[1125] | 5 | !!====================================================================== |
---|
| 6 | !! History : 1.0 ! 2005-02 (J. Chanut, A. Sellar) Original code |
---|
| 7 | !! - ! 2007-07 (D. Storkey) Move Flather implementation to separate routine. |
---|
| 8 | !! 3.0 ! 2008-04 (NEMO team) add in the reference version |
---|
[1502] | 9 | !! 3.2 ! 2008-04 (R. Benshila) consider velocity instead of transport |
---|
[2528] | 10 | !! 3.3 ! 2010-09 (E.O'Dea) modifications for Shelf configurations |
---|
| 11 | !! 3.3 ! 2010-09 (D.Storkey) add ice boundary conditions |
---|
[3294] | 12 | !! 3.4 ! 2011 (D. Storkey) rewrite in preparation for OBC-BDY merge |
---|
[1125] | 13 | !!---------------------------------------------------------------------- |
---|
| 14 | #if defined key_bdy |
---|
| 15 | !!---------------------------------------------------------------------- |
---|
| 16 | !! 'key_bdy' : Unstructured Open Boundary Condition |
---|
| 17 | !!---------------------------------------------------------------------- |
---|
[3294] | 18 | !! bdy_dyn : split velocities into barotropic and baroclinic parts |
---|
| 19 | !! and call bdy_dyn2d and bdy_dyn3d to apply boundary |
---|
| 20 | !! conditions |
---|
[1125] | 21 | !!---------------------------------------------------------------------- |
---|
[3294] | 22 | USE wrk_nemo ! Memory Allocation |
---|
| 23 | USE timing ! Timing |
---|
[911] | 24 | USE oce ! ocean dynamics and tracers |
---|
| 25 | USE dom_oce ! ocean space and time domain |
---|
| 26 | USE bdy_oce ! ocean open boundary conditions |
---|
[3294] | 27 | USE bdydyn2d ! open boundary conditions for barotropic solution |
---|
| 28 | USE bdydyn3d ! open boundary conditions for baroclinic velocities |
---|
[911] | 29 | USE lbclnk ! ocean lateral boundary conditions (or mpp link) |
---|
[1125] | 30 | USE in_out_manager ! |
---|
[5034] | 31 | USE domvvl ! variable volume |
---|
[911] | 32 | |
---|
| 33 | IMPLICIT NONE |
---|
| 34 | PRIVATE |
---|
| 35 | |
---|
[6043] | 36 | PUBLIC bdy_dyn ! routine called in dyn_nxt |
---|
[911] | 37 | |
---|
[3294] | 38 | # include "domzgr_substitute.h90" |
---|
[1125] | 39 | !!---------------------------------------------------------------------- |
---|
[2528] | 40 | !! NEMO/OPA 3.3 , NEMO Consortium (2010) |
---|
[1146] | 41 | !! $Id$ |
---|
[2528] | 42 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
---|
[1125] | 43 | !!---------------------------------------------------------------------- |
---|
[911] | 44 | CONTAINS |
---|
| 45 | |
---|
[3294] | 46 | SUBROUTINE bdy_dyn( kt, dyn3d_only ) |
---|
[1125] | 47 | !!---------------------------------------------------------------------- |
---|
[3294] | 48 | !! *** SUBROUTINE bdy_dyn *** |
---|
[1125] | 49 | !! |
---|
[3294] | 50 | !! ** Purpose : - Wrapper routine for bdy_dyn2d and bdy_dyn3d. |
---|
[911] | 51 | !! |
---|
[1125] | 52 | !!---------------------------------------------------------------------- |
---|
[911] | 53 | !! |
---|
[3294] | 54 | INTEGER, INTENT( in ) :: kt ! Main time step counter |
---|
| 55 | LOGICAL, INTENT( in ), OPTIONAL :: dyn3d_only ! T => only update baroclinic velocities |
---|
| 56 | !! |
---|
[4292] | 57 | INTEGER :: jk,ii,ij,ib_bdy,ib,igrd ! Loop counter |
---|
| 58 | LOGICAL :: ll_dyn2d, ll_dyn3d, ll_orlanski |
---|
[3294] | 59 | !! |
---|
[4354] | 60 | REAL(wp), POINTER, DIMENSION(:,:) :: pua2d, pva2d ! after barotropic velocities |
---|
[911] | 61 | |
---|
[3294] | 62 | IF( nn_timing == 1 ) CALL timing_start('bdy_dyn') |
---|
[911] | 63 | |
---|
[3294] | 64 | ll_dyn2d = .true. |
---|
| 65 | ll_dyn3d = .true. |
---|
[2528] | 66 | |
---|
[3294] | 67 | IF( PRESENT(dyn3d_only) ) THEN |
---|
| 68 | IF( dyn3d_only ) ll_dyn2d = .false. |
---|
| 69 | ENDIF |
---|
[1502] | 70 | |
---|
[4292] | 71 | ll_orlanski = .false. |
---|
| 72 | DO ib_bdy = 1, nb_bdy |
---|
| 73 | IF ( cn_dyn2d(ib_bdy) == 'orlanski' .or. cn_dyn2d(ib_bdy) == 'orlanski_npo' & |
---|
| 74 | & .or. cn_dyn3d(ib_bdy) == 'orlanski' .or. cn_dyn3d(ib_bdy) == 'orlanski_npo') ll_orlanski = .true. |
---|
| 75 | ENDDO |
---|
| 76 | |
---|
[3294] | 77 | !------------------------------------------------------- |
---|
| 78 | ! Set pointers |
---|
| 79 | !------------------------------------------------------- |
---|
[911] | 80 | |
---|
[4370] | 81 | CALL wrk_alloc(jpi,jpj,pua2d,pva2d) |
---|
[1125] | 82 | |
---|
[3294] | 83 | !------------------------------------------------------- |
---|
| 84 | ! Split velocities into barotropic and baroclinic parts |
---|
| 85 | !------------------------------------------------------- |
---|
[911] | 86 | |
---|
[4292] | 87 | ! "After" velocities: |
---|
| 88 | |
---|
| 89 | pua2d(:,:) = 0.e0 |
---|
[4370] | 90 | pva2d(:,:) = 0.e0 |
---|
| 91 | DO jk = 1, jpkm1 |
---|
| 92 | pua2d(:,:) = pua2d(:,:) + fse3u_a(:,:,jk) * umask(:,:,jk) * ua(:,:,jk) |
---|
| 93 | pva2d(:,:) = pva2d(:,:) + fse3v_a(:,:,jk) * vmask(:,:,jk) * va(:,:,jk) |
---|
| 94 | END DO |
---|
[4292] | 95 | |
---|
[4370] | 96 | pua2d(:,:) = pua2d(:,:) * hur_a(:,:) |
---|
| 97 | pva2d(:,:) = pva2d(:,:) * hvr_a(:,:) |
---|
| 98 | |
---|
[3294] | 99 | DO jk = 1 , jpkm1 |
---|
[4317] | 100 | ua(:,:,jk) = (ua(:,:,jk) - pua2d(:,:)) * umask(:,:,jk) |
---|
| 101 | va(:,:,jk) = (va(:,:,jk) - pva2d(:,:)) * vmask(:,:,jk) |
---|
[3294] | 102 | END DO |
---|
| 103 | |
---|
[4292] | 104 | ! "Before" velocities (required for Orlanski condition): |
---|
| 105 | |
---|
| 106 | IF ( ll_orlanski ) THEN |
---|
| 107 | DO jk = 1 , jpkm1 |
---|
[4354] | 108 | ub(:,:,jk) = (ub(:,:,jk) - ub_b(:,:)) * umask(:,:,jk) |
---|
| 109 | vb(:,:,jk) = (vb(:,:,jk) - vb_b(:,:)) * vmask(:,:,jk) |
---|
[4292] | 110 | END DO |
---|
| 111 | END IF |
---|
| 112 | |
---|
[3294] | 113 | !------------------------------------------------------- |
---|
| 114 | ! Apply boundary conditions to barotropic and baroclinic |
---|
| 115 | ! parts separately |
---|
| 116 | !------------------------------------------------------- |
---|
| 117 | |
---|
[4370] | 118 | IF( ll_dyn2d ) CALL bdy_dyn2d( kt, pua2d, pva2d, ub_b, vb_b, hur_a(:,:), hvr_a(:,:), ssha ) |
---|
[3294] | 119 | |
---|
| 120 | IF( ll_dyn3d ) CALL bdy_dyn3d( kt ) |
---|
| 121 | |
---|
| 122 | !------------------------------------------------------- |
---|
| 123 | ! Recombine velocities |
---|
| 124 | !------------------------------------------------------- |
---|
| 125 | |
---|
| 126 | DO jk = 1 , jpkm1 |
---|
[4292] | 127 | ua(:,:,jk) = ( ua(:,:,jk) + pua2d(:,:) ) * umask(:,:,jk) |
---|
| 128 | va(:,:,jk) = ( va(:,:,jk) + pva2d(:,:) ) * vmask(:,:,jk) |
---|
[3294] | 129 | END DO |
---|
| 130 | |
---|
[4292] | 131 | IF ( ll_orlanski ) THEN |
---|
| 132 | DO jk = 1 , jpkm1 |
---|
[4354] | 133 | ub(:,:,jk) = ( ub(:,:,jk) + ub_b(:,:) ) * umask(:,:,jk) |
---|
| 134 | vb(:,:,jk) = ( vb(:,:,jk) + vb_b(:,:) ) * vmask(:,:,jk) |
---|
[4292] | 135 | END DO |
---|
| 136 | END IF |
---|
[3294] | 137 | |
---|
[4370] | 138 | CALL wrk_dealloc(jpi,jpj,pua2d,pva2d) |
---|
[4292] | 139 | |
---|
[3294] | 140 | IF( nn_timing == 1 ) CALL timing_stop('bdy_dyn') |
---|
| 141 | |
---|
| 142 | END SUBROUTINE bdy_dyn |
---|
| 143 | |
---|
[911] | 144 | #else |
---|
[1125] | 145 | !!---------------------------------------------------------------------- |
---|
| 146 | !! Dummy module NO Unstruct Open Boundary Conditions |
---|
| 147 | !!---------------------------------------------------------------------- |
---|
[911] | 148 | CONTAINS |
---|
[3294] | 149 | SUBROUTINE bdy_dyn( kt ) ! Empty routine |
---|
| 150 | WRITE(*,*) 'bdy_dyn: You should not have seen this print! error?', kt |
---|
| 151 | END SUBROUTINE bdy_dyn |
---|
[911] | 152 | #endif |
---|
| 153 | |
---|
[1125] | 154 | !!====================================================================== |
---|
[911] | 155 | END MODULE bdydyn |
---|