mod_ocean_component Module Reference

module Oceanic component More...

Data Types
type	oceancomponent
	Derived type to manage oceanic component. More...

Functions/Subroutines
subroutine	ocean_setup (this)
	Setup an object to mange oceanic component.

Detailed Description

module Oceanic component

Description

Oceanic component module

Author

Yuta Kawai, Team SCALE

NAMELIST

• PARAM_OCEAN

  name	type	default value	comment
  ACTIVATE_FLAG	logical	.false.	Flag whether oceanic component is activated
  TIME_DT	real(DP)	UNDEF8	Timestep value of oceanic component
  TIME_DT_UNIT	character(len=H_SHORT)	'SEC'	Timestep unit of oceanic component
  TIME_DT_RESTART	real(DP)	UNDEF8	Timestep value when outputting restart file for oceanic component
  TIME_DT_RESTART_UNIT	character(len=H_SHORT)	'SEC'	Timestep unit when outputting restart file for oceanic component
  OCEAN_MESH_TYPE	character(len=H_SHORT)	'REGIONAL' !< Name of mesh type for oceanic component ('REGIONAL' or 'GLOBAL')
  OCEAN_DYN_DO	logical	.true.	Flag whether dynamics process is considered

  
  

History Output

No history output

Function/Subroutine Documentation

ocean_setup()

subroutine mod_ocean_component::ocean_setup

(

class(oceancomponent), intent(inout), target

this

)

Setup an object to mange oceanic component.

Definition at line 108 of file mod_ocean_component.F90.

    use scale_const, only: &
      undef8 => const_undef8
    
    use scale_file_history_meshfield, only: &
      file_history_meshfield_setup  
    use scale_time_manager, only: &
      time_manager_regist_component
 
    implicit none
    
    class(OceanComponent), intent(inout), target :: this
 
    logical :: ACTIVATE_FLAG = .false. !< Flag whether oceanic component is activated
 
    real(DP) :: TIME_DT                             = undef8  !< Timestep value of oceanic component
    character(len=H_SHORT) :: TIME_DT_UNIT          = 'SEC'   !< Timestep unit of oceanic component
    real(DP) :: TIME_DT_RESTART                     = undef8  !< Timestep value when outputting restart file for oceanic component
    character(len=H_SHORT) :: TIME_DT_RESTART_UNIT  = 'SEC'   !< Timestep unit when outputting restart file for oceanic component
 
    logical :: OCEAN_DYN_DO    = .true.  !< Flag whether dynamics process is considered
    character(len=H_SHORT) :: OCEAN_MESH_TYPE = 'REGIONAL'  !< Name of mesh type for oceanic component ('REGIONAL' or 'GLOBAL')
 
 
    namelist / param_ocean / &
      activate_flag,         &
      time_dt,               &
      time_dt_unit,          &
      time_dt_restart,       &
      time_dt_restart_unit,  &
      ocean_mesh_type,       &
      ocean_dyn_do
    
    integer :: ierr
    !--------------------------------------------------
 
    log_info('OceanComponent_setup',*) 'Oceanic model components '
    
    !--- read namelist
    rewind(io_fid_conf)
    read(io_fid_conf,nml=param_ocean,iostat=ierr)
    if( ierr < 0 ) then !--- missing
      log_info("Ocean_setup",*) 'Not found namelist. Default used.'
    elseif( ierr > 0 ) then !--- fatal error
      log_error("Ocean_setup",*) 'Not appropriate names in namelist PARAM_OCEAN. Check!'
      call prc_abort
    endif
    log_nml(param_ocean)
 
    !************************************************
    call this%ModelComponent_Init('OCEAN', activate_flag )
 
    if ( .not. activate_flag ) return
    
    call prof_rapstart( 'Ocean_setup', 1)
 
    !- Setup time manager
 
    call this%time_manager%Init( this%GetComponentName(), &
      time_dt, time_dt_unit,                              &
      time_dt_restart, time_dt_restart_unit               ) 
    
    call time_manager_regist_component( this%time_manager )
    
    !- Setup mesh & file I/O for oceanic component
    
    this%mesh_type = ocean_mesh_type
    select case( this%mesh_type )
    case('REGIONAL')
      call this%mesh_rm%Init()
      call file_history_meshfield_setup( mesh3d_=this%mesh_rm%mesh, & ! (in)
        dim_name_postfix_='_O',                                     & ! (in)
        registered_comp_id=this%vars%hist_comp_id                   ) ! (out)
      this%mesh => this%mesh_rm
    case('GLOBAL')
      call this%mesh_gm%Init()
      call file_history_meshfield_setup( meshcubedsphere3d_=this%mesh_gm%mesh, & ! (in)
        dim_name_postfix_='_O',                                                & ! (in)      
        registered_comp_id=this%vars%hist_comp_id )                              ! (out)
      this%mesh => this%mesh_gm
    case default
      log_error("Ocean_setup",*) 'Unsupported type of mesh is specified. Check!', this%mesh_type
      call prc_abort    
    end select
    
    !- setup common tools for oceanic model
 
    !- Setup each processes in ocean model ------------------------------------
 
    !- Setup the module for ocean / dynamics 
    call this%dyn_proc%ModelComponentProc_Init( 'OceanDyn', ocean_dyn_do )
    call this%dyn_proc%setup( this%mesh, this%time_manager )
    
    !- Setup
 
    log_newline
    log_info('OceanComponent_setup',*) 'Finish setup of each oceanic component.'
 
    call prof_rapend( 'Ocean_setup', 1)
 
    return

References scale_atm_phy_sf_bulk_simple::atmos_phy_sf_simple_flux(), mod_ocean_vars::atmvar2d_sflx_rd_lw_dif_id, mod_ocean_vars::atmvar2d_sflx_rd_sw_dir_id, mod_ocean_vars::auxvar2d_sfc_alb_vis_dir_id, scale_file_history_meshfield::file_history_meshfield_setup(), mod_ocean_vars::ocn_sflx_lh_id, mod_ocean_vars::ocn_sflx_mu_id, mod_ocean_vars::ocn_sflx_mv_id, mod_ocean_vars::ocn_sflx_mw_id, mod_ocean_vars::ocn_sflx_qv_id, mod_ocean_vars::ocn_sflx_sh_id, mod_ocean_vars::phytend_rhoh_id, and scale_time_manager::time_manager_regist_component().