SCALE-RM: scale_ocean_grid_cartesc_index Module Reference

SCALE-RM

module ocean / grid / cartesianC / index More...

Functions/Subroutines
subroutine, public	ocean_grid_cartesc_index_setup
	Setup. More...

Variables
integer, public	okmax = -1

integer, public	oimax = -1

integer, public	ojmax = -1

integer, public	oka = -1

integer, public	oks

integer, public	oke

integer, public	oia

integer, public	ois

integer, public	oie

integer, public	oja

integer, public	ojs

integer, public	oje

Detailed Description

module ocean / grid / cartesianC / index

Description: Grid Index module for ocean

Author: Team SCALE

NAMELIST

PARAM_OCEAN_GRID_CARTESC_INDEX

name type default value comment

OKMAX integer -1 # of computational cells: z for ocean

History Output: No history output

Function/Subroutine Documentation

◆ ocean_grid_cartesc_index_setup()

subroutine, public scale_ocean_grid_cartesc_index::ocean_grid_cartesc_index_setup ( )

Setup.

Definition at line 61 of file scale_ocean_grid_cartesC_index.F90.

References scale_atmos_grid_cartesc_index::ia, scale_atmos_grid_cartesc_index::ie, scale_atmos_grid_cartesc_index::imax, scale_io::io_fid_conf, scale_atmos_grid_cartesc_index::is, scale_atmos_grid_cartesc_index::ja, scale_atmos_grid_cartesc_index::je, scale_atmos_grid_cartesc_index::jmax, scale_atmos_grid_cartesc_index::js, oia, oie, oimax, ois, oja, oje, ojmax, ojs, oka, oke, okmax, oks, and scale_prc::prc_abort().

Referenced by mod_rm_driver::rm_driver(), and mod_rm_prep::rm_prep().

     use scale_prc, only: &
          prc_abort
     use scale_atmos_grid_cartesc_index, only: &
        imax,       &
        ia, is, ie, &
        jmax,       &
        ja, js, je
     implicit none
 
     namelist / param_ocean_grid_cartesc_index / &
        okmax
 
     integer :: ierr
     !---------------------------------------------------------------------------
 
     log_newline
     log_info("OCEAN_GRID_CARTESC_INDEX_setup",*) 'Setup'
 
     !--- read namelist
     rewind(io_fid_conf)
     read(io_fid_conf,nml=param_ocean_grid_cartesc_index,iostat=ierr)
     if( ierr < 0 ) then !--- missing
        log_info("OCEAN_GRID_CARTESC_INDEX_setup",*) 'Not found namelist. Default used.'
     elseif( ierr > 0 ) then !--- fatal error
        log_error("OCEAN_GRID_CARTESC_INDEX_setup",*) 'Not appropriate names in namelist PARAM_OCEAN_GRID_CARTESC_INDEX. Check!'
        call prc_abort
     endif
     log_nml(param_ocean_grid_cartesc_index)
 
     if ( okmax < 1 ) then
        log_error("OCEAN_GRID_CARTESC_INDEX_setup",*) 'OKMAX must be >= 1 ', okmax
        call prc_abort
     end if
 
     oka  = okmax
     oks  = 1
     oke  = okmax
 
     log_newline
     log_info("OCEAN_GRID_CARTESC_INDEX_setup",*) 'Ocean grid index information '
     log_info_cont('(1x,A,I6,A,I6,A,I6)') 'z-axis levels :', okmax
 
 
     ! at this moment horizontal grid is same as that in atmosphere
     oimax = imax
     oia = ia
     ois = is
     oie = ie
 
     ojmax = jmax
     oja = ja
     ojs = js
     oje = je
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ okmax

integer, public scale_ocean_grid_cartesc_index::okmax = -1

Definition at line 32 of file scale_ocean_grid_cartesC_index.F90.

Referenced by scale_file_cartesc::construct_derived_datatype(), scale_file_cartesc::file_cartesc_create(), scale_file_cartesc::file_cartesc_def_axes(), scale_file_cartesc::file_cartesc_read_1d(), scale_file_cartesc::file_cartesc_setup(), scale_file_cartesc::file_cartesc_write_axes(), scale_file_cartesc::file_cartesc_write_var_3d(), scale_file_cartesc::file_cartesc_write_var_4d(), scale_file_external_input_cartesc::file_external_input_cartesc_setup(), scale_file_history_cartesc::file_history_cartesc_set_pres(), scale_file_history_cartesc::file_history_cartesc_truncate_1d(), scale_file_history_cartesc::file_history_cartesc_truncate_3d(), mod_ocean_driver::ocean_driver_update(), ocean_grid_cartesc_index_setup(), scale_ocean_grid_cartesc::ocean_grid_cartesc_setup(), mod_ocean_vars::ocean_vars_setup(), mod_realinput::realinput_surface(), and scale_file_cartesc::set_dimension_informations().

32 integer, public :: okmax = -1 ! # of computational cells: z for ocean

◆ oimax

integer, public scale_ocean_grid_cartesc_index::oimax = -1

Definition at line 33 of file scale_ocean_grid_cartesC_index.F90.

Referenced by ocean_grid_cartesc_index_setup().

33 integer, public :: oimax = -1 ! # of computational cells: x for ocean

◆ ojmax

integer, public scale_ocean_grid_cartesc_index::ojmax = -1

Definition at line 34 of file scale_ocean_grid_cartesC_index.F90.

Referenced by ocean_grid_cartesc_index_setup().

34 integer, public :: ojmax = -1 ! # of computational cells: y for ocean

◆ oka

integer, public scale_ocean_grid_cartesc_index::oka = -1

Definition at line 36 of file scale_ocean_grid_cartesC_index.F90.

Referenced by scale_file_history_cartesc::file_history_cartesc_truncate_3d(), scale_monitor_cartesc::monitor_cartesc_setup(), mod_ocean_driver::ocean_driver_calc_tendency(), ocean_grid_cartesc_index_setup(), scale_ocean_grid_cartesc_real::ocean_grid_cartesc_real_setup(), scale_ocean_grid_cartesc::ocean_grid_cartesc_setup(), and mod_ocean_vars::ocean_vars_total().

36 integer, public :: oka = -1 ! # of total grids: z for ocean, local

◆ oks

integer, public scale_ocean_grid_cartesc_index::oks

Definition at line 37 of file scale_ocean_grid_cartesC_index.F90.

Referenced by scale_file_cartesc::construct_derived_datatype(), scale_file_cartesc::file_cartesc_read_1d(), scale_file_cartesc::file_cartesc_read_var_3d(), scale_file_cartesc::file_cartesc_read_var_4d(), scale_file_cartesc::file_cartesc_set_coordinates_ocean(), scale_file_cartesc::file_cartesc_set_coordinates_urban(), scale_file_cartesc::file_cartesc_write_axes(), scale_file_cartesc::file_cartesc_write_var_3d(), scale_file_cartesc::file_cartesc_write_var_4d(), scale_file_external_input_cartesc::file_external_input_cartesc_setup(), scale_file_history_cartesc::file_history_cartesc_truncate_1d(), scale_file_history_cartesc::file_history_cartesc_truncate_3d(), scale_monitor_cartesc::monitor_cartesc_setup(), mod_ocean_driver::ocean_driver_calc_tendency(), mod_ocean_driver::ocean_driver_update(), ocean_grid_cartesc_index_setup(), scale_ocean_grid_cartesc_real::ocean_grid_cartesc_real_setup(), scale_ocean_grid_cartesc::ocean_grid_cartesc_setup(), mod_ocean_vars::ocean_vars_history(), mod_ocean_vars::ocean_vars_total(), and mod_realinput::realinput_surface().

37 integer, public :: oks ! start point of inner domain: z for ocean, local

◆ oke

integer, public scale_ocean_grid_cartesc_index::oke

Definition at line 38 of file scale_ocean_grid_cartesC_index.F90.

Referenced by scale_file_cartesc::file_cartesc_read_1d(), scale_file_cartesc::file_cartesc_read_var_3d(), scale_file_cartesc::file_cartesc_read_var_4d(), scale_file_cartesc::file_cartesc_set_coordinates_ocean(), scale_file_cartesc::file_cartesc_set_coordinates_urban(), scale_file_cartesc::file_cartesc_write_axes(), scale_file_cartesc::file_cartesc_write_var_3d(), scale_file_cartesc::file_cartesc_write_var_4d(), scale_file_external_input_cartesc::file_external_input_cartesc_setup(), scale_file_history_cartesc::file_history_cartesc_truncate_3d(), scale_monitor_cartesc::monitor_cartesc_setup(), mod_ocean_driver::ocean_driver_calc_tendency(), mod_ocean_driver::ocean_driver_update(), ocean_grid_cartesc_index_setup(), scale_ocean_grid_cartesc_real::ocean_grid_cartesc_real_setup(), scale_ocean_grid_cartesc::ocean_grid_cartesc_setup(), mod_ocean_vars::ocean_vars_history(), and mod_ocean_vars::ocean_vars_total().

38 integer, public :: oke ! end point of inner domain: z for ocean, local

◆ oia

integer, public scale_ocean_grid_cartesc_index::oia

Definition at line 40 of file scale_ocean_grid_cartesC_index.F90.

