module Ocean / Mesh More...

Data Types
type	oceanmeshrm
	Derived type to manage a computational mesh of regional ocean model. More...

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

Detailed Description

module Ocean / Mesh

Description: Module for mesh with ocean regional model

Author: Yuta Kawai, Team SCALE

NAMELIST

PARAM_OCEAN_MESH

name	type	default value	comment
DOM_XMIN	real(RP)	0.0_RP	Minimum x-coordinate value of the computational domain
DOM_XMAX	real(RP)	100.0E3_RP	Maximum x-coordinate value of the computational domain
DOM_YMIN	real(RP)	0.0_RP	Minimum y-coordinate value of the computational domain
DOM_YMAX	real(RP)	100.0E3_RP	Maximum y-coordinate value of the computational domain
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
ISPERIODICX	logical	.true.	Flag whether a periodic boundary condition is applied in the x-direction
ISPERIODICY	logical	.true.	Flag whether a periodic boundary condition is applied in the y-direction
ISPERIODICZ	logical	.false.	Flag whether a periodic boundary condition is applied in the vertical direction
NEX	integer	2	Number of finite element in the x-direction in each MPI process
NEY	integer	2	Number of finite element in the y-direction in each MPI process
NEZ	integer	2	Number of finite element in the vertical direction in each 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'	Storage format of sparse matrix (CSR or ELL)
NPRCX	integer	1	Number of MPI process in the x-direction
NPRCY	integer	1	Number of MPI process in the y-direction
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
VERTICAL_COORD_NAME	character(len=H_MID)	"TERRAIN_FOLLOWING"	Type of the vertical coordinate
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

◆ oceanmeshrm_init()

subroutine mod_ocean_mesh_rm::oceanmeshrm_init ( class(oceanmeshrm), intent(inout), target this )

Initialize an object to manage computational mesh.

Definition at line 82 of file mod_ocean_mesh_rm.F90.

    use scale_meshutil_vcoord, only: &
      meshutil_get_vcoord_typeid
 
    implicit none
    class(OceanMeshRM), target, intent(inout) :: this
 
    real(RP) :: dom_xmin         = 0.0_rp      !< Minimum x-coordinate value of the computational domain
    real(RP) :: dom_xmax         = 100.0e3_rp  !< Maximum x-coordinate value of the computational domain
    real(RP) :: dom_ymin         = 0.0_rp      !< Minimum y-coordinate value of the computational domain
    real(RP) :: dom_ymax         = 100.0e3_rp  !< Maximum y-coordinate value of the computational domain
    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  :: isPeriodicX       = .true.     !< Flag whether a periodic boundary condition is applied in the x-direction
    logical  :: isPeriodicY       = .true.     !< Flag whether a periodic boundary condition is applied in the y-direction
    logical  :: isPeriodicZ       = .false.    !< Flag whether a periodic boundary condition is applied in the vertical direction
 
    integer  :: NeX               = 2        !< Number of finite element in the x-direction in each MPI process
    integer  :: NeY               = 2        !< Number of finite element in the y-direction in each MPI process
    integer  :: NeZ               = 2        !< Number of finite element in the vertical direction in each MPI process
    integer  :: NprcX             = 1        !< Number of MPI process in the x-direction
    integer  :: NprcY             = 1        !< Number of MPI process in the y-direction
    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'     !< Storage format of sparse matrix (CSR or ELL)
 
    integer, parameter :: ATMOS_MESH_NLocalMeshPerPrc = 1
 
    integer, parameter :: FZ_nmax = 1000
    real(RP) :: FZ(FZ_nmax)                  !< Values of the vertically computational coordinate at the element boundaries
 
    namelist / param_ocean_mesh / &
      dom_xmin, dom_xmax,                          &
      dom_ymin, dom_ymax,                          &
      dom_zmin, dom_zmax,                          &
      fz,                                          &
      isperiodicx, isperiodicy, isperiodicz,       &
      nex, ney, nez,                               &
      polyorder_h, polyorder_v, lumpedmassmatflag, &
      element_operation_type,                      &
      spmv_storage_format,                         &
      nprcx, nprcy,                                &
      topo_in_basename, topo_in_varname,           &
      vertical_coord_name,                         &
      comm_use_mpi_pc,                             &
      comm_use_mpi_pc_fujitsu_ext
    
    integer :: k
    logical :: is_spec_FZ
 
    integer :: ierr
    !-------------------------------------------
 
    log_newline
    log_info("OCEAN_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("OCEAN_MESH_setup",*) 'Not found namelist. Default used.'
    elseif( ierr > 0 ) then !--- fatal error
        log_error("OCEAN_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( &
        nprcx*nex, nprcy*ney, nez,                                 &
        dom_xmin, dom_xmax,dom_ymin, dom_ymax, dom_zmin, dom_zmax, &
        isperiodicx, isperiodicy, isperiodicz,                     &
        this%element, atmos_mesh_nlocalmeshperprc, nprcx, nprcy,   &
        fz=fz(1:nez+1)    )
    else
      call this%mesh%Init( &
        nprcx*nex, nprcy*ney, nez,                                 &
        dom_xmin, dom_xmax,dom_ymin, dom_ymax, dom_zmin, dom_zmax, &
        isperiodicx, isperiodicy, isperiodicz,                     &
        this%element, atmos_mesh_nlocalmeshperprc, nprcx, nprcy    )
    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_meshutil_vcoord::meshutil_get_vcoord_typeid(), and mod_ocean_mesh::ocn_mesh_max_commnuicator_num.

Data Types

Functions/Subroutines

Detailed Description

Function/Subroutine Documentation

◆ oceanmeshrm_init()