/[MITgcm]/MITgcm/pkg/flt/FLT.h
ViewVC logotype

Diff of /MITgcm/pkg/flt/FLT.h

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.1 by adcroft, Thu Sep 13 17:43:55 2001 UTC revision 1.2 by jmc, Thu Jan 8 19:40:41 2009 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C $Name$  C $Name$
3    
4  c     ==================================================================  C     ==================================================================
5  c     HEADER flt  C     HEADER flt
6  c     ==================================================================  C     ==================================================================
7  c  C
8  c     o This header file contains variables that are used by the  C     o This header file contains variables that are used by the
9  c       flt package.  C       flt package.
10  c  C
11  c     ==================================================================  C     ==================================================================
12  c     HEADER flt  C     HEADER flt
13  c     ==================================================================  C     ==================================================================
14  c  
15  c  C== Size ==
16  c     max_npart       - total number of floats  
17  c                       (this is read from the input files)  C     max_npart_tile :: maximum number of floats on a tile
18  c  C                       normally npart_tile < max_npart, but could be the same
19        _RL   max_npart  C                       for safety
20        common /flt_n/ max_npart  C     max_npart_exch :: maximum number of floats on a tile that can be
21    C                       exchanged at one time
22    C                       normally max_npart_exch < max_npart_tile,
23    C                       but could be the same for safety
24    C
25          INTEGER max_npart_tile, max_npart_exch
26          PARAMETER (max_npart_tile = 300)
27          PARAMETER (max_npart_exch =  50)
28    
29    C== Constant ==
30    
31  c     max_npart_tile  - maximum number of floats on a tile  C     flt_surf    :: "surface" level of the floats.
32  c                       normally npart_tile < max_npart, but could be the same  C                    Can be deeper than 1, e.g. IF no mixed layer model is used
33  c                       for safety  C     flt_nan     :: qualifier for a float that is not yet released or that died
34  c     max_npart_exch  - maximum number of floats on a tile that can be        _RL flt_surf
35  c                       exchanged at one time        _RL flt_nan
36  c                       normally max_npart_exch < max_npart_tile,        PARAMETER (flt_surf = 1.)
37  c                       but could be the same for safety        PARAMETER (flt_nan = -999.)
 c  
       INTEGER max_npart_tile, max_npart_exch  
       parameter (max_npart_tile = 300)  
       parameter (max_npart_exch =  50)  
