mod_arrays Module Reference

Functions/Subroutines
subroutine, public	roms_allocate_arrays (allocate_vars)
subroutine, public	roms_deallocate_arrays
subroutine, public	roms_initialize_arrays

Variables
logical	lallocateclima = .TRUE.

Function/Subroutine Documentation

roms_allocate_arrays()

subroutine, public mod_arrays::roms_allocate_arrays

(

logical, intent(in)

allocate_vars

)

Definition at line 113 of file mod_arrays.F.

!
!=======================================================================
!                                                                      !
!  This routine allocates ROMS state variables.                        !
!                                                                      !
!=======================================================================
!
!  Imported variable declarations
!
      logical, intent(in) :: allocate_vars
!
!  Local variable declarations.
!
      integer :: ng, thread, tile
      integer :: IminS, ImaxS, JminS, JmaxS
      integer :: LBi, UBi, LBj, UBj, LBij, UBij
!
      character (len=*), parameter :: MyFile =                          &
     &  __FILE__//", ROMS_allocate_arrays"
 
#ifdef PROFILE
!
!-----------------------------------------------------------------------
!  Turn on allocation time wall clock.
!-----------------------------------------------------------------------
!
      DO ng=1,ngrids
        DO thread=thread_range
          CALL wclock_on (ng, inlm, 1, __line__, myfile)
        END DO
!$OMP BARRIER
      END DO
#endif
!
!-----------------------------------------------------------------------
!  Allocate model type-derived structures and its variables.
!-----------------------------------------------------------------------
!
      IF (allocate_vars) then
#ifdef DISTRIBUTE
        tile=myrank
#else
        tile=0
#endif
        DO ng=1,ngrids
!$OMP MASTER
          lbi=bounds(ng)%LBi(tile)
          ubi=bounds(ng)%UBi(tile)
          lbj=bounds(ng)%LBj(tile)
          ubj=bounds(ng)%UBj(tile)
          lbij=bounds(ng)%LBij
          ubij=bounds(ng)%UBij
#if defined AVERAGES    || \
   (defined ad_averages && defined adjoint) || \
   (defined rp_averages && defined tl_ioms) || \
   (defined tl_averages && defined tangent)
          CALL allocate_average (ng, lbi, ubi, lbj, ubj)
#endif
          CALL allocate_boundary (ng)
#ifdef BBL_MODEL
          CALL allocate_bbl (ng, lbi, ubi, lbj, ubj)
#endif
          IF (lallocateclima.or.lclimatology(ng)) THEN
            CALL allocate_clima (ng, lbi, ubi, lbj, ubj)
          END IF
#ifdef SOLVE3D
          CALL allocate_coupling (ng, lbi, ubi, lbj, ubj)
#endif
#ifdef DIAGNOSTICS
          CALL allocate_diags (ng, lbi, ubi, lbj, ubj)
#endif
#ifdef GRID_EXTRACT
          CALL allocate_extract (ng, extractflag(ng),                   &
     &                           xtr_bounds(ng)%LBi(tile),              &
     &                           xtr_bounds(ng)%UBi(tile),              &
     &                           xtr_bounds(ng)%LBj(tile),              &
     &                           xtr_bounds(ng)%UBj(tile))
#endif
          CALL allocate_forces (ng, lbi, ubi, lbj, ubj)
          CALL allocate_grid (ng, extractflag(ng),                      &
     &                        lbi, ubi, lbj, ubj, lbij, ubij)
#ifdef ICE_MODEL
          CALL allocate_ice (ng, lbi, ubi, lbj, ubj, .true.)
#endif
          CALL allocate_mixing (ng, lbi, ubi, lbj, ubj)
          CALL allocate_ocean (ng, lbi, ubi, lbj, ubj)
#if defined SEDIMENT || defined BBL_MODEL
          CALL allocate_sedbed (ng, lbi, ubi, lbj, ubj)
#endif
#if defined SSH_TIDES || defined UV_TIDES
          CALL allocate_tides (ng, lbi, ubi, lbj, ubj)
#endif
          IF (luvsrc(ng).or.lwsrc(ng).or.any(ltracersrc(:,ng))) THEN
            CALL allocate_sources (ng)
          END IF
!$OMP END MASTER
!$OMP BARRIER
        END DO
 
#ifdef NESTING
!
!  Allocate and initialized contact points boundaty structure. It
!  needs to be delayed to the end because we need "LBC_apply" to
!  allocated in "mod_boundary" for all nested grid.
!
!$OMP MASTER
        CALL allocate_nesting
!$OMP END MASTER
!$OMP BARRIER
#endif
 
#if defined PIO_LIB && defined DISTRIBUTE
!
!  Allocate and initialize PIO single and double precision data
!  decomposition for mapping between computational and I/O processes.
!  It needs to done after all parameters have been allocated and
!  initialize. In particular, we need tidal constituents and state
!  propagator  parameters.
!
        CALL set_iodecomp
#endif
 
        lallocatedmemory=.true.
 
      END IF
 
#ifdef PROFILE
!
!-----------------------------------------------------------------------
!  Turn off allocation time wall clock.
!-----------------------------------------------------------------------
!
      DO ng=1,ngrids
        DO thread=thread_range
          CALL wclock_off (ng, inlm, 1, __line__, myfile)
        END DO
!$OMP BARRIER
      END DO
#endif
!
      RETURN

References mod_average::allocate_average(), mod_bbl::allocate_bbl(), mod_boundary::allocate_boundary(), mod_clima::allocate_clima(), mod_coupling::allocate_coupling(), mod_diags::allocate_diags(), mod_forces::allocate_forces(), mod_grid::allocate_grid(), mod_ice::allocate_ice(), mod_mixing::allocate_mixing(), mod_nesting::allocate_nesting(), mod_ocean::allocate_ocean(), mod_sedbed::allocate_sedbed(), mod_sources::allocate_sources(), mod_tides::allocate_tides(), mod_param::bounds, mod_scalars::extractflag, mod_param::inlm, lallocateclima, mod_scalars::lallocatedmemory, mod_scalars::lclimatology, mod_scalars::ltracersrc, mod_scalars::luvsrc, mod_scalars::lwsrc, mod_parallel::myrank, mod_param::ngrids, set_pio_mod::set_iodecomp(), wclock_off(), and wclock_on().

Referenced by roms_kernel_mod::roms_initialize(), and roms_kernel_mod::roms_initializep1().

Here is the call graph for this function:

Here is the caller graph for this function:

roms_deallocate_arrays()

subroutine, public mod_arrays::roms_deallocate_arrays

Definition at line 257 of file mod_arrays.F.

!
!=======================================================================
!                                                                      !
!  This routine deallocates ROMS state objects, arrays and vectors.    !
!                                                                      !
!=======================================================================
!
      USE mod_param, ONLY : ngrids
!
!  Local variable declarations.
!
      integer :: ng
!
      character (len=*), parameter :: MyFile =                          &
     &  __FILE__//", ROMS_deallocate_arrays"
!
!-----------------------------------------------------------------------
!  Deallocate all structures.
!-----------------------------------------------------------------------
!
      DO ng=1,ngrids
!$OMP MASTER
#if defined AVERAGES    || \
   (defined ad_averages && defined adjoint) || \
   (defined rp_averages && defined tl_ioms) || \
   (defined tl_averages && defined tangent)
        CALL deallocate_average (ng)
#endif
        CALL deallocate_boundary (ng)
#ifdef BBL_MODEL
        CALL deallocate_bbl (ng)
#endif
        IF (lallocateclima.or.lclimatology(ng)) THEN
          CALL deallocate_clima (ng)
        END IF
#ifdef SOLVE3D
        CALL deallocate_coupling (ng)
#endif
#ifdef DIAGNOSTICS
        CALL deallocate_diags (ng)
#endif
#ifdef GRID_EXTRACT
        CALL deallocate_extract (ng)
#endif
        CALL deallocate_forces (ng)
        CALL deallocate_grid (ng)
#ifdef ICE_MODEL
        CALL deallocate_ice (ng)
#endif
        CALL deallocate_mixing (ng)
        CALL deallocate_ocean (ng)
#if defined SEDIMENT || defined BBL_MODEL
        CALL deallocate_sedbed (ng)
#endif
#if defined SSH_TIDES || defined UV_TIDES
        CALL deallocate_tides (ng)
#endif
        IF (luvsrc(ng).or.lwsrc(ng).or.any(ltracersrc(:,ng))) THEN
          CALL deallocate_sources (ng)
        END IF
!$OMP END MASTER
!$OMP BARRIER
      END DO
 
#ifdef NESTING
!
!  Deallocate nesting variables and structures.
!
!$OMP MASTER
      CALL deallocate_nesting
!$OMP END MASTER
!$OMP BARRIER
#endif
 
#if defined FOUR_DVAR || defined VERIFICATION
!
!  Deallocate observations arrays and object.
!
      CALL deallocate_fourdvar
#endif
!
!  Deallocate I/O derived-type structures.
!
      CALL deallocate_iounits
!
!  Deallocate main configuration dimensions and associated parameters.
!
      CALL deallocate_param
!
      RETURN

References mod_average::deallocate_average(), mod_bbl::deallocate_bbl(), mod_boundary::deallocate_boundary(), mod_clima::deallocate_clima(), mod_coupling::deallocate_coupling(), mod_diags::deallocate_diags(), mod_forces::deallocate_forces(), mod_fourdvar::deallocate_fourdvar(), mod_grid::deallocate_grid(), mod_ice::deallocate_ice(), mod_iounits::deallocate_iounits(), mod_mixing::deallocate_mixing(), mod_nesting::deallocate_nesting(), mod_ocean::deallocate_ocean(), mod_param::deallocate_param(), mod_sedbed::deallocate_sedbed(), mod_sources::deallocate_sources(), mod_tides::deallocate_tides(), lallocateclima, mod_scalars::lclimatology, mod_scalars::ltracersrc, mod_scalars::luvsrc, mod_scalars::lwsrc, and mod_param::ngrids.

