scale_monitor Module Reference

module MONITOR More...

Functions/Subroutines
subroutine, public	monitor_setup (dt)
	Setup. More...
subroutine, public	monitor_set_dim (KA, KS, KE, IA, IS, IE, JA, JS, JE, dim_type, dim_size, area, total_area, volume, total_volume)
	Set area and volume. More...
subroutine, public	monitor_reg (name, desc, unit, itemid, ndims, dim_type, is_tendency)
	Search existing item, or matching check between requested and registered item. More...
subroutine	monitor_put_2d (itemid, var)
	Put total value to the monitor buffer. More...
subroutine	monitor_put_3d (itemid, var)
	Put total value to the monitor buffer. More...
subroutine	monitor_in_2d (var, name, desc, unit, ndims, dim_type, is_tendency)
	Wrapper routine of MONITOR_reg+MONITOR_put. More...
subroutine, public	monitor_write (memo, nowstep)
	Flush monitor buffer to formatted file. More...
subroutine, public	monitor_finalize
	Close file. More...

Detailed Description

module MONITOR

Description

Monitor output module

Author

Team SCALE

NAMELIST

• PARAM_MONITOR

  name	type	default value	comment
  MONITOR_OUT_BASENAME	character(len=H_LONG)	'monitor'	filename of monitor output
  MONITOR_USEDEVIATION	logical	.true.	use deviation from first step?
  MONITOR_GLOBAL_SUM	logical	.true.	global or local sum
  MONITOR_STEP_INTERVAL	integer	1	step interval

  
  
• MONITOR_ITEM

  name	type	default value	comment
  NAME	character(len=*)		name

  
  

History Output

No history output

Function/Subroutine Documentation

monitor_setup()

subroutine, public scale_monitor::monitor_setup

(

real(dp), intent(in)

dt

)

Setup.

Definition at line 105 of file scale_monitor.F90.

    use scale_prc, only: &
       prc_abort
    implicit none
 
    real(DP), intent(in) :: dt
 
    namelist / param_monitor / &
       monitor_out_basename, &
       monitor_usedeviation, &
       monitor_global_sum,   &
       monitor_step_interval
 
    character(len=H_SHORT) :: NAME
 
    namelist / monitor_item / &
       name
 
    integer :: ierr
    integer :: n
    !---------------------------------------------------------------------------
 
    log_newline
    log_info("MONITOR_setup",*) 'Setup'
 
    !--- read namelist
    rewind(io_fid_conf)
    read(io_fid_conf,nml=param_monitor,iostat=ierr)
    if( ierr < 0 ) then !--- missing
       log_info('MONITOR_setup',*) 'Not found namelist. Default used.'
    elseif( ierr > 0 ) then !--- fatal error
       log_error('MONITOR_setup',*) 'Not appropriate names in namelist PARAM_MONITOR. Check!'
       call prc_abort
    endif
    log_nml(param_monitor)
 
    ! listup monitor request
    rewind(io_fid_conf)
    do n = 1, monitor_req_max
       read(io_fid_conf,nml=monitor_item,iostat=ierr)
       if( ierr /= 0 ) exit
    enddo
    monitor_nreqs = n - 1
 
    if    ( monitor_nreqs > monitor_req_max ) then
       log_error('MONITOR_setup',*) 'request of monitor file is exceed! n >', monitor_req_max
       call prc_abort
    elseif( monitor_nreqs == 0 ) then
       log_info('MONITOR_setup',*) 'No monitor file specified.'
       return
    else
       log_info('MONITOR_setup',*) 'Number of requested monitor item : ', monitor_nreqs
       log_info('MONITOR_setup',*) 'Monitor output interval   [step] : ', monitor_step_interval
       log_info('MONITOR_setup',*) 'Use deviation from first step?   : ', monitor_usedeviation
    endif
 
    allocate( monitor_items(monitor_nreqs) )
 
    rewind(io_fid_conf)
    do n = 1, monitor_nreqs
       ! set default
       name  = 'unknown'
 
       read(io_fid_conf,nml=monitor_item,iostat=ierr)
       if( ierr /= 0 ) exit
 
       if ( io_fid_nml /= io_fid_log ) then
          log_nml(monitor_item)
       end if
 
       monitor_reqs(n) = name
    enddo
 
 
    monitor_dt = dt
 
    return

