scale_monitor Module Reference

module MONITOR More...

Functions/Subroutines
subroutine, public	monit_setup
	Setup. More...
subroutine, public	monit_reg (itemid, item, desc, unit, ndim, isflux)
	Search existing item, or matching check between requested and registered item. More...
subroutine	monit_put_3d (itemid, var)
	Put total value to the monitor buffer. More...
subroutine	monit_in_2d (var, item, desc, unit, ndim, isflux)
	Wrapper routine of MONIT_reg+MONIT_put. More...
subroutine, public	monit_write (memo)
	Flush monitor buffer to formatted file. More...
subroutine, public	monit_finalize
	Close file. More...

Detailed Description

module MONITOR

Description

Monitor output module

Author

Team SCALE

History

• 2012-03-22 (H.Yashiro) [new]

NAMELIST

• PARAM_MONITOR

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

  
  
• MONITITEM

  name	type	default value	comment
  ITEM	character(len=*)		name of the item

  
  

History Output

No history output

Function/Subroutine Documentation

monit_setup()

subroutine, public scale_monitor::monit_setup

(

)

Setup.

Definition at line 89 of file scale_monitor.F90.

References scale_stdio::io_fid_conf, scale_stdio::io_fid_log, scale_stdio::io_fid_nml, scale_stdio::io_l, scale_stdio::io_nml, and scale_process::prc_mpistop().

Referenced by mod_rm_driver::scalerm().

    use scale_process, only: &
       prc_mpistop
    implicit none

    namelist / param_monitor / &
       monitor_out_basename, &
       monitor_usedevation,  &
       monitor_step_interval

    character(len=H_SHORT) :: ITEM

    namelist / monititem / &
       item

    integer :: ierr
    integer :: n
    !---------------------------------------------------------------------------

    if( io_l ) write(io_fid_log,*)
    if( io_l ) write(io_fid_log,*) '++++++ Module[MONITOR] / Categ[IO] / Origin[SCALElib]'

    !--- read namelist
    rewind(io_fid_conf)
    read(io_fid_conf,nml=param_monitor,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_MONITOR. Check!'
       call prc_mpistop
    endif
    if( io_nml ) write(io_fid_nml,nml=param_monitor)

    ! listup monitor request
    rewind(io_fid_conf)
    do n = 1, monit_req_limit
       read(io_fid_conf,nml=monititem,iostat=ierr)
       if( ierr /= 0 ) exit
    enddo
    monit_req_nmax = n - 1

    if( io_l ) write(io_fid_log,*)
    if    ( monit_req_nmax > monit_req_limit ) then
       if( io_l ) write(io_fid_log,*) '*** request of monitor file is exceed! n >', monit_req_limit
    elseif( monit_req_nmax == 0 ) then
       if( io_l ) write(io_fid_log,*) '*** No monitor file specified.'
       return
    else
       if( io_l ) write(io_fid_log,*) '*** Number of requested monitor item: ', monit_req_nmax
       if( io_l ) write(io_fid_log,*) '*** Monitor output interval [step]  : ', monitor_step_interval
       if( io_l ) write(io_fid_log,*) '*** Use deviation from first step?  : ', monitor_usedevation
    endif

    allocate( monit_item(monit_req_nmax) )
    allocate( monit_desc(monit_req_nmax) )
    allocate( monit_unit(monit_req_nmax) )
    allocate( monit_ktype(monit_req_nmax) )
    allocate( monit_kmax(monit_req_nmax) )
    allocate( monit_var(monit_req_nmax) )
    allocate( monit_var0(monit_req_nmax) )
    allocate( monit_first(monit_req_nmax) )
    allocate( monit_flux(monit_req_nmax) )

    rewind(io_fid_conf)
    do n = 1, monit_req_nmax
       ! set default
       item  = 'unknown'

       read(io_fid_conf,nml=monititem,iostat=ierr)
       if( ierr /= 0 ) exit

       if( io_nml .AND. io_fid_nml /= io_fid_log ) write(io_fid_nml,nml=monititem)

       monit_req_item(n) = item
    enddo

    return

Here is the call graph for this function:

Here is the caller graph for this function:

monit_reg()

subroutine, public scale_monitor::monit_reg	(	integer, intent(out)	itemid,
		character(len=*), intent(in)	item,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	unit,
		integer, intent(in)	ndim,
		logical, intent(in)	isflux
	)

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

Parameters

[out]	itemid	index number of the item
[in]	item	name of the item
[in]	desc	description of the item
[in]	unit	unit of the item
[in]	ndim	dimension of the item
[in]	isflux	need to integrate value?

Definition at line 176 of file scale_monitor.F90.

References scale_stdio::io_fid_log, scale_stdio::io_l, scale_grid_index::kmax, and scale_time::time_dtsec.

Referenced by mod_atmos_vars::atmos_vars_setup(), and monit_in_2d().

    implicit none

    integer,          intent(out) :: itemid
    character(len=*), intent(in)  :: item
    character(len=*), intent(in)  :: desc
    character(len=*), intent(in)  :: unit
    integer,          intent(in)  :: ndim
    logical,          intent(in)  :: isflux

    character(len=8) :: lname

    integer :: n, nmax, reqid
    !---------------------------------------------------------------------------

    !--- search existing item
    itemid = -1
    nmax = min( monit_id_count, monit_req_nmax )
    do n = 1, nmax
       if ( item == monit_item(n) ) then ! match existing item
          itemid = n
          return
       endif
    enddo

    if ( itemid < 0 ) then ! request-register matching check
       do n = 1, monit_req_nmax
          if ( item == monit_req_item(n) ) then
             monit_id_count = monit_id_count + 1
             itemid = monit_id_count
             reqid  = n

             ! new file registration
             monit_item(itemid) = trim(item)
             monit_desc(itemid) = trim(desc)
             monit_unit(itemid) = trim(unit)
             if    ( ndim == 2 ) then
                monit_ktype(itemid) = 'ZSFC'
                monit_kmax(itemid) = 1
             elseif( ndim == 3 ) then
                write(lname,'(A,I4.4)') 'ZDEF', kmax
                monit_ktype(itemid) = lname
                monit_kmax(itemid) = kmax
             endif
             monit_var(itemid) = 0.0_rp
             monit_var0(itemid) = 0.0_rp
             monit_first(itemid) = .true.
             monit_flux(itemid) = isflux

             if( io_l ) write(io_fid_log,*)
             if( io_l ) write(io_fid_log,'(1x,A,I3)') ' *** [MONIT] Item registration No.= ', itemid
             if( io_l ) write(io_fid_log,*) ' ] Name            : ', trim(monit_item(itemid))
             if( io_l ) write(io_fid_log,*) ' ] Description     : ', trim(monit_desc(itemid))
             if( io_l ) write(io_fid_log,*) ' ] Unit            : ', trim(monit_unit(itemid))
             if( io_l ) write(io_fid_log,*) ' ] Vert. type      : ', trim(monit_ktype(itemid))
             if( io_l ) write(io_fid_log,*) ' ] # of layer      : ', monit_kmax(itemid)
             if( io_l ) write(io_fid_log,*) ' ] Integ. with dt? : ', monit_flux(itemid)
          endif
       enddo
    endif

    return

Here is the caller graph for this function:

monit_put_3d()

subroutine scale_monitor::monit_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 289 of file scale_monitor.F90.

References scale_time::time_dtsec.

    use scale_time, only: &
       dt => time_dtsec
    use scale_rm_statistics, only: &
       stat_total
    implicit none

    integer,  intent(in) :: itemid
    real(RP), intent(in) :: var(:,:,:)

    real(RP) :: total
    !---------------------------------------------------------------------------

    if( itemid <= 0 ) return

    call stat_total( total, var(:,:,:), monit_item(itemid) )

    if ( monit_flux(itemid) ) then
       if ( monit_first(itemid) ) then
          monit_var(itemid) = total * dt ! first put
          monit_first(itemid) = .false.
       else
          monit_var(itemid) = monit_var(itemid) + total * dt ! integrate by last put
       endif
    else
       if ( monitor_usedevation ) then
          if ( monit_first(itemid) ) then
             monit_var(itemid) = 0.0_rp
             monit_var0(itemid) = total
             monit_first(itemid) = .false.
          else
             monit_var(itemid) = total - monit_var0(itemid) ! overwrite by last put
          endif
       else
          monit_var(itemid) = total ! overwrite by last put
       endif
    endif

    return

monit_in_2d()

subroutine scale_monitor::monit_in_2d	(	real(rp), dimension(:,:), intent(in)	var,
		character(len=*), intent(in)	item,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	unit,
		integer, intent(in)	ndim,
		logical, intent(in)	isflux
	)

Wrapper routine of MONIT_reg+MONIT_put.

Parameters

[in]	var	value
[in]	item	name of the item
[in]	desc	description of the item
[in]	unit	unit of the item
[in]	ndim	dimension of the item
[in]	isflux	need to integrate values?

Definition at line 338 of file scale_monitor.F90.

References monit_reg().

    implicit none

    real(RP),         intent(in) :: var(:,:)
    character(len=*), intent(in) :: item
    character(len=*), intent(in) :: desc
    character(len=*), intent(in) :: unit
    integer,          intent(in) :: ndim
    logical,          intent(in) :: isflux

    integer :: itemid
    !---------------------------------------------------------------------------

    call monit_reg( itemid, item, desc, unit, ndim, isflux )
    call monit_put( itemid, var(:,:) )

    return

Here is the call graph for this function:

monit_write()

subroutine, public scale_monitor::monit_write

(

character(len=*), intent(in)

memo

)

Flush monitor buffer to formatted file.

Parameters

[in]

memo

note

Definition at line 386 of file scale_monitor.F90.

References scale_stdio::io_fid_log, scale_stdio::io_get_available_fid(), scale_stdio::io_l, scale_stdio::io_log_allnode, scale_stdio::io_make_idstr(), scale_process::prc_ismaster, scale_process::prc_mpistop(), scale_process::prc_myrank, scale_prof::prof_rapend(), scale_prof::prof_rapstart(), and scale_time::time_nowstep.

Referenced by mod_rm_driver::scalerm().

    use scale_time, only: &
       nowstep => time_nowstep
    implicit none

    character(len=*), intent(in) :: memo

    logical, save :: firsttime = .true.

    integer :: n
    !---------------------------------------------------------------------------

    if( monit_id_count == 0 ) return

    call prof_rapstart('FILE_O_ASCII', 2)

    if (firsttime) then
       firsttime = .false.
       call monit_writeheader
    endif

    if ( monit_fid > 0 ) then

       if ( mod(nowstep-1,monitor_step_interval) == 0 ) then
          if( io_l ) write(io_fid_log,*) '*** Output Monitor'

          write(monit_fid,'(A,i7,A,A4,A)',advance='no') 'STEP=',nowstep,' (',memo,')'
          do n = 1, monit_id_count
             write(monit_fid,'(A,ES15.8)',advance='no') ' ',monit_var(n)
          enddo
          write(monit_fid,*)
       endif

    endif

    call prof_rapend  ('FILE_O_ASCII', 2)

    return

Here is the call graph for this function:

Here is the caller graph for this function:

monit_finalize()

subroutine, public scale_monitor::monit_finalize

(

)

Close file.

Definition at line 491 of file scale_monitor.F90.

References scale_stdio::io_fid_log, scale_stdio::io_l, scale_stdio::io_make_idstr(), and scale_process::prc_myrank.

Referenced by mod_rm_driver::scalerm().

    use scale_process, only: &
       prc_myrank
    implicit none

    character(len=H_LONG) :: fname
    !---------------------------------------------------------------------------

    if ( monit_fid > 0 ) then
       call io_make_idstr(fname,trim(monitor_out_basename),'pe',prc_myrank)

       if( io_l ) write(io_fid_log,*)
       if( io_l ) write(io_fid_log,*) '*** Close ASCII file for monitor, name : ', trim(fname)

       close(monit_fid)
    endif

    return

Here is the call graph for this function:

Here is the caller graph for this function: