module LANDUSE More...

Functions/Subroutines
subroutine, public	landuse_setup
	Setup. More...

subroutine, public	landuse_calc_fact

subroutine, public	landuse_write
	Write landuse data. More...

Variables
real(rp), dimension(:,:), allocatable, public	landuse_fact_ocean
	ocean factor More...

real(rp), dimension(:,:), allocatable, public	landuse_fact_land
	land factor More...

real(rp), dimension(:,:), allocatable, public	landuse_fact_urban
	urban factor More...

real(rp), dimension(:,:), allocatable, public	landuse_frac_land
	land fraction More...

real(rp), dimension(:,:), allocatable, public	landuse_frac_lake
	lake fraction More...

real(rp), dimension(:,:), allocatable, public	landuse_frac_urban
	urban fraction More...

integer, public	landuse_pft_mosaic = 2
	number of PFT mosaic More...

integer, public	landuse_pft_nmax = 15
	number of plant functional type(PFT) More...

real(rp), dimension(:,:,:), allocatable, public	landuse_frac_pft
	fraction of PFT for each mosaic More...

integer, dimension(:,:,:), allocatable, public	landuse_index_pft
	index of PFT for each mosaic More...

Detailed Description

module LANDUSE

Description: Land use category module Manage land/lake/urban/PFT fraction and PFT index

Author: Team SCALE

NAMELIST

PARAM_LANDUSE

name	type	default value	comment
LANDUSE_IN_BASENAME	character(len=H_LONG)	''	basename of the input file
LANDUSE_IN_CHECK_COORDINATES	logical	.true.	switch for check of coordinates
LANDUSE_OUT_BASENAME	character(len=H_LONG)	''	basename of the output file
LANDUSE_OUT_DTYPE	character(len=H_SHORT)	'DEFAULT'	REAL4 or REAL8
LANDUSE_PFT_MOSAIC	integer	2	number of PFT mosaic
LANDUSE_PFT_NMAX	integer	15	number of plant functional type(PFT)
LANDUSE_ALLOCEAN	logical	.false.
LANDUSE_ALLLAND	logical	.false.
LANDUSE_ALLURBAN	logical	.false.
LANDUSE_MOSAICWORLD	logical	.false.

History Output: No history output

Function/Subroutine Documentation

◆ landuse_setup()

subroutine, public scale_landuse::landuse_setup ( )

Setup.

Definition at line 74 of file scale_landuse.F90.

