SCALE-RM
Functions/Subroutines | Variables
mod_ocean_admin Module Reference

module Ocean admin More...

Functions/Subroutines

subroutine, public ocean_admin_setup
 Setup. More...
 
subroutine, public ocean_admin_getscheme (scheme_name)
 Get name of scheme for each component. More...
 

Variables

logical, public ocean_do = .true.
 
character(len=h_short), public ocean_type = 'NONE'
 
logical, public ocean_sw
 

Detailed Description

module Ocean admin

Description
Ocean submodel administrator
Author
Team SCALE
NAMELIST
  • PARAM_OCEAN
    nametypedefault valuecomment
    OCEAN_DO logical .true. main switch for the model
    OCEAN_TYPE character(len=H_SHORT) 'NONE'

History Output
No history output

Function/Subroutine Documentation

◆ ocean_admin_setup()

subroutine, public mod_ocean_admin::ocean_admin_setup ( )

Setup.

Definition at line 52 of file mod_ocean_admin.f90.

References scale_stdio::io_fid_conf, scale_stdio::io_fid_log, scale_stdio::io_l, scale_stdio::io_lnml, ocean_do, ocean_sw, ocean_type, and scale_process::prc_mpistop().

Referenced by mod_rm_driver::scalerm(), and mod_rm_prep::scalerm_prep().

52  use scale_process, only: &
54  implicit none
55 
56  namelist / param_ocean / &
57  ocean_do, &
58  ocean_type
59 
60  integer :: ierr
61  !---------------------------------------------------------------------------
62 
63  if( io_l ) write(io_fid_log,*)
64  if( io_l ) write(io_fid_log,*) '++++++ Module[ADMIN] / Categ[OCEAN] / Origin[SCALE-RM]'
65 
66  !--- read namelist
67  rewind(io_fid_conf)
68  read(io_fid_conf,nml=param_ocean,iostat=ierr)
69  if( ierr < 0 ) then !--- missing
70  if( io_l ) write(io_fid_log,*) '*** Not found namelist. Default used.'
71  elseif( ierr > 0 ) then !--- fatal error
72  write(*,*) 'xxx Not appropriate names in namelist PARAM_OCEAN. Check!'
73  call prc_mpistop
74  endif
75  if( io_lnml ) write(io_fid_log,nml=param_ocean)
76 
77  !-----< module component check >-----
78 
79  if( io_l ) write(io_fid_log,*)
80  if( io_l ) write(io_fid_log,*) '*** Ocean model components ***'
81 
82  if ( ocean_type == 'OFF' .OR. ocean_type == 'NONE' ) then
83  ocean_do = .false. ! force off
84  endif
85 
86  if ( ocean_do ) then
87  if( io_l ) write(io_fid_log,*) '*** Ocean model : ON'
88  else
89  if( io_l ) write(io_fid_log,*) '*** Ocean model : OFF'
90  endif
91 
92  if ( ocean_type /= 'OFF' .AND. ocean_type /= 'NONE' ) then
93  if( io_l ) write(io_fid_log,*) '*** + Ocean physics : ON, ', trim(ocean_type)
94  ocean_sw = .true.
95  else
96  if( io_l ) write(io_fid_log,*) '*** + Ocean physics : OFF'
97  ocean_sw = .false.
98  endif
99 
100  return
logical, public ocean_sw
subroutine, public prc_mpistop
Abort MPI.
logical, public io_l
output log or not? (this process)
Definition: scale_stdio.F90:59
module PROCESS
logical, public io_lnml
output log or not? (for namelist, this process)
Definition: scale_stdio.F90:60
integer, public io_fid_conf
Config file ID.
Definition: scale_stdio.F90:55
integer, public io_fid_log
Log file ID.
Definition: scale_stdio.F90:56
Here is the call graph for this function:
Here is the caller graph for this function:

◆ ocean_admin_getscheme()

subroutine, public mod_ocean_admin::ocean_admin_getscheme ( character(len=h_short), intent(out)  scheme_name)

Get name of scheme for each component.

Definition at line 107 of file mod_ocean_admin.f90.

References ocean_type, and scale_process::prc_mpistop().

107  use scale_process, only: &
109  implicit none
110 
111  character(len=H_SHORT), intent(out) :: scheme_name
112  !---------------------------------------------------------------------------
113 
114  scheme_name = ocean_type
115 
116  return
subroutine, public prc_mpistop
Abort MPI.
module PROCESS
Here is the call graph for this function:

Variable Documentation

◆ ocean_do

logical, public mod_ocean_admin::ocean_do = .true.

Definition at line 33 of file mod_ocean_admin.f90.

Referenced by ocean_admin_setup(), mod_rm_driver::resume_state(), and mod_rm_driver::scalerm().

33  logical, public :: ocean_do = .true. ! main switch for the model

◆ ocean_type

character(len=h_short), public mod_ocean_admin::ocean_type = 'NONE'

Definition at line 35 of file mod_ocean_admin.f90.

Referenced by ocean_admin_getscheme(), ocean_admin_setup(), and mod_ocean_phy_driver::ocean_phy_driver_setup().

35  character(len=H_SHORT), public :: ocean_type = 'NONE'

◆ ocean_sw

logical, public mod_ocean_admin::ocean_sw