| 1 |
C $Header: /u/gcmpack/MITgcm/pkg/flt/FLT.h,v 1.7 2011/08/31 21:41:55 jmc 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 FLT_Iter0 :: timestep number when float are initialized |
| 45 |
C |
| 46 |
C note: flt_int_prof is the time between getting profiles, not the |
| 47 |
C the return cycle of the float to the surface. The latter can |
| 48 |
C be specified individually for every float. Because the mechanism |
| 49 |
C for returning to the surface is called in the profiling routine |
| 50 |
C flt_int_prof has to be the minimum of all iup(max_npart). |
| 51 |
C The subsampling of profiles can be done later in the analysis. |
| 52 |
|
| 53 |
_RL flt_noise, flt_deltaT |
| 54 |
_RL flt_int_traj, flt_int_prof |
| 55 |
INTEGER FLT_Iter0 |
| 56 |
COMMON / FLT_PARAM_R / |
| 57 |
& flt_noise, flt_deltaT, |
| 58 |
& flt_int_traj, flt_int_prof, |
| 59 |
& FLT_Iter0 |
| 60 |
|
| 61 |
C flt_selectTrajOutp :: select which var. to output along trajectories |
| 62 |
C flt_selectProfOutp :: select which var. to output along profiles |
| 63 |
C =0 : none ; =1 : position only ; =2 : +p,u,v,t,s |
| 64 |
INTEGER flt_selectTrajOutp |
| 65 |
INTEGER flt_selectProfOutp |
| 66 |
COMMON / FLT_PARAM_I / |
| 67 |
& flt_selectTrajOutp, flt_selectProfOutp |
| 68 |
|
| 69 |
C flt_file :: name of the file containing the initial positions. |
| 70 |
C At initialization the program first looks for a |
| 71 |
C global file flt_file.data. If that is not found it |
| 72 |
C looks for tiled files flt_file.iG.jG.data. |
| 73 |
CHARACTER*(MAX_LEN_FNAM) flt_file |
| 74 |
COMMON / FLT_PARAM_C / flt_file |
| 75 |
|
| 76 |
C mapIniPos2Index :: convert float initial position to (local) index map |
| 77 |
LOGICAL mapIniPos2Index |
| 78 |
COMMON / FLT_PARAM_L / mapIniPos2Index |
| 79 |
|
| 80 |
C== Float State == |
| 81 |
|
| 82 |
C npart_tile :: actual number of floats per tile |
| 83 |
INTEGER npart_tile(nSx,nSy) |
| 84 |
COMMON / FLT_STATE_I / npart_tile |
| 85 |
|
| 86 |
C max_npart :: total number of floats |
| 87 |
C (this is read from the input files) |
| 88 |
_RL max_npart |
| 89 |
COMMON / FLT_STATE_R / max_npart |
| 90 |
|
| 91 |
C npart :: float identifier |
| 92 |
C tstart :: start date of integration of float, in s. |
| 93 |
C Note: If tstart=-1 floats are integrated right from the |
| 94 |
C beginning |
| 95 |
C tend :: end date of integration of float, in s. |
| 96 |
C Note: If tend=-1 floats are integrated till the end of |
| 97 |
C integration |
| 98 |
C ipart :: horiz. position of float : 1rst decimal (local) index |
| 99 |
C jpart :: horiz. position of float : 2nd decimal (local) index |
| 100 |
C kpart :: vertical level of float (decimal number in case of 3D float) |
| 101 |
C kfloat :: target depth of float. |
| 102 |
C iup :: type of float : |
| 103 |
C o should profile ( > 0 = return cycle, in s, to surface) |
| 104 |
C o remain at depth ( = 0 ) |
| 105 |
C o is a 3D float ( = -1 ) |
| 106 |
C o should be advected without additional noise ( = -2 ). |
| 107 |
C This implies that the float is non-profiling |
| 108 |
C o is a mooring ( = -3 ), i.e. the float is not advected |
| 109 |
C itop :: time of float the surface, in s |
| 110 |
_RL npart(max_npart_tile,nSx,nSy) |
| 111 |
_RL tstart(max_npart_tile,nSx,nSy) |
| 112 |
_RL tend(max_npart_tile,nSx,nSy) |
| 113 |
_RL ipart(max_npart_tile,nSx,nSy) |
| 114 |
_RL jpart(max_npart_tile,nSx,nSy) |
| 115 |
_RL kpart(max_npart_tile,nSx,nSy) |
| 116 |
_RL kfloat(max_npart_tile,nSx,nSy) |
| 117 |
_RL iup(max_npart_tile,nSx,nSy) |
| 118 |
_RL itop(max_npart_tile,nSx,nSy) |
| 119 |
|
| 120 |
COMMON / FLT_STATE_VAR / |
| 121 |
& npart, tstart, tend, |
| 122 |
& ipart, jpart, kpart, |
| 123 |
& kfloat, iup, itop |
| 124 |
|
| 125 |
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |
Parent Directory
| 
Revision Log
| 
Revision Graph