Referenced by myroms().

Here is the call graph for this function:

Here is the caller graph for this function:

roms_initialize_arrays()

subroutine, public mod_arrays::roms_initialize_arrays

Definition at line 350 of file mod_arrays.F.

!
!=======================================================================
!                                                                      !
!  This routine initialize ROMS state variables. In shared-memory it   !
!  important for the first-touch policy in memory.                     !
!                                                                      !
!=======================================================================
!
!  Local variable declarations.
!
      integer :: ng, thread, tile
!
      integer, parameter :: model = 0
!
      character (len=*), parameter :: MyFile =                          &
     &  __FILE__//", ROMS_initialize_arrays"
 
#ifdef PROFILE
!
!-----------------------------------------------------------------------
!  Turn on allocation time wall clock.
!-----------------------------------------------------------------------
!
      DO ng=1,ngrids
        DO thread=thread_range
          CALL wclock_on (ng, inlm, 1, __line__, myfile)
        END DO
!$OMP BARRIER
      END DO
#endif
!
!-----------------------------------------------------------------------
!  Intialize variables within structures for each grid.
!-----------------------------------------------------------------------
!
      DO ng=1,ngrids
#ifdef NESTING
        IF (ng.eq.1) THEN
          CALL initialize_nesting
        END IF
#endif
        DO tile=first_tile(ng),last_tile(ng),+1
#if defined AVERAGES    || \
   (defined ad_averages && defined adjoint) || \
   (defined rp_averages && defined tl_ioms) || \
   (defined tl_averages && defined tangent)
          CALL initialize_average (ng, tile)
#endif
#ifdef BBL_MODEL
          CALL initialize_bbl (ng, tile)
#endif
          CALL initialize_boundary (ng, tile, model)
 
          IF (lallocateclima.or.lclimatology(ng)) THEN
            CALL initialize_clima (ng, tile)
          END IF
#ifdef SOLVE3D
          CALL initialize_coupling (ng, tile, model)
#endif
#ifdef DIAGNOSTICS
          CALL initialize_diags (ng, tile)
#endif
#ifdef GRID_EXTRACT
          CALL initialize_extract (ng, tile, model)
#endif
          CALL initialize_forces (ng, tile, model)
          CALL initialize_grid (ng, tile, model)
#ifdef ICE_MODEL
          CALL initialize_ice (ng, tile, model)
#endif
          CALL initialize_mixing (ng, tile, model)
          CALL initialize_ocean (ng, tile, model)
#if defined SEDIMENT || defined BBL_MODEL
          CALL initialize_sedbed (ng, tile, model)
#endif
#if defined SSH_TIDES || defined UV_TIDES
          CALL initialize_tides (ng, tile)
#endif
        END DO
!$OMP BARRIER
      END DO
 
#if defined FOUR_DVAR || defined VERIFICATION
!
!  Finish allocating observation arrays.  Then, initialize observation
!  arrays. Notice that some of the module variables are allocated in
!  the call to "allocate_fourdvar" in "read_phypar".
!
      CALL initialize_fourdvar
#endif
 
#ifdef PROFILE
!
!-----------------------------------------------------------------------
!  Turn off allocation time wall clock.
!-----------------------------------------------------------------------
!
      DO ng=1,ngrids
        DO thread=thread_range
          CALL wclock_off (ng, inlm, 1, __line__, myfile)
        END DO
!$OMP BARRIER
      END DO
#endif
!
      RETURN

References mod_parallel::first_tile, mod_average::initialize_average(), mod_bbl::initialize_bbl(), mod_boundary::initialize_boundary(), mod_clima::initialize_clima(), mod_coupling::initialize_coupling(), mod_diags::initialize_diags(), mod_forces::initialize_forces(), mod_fourdvar::initialize_fourdvar(), mod_grid::initialize_grid(), mod_ice::initialize_ice(), mod_mixing::initialize_mixing(), mod_nesting::initialize_nesting(), mod_ocean::initialize_ocean(), mod_sedbed::initialize_sedbed(), mod_tides::initialize_tides(), lallocateclima, mod_parallel::last_tile, mod_scalars::lclimatology, wclock_off(), and wclock_on().

Referenced by roms_kernel_mod::roms_initialize(), and roms_kernel_mod::roms_initializep1().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

lallocateclima

logical mod_arrays::lallocateclima = .TRUE.

Definition at line 106 of file mod_arrays.F.

      logical :: LallocateClima = .true.

Referenced by roms_allocate_arrays(), roms_deallocate_arrays(), and roms_initialize_arrays().