References scale_grid_index::ia, scale_stdio::io_fid_conf, scale_stdio::io_fid_log, scale_stdio::io_fid_nml, scale_stdio::io_l, scale_stdio::io_nml, scale_grid_index::ja, landuse_calc_fact(), landuse_fact_land, landuse_fact_ocean, landuse_fact_urban, landuse_frac_lake, landuse_frac_land, landuse_frac_pft, landuse_frac_urban, landuse_index_pft, landuse_pft_mosaic, landuse_pft_nmax, 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_landuse / &
        landuse_in_basename,          &
        landuse_in_check_coordinates, &
        landuse_out_basename,         &
        landuse_out_dtype,            &
        landuse_pft_mosaic,           &
        landuse_pft_nmax,             &
        landuse_allocean,             &
        landuse_allland,              &
        landuse_allurban,             &
        landuse_mosaicworld
 
     integer :: ierr
     !---------------------------------------------------------------------------
 
     if( io_l ) write(io_fid_log,*)
     if( io_l ) write(io_fid_log,*) '++++++ Module[LANDUSE] / Categ[COUPLER] / Origin[SCALElib]'
 
     !--- read namelist
     rewind(io_fid_conf)
     read(io_fid_conf,nml=param_landuse,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_LANDUSE. Check!'
        call prc_mpistop
     endif
     if( io_nml ) write(io_fid_nml,nml=param_landuse)
 
     allocate( landuse_frac_land(ia,ja) )
     allocate( landuse_frac_lake(ia,ja) )
     allocate( landuse_frac_urban(ia,ja) )
     landuse_frac_land(:,:) = 0.0_rp
     landuse_frac_lake(:,:) = 0.0_rp
     landuse_frac_urban(:,:) = 0.0_rp
 
     allocate( landuse_index_pft(ia,ja,landuse_pft_mosaic) )
     allocate( landuse_frac_pft(ia,ja,landuse_pft_mosaic) )
     landuse_frac_pft(:,:,:) = 0.0_rp
     landuse_frac_pft(:,:,1) = 1.0_rp ! tentative, mosaic is off
     landuse_index_pft(:,:,:) = 1      ! default
 
     allocate( landuse_fact_ocean(ia,ja) )
     allocate( landuse_fact_land(ia,ja) )
     allocate( landuse_fact_urban(ia,ja) )
     landuse_fact_ocean(:,:) = 0.0_rp
     landuse_fact_land(:,:) = 0.0_rp
     landuse_fact_urban(:,:) = 0.0_rp
 
 
     if    ( landuse_allocean ) then
        if( io_l ) write(io_fid_log,*) '*** Assume all grids are ocean'
        call landuse_calc_fact
     elseif( landuse_allland ) then
        if( io_l ) write(io_fid_log,*) '*** Assume all grids are land'
        landuse_frac_land(:,:) = 1.0_rp
        call landuse_calc_fact
     elseif( landuse_allurban ) then
        if( io_l ) write(io_fid_log,*) '*** Assume all grids are land'
        landuse_frac_land(:,:) = 1.0_rp
        if( io_l ) write(io_fid_log,*) '*** Assume all lands are urban'
        landuse_frac_urban(:,:) = 1.0_rp
        call landuse_calc_fact
     elseif( landuse_mosaicworld ) then
        if( io_l ) write(io_fid_log,*) '*** Assume all grids have ocean, land, and urban'
        landuse_frac_land(:,:) = 0.5_rp
        landuse_frac_urban(:,:) = 0.5_rp
        call landuse_calc_fact
     else
        ! read from file
        call landuse_read
     endif
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

◆ landuse_calc_fact()

subroutine, public scale_landuse::landuse_calc_fact ( )

Definition at line 156 of file scale_landuse.F90.

References scale_fileio::fileio_close(), scale_fileio::fileio_flush(), scale_fileio::fileio_open(), scale_stdio::io_fid_log, scale_stdio::io_l, landuse_fact_land, landuse_fact_ocean, landuse_fact_urban, landuse_frac_lake, landuse_frac_land, landuse_frac_pft, landuse_frac_urban, landuse_index_pft, and landuse_pft_mosaic.

Referenced by mod_cnvlanduse::cnvlanduse(), mod_mkinit::interporation_fact(), and landuse_setup().

     implicit none
     !---------------------------------------------------------------------------
 
     if( io_l ) write(io_fid_log,*)
     if( io_l ) write(io_fid_log,*) '+++ calculate landuse factor'
 
     ! tentative treatment: The area of the lake is treated as the ocean
     landuse_frac_land(:,:) = landuse_frac_land(:,:) * ( 1.0_rp - landuse_frac_lake(:,:) )
 
     ! make factors
     landuse_fact_ocean(:,:) = ( 1.0_rp - landuse_frac_land(:,:) )
     landuse_fact_land(:,:) = (          landuse_frac_land(:,:) ) * ( 1.0_rp - landuse_frac_urban(:,:) )
     landuse_fact_urban(:,:) = (          landuse_frac_land(:,:) ) * (          landuse_frac_urban(:,:) )
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

◆ landuse_write()

subroutine, public scale_landuse::landuse_write ( )

Write landuse data.

Definition at line 271 of file scale_landuse.F90.

References scale_fileio::fileio_close(), scale_fileio::fileio_create(), scale_fileio::fileio_def_var(), scale_fileio::fileio_enddef(), scale_stdio::io_fid_log, scale_stdio::io_l, landuse_fact_land, landuse_fact_ocean, landuse_fact_urban, landuse_frac_lake, landuse_frac_land, landuse_frac_pft, landuse_frac_urban, and landuse_pft_mosaic.

Referenced by mod_cnvlanduse::cnvlanduse(), and mod_mkinit::mkinit().

     use scale_fileio, only: &
        fileio_create, &
        fileio_def_var, &
        fileio_enddef, &
        fileio_write_var, &
        fileio_close
     implicit none
 
     real(RP) :: temp(IA,JA)
 
     integer :: fid, vid(6+LANDUSE_PFT_mosaic*2)
     character(len=H_SHORT) :: varname
     integer :: p
     !---------------------------------------------------------------------------
 
     if ( landuse_out_basename /= '' ) then
 
        if( io_l ) write(io_fid_log,*)
        if( io_l ) write(io_fid_log,*) '*** Output landuse file ***'
 
        call fileio_create( fid, landuse_out_basename, landuse_out_title, &
                            landuse_out_dtype, nozcoord=.true. )
 
        call fileio_def_var( fid, vid(1), 'FRAC_LAND',  'LAND fraction',  '1', 'XY', landuse_out_dtype )
        call fileio_def_var( fid, vid(2), 'FRAC_LAKE',  'LAKE fraction',  '1', 'XY', landuse_out_dtype )
        call fileio_def_var( fid, vid(3), 'FRAC_URBAN', 'URBAN fraction', '1', 'XY', landuse_out_dtype )
        call fileio_def_var( fid, vid(4), 'FRAC_OCEAN_abs', 'absolute OCEAN fraction', '1', 'XY', landuse_out_dtype )
        call fileio_def_var( fid, vid(5), 'FRAC_LAND_abs',  'absolute LAND fraction',  '1', 'XY', landuse_out_dtype )
        call fileio_def_var( fid, vid(6), 'FRAC_URBAN_abs', 'absolute URBAN fraction', '1', 'XY', landuse_out_dtype )
 
        do p = 1, landuse_pft_mosaic
           write(varname,'(A8,I1.1)') 'FRAC_PFT', p
           call fileio_def_var( fid, vid(7+2*(p-1)), varname, 'PFT fraction', '1', 'XY', landuse_out_dtype )
           write(varname,'(A9,I1.1)') 'INDEX_PFT', p
           call fileio_def_var( fid, vid(8+2*(p-1)), varname, 'PFT index',    '1', 'XY', landuse_out_dtype )
        end do
 
        call fileio_enddef( fid )
 
        call fileio_write_var( fid, vid(1), landuse_frac_land(:,:), 'FRAC_LAND',  'XY' )
        call fileio_write_var( fid, vid(2), landuse_frac_lake(:,:), 'FRAC_LAKE',  'XY' )
        call fileio_write_var( fid, vid(3), landuse_frac_urban(:,:), 'FRAC_URBAN', 'XY' )
        call fileio_write_var( fid, vid(4), landuse_fact_ocean(:,:), 'FRAC_OCEAN_abs', 'XY' )
        call fileio_write_var( fid, vid(5), landuse_fact_land(:,:), 'FRAC_LAND_abs',  'XY' )
        call fileio_write_var( fid, vid(6), landuse_fact_urban(:,:), 'FRAC_URBAN_abs', 'XY' )
 
        do p = 1, landuse_pft_mosaic
           write(varname,'(A8,I1.1)') 'FRAC_PFT', p
           call fileio_write_var( fid, vid(7+2*(p-1)), landuse_frac_pft(:,:,p), varname, 'XY' )
           write(varname,'(A9,I1.1)') 'INDEX_PFT', p
           temp(:,:) = real(LANDUSE_index_PFT(:,:,p),kind=rp)
           call fileio_write_var( fid, vid(8+2*(p-1)), temp(:,:),               varname, 'XY' )
        end do
 
        call fileio_close( fid )
 
     end if
 
     return