References scale_io::io_fid_conf, scale_io::io_fid_log, scale_io::io_fid_nml, and scale_prc::prc_abort().

Referenced by scale_monitor_cartesc::monitor_cartesc_setup().

Here is the call graph for this function:

Here is the caller graph for this function:

monitor_set_dim()

subroutine, public scale_monitor::monitor_set_dim	(	integer, intent(in)	KA,
		integer, intent(in)	KS,
		integer, intent(in)	KE,
		integer, intent(in)	IA,
		integer, intent(in)	IS,
		integer, intent(in)	IE,
		integer, intent(in)	JA,
		integer, intent(in)	JS,
		integer, intent(in)	JE,
		character(len=*), intent(in)	dim_type,
		integer, intent(in)	dim_size,
		real(rp), dimension(ia,ja), intent(in), optional	area,
		real(rp), intent(in), optional	total_area,
		real(rp), dimension(ka,ia,ja), intent(in), optional	volume,
		real(rp), intent(in), optional	total_volume
	)

Set area and volume.

Definition at line 190 of file scale_monitor.F90.

    integer, intent(in) :: KA, KS, KE
    integer, intent(in) :: IA, IS, IE
    integer, intent(in) :: JA, JS, JE
 
    character(len=*), intent(in) :: dim_type
    integer,          intent(in) :: dim_size
    real(RP),         intent(in), optional :: area(IA,JA)
    real(RP),         intent(in), optional :: total_area
    real(RP),         intent(in), optional :: volume(KA,IA,JA)
    real(RP),         intent(in), optional :: total_volume
 
    integer :: n
 
    monitor_ndims = monitor_ndims + 1
    n = monitor_ndims
 
    monitor_dims(n)%name = dim_type
    monitor_dims(n)%dim_size = dim_size
 
    monitor_dims(n)%KA = ka
    monitor_dims(n)%KS = ks
    monitor_dims(n)%KE = ke
    monitor_dims(n)%IA = ia
    monitor_dims(n)%IS = is
    monitor_dims(n)%IE = ie
    monitor_dims(n)%JA = ja
    monitor_dims(n)%JS = js
    monitor_dims(n)%JE = je
 
    if ( dim_size >= 2 ) then
       allocate( monitor_dims(n)%area(ia,ja) )
       monitor_dims(n)%area(:,:) = area(:,:)
       monitor_dims(n)%total_area = total_area
    end if
 
    if ( dim_size >= 3 ) then
       allocate( monitor_dims(n)%volume(ka,ia,ja) )
       monitor_dims(n)%volume(:,:,:) = volume(:,:,:)
       monitor_dims(n)%total_volume = total_volume
    end if
 
    return

Referenced by scale_monitor_cartesc::monitor_cartesc_setup().

Here is the caller graph for this function:

monitor_reg()

subroutine, public scale_monitor::monitor_reg	(	character(len=*), intent(in)	name,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	unit,
		integer, intent(out)	itemid,
		integer, intent(in), optional	ndims,
		character(len=*), intent(in), optional	dim_type,
		logical, intent(in), optional	is_tendency
	)

Search existing item, or matching check between requested and registered item.

Parameters

[in]	name	name of the item
[in]	desc	description of the item
[in]	unit	unit of the item
[out]	itemid	index number of the item
[in]	ndims	# of dimension
[in]	dim_type	dimension type
[in]	is_tendency	need to integrate value?