38    
39  c     npart_tile   - actual number of floats per tile  C     Full domain extension:
40  c  C     flt_xLo     :: Full domain lower X boundary
41    C     flt_xHi     :: Full domain upper X boundary
42    C     flt_yLo     :: Full domain lower Y boundary
43    C     flt_yHi     :: Full domain upper X boundary
44    C
45          _RL    flt_xLo, flt_xHi, flt_yLo, flt_yHi
46          COMMON / FLT_CONST_R /
47         &       flt_xLo, flt_xHi, flt_yLo, flt_yHi
48    
49    C== Parameters ==
50    
51    C     flt_noise   :: range of noise added to the velocity component
52    C                    (randomly). The noise can be added or subtracted,
53    C                    the range is +/- flt_noise/2
54    C    flt_int_traj :: period between storing model state at float position, in s
55    C    flt_int_prof :: period between float vertical profiles, in s
56    C
57    C    note:  flt_int_prof is the time between getting profiles, not the
58    C           the return  cycle of the float to the surface. The latter can
59    C           be specified individually for every float. Because the mechanism
60    C           for return ing to the surface is called in the profiling routine
61    C           flt_int_prof has to be the minimum of all iup(max_npart).
62    C           The subsampling of profiles can be done later in the analysis.
63    C
64          _RL flt_noise
65          _RL flt_int_traj, flt_int_prof
66          COMMON / FLT_PARAM_R /
67         &       flt_noise,
68         &       flt_int_traj, flt_int_prof
69    
70    C     flt_file    :: name of the file containing the initial positions.
71    C                    At initialization the program first looks for a
72    C                    global file flt_file.data. If that is not found it
73    C                    looks for tiled files flt_file.iG.jG.data.
74    C
75          CHARACTER*(MAX_LEN_FNAM) flt_file
76          COMMON / FLT_PARAM_C / flt_file
77    
78    C== Float State ==
79    
80    C     npart_tile  :: actual number of floats per tile
81    C
82        INTEGER npart_tile(nSx,nSy)        INTEGER npart_tile(nSx,nSy)
83        common /flt_t/ npart_tile        COMMON / FLT_STATE_I / npart_tile
84    
85  c     npart        - float identifier  C     max_npart   :: total number of floats
86  c     xpart        - x position of float (in units of XC)  C                    (this is read from the input files)
87  c     ypart        - y position of float (in units of YC)  C
88  c     kpart        - vertical level of float (might be decimal        _RL   max_npart
89  c                    number in case of 3D floats)        COMMON / FLT_STATE_R / max_npart
90  c     tstart       - start date of integration of float, in s.  
91  c                    Note: If tstart=-1 floats are integrated right from the  C     npart       :: float identifier
92  c                          beginning  C     tstart      :: start date of integration of float, in s.
93  c     tend         - end   date of integration of float, in s.  C                    Note: If tstart=-1 floats are integrated right from the
94  c                    Note: If tend=-1 floats are integrated till the end of  C                          beginning
95  c                          integration  C     tend        :: end date of integration of float, in s.
96  c     kfloat       - target depth of float.  C                    Note: If tend=-1 floats are integrated till the end of
97  c     iup          - flag if the float  C                          integration
98  c                    should profile   ( >  0 = return cycle, in s, to surface)  C     xpart       :: x position of float (in units of XC)
99  c                    remain at depth  ( =  0 )  C     ypart       :: y position of float (in units of YC)
100  c                    is a 3D float    ( = -1 ).  C     kpart       :: vertical level of float (might be decimal
101  c                    should be advected WITHOUT additional noise ( = -2 ).  C                    number in case of 3D floats)
102  c                    This implies that the float is non-profiling  C     kfloat      :: target depth of float.
103  c                    is a mooring     ( = -3 ), i.e. the float is not advected  C     iup         :: flag IF the float
104  c     itop         - time of float the surface, in s  C                    should profile   ( >  0 = RETURN  cycle, in s, to surface)
105  c  C                    remain at depth  ( =  0 )
106    C                    is a 3D float    ( = -1 )
107    C                    should be advected WITHOUT additional noise ( = -2 ).
108    C                    This implies that the float is non-profiling
109    C                    is a mooring     ( = -3 ), i.e. the float is not advected
110    C     itop        :: time of float the surface, in s
111        _RL     npart(max_npart_tile,nSx,nSy)        _RL     npart(max_npart_tile,nSx,nSy)
112        _RL    tstart(max_npart_tile,nSx,nSy)        _RL    tstart(max_npart_tile,nSx,nSy)
113        _RL      tend(max_npart_tile,nSx,nSy)        _RL      tend(max_npart_tile,nSx,nSy)
# Line 68  c Line 118  c
118        _RL       iup(max_npart_tile,nSx,nSy)        _RL       iup(max_npart_tile,nSx,nSy)
119        _RL      itop(max_npart_tile,nSx,nSy)        _RL      itop(max_npart_tile,nSx,nSy)
120    
121        common /flt_v/ npart,tstart,tend,xpart,ypart,kpart,kfloat,iup,itop        COMMON / FLT_STATE_VAR /
122         &       npart, tstart, tend,
123  c     flt_int_traj - period between storing model state at float position, in s       &       xpart, ypart, kpart,
124  c     flt_int_prof - period between float vertical profiles, in s       &       kfloat, iup, itop
 c  
 c     note: flt_int_prof is the time between getting profiles, NOT the  
 c           the return cycle of the float to the surface. The latter can  
 c           be specified individually for every float. Because the mechanism  
 c           for returning to the surface is called in the profiling routine  
 c           flt_int_prof has to be the minimum of all iup(max_npart).  
 c           The subsampling of profiles can be done later in the analysis.  
 c  
       _RL flt_int_traj, flt_int_prof  
       common /flt_param_i/ flt_int_traj, flt_int_prof  
   
 c      flt_surf - "surface" level of the floats.  
 c                  Can be deeper than 1, e.g. if no mixed layer model is used  
       _RL flt_surf  
       parameter (flt_surf = 1.)  
   
 c     flt_nan    - qualifier for a float that is not yet released or that died  
 c  
       _RL flt_nan  
       parameter (flt_nan = -999.)  
125    
126  c     flt_noise - range of noise added to the velocity component  C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
 c                 (randomly). The noise can be added or subtracted,  
 c                 the range is +/- flt_noise/2  
 c  
       _RL flt_noise  
       common /flt_param_n/ flt_noise  
   
 c     flt_file  - name of the file containing the initial/restart positions.  
 c                 At initialization the program first looks for a global  
 c                 file flt_file.data. If that is not found it looks  
 c                 for  flt_file.iG.jG.data. That is also written as a restart  
 c  
       CHARACTER*(MAX_LEN_FNAM) flt_file  
       common /flt_param_d/ flt_file  
Legend:
Removed from v.1.1  
changed lines
  Added in v.1.2
  ViewVC Help
Powered by ViewVC 1.1.22