source: NEMO/branches/2019/dev_r10721_KERNEL-02_Storkey_Coward_IMMERSE_first_steps/src/OCE/FLO/floats.F90 @ 10970

Last change on this file since 10970 was 10970, checked in by davestorkey, 2 years ago

2019/dev_r10721_KERNEL-02_Storkey_Coward_IMMERSE_first_steps : CRS and FLO. Only tested compilation. Note that base code doesn't compile with key_floats (#2279), so changes to FLO not really tested at all.

  • Property svn:keywords set to Id
File size: 7.5 KB
Line 
1MODULE floats
2   !!======================================================================
3   !!                       ***  MODULE  floats  ***
4   !! Ocean floats : floats
5   !!======================================================================
6   !! History :  OPA  !          (CLIPPER)   original Code
7   !!   NEMO     1.0  ! 2002-06  (A. Bozec)  F90, Free form and module
8   !!----------------------------------------------------------------------
9#if   defined   key_floats
10   !!----------------------------------------------------------------------
11   !!   'key_floats'                                     float trajectories
12   !!----------------------------------------------------------------------
13   !!   flo_stp   : float trajectories computation
14   !!   flo_init  : initialization of float trajectories computation
15   !!----------------------------------------------------------------------
16   USE oce             ! ocean variables
17   USE flo_oce         ! floats variables
18   USE lib_mpp         ! distributed memory computing
19   USE flodom          ! initialisation Module
20   USE flowri          ! float output                     (flo_wri routine)
21   USE florst          ! float restart                    (flo_rst routine)
22   USE flo4rk          ! Trajectories, Runge Kutta scheme (flo_4rk routine)
23   USE floblk          ! Trajectories, Blanke scheme      (flo_blk routine)
24   !
25   USE in_out_manager  ! I/O manager
26   USE timing          ! preformance summary
27
28   IMPLICIT NONE
29   PRIVATE 
30
31   PUBLIC   flo_stp    ! routine called by step.F90
32   PUBLIC   flo_init   ! routine called by opa.F90
33
34   !!----------------------------------------------------------------------
35   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
36   !! $Id$
37   !! Software governed by the CeCILL license (see ./LICENSE)
38   !!----------------------------------------------------------------------
39CONTAINS
40
41   SUBROUTINE flo_stp( kt, Kbb, Kmm )
42      !!----------------------------------------------------------------------
43      !!                   ***  ROUTINE flo_stp  ***
44      !!                   
45      !! ** Purpose :   Compute the geographical position (lat., long., depth)
46      !!      of each float at each time step with one of the algorithm.
47      !!
48      !! ** Method  :   The position of a float is computed with Bruno Blanke
49      !!        algorithm by default and with a 4th order Runge-Kutta scheme
50      !!        if ln_flork4 =T
51      !!----------------------------------------------------------------------
52      INTEGER, INTENT( in  ) ::   kt        ! ocean time step
53      INTEGER, INTENT( in  ) ::   Kbb, Kmm  ! ocean time level indices
54      !!----------------------------------------------------------------------
55      !
56      IF( ln_timing )   CALL timing_start('flo_stp')
57      !
58      IF( ln_flork4 ) THEN   ;   CALL flo_4rk( kt, Kbb, Kmm )  ! Trajectories using a 4th order Runge Kutta scheme
59      ELSE                   ;   CALL flo_blk( kt, Kbb, Kmm )  ! Trajectories using Blanke' algorithme
60      ENDIF
61      !
62      IF( lk_mpp )   CALL mppsync   ! synchronization of all the processor
63      !
64      CALL flo_wri( kt, Kmm ) ! trajectories ouput
65      !
66      CALL flo_rst( kt )      ! trajectories restart
67      !
68      wb(:,:,:) = ww(:,:,:)         ! Save the old vertical velocity field
69      !
70      IF( ln_timing )   CALL timing_stop('flo_stp')
71      !
72   END SUBROUTINE flo_stp
73
74
75   SUBROUTINE flo_init( Kmm )
76      !!----------------------------------------------------------------
77      !!                 ***  ROUTINE flo_init  ***
78      !!                   
79      !! ** Purpose :   Read the namelist of floats
80      !!----------------------------------------------------------------------
81      INTEGER, INTENT(in) :: Kmm       ! ocean time level index
82      !
83      INTEGER ::   jfl
84      INTEGER ::   ios                 ! Local integer output status for namelist read
85      !
86      NAMELIST/namflo/ jpnfl, jpnnewflo, ln_rstflo, nn_writefl, nn_stockfl, ln_argo, ln_flork4, ln_ariane, ln_flo_ascii
87      !!---------------------------------------------------------------------
88      !
89      IF(lwp) WRITE(numout,*)
90      IF(lwp) WRITE(numout,*) 'flo_stp : call floats routine '
91      IF(lwp) WRITE(numout,*) '~~~~~~~'
92
93      REWIND( numnam_ref )              ! Namelist namflo in reference namelist : Floats
94      READ  ( numnam_ref, namflo, IOSTAT = ios, ERR = 901)
95901   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namflo in reference namelist', lwp )
96
97      REWIND( numnam_cfg )              ! Namelist namflo in configuration namelist : Floats
98      READ  ( numnam_cfg, namflo, IOSTAT = ios, ERR = 902 )
99902   IF( ios >  0 )   CALL ctl_nam ( ios , 'namflo in configuration namelist', lwp )
100      IF(lwm) WRITE ( numond, namflo )
101      !
102      IF(lwp) THEN                  ! control print
103         WRITE(numout,*)
104         WRITE(numout,*) '         Namelist floats :'
105         WRITE(numout,*) '            number of floats                      jpnfl        = ', jpnfl
106         WRITE(numout,*) '            number of new floats                  jpnflnewflo  = ', jpnnewflo
107         WRITE(numout,*) '            restart                               ln_rstflo    = ', ln_rstflo
108         WRITE(numout,*) '            frequency of float output file        nn_writefl   = ', nn_writefl
109         WRITE(numout,*) '            frequency of float restart file       nn_stockfl   = ', nn_stockfl
110         WRITE(numout,*) '            Argo type floats                      ln_argo      = ', ln_argo
111         WRITE(numout,*) '            Computation of T trajectories         ln_flork4    = ', ln_flork4
112         WRITE(numout,*) '            Use of ariane convention              ln_ariane    = ', ln_ariane
113         WRITE(numout,*) '            ascii output (T) or netcdf output (F) ln_flo_ascii = ', ln_flo_ascii
114
115      ENDIF
116      !
117      !                             ! allocate floats arrays
118      IF( flo_oce_alloc() /= 0 )   CALL ctl_stop( 'STOP', 'flo_init : unable to allocate arrays' )
119      !
120      !                             ! allocate flodom arrays
121      IF( flo_dom_alloc() /= 0 )   CALL ctl_stop( 'STOP', 'flo_dom : unable to allocate arrays' )
122      !
123      !                             ! allocate flowri arrays
124      IF( flo_wri_alloc() /= 0 )   CALL ctl_stop( 'STOP', 'flo_wri : unable to allocate arrays' )
125      !
126      !                             ! allocate florst arrays
127      IF( flo_rst_alloc() /= 0 )   CALL ctl_stop( 'STOP', 'flo_rst : unable to allocate arrays' )
128      !
129      jpnrstflo = jpnfl-jpnnewflo   ! memory allocation
130      !
131      DO jfl = 1, jpnfl             ! vertical axe for netcdf IOM ouput
132         nfloat(jfl) = jfl 
133      END DO
134      !
135      CALL flo_dom( Kmm )           ! compute/read initial position of floats
136      !
137      wb(:,:,:) = ww(:,:,:)         ! set wb for computation of floats trajectories at the first time step
138      !
139   END SUBROUTINE flo_init
140
141#  else
142   !!----------------------------------------------------------------------
143   !!   Default option :                                       Empty module
144   !!----------------------------------------------------------------------
145CONTAINS
146   SUBROUTINE flo_stp( kt, Kbb, Kmm )  ! Empty routine
147      IMPLICIT NONE
148      INTEGER, INTENT( in ) :: kt
149      INTEGER, INTENT( in ) :: Kbb, Kmm
150      WRITE(*,*) 'flo_stp: You should not have seen this print! error?', kt
151   END SUBROUTINE flo_stp
152   SUBROUTINE flo_init( Kmm )          ! Empty routine
153      IMPLICIT NONE
154      INTEGER, INTENT( in ) :: Kmm
155   END SUBROUTINE flo_init
156#endif
157
158   !!======================================================================
159 END MODULE floats
Note: See TracBrowser for help on using the repository browser.