Definition at line 241 of file scale_monitor.F90.

    use scale_prc, only: &
       prc_abort
    implicit none
 
    character(len=*), intent(in)  :: name
    character(len=*), intent(in)  :: desc
    character(len=*), intent(in)  :: unit
 
    integer, intent(out) :: itemid
 
    integer,          intent(in), optional :: ndims
    character(len=*), intent(in), optional :: dim_type
    logical,          intent(in), optional :: is_tendency
 
    integer :: n, reqid, dimid
    !---------------------------------------------------------------------------
 
    !--- search existing item
    do itemid = 1, monitor_nitems
       if ( name == monitor_items(itemid)%name ) return ! match existing item
    enddo
 
    do reqid = 1, monitor_nreqs
       if ( name == monitor_reqs(reqid) ) then
          monitor_nitems = monitor_nitems + 1
          itemid = monitor_nitems
 
          ! new file registration
          monitor_items(itemid)%name = name
          monitor_items(itemid)%desc = desc
          monitor_items(itemid)%unit = unit
 
          dimid = -1
          if ( present(dim_type) ) then
             do n = 1, monitor_ndims
                if ( monitor_dims(n)%name == dim_type ) then
                   dimid = n
                   exit
                end if
             end do
             if ( dimid < 0 ) then
                log_error('MONITOR_reg',*) 'dim_type (', trim(dim_type), ') must be registerd by MONITOR_set_dim'
                call prc_abort
             end if
          else if ( present(ndims) ) then
             do n = 1, monitor_ndims
                if ( monitor_dims(n)%dim_size == ndims ) then
                   dimid = n
                   exit
                end if
             end do
             if ( dimid == -1 ) then
                log_error('MONITOR_reg','(a,i1,a)') 'dim_type of ', ndims, 'D must be registerd with MONITOR_set_dim'
                call prc_abort
             end if
          else
             ! ndims = 3 is assumed as default
             do n = 1, monitor_ndims
                if ( monitor_dims(n)%dim_size == 3 ) then
                   dimid = n
                   exit
                end if
             end do
             if ( dimid == -1 ) then
                log_error('MONITOR_reg',*) 'dim_type or ndims must be specified'
                call prc_abort
             end if
          end if
 
          monitor_items(itemid)%dimid = dimid
 
          monitor_items(itemid)%var   = 0.0_dp
          monitor_items(itemid)%var0  = 0.0_dp
          monitor_items(itemid)%first = .true.
          if ( present(is_tendency) ) then
             monitor_items(itemid)%tendency = is_tendency
          else
             monitor_items(itemid)%tendency = .false.
          end if
 
          log_newline
          log_info('MONOTOR_reg','(A,I3)') ' Item registration No.= ', itemid
          log_info_cont(*) 'Name            : ', trim(monitor_items(itemid)%name)
          log_info_cont(*) 'Description     : ', trim(monitor_items(itemid)%desc)
          log_info_cont(*) 'Unit            : ', trim(monitor_items(itemid)%unit)
          log_info_cont(*) 'Dimension type  : ', trim(monitor_dims(monitor_items(itemid)%dimid)%name)
          log_info_cont(*) 'Integ. with dt? : ', monitor_items(itemid)%tendency
 
          return
       end if
    end do
 
    itemid = -1 ! not found
 
    return

References scale_prc::prc_abort().

Referenced by scale_atmos_dyn_tstep_large_fvm_heve::atmos_dyn_tstep_large_fvm_heve_setup(), mod_atmos_phy_mp_driver::atmos_phy_mp_driver_setup(), mod_atmos_phy_tb_driver::atmos_phy_tb_driver_setup(), mod_atmos_vars::atmos_vars_setup(), mod_land_vars::land_vars_setup(), monitor_in_2d(), mod_ocean_vars::ocean_vars_setup(), and mod_urban_vars::urban_vars_setup().

Here is the call graph for this function:

Here is the caller graph for this function:

monitor_put_2d()

subroutine scale_monitor::monitor_put_2d	(	integer, intent(in)	itemid,
		real(rp), dimension(:,:), intent(in)	var
	)

Put total value to the monitor buffer.

Parameters

[in]	itemid	index number of the item
[in]	var	value

