Data Types
type	t_drifter

Functions/Subroutines
subroutine, public	allocate_floats (ldrifter)

subroutine, public	deallocate_floats (ng)

Variables
type(t_drifter), dimension(:), allocatable	drifter

logical, dimension(:), allocatable	fprint

integer, parameter	itstr = 0

integer, parameter	ixgrd = 1

integer, parameter	iygrd = 2

integer, parameter	izgrd = 3

integer, parameter	iflon = 4

integer, parameter	iflat = 5

integer, parameter	idpth = 6

integer, parameter	ixrhs = 7

integer, parameter	iyrhs = 8

integer, parameter	izrhs = 9

integer, parameter	ifden = 10

integer, parameter	ifakt = 11

integer, parameter	ifdak = 12

integer, parameter	i1ohz = 13

integer, parameter	isizf = 14

integer, parameter	ibrhs = 15

integer, parameter	iswim = 16

integer, parameter	iwbio = 17

integer, parameter	iwsin = 18

integer, dimension(:), allocatable	iftvar

integer, parameter	flt_lagran = 1

integer, parameter	flt_isobar = 2

integer, parameter	flt_geopot = 3

integer	flt_iseed

integer, dimension(:), allocatable	frrec

Function/Subroutine Documentation

◆ allocate_floats()

subroutine, public mod_floats::allocate_floats ( logical, intent(in) ldrifter )

Definition at line 142 of file mod_floats.F.

!
!=======================================================================
!                                                                      !
!  This routine eihter  allocates and initialize all variables in      !
!  the DRIFTER structure (Ldrifter=.TRUE.) or other parameters in      !
!  the module that are independent of Nfloats (Ldrifter=.FALSE.).      !
!                                                                      !
!=======================================================================
!
      USE mod_scalars
!
!  Imported variable declarations.
!
      logical, intent(in) :: Ldrifter
!
!  Local variable declarations.
!
      integer :: ng, i, ic, iflt
 
      real(r8), parameter :: IniVal = 0.0_r8
!
!-----------------------------------------------------------------------
!  Allocate Langrangian drifters structure.
!-----------------------------------------------------------------------
!
      IF (ldrifter) THEN
 
        allocate ( drifter(ngrids) )
!
!  Allocate variables.
!
        DO ng=1,ngrids
          allocate ( drifter(ng) % bounded(nfloats(ng)) )
          dmem(ng)=dmem(ng)+real(nfloats(ng),r8)
 
# if defined SOLVE3D && defined FLOAT_STICKY
          allocate ( drifter(ng) % stuck(nfloats(ng)) )
          dmem(ng)=dmem(ng)+real(nfloats(ng),r8)
# endif
 
          allocate ( drifter(ng) % Findex(0:nfloats(ng)) )
          dmem(ng)=dmem(ng)+real(nfloats(ng)+1,r8)
 
          allocate ( drifter(ng) % Ftype(nfloats(ng)) )
          dmem(ng)=dmem(ng)+real(nfloats(ng),r8)
 
          allocate ( drifter(ng) % Flon(nfloats(ng)) )
          dmem(ng)=dmem(ng)+real(nfloats(ng),r8)
 
          allocate ( drifter(ng) % Flat(nfloats(ng)) )
          dmem(ng)=dmem(ng)+real(nfloats(ng),r8)
 
          allocate ( drifter(ng) % Fz0(nfloats(ng)) )
          dmem(ng)=dmem(ng)+real(nfloats(ng),r8)
 
          allocate ( drifter(ng) % Tinfo(0:izrhs,nfloats(ng)) )
          dmem(ng)=dmem(ng)+real((izrhs+1)*nfloats(ng),r8)
 
# if defined SOLVE3D && defined FLOAT_VWALK
          allocate ( drifter(ng) % rwalk(nfloats(ng)) )
          dmem(ng)=dmem(ng)+real(nfloats(ng),r8)
# endif
 
          allocate ( drifter(ng) % track(nfv(ng),0:nft,nfloats(ng)) )
          dmem(ng)=dmem(ng)+real(nfv(ng)*(nft+1)*nfloats(ng),r8)
        END DO
      END IF
