mod_ocean_admin.f90

Go to the documentation of this file.

!-------------------------------------------------------------------------------
!-------------------------------------------------------------------------------
module mod_ocean_admin
  !-----------------------------------------------------------------------------
  !
  !++ used modules
  !
  use scale_precision
  use scale_stdio
  use scale_prof
  use scale_debug
  !-----------------------------------------------------------------------------
  implicit none
  private
  !-----------------------------------------------------------------------------
  !
  !++ Public procedure
  !
  public :: ocean_admin_setup
  public :: ocean_admin_getscheme

  !-----------------------------------------------------------------------------
  !
  !++ Public parameters & variables
  !
  logical,                public :: ocean_do   = .true. ! main switch for the model

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

  logical,                public :: ocean_sw

  !-----------------------------------------------------------------------------
  !
  !++ Private procedure
  !
  !-----------------------------------------------------------------------------
  !
  !++ Private parameters & variables
  !
  !-----------------------------------------------------------------------------
contains
  !-----------------------------------------------------------------------------
  subroutine ocean_admin_setup
    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
  end subroutine ocean_admin_setup

  !-----------------------------------------------------------------------------
  subroutine ocean_admin_getscheme( &
       scheme_name     )
    use scale_process, only: &
       prc_mpistop
    implicit none

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

    scheme_name = ocean_type

    return
  end subroutine ocean_admin_getscheme

end module mod_ocean_admin