Definition at line 342 of file scale_monitor.F90.

    use scale_statistics, only: &
       statistics_total
    implicit none
    integer,  intent(in) :: itemid
    real(RP), intent(in) :: var(:,:)
 
    integer :: dimid
    real(DP) :: total
    !---------------------------------------------------------------------------
 
    if( itemid <= 0 ) return
 
    dimid = monitor_items(itemid)%dimid
 
    call statistics_total( monitor_dims(dimid)%IA, monitor_dims(dimid)%IS, monitor_dims(dimid)%IE, &
                           monitor_dims(dimid)%JA, monitor_dims(dimid)%JS, monitor_dims(dimid)%JE, &
                           var(:,:), monitor_items(itemid)%name,                          & ! (in)
                           monitor_dims(dimid)%area(:,:), monitor_dims(dimid)%total_area, & ! (in)
                           log_suppress = .true., global = monitor_global_sum,            & ! (in)
                           sum = total                                                    ) ! (out)
 
    if ( monitor_items(itemid)%tendency ) then
       if ( monitor_items(itemid)%first ) then
          monitor_items(itemid)%var = 0.0_rp
          monitor_items(itemid)%first = .false.
       else
          monitor_items(itemid)%var = monitor_items(itemid)%var + total * monitor_dt ! integrate by last put
       endif
    else
       if ( monitor_usedeviation ) then
          if ( monitor_items(itemid)%first ) then
             monitor_items(itemid)%var  = 0.0_rp
             monitor_items(itemid)%var0 = total
             monitor_items(itemid)%first = .false.
          else
             monitor_items(itemid)%var = total - monitor_items(itemid)%var0 ! overwrite by last put
          endif
       else
          monitor_items(itemid)%var = total ! overwrite by last put
       endif
    endif
 
    return

monitor_put_3d()

subroutine scale_monitor::monitor_put_3d	(	integer, intent(in)	itemid,
		real(rp), dimension(:,:,:), intent(in)	var
	)

Put total value to the monitor buffer.

Parameters

[in]	itemid	index number of the item
[in]	var	value

Definition at line 391 of file scale_monitor.F90.

    use scale_statistics, only: &
       statistics_total
    implicit none
 
    integer,  intent(in) :: itemid
    real(RP), intent(in) :: var(:,:,:)
 
    integer :: dimid
 
    real(DP) :: total
    !---------------------------------------------------------------------------
 
    if( itemid <= 0 ) return
 
    dimid = monitor_items(itemid)%dimid
 
 
    call statistics_total( monitor_dims(dimid)%KA, monitor_dims(dimid)%KS, monitor_dims(dimid)%KE, &
                           monitor_dims(dimid)%IA, monitor_dims(dimid)%IS, monitor_dims(dimid)%IE, &
                           monitor_dims(dimid)%JA, monitor_dims(dimid)%JS, monitor_dims(dimid)%JE, &
                           var(:,:,:), monitor_items(itemid)%name,                              & ! (in)
                           monitor_dims(dimid)%volume(:,:,:), monitor_dims(dimid)%total_volume, & ! (in)
                           log_suppress = .true., global = monitor_global_sum,                  & ! (in)
                           sum = total                                                          ) ! (out)
 
    if ( monitor_items(itemid)%tendency ) then
       if ( monitor_items(itemid)%first ) then
          monitor_items(itemid)%var   = total * monitor_dt ! first put
          monitor_items(itemid)%first = .false.
       else
          monitor_items(itemid)%var = monitor_items(itemid)%var + total * monitor_dt ! integrate by last put
       endif
    else
       if ( monitor_usedeviation ) then
          if ( monitor_items(itemid)%first ) then
             monitor_items(itemid)%var   = 0.0_rp
             monitor_items(itemid)%var0  = total
             monitor_items(itemid)%first = .false.
          else
             monitor_items(itemid)%var = total - monitor_items(itemid)%var0 ! overwrite by last put
          endif
       else
          monitor_items(itemid)%var = total ! overwrite by last put
       endif
    endif
 
    return

monitor_in_2d()

subroutine scale_monitor::monitor_in_2d	(	real(rp), dimension(:,:), intent(in)	var,
		character(len=*), intent(in)	name,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	unit,
		integer, intent(in), optional	ndims,
		character(len=*), intent(in), optional	dim_type,
		logical, intent(in), optional	is_tendency
	)