!
!-----------------------------------------------------------------------
!  Lagrangian drifters parameters.
!-----------------------------------------------------------------------
!
      IF (.not.ldrifter) THEN
        allocate ( fprint(ngrids) )
        allocate ( frrec(ngrids) )
 
# ifdef SOLVE3D
        allocate ( iftvar(mt) )
# endif
      END IF
!
!-----------------------------------------------------------------------
!  Initialize Langrangian drifters structure.
!-----------------------------------------------------------------------
!
      IF (ldrifter) THEN
        DO ng=1,ngrids
          drifter(ng) % Findex(0) = 0
          DO iflt=1,nfloats(ng)
            drifter(ng) % bounded(iflt) = .false.
# if defined SOLVE3D && defined FLOAT_STICKY
            drifter(ng) % stuck(iflt) = .false.
# endif
            drifter(ng) % Findex(iflt) = 0
            drifter(ng) % Ftype(iflt) = 0
            drifter(ng) % Flon(iflt) = inival
            drifter(ng) % Flat(iflt) = inival
            drifter(ng) % Fz0(iflt) = 0
# if defined SOLVE3D && defined FLOAT_VWALK
            drifter(ng) % rwalk = inival
# endif
            DO i=0,izrhs
              drifter(ng) % Tinfo(i,iflt) = inival
            END DO
            DO i=1,nfv(ng)
              drifter(ng) % track(i,0,iflt) = inival
              drifter(ng) % track(i,1,iflt) = inival
              drifter(ng) % track(i,2,iflt) = inival
              drifter(ng) % track(i,3,iflt) = inival
              drifter(ng) % track(i,4,iflt) = inival
            END DO
          END DO
        END DO
      END IF
!
!-----------------------------------------------------------------------
!  Initialize Langrangian drifters parameters.
!-----------------------------------------------------------------------
!
      IF (.not.ldrifter) THEN
# ifdef FLOAT_VWALK
        flt_iseed=149876
# endif
        DO ng=1,ngrids
          fprint(ng)=.true.
        END DO
 
# ifdef SOLVE3D
!
!  Indices for tracer variables in the floats array track.
!
#  ifdef FLOAT_OYSTER
#   ifdef FLOAT_VWALK
        ic=18
#   else
        ic=16
#   endif
#  else
#   ifdef FLOAT_VWALK
        ic=12
#   else
        ic=10
#   endif
#  endif
        DO i=1,mt
          ic=ic+1
          iftvar(i)=ic
        END DO
# endif
      END IF
!
      RETURN

References mod_param::dmem, drifter, flt_iseed, fprint, frrec, iftvar, izrhs, mod_param::mt, mod_param::nfloats, mod_param::nft, mod_param::nfv, and mod_param::ngrids.

Referenced by read_fltpar().

Here is the caller graph for this function:

◆ deallocate_floats()

subroutine, public mod_floats::deallocate_floats ( integer, intent(in) ng )

Definition at line 297 of file mod_floats.F.

!
!=======================================================================
!                                                                      !
!  This routine dealocates all variables in module for all nested      !
!  grids.                                                              !
!                                                                      !
!=======================================================================
!
      USE mod_param,   ONLY : ngrids
# ifdef SUBOBJECT_DEALLOCATION
      USE destroy_mod, ONLY : destroy
# endif
!
!  Imported variable declarations.
!
      integer, intent(in) :: ng
!
!  Local variable declarations.
!
      character (len=*), parameter :: MyFile =                          &
     &  __FILE__//", deallocate_floats"
 
# ifdef SUBOBJECT_DEALLOCATION
!
!-----------------------------------------------------------------------
!  Deallocate each variable in the derived-type T_DRIFTER structure
!  separately.
!-----------------------------------------------------------------------
!
      IF (.not.destroy(ng, drifter(ng)%bounded, myfile,                 &
     &                 __line__, 'DRIFTER(ng)%bounded')) RETURN
 
#  if defined SOLVE3D && defined FLOAT_STICKY
      IF (.not.destroy(ng, drifter(ng)%stuck, myfile,                   &
     &                 __line__, 'DRIFTER(ng)%stuck')) RETURN