Referenced by mod_atmos_phy_ch_driver::atmos_phy_ch_driver_ocean_flux(), scale_monitor_cartesc::monitor_cartesc_setup(), mod_ocean_driver::ocean_driver_calc_tendency(), mod_ocean_driver::ocean_driver_setup(), mod_ocean_driver::ocean_driver_update(), ocean_grid_cartesc_index_setup(), scale_ocean_grid_cartesc_real::ocean_grid_cartesc_real_setup(), mod_ocean_vars::ocean_vars_restart_read(), mod_ocean_vars::ocean_vars_setup(), and mod_ocean_vars::ocean_vars_total().

40 integer, public :: oia ! # of total grids: x for ocean, local

◆ ois

integer, public scale_ocean_grid_cartesc_index::ois

Definition at line 41 of file scale_ocean_grid_cartesC_index.F90.

Referenced by mod_atmos_phy_ch_driver::atmos_phy_ch_driver_ocean_flux(), scale_monitor_cartesc::monitor_cartesc_setup(), mod_ocean_driver::ocean_driver_calc_tendency(), mod_ocean_driver::ocean_driver_update(), ocean_grid_cartesc_index_setup(), scale_ocean_grid_cartesc_real::ocean_grid_cartesc_real_setup(), mod_ocean_vars::ocean_vars_history(), mod_ocean_vars::ocean_vars_restart_read(), and mod_ocean_vars::ocean_vars_total().

41 integer, public :: ois ! start point of inner domain: x for ocean, local

◆ oie

integer, public scale_ocean_grid_cartesc_index::oie

Definition at line 42 of file scale_ocean_grid_cartesC_index.F90.

Referenced by mod_atmos_phy_ch_driver::atmos_phy_ch_driver_ocean_flux(), scale_monitor_cartesc::monitor_cartesc_setup(), mod_ocean_driver::ocean_driver_calc_tendency(), mod_ocean_driver::ocean_driver_update(), ocean_grid_cartesc_index_setup(), scale_ocean_grid_cartesc_real::ocean_grid_cartesc_real_setup(), mod_ocean_vars::ocean_vars_history(), mod_ocean_vars::ocean_vars_restart_read(), and mod_ocean_vars::ocean_vars_total().

42 integer, public :: oie ! end point of inner domain: x for ocean, local

◆ oja

integer, public scale_ocean_grid_cartesc_index::oja

Definition at line 44 of file scale_ocean_grid_cartesC_index.F90.

Referenced by mod_atmos_phy_ch_driver::atmos_phy_ch_driver_ocean_flux(), scale_monitor_cartesc::monitor_cartesc_setup(), mod_ocean_driver::ocean_driver_calc_tendency(), mod_ocean_driver::ocean_driver_setup(), mod_ocean_driver::ocean_driver_update(), ocean_grid_cartesc_index_setup(), scale_ocean_grid_cartesc_real::ocean_grid_cartesc_real_setup(), mod_ocean_vars::ocean_vars_restart_read(), mod_ocean_vars::ocean_vars_setup(), and mod_ocean_vars::ocean_vars_total().

44 integer, public :: oja ! # of total grids: y for ocean, local

◆ ojs

integer, public scale_ocean_grid_cartesc_index::ojs

Definition at line 45 of file scale_ocean_grid_cartesC_index.F90.

Referenced by mod_atmos_phy_ch_driver::atmos_phy_ch_driver_ocean_flux(), scale_monitor_cartesc::monitor_cartesc_setup(), mod_ocean_driver::ocean_driver_calc_tendency(), mod_ocean_driver::ocean_driver_update(), ocean_grid_cartesc_index_setup(), scale_ocean_grid_cartesc_real::ocean_grid_cartesc_real_setup(), mod_ocean_vars::ocean_vars_history(), mod_ocean_vars::ocean_vars_restart_read(), and mod_ocean_vars::ocean_vars_total().

45 integer, public :: ojs ! start point of inner domain: y for ocean, local

◆ oje

integer, public scale_ocean_grid_cartesc_index::oje

Definition at line 46 of file scale_ocean_grid_cartesC_index.F90.

Referenced by mod_atmos_phy_ch_driver::atmos_phy_ch_driver_ocean_flux(), scale_monitor_cartesc::monitor_cartesc_setup(), mod_ocean_driver::ocean_driver_calc_tendency(), mod_ocean_driver::ocean_driver_update(), ocean_grid_cartesc_index_setup(), scale_ocean_grid_cartesc_real::ocean_grid_cartesc_real_setup(), mod_ocean_vars::ocean_vars_history(), mod_ocean_vars::ocean_vars_restart_read(), and mod_ocean_vars::ocean_vars_total().

46 integer, public :: oje ! end point of inner domain: y for ocean, local