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

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

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


Revision 1.6 - (show annotations) (download)
Wed Jan 12 19:00:52 2011 UTC (13 years, 4 months ago) by jmc
Branch: MAIN
CVS Tags: checkpoint62v, checkpoint62u, checkpoint62t, checkpoint62s, checkpoint62r, checkpoint62w, checkpoint62z, checkpoint62y, checkpoint62x, checkpoint63, checkpoint63a, checkpoint63b
Changes since 1.5: +7 -6 lines
File MIME type: text/plain
add run-time parameter to avoid initial position conversion to index map
 in tiled flt_file (initial condition).

1 C $Header: /u/gcmpack/MITgcm/pkg/flt/FLT.h,v 1.5 2010/12/22 21:25:18 jahn Exp $
2 C $Name: $
3
4 C ==================================================================
5 C HEADER flt
6 C ==================================================================
7 C
8 C o This header file contains variables that are used by the
9 C flt package.
10 C
11 C ==================================================================
12 C HEADER flt
13 C ==================================================================
14
15 C== Constant ==
16
17 C flt_surf :: "surface" level of the floats.
18 C Can be deeper than 1, e.g. IF no mixed layer model is used
19 C flt_nan :: qualifier for a float that is not yet released or that died
20 _RL flt_surf
21 _RL flt_nan
22 PARAMETER (flt_surf = 1.)
23 PARAMETER (flt_nan = -999.)
24
25 C Full domain extension:
26 C flt_xLo :: Full domain lower X boundary
27 C flt_xHi :: Full domain upper X boundary
28 C flt_yLo :: Full domain lower Y boundary
29 C flt_yHi :: Full domain upper Y boundary
30
31 _RL flt_xLo, flt_xHi, flt_yLo, flt_yHi
32 COMMON / FLT_CONST_R /
33 & flt_xLo, flt_xHi, flt_yLo, flt_yHi
34
35 C== Parameters ==
36
37 C flt_noise :: range of noise added to the velocity component
38 C (randomly). The noise can be added or subtracted,
39 C the range is +/- flt_noise/2
40 C flt_deltaT :: time-step to step forward floats (in flt_runga2.F)
41 C default is deltaTClock
42 C flt_int_traj :: period between storing model state at float position, in s
43 C flt_int_prof :: period between float vertical profiles, in s
44 C
45 C note: flt_int_prof is the time between getting profiles, not the
46 C the return cycle of the float to the surface. The latter can
47 C be specified individually for every float. Because the mechanism
48 C for return ing to the surface is called in the profiling routine
49 C flt_int_prof has to be the minimum of all iup(max_npart).
50 C The subsampling of profiles can be done later in the analysis.
51
52 _RL flt_noise, flt_deltaT
53 _RL flt_int_traj, flt_int_prof
54 COMMON / FLT_PARAM_R /
55 & flt_noise, flt_deltaT,
56 & flt_int_traj, flt_int_prof
57
58 C flt_file :: name of the file containing the initial positions.
59 C At initialization the program first looks for a
60 C global file flt_file.data. If that is not found it
61 C looks for tiled files flt_file.iG.jG.data.
62 CHARACTER*(MAX_LEN_FNAM) flt_file
63 COMMON / FLT_PARAM_C / flt_file
64
65 C mapIniPos2Index :: convert float initial position to (local) index map
66 LOGICAL mapIniPos2Index
67 COMMON / FLT_PARAM_L / mapIniPos2Index
68
69 C== Float State ==
70
71 C npart_tile :: actual number of floats per tile
72 INTEGER npart_tile(nSx,nSy)
73 COMMON / FLT_STATE_I / npart_tile
74
75 C max_npart :: total number of floats
76 C (this is read from the input files)
77 _RL max_npart
78 COMMON / FLT_STATE_R / max_npart
79
80 C npart :: float identifier
81 C tstart :: start date of integration of float, in s.
82 C Note: If tstart=-1 floats are integrated right from the
83 C beginning
84 C tend :: end date of integration of float, in s.
85 C Note: If tend=-1 floats are integrated till the end of
86 C integration
87 C ipart :: horiz. position of float : 1rst decimal (local) index
88 C jpart :: horiz. position of float : 2nd decimal (local) index
89 C kpart :: vertical level of float (decimal number in case of 3D float)
90 C kfloat :: target depth of float.
91 C iup :: type of float :
92 C o should profile ( > 0 = return cycle, in s, to surface)
93 C o remain at depth ( = 0 )
94 C o is a 3D float ( = -1 )
95 C o should be advected without additional noise ( = -2 ).
96 C This implies that the float is non-profiling
97 C o is a mooring ( = -3 ), i.e. the float is not advected
98 C itop :: time of float the surface, in s
99 _RL npart(max_npart_tile,nSx,nSy)
100 _RL tstart(max_npart_tile,nSx,nSy)
101 _RL tend(max_npart_tile,nSx,nSy)
102 _RL ipart(max_npart_tile,nSx,nSy)
103 _RL jpart(max_npart_tile,nSx,nSy)
104 _RL kpart(max_npart_tile,nSx,nSy)
105 _RL kfloat(max_npart_tile,nSx,nSy)
106 _RL iup(max_npart_tile,nSx,nSy)
107 _RL itop(max_npart_tile,nSx,nSy)
108
109 COMMON / FLT_STATE_VAR /
110 & npart, tstart, tend,
111 & ipart, jpart, kpart,
112 & kfloat, iup, itop
113
114 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|

  ViewVC Help
Powered by ViewVC 1.1.22