#  endif
 
      IF (.not.destroy(ng, drifter(ng)%Findex, myfile,                  &
     &                 __line__, 'DRIFTER(ng)%Findex')) RETURN
 
      IF (.not.destroy(ng, drifter(ng)%Ftype, myfile,                   &
     &                 __line__, 'DRIFTER(ng)%Ftype')) RETURN
 
      IF (.not.destroy(ng, drifter(ng)%Flon, myfile,                    &
     &                 __line__, 'DRIFTER(ng)%Flon')) RETURN
 
      IF (.not.destroy(ng, drifter(ng)%Flat, myfile,                    &
     &                 __line__, 'DRIFTER(ng)%Flat')) RETURN
 
      IF (.not.destroy(ng, drifter(ng)%Fz0, myfile,                     &
     &                 __line__, 'DRIFTER(ng)%Fz0')) RETURN
 
      IF (.not.destroy(ng, drifter(ng)%Tinfo, myfile,                   &
     &                 __line__, 'DRIFTER(ng)%Tinfo')) RETURN
 
#  if defined SOLVE3D && defined FLOAT_VWALK
      IF (.not.destroy(ng, drifter(ng)%rwalk, myfile,                   &
     &                 __line__, 'DRIFTER(ng)%rwalk')) RETURN
#  endif
 
      IF (.not.destroy(ng, drifter(ng)%track, myfile,                   &
     &                 __line__, 'DRIFTER(ng)%track')) RETURN
# endif
!
!-----------------------------------------------------------------------
!  Deallocate T_DRIFTER structure.
!-----------------------------------------------------------------------
!
      IF (ng.eq.ngrids) THEN
        IF (allocated(drifter)) deallocate ( drifter )
      END IF
!
!-----------------------------------------------------------------------
!  Deallocate other variables in module.
!-----------------------------------------------------------------------
!
      IF (allocated(fprint))  deallocate ( fprint )
 
      IF (allocated(frrec))   deallocate ( frrec )
 
# ifdef SOLVE3D
      IF (allocated(iftvar))  deallocate ( iftvar )
# endif
!
      RETURN

References drifter, fprint, frrec, iftvar, and mod_param::ngrids.

Variable Documentation

◆ drifter

type (t_drifter), dimension(:), allocatable mod_floats::drifter

Definition at line 67 of file mod_floats.F.

67 TYPE (T_DRIFTER), allocatable :: DRIFTER(:)

Referenced by allocate_floats(), biology_floats_mod::biology_floats(), deallocate_floats(), def_floats_mod::def_floats_nf90(), def_floats_mod::def_floats_pio(), grid_coords(), step_floats_mod::step_floats(), vwalk_floats_mod::vwalk_floats(), wrt_floats_mod::wrt_floats_nf90(), and wrt_floats_mod::wrt_floats_pio().

◆ flt_geopot

integer, parameter mod_floats::flt_geopot = 3

Definition at line 127 of file mod_floats.F.

127 integer, parameter :: flt_Geopot = 3

Referenced by step_floats_mod::step_floats_tile().

◆ flt_iseed

integer mod_floats::flt_iseed

Definition at line 133 of file mod_floats.F.

133 integer :: flt_iseed

Referenced by allocate_floats().

◆ flt_isobar

integer, parameter mod_floats::flt_isobar = 2

Definition at line 126 of file mod_floats.F.

126 integer, parameter :: flt_Isobar = 2

Referenced by step_floats_mod::step_floats_tile().

◆ flt_lagran

integer, parameter mod_floats::flt_lagran = 1

Definition at line 125 of file mod_floats.F.

125 integer, parameter :: flt_Lagran = 1

Referenced by step_floats_mod::step_floats_tile().

◆ fprint

logical, dimension(:), allocatable mod_floats::fprint

Definition at line 76 of file mod_floats.F.

76 logical, allocatable :: Fprint(:)

Referenced by allocate_floats(), and deallocate_floats().

◆ frrec

integer, dimension(:), allocatable mod_floats::frrec

Definition at line 138 of file mod_floats.F.

138 integer, allocatable :: frrec(:)