Wrapper routine of MONITOR_reg+MONITOR_put.

Parameters

[in]	var	value
[in]	desc	description
[in]	ndims	# of dimension
[in]	dim_type	dimension type
[in]	is_tendency	need to integrate values?

Definition at line 447 of file scale_monitor.F90.

    implicit none
 
    real(RP),         intent(in) :: var(:,:)
    character(len=*), intent(in) :: name
    character(len=*), intent(in) :: desc
    character(len=*), intent(in) :: unit
 
    integer,          intent(in), optional :: ndims
    character(len=*), intent(in), optional :: dim_type
    logical,          intent(in), optional :: is_tendency
 
    integer :: itemid
    !---------------------------------------------------------------------------
 
    call monitor_reg( name, desc, unit,             & ! (in)
                    itemid,                         & ! (out)
                    ndims=ndims, dim_type=dim_type, & ! (in)
                    is_tendency=is_tendency         ) ! (in)
    call monitor_put( itemid, var(:,:) )
 
    return

References monitor_reg().

Here is the call graph for this function:

monitor_write()

subroutine, public scale_monitor::monitor_write	(	character(len=*), intent(in)	memo,
		integer, intent(in)	nowstep
	)

Flush monitor buffer to formatted file.

Parameters

[in]

memo

note

Definition at line 503 of file scale_monitor.F90.

    implicit none
    character(len=*), intent(in) :: memo
    integer         , intent(in) :: nowstep
 
    logical, save :: firsttime = .true.
 
    integer :: n
    !---------------------------------------------------------------------------
 
    if( monitor_nitems == 0 ) return
 
    call prof_rapstart('FILE_O_ASCII', 2)
 
    if (firsttime) then
       firsttime = .false.
       call monitor_writeheader
    endif
 
    if ( monitor_fid > 0 ) then
 
       if ( mod(nowstep-1,monitor_step_interval) == 0 ) then
          log_progress(*) 'output monitor'
 
          write(monitor_fid,'(A,i7,A,A4,A)',advance='no') 'STEP=',nowstep,' (',memo,')'
          do n = 1, monitor_nitems
             write(monitor_fid,'(A,ES15.8)',advance='no') ' ', monitor_items(n)%var
          enddo
          write(monitor_fid,*)
       endif
 
    endif
 
    call prof_rapend  ('FILE_O_ASCII', 2)
 
    return

References scale_io::io_get_available_fid(), scale_io::io_log_allnode, scale_io::io_make_idstr(), scale_prc::prc_abort(), scale_prc::prc_ismaster, scale_prc::prc_myrank, scale_prof::prof_rapend(), and scale_prof::prof_rapstart().

Referenced by mod_rm_driver::rm_driver().

Here is the call graph for this function:

Here is the caller graph for this function:

monitor_finalize()

subroutine, public scale_monitor::monitor_finalize

Close file.

Definition at line 610 of file scale_monitor.F90.

    use scale_prc, only: &
       prc_myrank
    implicit none
 
    character(len=H_LONG) :: fname
 
    integer :: n
    !---------------------------------------------------------------------------
 
    if ( monitor_fid > 0 ) then
       call io_make_idstr(fname,trim(monitor_out_basename),'pe',prc_myrank)
 
       log_newline
       log_info('MONITOR_finalize',*) 'Close ASCII file for monitor, name : ', trim(fname)
 
       close(monitor_fid)
    endif
 
    do n = 1, monitor_ndims
       if ( monitor_dims(n)%dim_size >= 2 ) deallocate( monitor_dims(n)%area )
       if ( monitor_dims(n)%dim_size >= 3 ) deallocate( monitor_dims(n)%volume )
    end do
    monitor_ndims = 0
 
    if ( allocated(monitor_items) ) deallocate( monitor_items )
    monitor_nitems = 0
 
    return

References scale_io::io_make_idstr(), and scale_prc::prc_myrank.

Referenced by mod_rm_driver::rm_driver().

Here is the call graph for this function:

Here is the caller graph for this function: