mod_ocean_mesh_gm Module Reference

module Ocean / Mesh More...

Data Types
type	oceanmeshgm
	Derived type to manage a computational mesh of global ocean model. More...

Functions/Subroutines
subroutine	oceanmeshgm_init (this)
	Initialize an object to manage computational mesh.

Detailed Description

module Ocean / Mesh

Description

Module for mesh with ocean global model

Author

Yuta kawai, Team SCALE

NAMELIST

• PARAM_OCEAN_MESH

  name	type	default value	comment
  SHALLOW_OCN_APPROX_FLAG	logical	.true.	Flag whether the shallow ocean approximation is applied
  DOM_ZMIN	real(RP)	0.0_RP	Minimum vertical coordinate value of the computational domain
  DOM_ZMAX	real(RP)	10.0E3_RP	Maximum vertical coordinate value of the computational domain
  FZ	real(RP), dimension(FZ_NMAX)		Values of the vertically computational coordinate at the element boundaries
  ISPERIODICZ	logical	.false.	Flag whether a periodic boundary condition is applied in the vertical direction
  NEGX	integer	2	Number of finite element in the y-coordinate direction in each panel of the cubed-sphere mesh
  NEGY	integer	2	Number of finite element in the y-coordinate direction in each panel of the cubed-sphere mesh
  NEZ	integer	2	Number of finite element in the vertical direction in each MPI process
  NLOCALMESHPERPRC	integer	6	Number of local mesh per MPI process
  NPRC	integer	1	Total number of MPI process
  POLYORDER_H	integer	2	Polynomial order for the horizontal direction
  POLYORDER_V	integer	2	Polynomial order for the z-direction
  LUMPEDMASSMATFLAG	logical	.false.	Flag whether a mass lumping is applied
  ELEMENT_OPERATION_TYPE	character(len=H_SHORT)	'General'	General or TensorProd3D
  SPMV_STORAGE_FORMAT	character(len=H_SHORT)	'ELL'	CSR or ELL
  VERTICAL_COORD_NAME	character(len=H_MID)	"TERRAIN_FOLLOWING"	Type of the vertical coordinate
  TOPO_IN_BASENAME	character(len=H_LONG)	''	Basename of the input file
  TOPO_IN_VARNAME	character(len=H_MID)	'topo'	Variable name of topography in the input file
  COMM_USE_MPI_PC	logical	.false.	Flag whether persistent communication is used in MPI
  COMM_USE_MPI_PC_FUJITSU_EXT	logical

  
  

History Output

No history output

Function/Subroutine Documentation

oceanmeshgm_init()

subroutine mod_ocean_mesh_gm::oceanmeshgm_init

(

class(oceanmeshgm), intent(inout), target

this

)

Initialize an object to manage computational mesh.

Definition at line 81 of file mod_ocean_mesh_gm.F90.

    use scale_const, only: &
      rplanet => const_radius
    use scale_mesh_base2d, only: meshbase2d
    use scale_meshutil_vcoord, only: &
      meshutil_get_vcoord_typeid
    
    implicit none
    class(OceanMeshGM), target, intent(inout) :: this
 
    real(RP) :: dom_zmin          = 0.0_rp      !< Minimum vertical coordinate value of the computational domain
    real(RP) :: dom_zmax          = 10.0e3_rp   !< Maximum vertical coordinate value of the computational domain
    logical  :: isPeriodicZ       = .false.     !< Flag whether a periodic boundary condition is applied in the vertical direction
  
    integer, parameter :: FZ_nmax = 1000
    real(RP) :: FZ(FZ_nmax)                  !< Values of the vertically computational coordinate at the element boundaries
 
    !* Global
    logical :: SHALLOW_OCN_APPROX_FLAG = .true.  !< Flag whether the shallow ocean approximation is applied
    integer  :: NeGX               = 2           !< Number of finite element in the y-coordinate direction in each panel of the cubed-sphere mesh
    integer  :: NeGY               = 2           !< Number of finite element in the y-coordinate direction in each panel of the cubed-sphere mesh
    integer  :: NeZ                = 2           !< Number of finite element in the vertical direction in each MPI process
    integer  :: NLocalMeshPerPrc   = 6           !< Number of local mesh per MPI process 
    integer  :: Nprc               = 1           !< Total number of MPI process
    integer  :: PolyOrder_h        = 2           !< Polynomial order for the horizontal direction
    integer  :: PolyOrder_v        = 2           !< Polynomial order for the z-direction
    logical  :: LumpedMassMatFlag  = .false.     !< Flag whether a mass lumping is applied
 
    character(len=H_LONG) :: TOPO_IN_BASENAME    = ''                   !< Basename of the input file
    character(len=H_MID)  :: TOPO_IN_VARNAME     = 'topo'               !< Variable name of topography in the input file
    character(len=H_MID)  :: VERTICAL_COORD_NAME = "TERRAIN_FOLLOWING"  !< Type of the vertical coordinate
 
    logical :: COMM_USE_MPI_PC             = .false. !< Flag whether persistent communication is used in MPI
    logical :: COMM_USE_MPI_PC_FUJITSU_EXT
 
    character(len=H_SHORT) :: Element_operation_type = 'General' !< General or TensorProd3D
    character(len=H_SHORT) :: SpMV_storage_format    = 'ELL'     !< CSR or ELL
    
    namelist / param_ocean_mesh / &
      shallow_ocn_approx_flag,                     &
      dom_zmin, dom_zmax,                          &
      fz, isperiodicz,                             &
      negx, negy, nez, nlocalmeshperprc, nprc,     &
      polyorder_h, polyorder_v, lumpedmassmatflag, &
      element_operation_type,                      &
      spmv_storage_format,                         &
      vertical_coord_name,                         &
      topo_in_basename, topo_in_varname,           &
      comm_use_mpi_pc,                             &
      comm_use_mpi_pc_fujitsu_ext
    
    integer :: k
    logical :: is_spec_FZ
    
    integer :: ierr
    !-------------------------------------------
 
    log_newline
    log_info("OCN_MESH_setup",*) 'Setup'
 
    fz(:) = -1.0_rp
#ifdef __FUJITSU
    comm_use_mpi_pc_fujitsu_ext = .true.
#else
    comm_use_mpi_pc_fujitsu_ext = .false.
#endif
 
    rewind(io_fid_conf)
    read(io_fid_conf,nml=param_ocean_mesh,iostat=ierr)
    if( ierr < 0 ) then !--- missing
      log_info("OCN_MESH_setup",*) 'Not found namelist. Default used.'
    elseif( ierr > 0 ) then !--- fatal error
      log_error("OCN_MESH_setup",*) 'Not appropriate names in namelist PARAM_OCEAN_MESH. Check!'
      call prc_abort
    endif
    log_nml(param_ocean_mesh)
 
    !----
 
    !- Setup the element
 
    call this%element%Init( polyorder_h, polyorder_v, lumpedmassmatflag )
    call this%element_v1D%Init( polyorder_v, lumpedmassmatflag )
 
    !- Setup the mesh
 
    is_spec_fz = .true.
    do k=1, nez+1
      if (fz(k) < 0.0_rp) then
        is_spec_fz = .false.
      end if
    end do
    if (is_spec_fz) then
      call this%mesh%Init( &
        negx, negy, nez, rplanet, dom_zmin, dom_zmax,          &
        this%element, nlocalmeshperprc, nproc=nprc,            &
        fz=fz(1:nez+1), shallow_approx=shallow_ocn_approx_flag )
    else
      call this%mesh%Init( &
        negx, negy, nez, rplanet, dom_zmin, dom_zmax, &
        this%element, nlocalmeshperprc, nproc=nprc,   &
        shallow_approx=shallow_ocn_approx_flag        )
    end if
    
    call this%mesh%Generate()
    
    !-
 
    call this%OceanMesh_Init( this%mesh )
    call this%PrepairElementOperation( element_operation_type, spmv_storage_format )
 
    !- Set topography & vertical coordinate
    
    call this%Read_topography_file( topo_in_basename, topo_in_varname, &
      this%mesh%mesh2D, dom_zmin )
 
    this%vcoord_type_id = meshutil_get_vcoord_typeid( vertical_coord_name )
    ! We tentatively disable the setup of vertical coordinate in ocean component. 
    ! For future, we will implement a more flexible setup of vertical coordinate.
    ! call this%Setup_vcoordinate()
 
    !-
    this%comm_use_mpi_pc             = comm_use_mpi_pc
    this%comm_use_mpi_pc_fujitsu_ext = comm_use_mpi_pc_fujitsu_ext
 
    return

References scale_cubedsphere_coord_cnv::cubedspherecoordcnv_cs2lonlatvec(), scale_meshutil_vcoord::meshutil_get_vcoord_typeid(), and mod_ocean_mesh::ocn_mesh_max_commnuicator_num.