module HISTORY More...

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

subroutine, public	hist_switch (switch)
	set switch More...

subroutine, public	hist_reg (itemid, zinterp, item, desc, unit, ndim, xdim, ydim, zdim)
	Register/Append variable to history file. More...

subroutine, public	hist_query (itemid, answer)
	Check time to putting data. More...

subroutine	hist_put_0d (itemid, var)
	Put 1D data to history buffer. More...

subroutine	hist_put_1d (itemid, var)
	Put 1D data to history buffer. More...

subroutine	hist_put_2d (itemid, var, nohalo)
	Put 2D data to history buffer. More...

subroutine	hist_put_3d (itemid, var, zinterp, xdim, ydim, zdim, nohalo)
	Put 3D data to history buffer. More...

subroutine	hist_in_0d (var, item, desc, unit)
	Wrapper routine of HIST_reg+HIST_put 0D. More...

subroutine	hist_get_2d (var, basename, varname, step, allow_missing)
	Get 2D data from file. More...

subroutine	hist_get_3d (var, basename, varname, step, allow_missing)
	Get 3D data from file. More...

subroutine, public	hist_write
	Flush history buffer to file. More...

Detailed Description

module HISTORY

Description: History output module

Author: Team SCALE

History

2011-12-05 (H.Yashiro) [new]
2012-03-23 (H.Yashiro) [mod] Explicit index parameter inclusion
2012-06-11 (S.Nishizawa) [mod] use gtool_history

Function/Subroutine Documentation

◆ hist_setup()

subroutine, public scale_history::hist_setup ( )

Setup.

Definition at line 87 of file scale_history.F90.

References scale_stdio::h_institute, scale_stdio::h_source, gtool_history::historyinit(), scale_grid_index::ie, scale_grid_index::ieb, scale_grid_index::imax, scale_grid_index::imaxb, scale_stdio::io_fid_conf, scale_stdio::io_fid_log, scale_stdio::io_l, scale_stdio::io_lnml, scale_grid_index::is, scale_grid_index::isb, scale_grid_index::je, scale_grid_index::jeb, scale_grid_index::jmax, scale_grid_index::jmaxb, scale_grid_index::js, scale_grid_index::jsb, scale_grid_index::kmax, scale_rm_process::prc_2drank, scale_process::prc_masterrank, scale_process::prc_mpistop(), scale_process::prc_myrank, scale_prof::prof_rapend(), scale_prof::prof_rapstart(), scale_time::time_dtsec, scale_time::time_nowdate, scale_time::time_nowms, scale_time::time_offset_year, and scale_time::time_startdaysec.

