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

  name	type	default value	comment
  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_fid_nml, scale_stdio::io_l, scale_stdio::io_nml, ocean_do, ocean_sw, ocean_type, and scale_process::prc_mpistop().

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

    use scale_process, only: &
       prc_mpistop
    implicit none

    namelist / param_ocean / &
       ocean_do,   &
       ocean_type

    integer :: ierr
    !---------------------------------------------------------------------------

    if( io_l ) write(io_fid_log,*)
    if( io_l ) write(io_fid_log,*) '++++++ Module[ADMIN] / Categ[OCEAN] / Origin[SCALE-RM]'

    !--- read namelist
    rewind(io_fid_conf)
    read(io_fid_conf,nml=param_ocean,iostat=ierr)
    if( ierr < 0 ) then !--- missing
       if( io_l ) write(io_fid_log,*) '*** Not found namelist. Default used.'
    elseif( ierr > 0 ) then !--- fatal error
       write(*,*) 'xxx Not appropriate names in namelist PARAM_OCEAN. Check!'
       call prc_mpistop
    endif
    if( io_nml ) write(io_fid_nml,nml=param_ocean)

    !-----< module component check >-----

    if( io_l ) write(io_fid_log,*)
    if( io_l ) write(io_fid_log,*) '*** Ocean model components ***'

    if ( ocean_type == 'OFF' .OR. ocean_type == 'NONE' ) then
       ocean_do = .false. ! force off
    endif

    if ( ocean_do ) then
       if( io_l ) write(io_fid_log,*) '*** Ocean model     : ON'
    else
       if( io_l ) write(io_fid_log,*) '*** Ocean model     : OFF'
    endif

    if ( ocean_type /= 'OFF' .AND. ocean_type /= 'NONE' ) then
       if( io_l ) write(io_fid_log,*) '*** + Ocean physics : ON, ', trim(ocean_type)
       ocean_sw = .true.
    else
       if( io_l ) write(io_fid_log,*) '*** + Ocean physics : OFF'
       ocean_sw = .false.
    endif

    return

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().

    use scale_process, only: &
       prc_mpistop
    implicit none

    character(len=H_SHORT), intent(out) :: scheme_name
    !---------------------------------------------------------------------------

    scheme_name = ocean_type

    return

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 mod_admin_restart::admin_restart_read(), ocean_admin_setup(), mod_rm_driver::resume_state(), and mod_rm_driver::scalerm().

  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().

  character(len=H_SHORT), public :: OCEAN_TYPE = 'NONE'

ocean_sw

logical, public mod_ocean_admin::ocean_sw

Definition at line 37 of file mod_ocean_admin.f90.

Referenced by mod_cpl_admin::cpl_admin_setup(), mod_cpl_vars::cpl_vars_setup(), ocean_admin_setup(), mod_ocean_driver::ocean_driver(), mod_ocean_driver::ocean_driver_resume(), mod_ocean_phy_driver::ocean_phy_driver_resume(), mod_ocean_phy_driver::ocean_phy_driver_setup(), mod_ocean_driver::ocean_surface_get(), mod_ocean_driver::ocean_surface_set(), mod_ocean_vars::ocean_vars_restart_create(), and mod_ocean_vars::ocean_vars_restart_open().

  logical,                public :: OCEAN_sw