pkg/flt/flt_main.F

C $Header: /u/gcmpack/MITgcm/pkg/flt/flt_main.F,v 1.4 2009/01/25 21:09:59 jmc Exp $
C $Name:  $

#include "FLT_OPTIONS.h"

C     ==================================================================
C
C     Float Package for the MIT Model
C
C     Main Routines:
C
C     o flt_main       - Integrates the floats forward and stores
C                        positions and vertical profiles at specific
C                        time intervals.
C     o flt_readparms  - Read parameter file
C     o flt_init_fixed - Initialise fixed
C     o flt_init_varia - Initialise the floats
C     o flt_restart    - Writes restart data to file (=> renamed: flt_write_pickup)
C
C     Second Level Subroutines:
C
C     o flt_runga2     - Second order Runga-Kutta inetgration (default)
C     o flt_exchg      - Does a new distribution of floats over tiles
C                        after every integration step.
C     o flt_up         - moves float to the surface (if flag is set)
C                        and stores profiles to file
C     o flt_down       - moves float to its target depth (if flag is set)
C     o flt_traj       - stores positions and data to file
C     o flt_interp_linear  - contains blinear interpolation scheme
C     o flt_mapping        - contains mapping functions & subroutine
C     o flt_mdsreadvector  - modified mdsreadvector to read files
C
C     ToDo:
C
C     o avoid exchanges when arrays empty
C     o 3D advection of floats
C
C     ==================================================================
C
C     Documentation:
C
C     To be made....
C
C
C     started: Arne Biastoch abiastoch@ucsd.edu 10-Jan-2000
C              (adopted from version written by Detlef Stammer
C               for the old model code)
C
C     changed: Arne Biastoch abiastoch@ucsd.edu 21-JUN-2001
C
C     ==================================================================


      SUBROUTINE FLT_MAIN (
     I                      myTime, myIter, myThid )

C     ==================================================================
C     SUBROUTINE FLT_MAIN
C     ==================================================================
C     o This routine steps floats forward in time and samples the model
C       state at float position every flt_int_traj time steps.
C       Also moves the float up and down and samples vertical profiles.
C
C     o Uses  2nd or fourth order runga-kutta
C     o Spatial interpolation is bilinear close to boundaries and otherwise
C       a polynomial interpolation.
C     o Particles are kept in grid space (with position of dp taken as
C       x(south), y(east) grid cell point)
C     o Calls profile every flt_int_prof time steps; in that event the
C       profile over the whole water column is written to file and the
C       float might be moved upwards to the surface (depending on its
C       configuration).
C     ==================================================================

C     !USES:
      IMPLICIT NONE

#include "EEPARAMS.h"
#include "SIZE.h"
#include "FLT.h"

C     == routine arguments ==
C     myThid - thread number for this instance of the routine.
      _RL myTime
      INTEGER myIter, myThid

C     integration of the float trajectories

c         WRITE(0,*) ' bf call flt_runga2', myIter
         CALL TIMER_START('FLOATS RUNGA2      [FLT  LOOP]',myThid)
         CALL FLT_RUNGA2( myTime, myIter, myThid )
         CALL TIMER_STOP ('FLOATS RUNGA2      [FLT  LOOP]',myThid)
c         WRITE(0,*) ' af call flt_runga2', myIter

C     check if exchanges between tiles are necessary

c        IF (Nx .NE. sNx .OR. Ny .NE. sNy) THEN
         CALL TIMER_START('FLOATS EXCHG       [FLT  LOOP]',myThid)
         CALL FLT_EXCHG( myTime, myIter, myThid )
         CALL TIMER_STOP ('FLOATS EXCHG       [FLT  LOOP]',myThid)
c        ENDIF

C     store profiles every flt_int_prof time steps:
C     and move floats up and down

         IF ( MOD(myTime,flt_int_prof).EQ.0. ) THEN
           CALL TIMER_START('FLOATS UP          [FLT  LOOP]',myThid)
           CALL FLT_UP( myTime, myIter, myThid )
           CALL TIMER_STOP ('FLOATS UP          [FLT  LOOP]',myThid)
         ENDIF

c         WRITE(0,*) ' bf call flt_down', myIter
           CALL TIMER_START('FLOATS DOWN        [FLT  LOOP]',myThid)
           CALL FLT_DOWN( myTime, myIter, myThid )
           CALL TIMER_STOP ('FLOATS DOWN        [FLT  LOOP]',myThid)
c         WRITE(0,*) ' af call flt_down', myIter

C     store particles every flt_int_traj timesteps:

         IF ( MOD(myTime,flt_int_traj).EQ.0. ) THEN
c         WRITE(0,*) ' bf call flt_traj', myIter
           CALL TIMER_START('FLOATS TRAJ        [FLT  LOOP]',myThid)
           CALL FLT_TRAJ( myTime, myIter, myThid )
           CALL TIMER_STOP ('FLOATS TRAJ        [FLT  LOOP]',myThid)
c         WRITE(0,*) ' af call flt_traj', myIter
         ENDIF

      RETURN
      END
1	jmc	1.5	C $Header: /u/gcmpack/MITgcm/pkg/flt/flt_main.F,v 1.4 2009/01/25 21:09:59 jmc Exp $
2	jmc	1.2	C $Name: $
3	adcroft	1.1
4	jmc	1.2	#include "FLT_OPTIONS.h"
5	adcroft	1.1
6	jmc	1.3	C ==================================================================
7			C
8			C Float Package for the MIT Model
9			C
10			C Main Routines:
11			C
12	jmc	1.5	C o flt_main - Integrates the floats forward and stores
13			C positions and vertical profiles at specific
14			C time intervals.
15			C o flt_readparms - Read parameter file
16			C o flt_init_fixed - Initialise fixed
17			C o flt_init_varia - Initialise the floats
18			C o flt_restart - Writes restart data to file (=> renamed: flt_write_pickup)
19	jmc	1.3	C
20			C Second Level Subroutines:
21			C
22	jmc	1.5	C o flt_runga2 - Second order Runga-Kutta inetgration (default)
23			C o flt_exchg - Does a new distribution of floats over tiles
24			C after every integration step.
25			C o flt_up - moves float to the surface (if flag is set)
26			C and stores profiles to file
27			C o flt_down - moves float to its target depth (if flag is set)
28			C o flt_traj - stores positions and data to file
29			C o flt_interp_linear - contains blinear interpolation scheme
30			C o flt_mapping - contains mapping functions & subroutine
31			C o flt_mdsreadvector - modified mdsreadvector to read files
32	jmc	1.3	C
33			C ToDo:
34			C
35			C o avoid exchanges when arrays empty
36			C o 3D advection of floats
37			C
38			C ==================================================================
39			C
40			C Documentation:
41			C
42			C To be made....
43			C
44			C
45			C started: Arne Biastoch abiastoch@ucsd.edu 10-Jan-2000
46			C (adopted from version written by Detlef Stammer
47			C for the old model code)
48			C
49			C changed: Arne Biastoch abiastoch@ucsd.edu 21-JUN-2001
50			C
51			C ==================================================================
52	adcroft	1.1
53
54	jmc	1.2	SUBROUTINE FLT_MAIN (
55	jmc	1.3	I myTime, myIter, myThid )
56	adcroft	1.1
57	jmc	1.2	C ==================================================================
58			C SUBROUTINE FLT_MAIN
59			C ==================================================================
60			C o This routine steps floats forward in time and samples the model
61			C state at float position every flt_int_traj time steps.
62			C Also moves the float up and down and samples vertical profiles.
63			C
64			C o Uses 2nd or fourth order runga-kutta
65			C o Spatial interpolation is bilinear close to boundaries and otherwise
66			C a polynomial interpolation.
67			C o Particles are kept in grid space (with position of dp taken as
68			C x(south), y(east) grid cell point)
69			C o Calls profile every flt_int_prof time steps; in that event the
70			C profile over the whole water column is written to file and the
71			C float might be moved upwards to the surface (depending on its
72			C configuration).
73			C ==================================================================
74	jmc	1.5
75			C !USES:
76			IMPLICIT NONE
77	adcroft	1.1
78			#include "EEPARAMS.h"
79			#include "SIZE.h"
80			#include "FLT.h"
81
82	jmc	1.2	C == routine arguments ==
83	jmc	1.3	C myThid - thread number for this instance of the routine.
84			_RL myTime
85	jmc	1.2	INTEGER myIter, myThid
86	adcroft	1.1
87	jmc	1.2	C integration of the float trajectories
88
89	jmc	1.3	c WRITE(0,*) ' bf call flt_runga2', myIter
90	adcroft	1.1	CALL TIMER_START('FLOATS RUNGA2 [FLT LOOP]',myThid)
91	jmc	1.3	CALL FLT_RUNGA2( myTime, myIter, myThid )
92	adcroft	1.1	CALL TIMER_STOP ('FLOATS RUNGA2 [FLT LOOP]',myThid)
93	jmc	1.3	c WRITE(0,*) ' af call flt_runga2', myIter
94	jmc	1.2
95			C check if exchanges between tiles are necessary
96	adcroft	1.1
97	jmc	1.4	c IF (Nx .NE. sNx .OR. Ny .NE. sNy) THEN
98			CALL TIMER_START('FLOATS EXCHG [FLT LOOP]',myThid)
99			CALL FLT_EXCHG( myTime, myIter, myThid )
100			CALL TIMER_STOP ('FLOATS EXCHG [FLT LOOP]',myThid)
101			c ENDIF
102	adcroft	1.1
103	jmc	1.2	C store profiles every flt_int_prof time steps:
104			C and move floats up and down
105	adcroft	1.1
106	jmc	1.3	IF ( MOD(myTime,flt_int_prof).EQ.0. ) THEN
107	jmc	1.4	CALL TIMER_START('FLOATS UP [FLT LOOP]',myThid)
108			CALL FLT_UP( myTime, myIter, myThid )
109			CALL TIMER_STOP ('FLOATS UP [FLT LOOP]',myThid)
110	jmc	1.3	ENDIF
111	adcroft	1.1
112	jmc	1.3	c WRITE(0,*) ' bf call flt_down', myIter
113	jmc	1.4	CALL TIMER_START('FLOATS DOWN [FLT LOOP]',myThid)
114			CALL FLT_DOWN( myTime, myIter, myThid )
115			CALL TIMER_STOP ('FLOATS DOWN [FLT LOOP]',myThid)
116	jmc	1.3	c WRITE(0,*) ' af call flt_down', myIter
117	jmc	1.2
118			C store particles every flt_int_traj timesteps:
119	adcroft	1.1
120	jmc	1.3	IF ( MOD(myTime,flt_int_traj).EQ.0. ) THEN
121			c WRITE(0,*) ' bf call flt_traj', myIter
122	jmc	1.4	CALL TIMER_START('FLOATS TRAJ [FLT LOOP]',myThid)
123			CALL FLT_TRAJ( myTime, myIter, myThid )
124			CALL TIMER_STOP ('FLOATS TRAJ [FLT LOOP]',myThid)
125	jmc	1.3	c WRITE(0,*) ' af call flt_traj', myIter
126			ENDIF
127	adcroft	1.1
128	jmc	1.2	RETURN
129			END