Referenced by mod_rm_driver::scalerm(), and mod_rm_prep::scalerm_prep().

     use gtool_history, only: &
        historyinit
     use scale_process, only: &
        prc_mpistop,    &
        prc_masterrank, &
        prc_myrank
     use scale_rm_process, only: &
        prc_2drank
     use scale_time, only: &
        time_nowdate,     &
        time_nowms,       &
        time_dtsec,       &
        time_startdaysec, &
        time_offset_year
     implicit none
 
     character(len=H_MID)   :: history_h_title = 'SCALE-RM HISTORY OUTPUT'
     character(len=H_SHORT) :: history_t_units = 'seconds'
     character(len=H_MID)   :: history_t_since = ''
 
     logical :: hist_bnd = .false.
 
     namelist / param_hist /      &
          hist_bnd
 
     real(DP) :: start_daysec
     integer  :: rankidx(2)
     integer  :: ierr
     !---------------------------------------------------------------------------
 
     if( io_l ) write(io_fid_log,*)
     if( io_l ) write(io_fid_log,*) '++++++ Module[HISTORY] / Categ[ATMOS-RM IO] / Origin[SCALElib]'
 
     !--- read namelist
     rewind(io_fid_conf)
     read(io_fid_conf,nml=param_hist,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_HIST. Check!'
        call prc_mpistop
     endif
     if( io_lnml ) write(io_fid_log,nml=param_hist)
 
     call prof_rapstart('FILE_O_NetCDF', 2)
 
     rankidx(1) = prc_2drank(prc_myrank, 1)
     rankidx(2) = prc_2drank(prc_myrank, 2)
 
     start_daysec = time_startdaysec
     if ( time_nowdate(1) > 0 ) then
        write(history_t_since, '(I4.4,5(A1,I2.2))') &
                               time_nowdate(1),'-',time_nowdate(2),'-',time_nowdate(3),' ', &
                               time_nowdate(4),':',time_nowdate(5),':',time_nowdate(6)
        start_daysec = time_nowms
     endif
 
     if ( hist_bnd ) then
        im  = imaxb
        jm  = jmaxb
        ims = isb
        ime = ieb
        jms = jsb
        jme = jeb
     else
        im  = imax
        jm  = jmax
        ims = is
        ime = ie
        jms = js
        jme = je
     endif
 
     call historyinit( history_h_title,                & ! [IN]
                       h_source,                       & ! [IN]
                       h_institute,                    & ! [IN]
                       im*jm*kmax,                     & ! [IN]
                       prc_masterrank,                 & ! [IN]
                       prc_myrank,                     & ! [IN]
                       rankidx,                        & ! [IN]
                       start_daysec,                   & ! [IN]
                       time_dtsec,                     & ! [IN]
                       time_units   = history_t_units, & ! [IN]
                       time_since   = history_t_since, & ! [IN]
                       namelist_fid = io_fid_conf      ) ! [IN]
 
     call hist_put_axes
 
     call prof_rapend  ('FILE_O_NetCDF', 2)
 
     enabled = .true.
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hist_switch()

subroutine, public scale_history::hist_switch ( logical, intent(in) switch )

set switch

Definition at line 185 of file scale_history.F90.

References scale_const::const_d2r, scale_grid::grid_cbfx, scale_grid::grid_cbfxg, scale_grid::grid_cbfy, scale_grid::grid_cbfyg, scale_grid::grid_cbfz, scale_grid::grid_cdx, scale_grid::grid_cdy, scale_grid::grid_cdz, scale_grid::grid_cx, scale_grid::grid_cxg, scale_grid::grid_cy, scale_grid::grid_cyg, scale_grid::grid_cz, scale_grid::grid_fbfx, scale_grid::grid_fbfxg, scale_grid::grid_fbfy, scale_grid::grid_fbfyg, scale_grid::grid_fbfz, scale_grid::grid_fdx, scale_grid::grid_fdy, scale_grid::grid_fdz, scale_grid::grid_fx, scale_grid::grid_fxg, scale_grid::grid_fy, scale_grid::grid_fyg, scale_grid::grid_fz, scale_land_grid::grid_lcdz, scale_land_grid::grid_lcz, scale_land_grid::grid_lfz, scale_urban_grid::grid_ucdz, scale_urban_grid::grid_ucz, scale_urban_grid::grid_ufz, scale_grid_index::ke, scale_grid_index::kmax, scale_grid_index::ks, scale_landuse::landuse_frac_land, scale_land_grid_index::lke, scale_land_grid_index::lks, scale_grid_real::real_cz, scale_grid_real::real_fz, scale_grid_real::real_lat, scale_grid_real::real_latx, scale_grid_real::real_latxy, scale_grid_real::real_laty, scale_grid_real::real_lon, scale_grid_real::real_lonx, scale_grid_real::real_lonxy, scale_grid_real::real_lony, scale_topography::topo_zsfc, scale_urban_grid_index::uke, and scale_urban_grid_index::uks.

     logical, intent(in) :: switch
 
     enabled = switch
 
     return

◆ hist_reg()

subroutine, public scale_history::hist_reg	(	integer, intent(out)	itemid,
		logical, intent(out)	zinterp,
		character(len=*), intent(in)	item,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	unit,
		integer, intent(in)	ndim,
		character(len=*), intent(in), optional	xdim,
		character(len=*), intent(in), optional	ydim,
		character(len=*), intent(in), optional	zdim
	)

Register/Append variable to history file.

Parameters

[out]	itemid	index number of the item
[out]	zinterp	z* -> z flag 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

Definition at line 494 of file scale_history.F90.

References gtool_history::historyaddvariable(), scale_prof::prof_rapend(), scale_prof::prof_rapstart(), and scale_time::time_nowstep.

Referenced by scale_atmos_phy_mp_tomita08::atmos_phy_mp_tomita08_setup(), mod_atmos_vars::atmos_vars_setup(), and hist_in_0d().

     use gtool_history, only: &
        historyaddvariable
     use scale_time, only: &
        nowstep => time_nowstep
     implicit none
 
     integer,          intent(out) :: itemid
     logical,          intent(out) :: zinterp
     character(len=*), intent(in)  :: item
     character(len=*), intent(in)  :: desc
     character(len=*), intent(in)  :: unit
     integer,          intent(in)  :: ndim
 
     character(len=*), intent(in), optional :: xdim
     character(len=*), intent(in), optional :: ydim
     character(len=*), intent(in), optional :: zdim
 
     logical :: xh
     logical :: yh
 
     logical :: existed
 
     character(len=H_SHORT) :: dims(3)
     !---------------------------------------------------------------------------
 
     call prof_rapstart('FILE_O_NetCDF', 2)
 
     if ( ndim == 1 ) then
 
        dims(1) = "z"
        if ( present(zdim) ) then
           if ( zdim=='half' ) then
              dims(1) = "zh"
           endif
        endif
 
     else
 
        xh = .false.
        if ( present(xdim) ) then
           if ( xdim=='half' ) xh = .true.
        endif
        yh = .false.
        if ( present(ydim) ) then
           if ( ydim=='half' ) yh = .true.
        endif
 
        if ( xh .AND. yh ) then
           dims(1) = 'lon_uv'
           dims(2) = 'lat_uv'
           dims(3) = 'height_uvz'
        else if ( xh ) then
           dims(1) = 'lon_uy'
           dims(2) = 'lat_uy'
           dims(3) = 'height_uyz'
        else if ( yh ) then
           dims(1) = 'lon_xv'
           dims(2) = 'lat_xv'
           dims(3) = 'height_xvz'
        else
           dims(1) = 'lon'
           dims(2) = 'lat'
           dims(3) = 'height'
        endif
 
        if ( present(zdim) ) then
           if ( zdim=='land' ) then
              dims(3) = 'lz'
           else if ( zdim=='landhalf' ) then
              dims(3) = 'lzh'
           else if ( zdim=='urban' ) then
              dims(3) = 'uz'
           else if ( zdim=='urbanhalf' ) then
              dims(3) = 'uzh'
           else if ( zdim=='half' ) then
              if ( xh .AND. yh ) then
                 dims(3) = 'height_uvw'
              else if ( xh ) then
                 dims(3) = 'height_uyw'
              else if ( yh ) then
                 dims(3) = 'height_xvw'
              else
                 dims(3) = 'height_xyw'
              endif
           endif
        endif
 
     endif
 
     call historyaddvariable( item,         & ! [IN]
                              dims(1:ndim), & ! [IN]
                              desc,         & ! [IN]
                              unit,         & ! [IN]
                              nowstep,      & ! [IN]
                              itemid,       & ! [OUT]
                              zinterp,      & ! [OUT]
                              existed       ) ! [OUT]
 
     call prof_rapend  ('FILE_O_NetCDF', 2)
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hist_query()

subroutine, public scale_history::hist_query	(	integer, intent(in)	itemid,
		logical, intent(out)	answer
	)

Check time to putting data.

Parameters

[in]	itemid	index number of the item
[out]	answer	is it time to store?

Definition at line 602 of file scale_history.F90.

References gtool_history::historyquery(), scale_prof::prof_rapend(), scale_prof::prof_rapstart(), and scale_time::time_nowstep.

Referenced by scale_atmos_phy_mp_tomita08::atmos_phy_mp_tomita08(), and hist_in_0d().

     use gtool_history, only: &
        historyquery
     use scale_time, only: &
        time_nowstep
     implicit none
 
     integer, intent(in)  :: itemid
     logical, intent(out) :: answer
 
     !---------------------------------------------------------------------------
 
     answer = .false.
 
     if ( .NOT. enabled ) return
 
     if ( itemid < 0 ) return
 
     call prof_rapstart('FILE_O_NetCDF', 2)
 
     call historyquery(itemid, time_nowstep, answer)
 
     call prof_rapend  ('FILE_O_NetCDF', 2)
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hist_put_0d()

subroutine scale_history::hist_put_0d	(	integer, intent(in)	itemid,
		real(rp), intent(in)	var
	)

Put 1D data to history buffer.

Parameters

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

Definition at line 633 of file scale_history.F90.

References scale_prof::prof_rapend(), scale_prof::prof_rapstart(), and scale_time::time_nowstep.

     use gtool_history, only: &
        historyput
     use scale_time, only: &
        time_nowstep
     implicit none
 
     integer,  intent(in) :: itemid
     real(RP), intent(in) :: var
 
     !---------------------------------------------------------------------------
 
     if ( .NOT. enabled ) return
 
     if ( itemid < 0 ) return
 
     call prof_rapstart('FILE_O_NetCDF', 2)
 
     call historyput(itemid, time_nowstep, var)
 
     call prof_rapend  ('FILE_O_NetCDF', 2)
 
     return

Here is the call graph for this function:

◆ hist_put_1d()

subroutine scale_history::hist_put_1d	(	integer, intent(in)	itemid,
		real(rp), dimension(:), intent(in)	var
	)

Put 1D data to history buffer.

Parameters

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

Definition at line 662 of file scale_history.F90.

References scale_grid_index::kmax, scale_grid_index::ks, scale_prof::prof_rapend(), scale_prof::prof_rapstart(), and scale_time::time_nowstep.

     use gtool_history, only: &
        historyput
     use scale_time, only: &
        time_nowstep
     implicit none
 
     integer,  intent(in) :: itemid
     real(RP), intent(in) :: var(:)
 
     real(RP) :: var2(kmax)
     integer  :: k
     !---------------------------------------------------------------------------
 
     if ( .NOT. enabled ) return
 
     if ( itemid < 0 ) return
 
     call prof_rapstart('FILE_O_NetCDF', 2)
 
     do k = 1, kmax
        var2(k) = var(ks+k-1)
     enddo
 
     call historyput(itemid, time_nowstep, var2)
 
     call prof_rapend  ('FILE_O_NetCDF', 2)
 
     return

Here is the call graph for this function:

◆ hist_put_2d()

subroutine scale_history::hist_put_2d	(	integer, intent(in)	itemid,
		real(rp), dimension(:,:), intent(in)	var,
		logical, intent(in), optional	nohalo
	)

Put 2D data to history buffer.

Parameters

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

Definition at line 698 of file scale_history.F90.

References scale_grid_index::ie, scale_grid_index::is, scale_grid_index::je, scale_grid_index::js, scale_prof::prof_rapend(), scale_prof::prof_rapstart(), gtool_file::rmiss, and scale_time::time_nowstep.

     use gtool_file, only: &
        rmiss
     use gtool_history, only: &
        historyput
     use scale_time, only: &
        time_nowstep
     implicit none
 
     integer,  intent(in) :: itemid
     real(RP), intent(in) :: var(:,:)
 
     logical,  intent(in), optional :: nohalo
 
     real(RP) :: var2(im*jm)
     integer  :: i, j
     logical :: nohalo_
     !---------------------------------------------------------------------------
 
     if ( .NOT. enabled ) return
 
     if ( itemid < 0 ) return
 
     call prof_rapstart('FILE_O_NetCDF', 2)
 
     do j = 1, jm
     do i = 1, im
        var2(i + (j-1)*im) = var(ims+i-1,jms+j-1)
     enddo
     enddo
 
     nohalo_ = .false.
     if ( present(nohalo) ) nohalo_ = nohalo
 
     if ( nohalo_ ) then
        ! W halo
        do j = 1, jm
        do i = 1, is-ims
           var2(i + (j-1)*im) = rmiss
        enddo
        enddo
        ! E halo
        do j = 1, jm
        do i = ie-ims+2, ime-ims+1
           var2(i + (j-1)*im) = rmiss
        enddo
        enddo
        ! S halo
        do j = 1, js-jms
        do i = 1, im
           var2(i + (j-1)*im) = rmiss
        enddo
        enddo
        ! N halo
        do j = je-jms+2, jme-jms+1
        do i = 1, im
           var2(i + (j-1)*im) = rmiss
        enddo
        enddo
     endif
 
     call historyput(itemid, time_nowstep, var2)
 
     call prof_rapend  ('FILE_O_NetCDF', 2)
 
     return

Here is the call graph for this function:

◆ hist_put_3d()

subroutine scale_history::hist_put_3d	(	integer, intent(in)	itemid,
		real(rp), dimension(:,:,:), intent(in)	var,
		logical, intent(in)	zinterp,
		character(len=*), intent(in), optional	xdim,
		character(len=*), intent(in), optional	ydim,
		character(len=*), intent(in), optional	zdim,
		logical, intent(in), optional	nohalo
	)

Put 3D data to history buffer.

Parameters

[in]	itemid	index number of the item
[in]	var	value
[in]	zinterp	vertical interpolation?

Definition at line 775 of file scale_history.F90.

References scale_grid_index::ia, scale_grid_index::ie, scale_interpolation::interp_available, scale_interpolation::interp_vertical_xi2z(), scale_grid_index::is, scale_grid_index::ja, scale_grid_index::je, scale_grid_index::js, scale_grid_index::ka, scale_grid_index::kmax, scale_grid_index::ks, scale_land_grid_index::lke, scale_land_grid_index::lkmax, scale_land_grid_index::lks, scale_prof::prof_rapend(), scale_prof::prof_rapstart(), gtool_file::rmiss, scale_time::time_nowstep, scale_urban_grid_index::uke, scale_urban_grid_index::ukmax, and scale_urban_grid_index::uks.

     use gtool_file, only: &
        rmiss
     use gtool_history, only: &
        historyput
     use scale_time, only: &
        time_nowstep
     use scale_interpolation, only: &
        interp_vertical_xi2z, &
        interp_available
     implicit none
 
     integer,  intent(in) :: itemid
     real(RP), intent(in) :: var(:,:,:)
     logical,  intent(in) :: zinterp
 
     character(len=*), intent(in), optional :: xdim
     character(len=*), intent(in), optional :: ydim
     character(len=*), intent(in), optional :: zdim
     logical,          intent(in), optional :: nohalo
 
     intrinsic shape
     integer :: s(3)
 
     character(len=H_SHORT) :: xd, yd, zd
 
     real(RP), allocatable :: var_z(:,:,:)
     real(RP), allocatable :: var2 (:)
 
     integer :: i, j, k
     integer :: isize, jsize, ksize
     integer :: iall, jall, kall
     integer :: istart, jstart, kstart
 
     logical :: nohalo_
     !---------------------------------------------------------------------------
 
     if ( .NOT. enabled ) return
 
     if ( itemid < 0 ) return
 
     call prof_rapstart('FILE_O_NetCDF', 2)
 
     xd = ''
     yd = ''
     zd = ''
     if( present(xdim) ) xd = xdim
     if( present(ydim) ) yd = ydim
     if( present(zdim) ) zd = zdim
 
     nohalo_ = .false.
     if ( present(nohalo) ) nohalo_ = nohalo
 
 
     ! select dimension
     select case ( xd )
       case default
         isize  = im
         iall   = ia
         istart = ims
     end select
     select case ( yd )
       case default
         jsize  = jm
         jall   = ja
         jstart = jms
     end select
     select case ( zd )
       case ('land')
         ksize  = lkmax
         kall   = lke
         kstart = lks
       case ('urban')
         ksize  = ukmax
         kall   = uke
         kstart = uks
       case default
         ksize  = kmax
         kall   = ka
         kstart = ks
     end select
 
     allocate( var_z(kall,iall,jall)    )
     allocate( var2(ksize*isize*jsize) )
 
     s = shape(var)
     if ( s(1) == 1 ) then
 
        do j = 1, jsize
        do i = 1, isize
           var2(i + (j-1)*isize) = var(1,istart+i-1,jstart+j-1)
        enddo
        enddo
 
        if ( nohalo_ ) then
           ! W halo
           do j = 1, jsize
           do i = 1, is-ims
              var2(i + (j-1)*isize) = rmiss
           enddo
           enddo
           ! E halo
           do j = 1, jsize
           do i = ie-ims+2, ime-ims+1
              var2(i + (j-1)*isize) = rmiss
           enddo
           enddo
           ! S halo
           do j = 1, js-jms
           do i = 1, isize
              var2(i + (j-1)*isize) = rmiss
           enddo
           enddo
           ! N halo
           do j = je-jms+2, jme-jms+1
           do i = 1, isize
              var2(i + (j-1)*isize) = rmiss
           enddo
           enddo
        endif
 
        call historyput(itemid, time_nowstep, var2(1:isize*jsize))
 
     else
        if (       ksize == kmax    &
             .AND. zinterp          &
             .AND. interp_available ) then
           call prof_rapstart('FILE_O_interp', 2)
           call interp_vertical_xi2z( var(:,:,:), & ! [IN]
                                      var_z(:,:,:)  ) ! [OUT]
           call prof_rapend  ('FILE_O_interp', 2)
 
           do k = 1, ksize
           do j = 1, jsize
           do i = 1, isize
              var2(i + (j-1)*isize + (k-1)*jsize*isize) = var_z(kstart+k-1,istart+i-1,jstart+j-1)
           enddo
           enddo
           enddo
        else
           do k = 1, ksize
           do j = 1, jsize
           do i = 1, isize
              var2(i + (j-1)*isize + (k-1)*jsize*isize) = var(kstart+k-1,istart+i-1,jstart+j-1)
           enddo
           enddo
           enddo
        endif
 
        if ( nohalo_ ) then
           ! W halo
           do k = 1, ksize
           do j = 1, jsize
           do i = 1, is-ims
              var2(i + (j-1)*isize + (k-1)*jsize*isize) = rmiss
           enddo
           enddo
           enddo
           ! E halo
           do k = 1, ksize
           do j = 1, jsize
           do i = ie-ims+2, ime-ims+1
              var2(i + (j-1)*isize + (k-1)*jsize*isize) = rmiss
           enddo
           enddo
           enddo
           ! S halo
           do k = 1, ksize
           do j = 1, js-jms
           do i = 1, isize
              var2(i + (j-1)*isize + (k-1)*jsize*isize) = rmiss
           enddo
           enddo
           enddo
           ! N halo
           do k = 1, ksize
           do j = je-jms+2, jme-jms+1
           do i = 1, isize
              var2(i + (j-1)*isize + (k-1)*jsize*isize) = rmiss
           enddo
           enddo
           enddo
        endif
 
        call historyput(itemid, time_nowstep, var2)
 
     endif
 
     deallocate( var_z )
     deallocate( var2  )
 
     call prof_rapend  ('FILE_O_NetCDF', 2)
 
     return

Here is the call graph for this function:

◆ hist_in_0d()

subroutine scale_history::hist_in_0d	(	real(rp), intent(in)	var,
		character(len=*), intent(in)	item,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	unit
	)

Wrapper routine of HIST_reg+HIST_put 0D.

Definition at line 977 of file scale_history.F90.

References hist_query(), hist_reg(), scale_prof::prof_rapend(), and scale_prof::prof_rapstart().

     implicit none
 
     real(RP),         intent(in) :: var
     character(len=*), intent(in) :: item
     character(len=*), intent(in) :: desc
     character(len=*), intent(in) :: unit
 
     integer           :: itemid
     logical           :: zinterp
     logical           :: do_put
     !---------------------------------------------------------------------------
 
     if ( .NOT. enabled ) return
 
 
     call hist_reg( itemid,              & ! [OUT]
                    zinterp,             & ! [OUT]
                    item, desc, unit, 0 )  ! [IN]
 
 
     call hist_query( itemid, & ! [IN]
                      do_put  ) ! [OUT]
 
     if ( do_put ) then
        call hist_put( itemid, var ) ! [IN]
     endif
 
     return

Here is the call graph for this function:

◆ hist_get_2d()

subroutine scale_history::hist_get_2d	(	real(rp), dimension(:,:), intent(out)	var,
		character(len=*), intent(in)	basename,
		character(len=*), intent(in)	varname,
		integer, intent(in)	step,
		logical, intent(in), optional	allow_missing
	)

Get 2D data from file.

Parameters

[out]	var	value
[in]	basename	basename of the file
[in]	varname	name of the variable
[in]	step	step number

Definition at line 1201 of file scale_history.F90.

References scale_prof::prof_rapend(), and scale_prof::prof_rapstart().

     use gtool_history, only: &
        historyget
     implicit none
 
     real(RP),         intent(out) :: var(:,:)
     character(len=*), intent(in)  :: basename
     character(len=*), intent(in)  :: varname
     integer,          intent(in)  :: step
 
     logical,          intent(in), optional :: allow_missing
 
     logical :: am
     !---------------------------------------------------------------------------
 
     call prof_rapstart('FILE_I_NetCDF', 2)
 
     am = .false.
     if( present(allow_missing) ) am = allow_missing
 
     call historyget( var(:,:),        & ! [OUT]
                      basename,        & ! [IN]
                      varname,         & ! [IN]
                      step,            & ! [IN]
                      allow_missing=am ) ! [IN]
 
     call prof_rapend  ('FILE_I_NetCDF', 2)
 
     return

Here is the call graph for this function:

◆ hist_get_3d()

subroutine scale_history::hist_get_3d	(	real(rp), dimension(:,:,:), intent(out)	var,
		character(len=*), intent(in)	basename,
		character(len=*), intent(in)	varname,
		integer, intent(in)	step,
		logical, intent(in), optional	allow_missing
	)

Get 3D data from file.

Parameters

[out]	var	value
[in]	basename	basename of the file
[in]	varname	name of the variable
[in]	step	step number

Definition at line 1239 of file scale_history.F90.

References scale_prof::prof_rapend(), and scale_prof::prof_rapstart().

     use gtool_history, only: &
        historyget
     implicit none
 
     real(RP),         intent(out) :: var(:,:,:)
     character(len=*), intent(in)  :: basename
     character(len=*), intent(in)  :: varname
     integer,          intent(in)  :: step
 
     logical,          intent(in), optional :: allow_missing
 
     logical :: am
     !---------------------------------------------------------------------------
 
     call prof_rapstart('FILE_I_NetCDF', 2)
 
     am = .false.
     if( present(allow_missing) ) am = allow_missing
 
     call historyget( var(:,:,:),      & ! [OUT]
                      basename,        & ! [IN]
                      varname,         & ! [IN]
                      step,            & ! [IN]
                      allow_missing=am ) ! [IN]
 
     call prof_rapend  ('FILE_I_NetCDF', 2)
 
     return

Here is the call graph for this function:

◆ hist_write()

subroutine, public scale_history::hist_write ( )

Flush history buffer to file.

Definition at line 1272 of file scale_history.F90.

References gtool_history::historywriteall(), scale_prof::prof_rapend(), scale_prof::prof_rapstart(), and scale_time::time_nowstep.

Referenced by mod_rm_driver::scalerm().

     use gtool_history, only: &
        historywriteall
     use scale_time, only: &
        time_nowstep
     implicit none
     !---------------------------------------------------------------------------
 
     call prof_rapstart('FILE_O_NetCDF', 2)
 
     call historywriteall( time_nowstep ) ![IN]
 
     call prof_rapend  ('FILE_O_NetCDF', 2)
 
     return

Here is the call graph for this function:

Here is the caller graph for this function:

Functions/Subroutines

Detailed Description

Function/Subroutine Documentation

◆ hist_setup()

◆ hist_switch()

◆ hist_reg()

◆ hist_query()

◆ hist_put_0d()

◆ hist_put_1d()

◆ hist_put_2d()

◆ hist_put_3d()

◆ hist_in_0d()

◆ hist_get_2d()

◆ hist_get_3d()

◆ hist_write()