Referenced by allocate_floats(), deallocate_floats(), def_floats_mod::def_floats_nf90(), def_floats_mod::def_floats_pio(), and output().

◆ i1ohz

integer, parameter mod_floats::i1ohz = 13

Definition at line 97 of file mod_floats.F.

97 integer, parameter :: i1oHz = 13 ! 1/Hz

Referenced by step_floats_mod::step_floats_tile(), and vwalk_floats_mod::vwalk_floats_tile().

◆ ibrhs

integer, parameter mod_floats::ibrhs = 15

Definition at line 99 of file mod_floats.F.

99 integer, parameter :: ibrhs = 15 ! behavior RHS

Referenced by biology_floats_mod::oyster_floats_tile().

◆ idpth

integer, parameter mod_floats::idpth = 6

Definition at line 86 of file mod_floats.F.

86 integer, parameter :: idpth = 6 ! depth

Referenced by biology_floats_mod::oyster_floats_tile(), step_floats_mod::step_floats_tile(), wrt_floats_mod::wrt_floats_nf90(), and wrt_floats_mod::wrt_floats_pio().

◆ ifakt

integer, parameter mod_floats::ifakt = 11

Definition at line 92 of file mod_floats.F.

92 integer, parameter :: ifakt = 11 ! diffusivity, Akt

Referenced by vwalk_floats_mod::vwalk_floats_tile().

◆ ifdak

integer, parameter mod_floats::ifdak = 12

Definition at line 93 of file mod_floats.F.

93 integer, parameter :: ifdak = 12 ! d(Akt)/d(s)

Referenced by vwalk_floats_mod::vwalk_floats_tile().

◆ ifden

integer, parameter mod_floats::ifden = 10

Definition at line 90 of file mod_floats.F.

90 integer, parameter :: ifden = 10 ! density anomaly

Referenced by step_floats_mod::step_floats_tile(), wrt_floats_mod::wrt_floats_nf90(), and wrt_floats_mod::wrt_floats_pio().

◆ iflat

integer, parameter mod_floats::iflat = 5

Definition at line 85 of file mod_floats.F.

85 integer, parameter :: iflat = 5 ! latitude location

Referenced by step_floats_mod::step_floats_tile(), wrt_floats_mod::wrt_floats_nf90(), and wrt_floats_mod::wrt_floats_pio().

◆ iflon

integer, parameter mod_floats::iflon = 4

Definition at line 84 of file mod_floats.F.

84 integer, parameter :: iflon = 4 ! longitude location

Referenced by step_floats_mod::step_floats_tile(), wrt_floats_mod::wrt_floats_nf90(), and wrt_floats_mod::wrt_floats_pio().

◆ iftvar

integer, dimension(:), allocatable mod_floats::iftvar

Definition at line 116 of file mod_floats.F.

116 integer, allocatable :: ifTvar(:)

Referenced by allocate_floats(), deallocate_floats(), biology_floats_mod::oyster_floats_tile(), step_floats_mod::step_floats_tile(), wrt_floats_mod::wrt_floats_nf90(), and wrt_floats_mod::wrt_floats_pio().

◆ isizf

integer, parameter mod_floats::isizf = 14

Definition at line 98 of file mod_floats.F.

98 integer, parameter :: isizf = 14 ! larvae size (length)

Referenced by biology_floats_mod::oyster_floats_tile(), wrt_floats_mod::wrt_floats_nf90(), and wrt_floats_mod::wrt_floats_pio().

◆ iswim

integer, parameter mod_floats::iswim = 16

Definition at line 100 of file mod_floats.F.

100 integer, parameter :: iswim = 16 ! swimming time

Referenced by biology_floats_mod::oyster_floats_tile(), wrt_floats_mod::wrt_floats_nf90(), and wrt_floats_mod::wrt_floats_pio().

◆ itstr

integer, parameter mod_floats::itstr = 0

Definition at line 80 of file mod_floats.F.

80 integer, parameter :: itstr = 0 ! release time

Referenced by biology_floats_mod::oyster_floats_tile(), step_floats_mod::step_floats_tile(), and vwalk_floats_mod::vwalk_floats_tile().

◆ iwbio

integer, parameter mod_floats::iwbio = 17

Definition at line 101 of file mod_floats.F.

101 integer, parameter :: iwbio = 17 ! biological w-velocity

Referenced by biology_floats_mod::oyster_floats_tile(), step_floats_mod::step_floats_tile(), vwalk_floats_mod::vwalk_floats_tile(), wrt_floats_mod::wrt_floats_nf90(), and wrt_floats_mod::wrt_floats_pio().

◆ iwsin

integer, parameter mod_floats::iwsin = 18

Definition at line 102 of file mod_floats.F.

102 integer, parameter :: iwsin = 18 ! sinking velocity

Referenced by biology_floats_mod::oyster_floats_tile(), wrt_floats_mod::wrt_floats_nf90(), and wrt_floats_mod::wrt_floats_pio().

◆ ixgrd

integer, parameter mod_floats::ixgrd = 1

Definition at line 81 of file mod_floats.F.

81 integer, parameter :: ixgrd = 1 ! x-grid location

Referenced by def_floats_mod::def_floats_nf90(), def_floats_mod::def_floats_pio(), grid_coords(), interp_floats_mod::interp_floats(), biology_floats_mod::oyster_floats_tile(), step_floats_mod::step_floats_tile(), wrt_floats_mod::wrt_floats_nf90(), and wrt_floats_mod::wrt_floats_pio().

◆ ixrhs

integer, parameter mod_floats::ixrhs = 7

Definition at line 87 of file mod_floats.F.

87 integer, parameter :: ixrhs = 7 ! x-slope

Referenced by def_floats_mod::def_floats_nf90(), def_floats_mod::def_floats_pio(), and step_floats_mod::step_floats_tile().

◆ iygrd

integer, parameter mod_floats::iygrd = 2

Definition at line 82 of file mod_floats.F.

82 integer, parameter :: iygrd = 2 ! y-grid location

Referenced by def_floats_mod::def_floats_nf90(), def_floats_mod::def_floats_pio(), grid_coords(), interp_floats_mod::interp_floats(), biology_floats_mod::oyster_floats_tile(), step_floats_mod::step_floats_tile(), wrt_floats_mod::wrt_floats_nf90(), and wrt_floats_mod::wrt_floats_pio().

◆ iyrhs

integer, parameter mod_floats::iyrhs = 8

Definition at line 88 of file mod_floats.F.

88 integer, parameter :: iyrhs = 8 ! y-slope

Referenced by def_floats_mod::def_floats_nf90(), def_floats_mod::def_floats_pio(), and step_floats_mod::step_floats_tile().

◆ izgrd

integer, parameter mod_floats::izgrd = 3

Definition at line 83 of file mod_floats.F.

83 integer, parameter :: izgrd = 3 ! z-grid location

Referenced by def_floats_mod::def_floats_nf90(), def_floats_mod::def_floats_pio(), grid_coords(), interp_floats_mod::interp_floats(), step_floats_mod::step_floats_tile(), vwalk_floats_mod::vwalk_floats_tile(), wrt_floats_mod::wrt_floats_nf90(), and wrt_floats_mod::wrt_floats_pio().

◆ izrhs

integer, parameter mod_floats::izrhs = 9

Definition at line 89 of file mod_floats.F.

89 integer, parameter :: izrhs = 9 ! z-slope

Referenced by allocate_floats(), def_floats_mod::def_floats_nf90(), and def_floats_mod::def_floats_pio().

Data Types

Functions/Subroutines

Variables

Function/Subroutine Documentation

◆ allocate_floats()

◆ deallocate_floats()

Variable Documentation

◆ drifter

◆ flt_geopot

◆ flt_iseed

◆ flt_isobar

◆ flt_lagran

◆ fprint

◆ frrec

◆ i1ohz

◆ ibrhs

◆ idpth

◆ ifakt

◆ ifdak

◆ ifden

◆ iflat

◆ iflon

◆ iftvar

◆ isizf

◆ iswim

◆ itstr

◆ iwbio

◆ iwsin

◆ ixgrd

◆ ixrhs

◆ iygrd

◆ iyrhs

◆ izgrd

◆ izrhs