scale_file_history Module Reference

module file_history More...

Functions/Subroutines
subroutine, public	file_history_setup (title, source, institution, time_start, time_interval, time_units, time_since, calendar, default_basename, default_postfix_timelabel, default_zcoord, default_tinterval, default_tunit, default_taverage, default_datatype, myrank)
	Setup. More...
subroutine, public	file_history_reg (name, desc, unit, itemid, standard_name, ndims, dim_type, cell_measures, fill_halo)
	Register/Append variable to history file. More...
subroutine	file_history_in_0d (var, name, desc, unit, standard_name, dim_type)
	Wrapper routine of FILE_HISTORY_reg + FILE_HISTORY_put. More...
subroutine	file_history_in_1d (var, name, desc, unit, standard_name, dim_type)
	Wrapper routine of FILE_HISTORY_reg + FILE_HISTORY_put. More...
subroutine	file_history_in_2d (var, name, desc, unit, standard_name, dim_type, fill_halo)
	Wrapper routine of FILE_HISTORY_reg + FILE_HISTORY_put. More...
subroutine	file_history_in_3d (var, name, desc, unit, standard_name, dim_type, fill_halo)
	Wrapper routine of FILE_HISTORY_reg + FILE_HISTORY_put. More...
subroutine	file_history_in_4d (var, name, desc, unit, standard_name, dim_type, fill_halo)
	Wrapper routine of FILE_HISTORY_reg + FILE_HISTORY_put. More...
subroutine, public	file_history_set_dim (name, ndims, nzcoords, dims, zcoords, start, count, mapping, area, area_x, area_y, volume, location, grid)
	set dimension information More...
subroutine, public	file_history_set_axis (name, desc, units, dim, var, bounds, down, gsize, start)
	set axis information More...
subroutine, public	file_history_write
subroutine, public	file_history_set_nowdate (NOWDATE, NOWSUBSEC, NOWSTEP)
	set now step More...
subroutine, public	file_history_set_disable (switch)
	set switch to turn on/off history More...
subroutine, public	file_history_finalize
	finalization More...
subroutine	file_history_set_associatedcoordinate_1d (name, desc, units, dims, var, datatype, start)
subroutine	file_history_set_associatedcoordinate_2d (name, desc, units, dims, var, datatype, start)
subroutine	file_history_set_associatedcoordinate_3d (name, desc, units, dims, var, datatype, start)
subroutine	file_history_set_attribute_text (varname, key, val, add_variable)
subroutine	file_history_set_attribute_logical (varname, key, val, add_variable)
subroutine	file_history_set_attribute_int_ary (varname, key, val, add_variable)
subroutine	file_history_set_attribute_int (varname, key, val, add_variable)
subroutine	file_history_set_attribute_float (varname, key, val, add_variable)
subroutine	file_history_set_attribute_double (varname, key, val, add_variable)

Variables
procedure(truncate_1d), pointer, public	file_history_truncate_1d => NULL()
procedure(truncate_2d), pointer, public	file_history_truncate_2d => NULL()
procedure(truncate_3d), pointer, public	file_history_truncate_3d => NULL()
procedure(truncate_4d), pointer, public	file_history_truncate_4d => NULL()
logical, public	file_history_aggregate
logical, public	switch
logical, public	to
logical, public	use
logical, public	aggregate
logical, public	file
logical, public	i
logical, public	o

Detailed Description

module file_history

Description

I/O handling for history output

Author

Team SCALE

NAMELIST

• PARAM_FILE_HISTORY

  name	type	default value	comment
  FILE_HISTORY_TITLE	character(len=H_MID)		> Header information of the output file: title
  FILE_HISTORY_SOURCE	character(len=H_MID)		> Header information of the output file: model name
  FILE_HISTORY_INSTITUTION	character(len=H_MID)		> Header information of the output file: institution
  FILE_HISTORY_TIME_UNITS	character(len=H_MID)		> Unit for time axis
  FILE_HISTORY_DEFAULT_BASENAME	character(len=H_LONG)		> Base name of the file
  FILE_HISTORY_DEFAULT_POSTFIX_TIMELABEL	logical		> Add timelabel to the basename?
  FILE_HISTORY_DEFAULT_ZCOORD	character(len=H_SHORT)		> Default z-coordinate
  FILE_HISTORY_DEFAULT_TINTERVAL	real(DP)		> Time interval
  FILE_HISTORY_DEFAULT_TUNIT	character(len=H_SHORT)		> Time unit
  FILE_HISTORY_DEFAULT_TAVERAGE	logical		> Apply time average?
  FILE_HISTORY_DEFAULT_DATATYPE	character(len=H_SHORT)		> Data type
  FILE_HISTORY_OUTPUT_STEP0	logical	.false.	> Output value at step=0?
  FILE_HISTORY_OUTPUT_WAIT	real(DP)		> Time length to suppress output
  FILE_HISTORY_OUTPUT_WAIT_TUNIT	character(len=H_SHORT)		> Time unit
  FILE_HISTORY_OUTPUT_SWITCH_TINTERVAL	real(DP)		> Time interval to switch output file
  FILE_HISTORY_OUTPUT_SWITCH_TUNIT	character(len=H_SHORT)		> Time unit
  FILE_HISTORY_ERROR_PUTMISS	logical	.true.	> Abort if the value is never stored after last output?
  FILE_HISTORY_AGGREGATE	logical		> Switch to use aggregate file I/O
  FILE_HISTORY_OPTIONS	character(len=H_MID)	'' !> option to give file. 'filetype1:key1=val1&filetype2:key2=val2&...'
  DEBUG	logical	.false.

  
  
• HISTORY_ITEM

  name	type	default value	comment
  NAME	character(len=*)
  OUTNAME	character(len=H_SHORT)		> name of variable (for output)
  BASENAME	character(len=H_LONG)		> base name of the file
  POSTFIX_TIMELABEL	logical		> Add timelabel to the basename?
  ZCOORD	character(len=*)
  TINTERVAL	real(DP)		> time interval
  TUNIT	character(len=H_SHORT)		> time unit
  TAVERAGE	logical		> apply time average?
  DATATYPE	character(len=*)

  
  

History Output

No history output

Function/Subroutine Documentation

file_history_setup()

subroutine, public scale_file_history::file_history_setup	(	character(len=*), intent(in)	title,
		character(len=*), intent(in)	source,
		character(len=*), intent(in)	institution,
		real(dp), intent(in)	time_start,
		real(dp), intent(in)	time_interval,
		character(len=*), intent(in), optional	time_units,
		character(len=*), intent(in), optional	time_since,
		character(len=*), intent(in), optional	calendar,
		character(len=*), intent(in), optional	default_basename,
		logical, intent(in), optional	default_postfix_timelabel,
		character(len=*), intent(in), optional	default_zcoord,
		real(dp), intent(in), optional	default_tinterval,
		character(len=*), intent(in), optional	default_tunit,
		logical, intent(in), optional	default_taverage,
		character(len=*), intent(in), optional	default_datatype,
		integer, intent(in), optional	myrank
	)

Setup.

REAL4 : single precision REAL8 : double precision

Unit for time axis

Base name of the file

Add timelabel to the basename?

Default z-coordinate

Time interval

Time unit

Apply time average?

Data type

Time length to suppress output

Time unit

Time interval to switch output file

Time unit

Definition at line 342 of file scale_file_history.F90.

    use scale_file_h, only: &
       file_real4, &
       file_real8
    use scale_file, only: &
       file_aggregate
    use scale_calendar, only: &
       calendar_unit2sec
    implicit none
 
    character(len=*), intent(in)  :: title
    character(len=*), intent(in)  :: source
    character(len=*), intent(in)  :: institution
    real(DP),         intent(in)  :: time_start
    real(DP),         intent(in)  :: time_interval
 
    character(len=*), intent(in), optional :: time_units
    character(len=*), intent(in), optional :: time_since
    character(len=*), intent(in), optional :: calendar
    character(len=*), intent(in), optional :: default_basename
    logical,          intent(in), optional :: default_postfix_timelabel
    character(len=*), intent(in), optional :: default_zcoord
    real(DP),         intent(in), optional :: default_tinterval
    character(len=*), intent(in), optional :: default_tunit
    logical,          intent(in), optional :: default_taverage
    character(len=*), intent(in), optional :: default_datatype
    integer,          intent(in), optional :: myrank
 
    character(len=H_LONG)  :: FILE_HISTORY_DEFAULT_BASENAME
    logical                :: FILE_HISTORY_DEFAULT_POSTFIX_TIMELABEL
    character(len=H_SHORT) :: FILE_HISTORY_DEFAULT_ZCOORD
    real(DP)               :: FILE_HISTORY_DEFAULT_TINTERVAL
    character(len=H_SHORT) :: FILE_HISTORY_DEFAULT_TUNIT
    logical                :: FILE_HISTORY_DEFAULT_TAVERAGE
    character(len=H_SHORT) :: FILE_HISTORY_DEFAULT_DATATYPE
    real(DP)               :: FILE_HISTORY_OUTPUT_WAIT
    character(len=H_SHORT) :: FILE_HISTORY_OUTPUT_WAIT_TUNIT
    real(DP)               :: FILE_HISTORY_OUTPUT_SWITCH_TINTERVAL
    character(len=H_SHORT) :: FILE_HISTORY_OUTPUT_SWITCH_TUNIT
 
    namelist / param_file_history / &
       file_history_title,                     &
       file_history_source,                    &
       file_history_institution,               &
       file_history_time_units,                &
       file_history_default_basename,          &
       file_history_default_postfix_timelabel, &
       file_history_default_zcoord,            &
       file_history_default_tinterval,         &
       file_history_default_tunit,             &
       file_history_default_taverage,          &
       file_history_default_datatype,          &
       file_history_output_step0,              &
       file_history_output_wait,               &
       file_history_output_wait_tunit,         &
       file_history_output_switch_tinterval,   &
       file_history_output_switch_tunit,       &
       file_history_error_putmiss,             &
       file_history_aggregate,                 &
       file_history_options,                   &
       debug
 
    character(len=H_SHORT) :: NAME
    character(len=H_SHORT) :: OUTNAME
    character(len=H_LONG)  :: BASENAME
    logical                :: POSTFIX_TIMELABEL
    character(len=H_SHORT) :: ZCOORD
    real(DP)               :: TINTERVAL
    character(len=H_SHORT) :: TUNIT
    logical                :: TAVERAGE
    character(len=H_SHORT) :: DATATYPE
 
    namelist / history_item / &
       name,              &
       outname,           &
       basename,          &
       postfix_timelabel, &
       zcoord,            &
       tinterval,         &
       tunit,             &
       taverage,          &
       datatype
 
 
    integer  :: reqid
    real(DP) :: dtsec
    integer  :: dstep
 
    integer  :: ierr
    integer  :: n, id
 
    intrinsic size
    !---------------------------------------------------------------------------
 
    log_newline
    log_info("FILE_HISTORY_Setup",*) 'Setup'
 
    ! setup
    file_history_myrank      = myrank
 
    file_history_startdaysec = time_start
    file_history_dtsec       = time_interval
    if ( present(time_since) ) then
       file_history_time_since = time_since
    else
       file_history_time_since = ''
    endif
 
    if ( present(calendar) ) then
       file_history_calendar = calendar
    else
       file_history_calendar = ""
    end if
 
    file_history_time_units                = 'seconds'
    file_history_default_basename          = ''
    file_history_default_postfix_timelabel = .false.
    file_history_default_zcoord            = ''
    file_history_default_tinterval         = -1.0_dp
    file_history_default_tunit             = 'SEC'
    file_history_default_taverage          = .false.
    file_history_default_datatype          = 'REAL4'
    file_history_output_wait               =  0.0_dp
    file_history_output_wait_tunit         = 'SEC'
    file_history_output_switch_tinterval   = -1.0_dp
    file_history_output_switch_tunit       = 'SEC'
 
    file_history_aggregate                 = file_aggregate
 
    !--- read namelist
    file_history_title       = title
    file_history_source      = source
    file_history_institution = institution
    if( present(time_units)                ) file_history_time_units                = time_units
    if( present(default_basename)          ) file_history_default_basename          = default_basename
    if( present(default_postfix_timelabel) ) file_history_default_postfix_timelabel = default_postfix_timelabel
    if( present(default_zcoord)            ) file_history_default_zcoord            = default_zcoord
    if( present(default_tinterval)         ) file_history_default_tinterval         = default_tinterval
    if( present(default_tunit)             ) file_history_default_tunit             = default_tunit
    if( present(default_taverage)          ) file_history_default_taverage          = default_taverage
    if( present(default_datatype)          ) file_history_default_datatype          = default_datatype
 
    !--- read namelist
    rewind(io_fid_conf)
    read(io_fid_conf,nml=param_file_history,iostat=ierr)
    if( ierr < 0 ) then !--- missing
       log_info("FILE_HISTORY_Setup",*) 'Not found namelist. Default used.'
    elseif( ierr > 0 ) then !--- fatal error
       log_error("FILE_HISTORY_Setup",*) 'Not appropriate names in namelist PARAM_FILE_HISTORY. Check!'
       call prc_abort
    endif
    log_nml(param_file_history)
 
 
 
    if ( file_history_output_wait >= 0.0_dp ) then
       call calendar_unit2sec( dtsec, file_history_output_wait, file_history_output_wait_tunit )
       file_history_output_wait_step = int( dtsec / file_history_dtsec )
    else
       log_error("FILE_HISTORY_Setup",*) 'FILE_HISTORY_OUTPUT_WAIT must be positive. STOP'
       call prc_abort
    endif
 
    if ( file_history_output_switch_tinterval >= 0.0_dp ) then
       call calendar_unit2sec( dtsec, file_history_output_switch_tinterval, file_history_output_switch_tunit )
       file_history_output_switch_step = int( dtsec / file_history_dtsec )
    else
       file_history_output_switch_step = -1
    endif
    file_history_output_switch_laststep = 0
 
 
    ! count history request
    file_history_nreqs = 0
    if ( io_fid_conf > 0 ) rewind(io_fid_conf)
    do n = 1, file_history_req_max
       name      = ''
       outname   = 'undefined'
       basename  = file_history_default_basename
 
       read(io_fid_conf,nml=history_item,iostat=ierr)
       if( ierr /= 0 ) exit
       if( basename == '' .OR. name == '' .OR. outname == '' ) cycle ! invalid HISTORY_ITEM
 
       file_history_nreqs = file_history_nreqs + 1
    enddo
 
    if    ( file_history_nreqs > file_history_req_max ) then
       log_error("FILE_HISTORY_Setup",*) 'request of history file is exceed! n >', file_history_req_max
       call prc_abort
    elseif( file_history_nreqs == 0 ) then
       log_info("FILE_HISTORY_Setup",*) 'No history file specified.'
       return
    endif
 
    allocate( file_history_req(file_history_nreqs) )
 
    ! read history request
    reqid   = 0
    if ( io_fid_conf > 0 ) rewind(io_fid_conf)
    do n = 1, file_history_req_max
       ! set default
       name              = ''
       outname           = 'undefined'
       basename          = file_history_default_basename
       postfix_timelabel = file_history_default_postfix_timelabel
       zcoord            = file_history_default_zcoord
       tinterval         = file_history_default_tinterval
       tunit             = file_history_default_tunit
       taverage          = file_history_default_taverage
       datatype          = file_history_default_datatype
 
       read(io_fid_conf,nml=history_item,iostat=ierr)
       if    ( ierr < 0 ) then
          exit ! no more items
       elseif( ierr > 0 ) then
          log_error("FILE_HISTORY_Setup",*) 'Not appropriate names in namelist HISTORY_ITEM. Check!'
          call prc_abort
       endif
       if( basename == '' .OR. name == '' .OR. outname == '' ) cycle ! invalid HISTORY_ITEM
 
       log_nml(history_item)
 
       ! check duplicated request
       if ( outname == 'undefined' ) outname = name ! set default name
       do id = 1, reqid
          if ( file_history_req(id)%outname == outname ) then
             log_error("FILE_HISTORY_Setup",*) 'Same name of history output is already registered. Check!', trim(outname)
             call prc_abort
          endif
       enddo
 
       reqid = reqid + 1
 
       file_history_req(reqid)%name              = name
       file_history_req(reqid)%outname           = outname
       file_history_req(reqid)%basename          = basename
       file_history_req(reqid)%postfix_timelabel = postfix_timelabel
       if( file_history_output_switch_step >= 0 ) file_history_req(reqid)%postfix_timelabel = .true. ! force true
       file_history_req(reqid)%zcoord            = zcoord
       file_history_req(reqid)%taverage          = taverage
 
       call calendar_unit2sec( dtsec, tinterval, tunit )
       dstep = int( dtsec / file_history_dtsec )
 
       if ( dtsec <= 0.d0 ) then
          log_error("FILE_HISTORY_Setup",*) 'Not appropriate time interval. Check!', trim(name), tinterval, trim(tunit)
          call prc_abort
       endif
 
       if ( abs(dtsec-real(dstep,kind=dp)*file_history_dtsec) > dtsec*1.e-3_dp ) then
          log_error("FILE_HISTORY_Setup",*) 'time interval must be a multiple of delta t. (interval,dt)=', dtsec, file_history_dtsec
          call prc_abort
       endif
 
       file_history_req(reqid)%dstep  = dstep
 
       if    ( datatype == 'REAL4' ) then
          file_history_req(reqid)%dtype  = file_real4
       elseif( datatype == 'REAL8' ) then
          file_history_req(reqid)%dtype  = file_real8
       else
          log_error("FILE_HISTORY_Setup",*) 'Not appropriate DATATYPE. Check!', datatype
          call prc_abort
       endif
 
       file_history_req(reqid)%registered = .false.
    enddo
 
    log_newline
    log_info("FILE_HISTORY_Setup",*) 'Number of requested history item             : ', file_history_nreqs
    log_info("FILE_HISTORY_Setup",*) 'Output default data type                     : ', trim(file_history_default_datatype)
    log_info("FILE_HISTORY_Setup",*) 'Output value at the initial step?            : ', file_history_output_step0
    if ( file_history_output_wait_step > 0 ) then
       log_info("FILE_HISTORY_Setup",*) 'Time when the output is suppressed [step]    : ', file_history_output_wait_step
    end if
    if ( file_history_output_switch_step >= 0 ) then
       log_info("FILE_HISTORY_Setup",*) 'Interval for switching the file [step]       : ', file_history_output_switch_step
    end if
    log_info("FILE_HISTORY_Setup",*) 'Check if requested item is not registered?   : ', file_history_error_putmiss
 
    file_history_nitems = 0
    allocate( file_history_vars(file_history_nreqs) )
 
    file_history_nvar_inputs = 0
    allocate( file_history_var_inputs(file_history_nreqs) )
 
    file_history_truncate_1d => file_history_truncate_1d_default
    file_history_truncate_2d => file_history_truncate_2d_default
    file_history_truncate_3d => file_history_truncate_3d_default
    file_history_truncate_4d => file_history_truncate_4d_default
 
    file_history_disabled = .false.
 
    return

References scale_calendar::calendar_unit2sec(), scale_precision::dp, scale_file::file_aggregate, file_history_aggregate, file_history_truncate_1d, file_history_truncate_2d, file_history_truncate_3d, file_history_truncate_4d, scale_file_h::file_real4, scale_file_h::file_real8, scale_io::io_fid_conf, and scale_prc::prc_abort().

Referenced by scale_file_history_cartesc::file_history_cartesc_setup().

Here is the call graph for this function:

Here is the caller graph for this function:

file_history_reg()

subroutine, public scale_file_history::file_history_reg	(	character(len=*), intent(in)	name,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	unit,
		integer, intent(out)	itemid,
		character(len=*), intent(in), optional	standard_name,
		integer, intent(in), optional	ndims,
		character(len=*), intent(in), optional	dim_type,
		character(len=*), intent(in), optional	cell_measures,
		logical, intent(in), optional	fill_halo
	)

Register/Append variable to history file.

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	if ndims is set and dim_type is not set, the dim_type that set firstry by FILE_HISTORY_set_dim of ndims is used

Definition at line 650 of file scale_file_history.F90.

    implicit none
 
    character(len=*), intent(in)  :: name
    character(len=*), intent(in)  :: desc
    character(len=*), intent(in)  :: unit
 
    integer,          intent(out) :: itemid
 
    character(len=*), intent(in), optional :: standard_name
    integer,          intent(in), optional :: ndims
    character(len=*), intent(in), optional :: dim_type
    character(len=*), intent(in), optional :: cell_measures
    logical,          intent(in), optional :: fill_halo
 
    character(len=H_SHORT) :: standard_name_
    character(len=H_SHORT) :: cell_measures_
    integer :: dimid, iid
    integer :: n
    !---------------------------------------------------------------------------
 
    itemid = -1
    if ( file_history_nreqs == 0 ) return
 
    itemid = file_history_find_id( name )
    if ( itemid > 0 ) return ! already registered
 
    call prof_rapstart('FILE_HISTORY_OUT', 2)
 
    if ( len_trim(name) >= h_short ) then
       log_error("FILE_HISTORY_reg",'(1x,A,I2,A,A)') 'Length of history name should be <= ', h_short-1 ,' chars. name=', trim(name)
       call prc_abort
    endif
 
    ! standard_name
    if ( present(standard_name) ) then
       standard_name_ = standard_name
    else
       standard_name_ = ""
    end if
 
    ! get dimension id
    if ( file_history_ndims < 1 ) then
       log_error("FILE_HISTORY_reg",*) 'at least one dim_type must be registerd with FILE_HISTORY_set_dim. name=', trim(name)
       call prc_abort
    end if
    dimid = -1
    if ( present(dim_type) ) then
       do n = 1, file_history_ndims
          if ( file_history_dims(n)%name == dim_type ) then
             dimid = n
             exit
          end if
       end do
       if ( dimid == -1 ) then
          log_error("FILE_HISTORY_reg",*) 'dim_type must be registerd with FILE_HISTORY_set_dim: ', trim(dim_type) ,' name=', trim(name)
          call prc_abort
       end if
    else if ( present(ndims) ) then
       do n = 1, file_history_ndims
          if ( file_history_dims(n)%ndims == ndims ) then
             dimid = n
             exit
          end if
       end do
       if ( dimid == -1 ) then
          log_error("FILE_HISTORY_reg",'(a,i1,a)') 'dim_type of ', ndims, 'D must be registerd with FILE_HISTORY_set_dim. name=', trim(name)
          call prc_abort
       end if
    else
       ! ndims = 3 is assumed as default
       do n = 1, file_history_ndims
          if ( file_history_dims(n)%ndims == 3 ) then
             dimid = n
             exit
          end if
       end do
       if ( dimid == -1 ) then
          log_error("FILE_HISTORY_reg",'(a,i1,a)') 'dim_type or ndims must be specified. name=', trim(name)
          call prc_abort
       end if
    end if
 
    if ( present(cell_measures) ) then
       select case ( cell_measures )
       case ( "area" )
          if ( file_history_dims(dimid)%area == "" ) then
             log_error("FILE_HISTORY_reg",*) 'area is not supported for cell_measures. name=', trim(name)
             call prc_abort
          end if
       case ( "area_z" )
          if ( file_history_dims(dimid)%area == "" ) then
             log_error("FILE_HISTORY_reg",*) 'area_z is not supported for cell_measures. name=', trim(name)
             call prc_abort
          end if
       case ( "area_x" )
          if ( file_history_dims(dimid)%area_x == "" ) then
             log_error("FILE_HISTORY_reg",*) 'area_x is not supported for cell_measures. name=', trim(name)
             call prc_abort
          end if
       case ( "area_y" )
          if ( file_history_dims(dimid)%area_y == "" ) then
             log_error("FILE_HISTORY_reg",*) 'area_y is not supported for cell_measures. name=', trim(name)
             call prc_abort
          end if
       case ( "volume" )
          if ( file_history_dims(dimid)%volume == "" ) then
             log_error("FILE_HISTORY_reg",*) 'volume is not supported for cell_measures. name=', trim(name)
             call prc_abort
          end if
       case default
          log_error("FILE_HISTORY_reg",*) 'cell_measures must be "area" or "volume". name=', trim(name)
          call prc_abort
       end select
       cell_measures_ = cell_measures
    else if ( file_history_dims(dimid)%ndims == 2 ) then
       cell_measures_ = "area"
    else if ( file_history_dims(dimid)%ndims == 3 ) then
       cell_measures_ = "volume"
    else
       cell_measures_ = ""
    end if
 
    if ( file_history_dims(dimid)%nzcoords > 1 ) then
 
       itemid = -1
       do n = 1, file_history_dims(dimid)%nzcoords
          if ( file_history_dims(dimid)%zcoords(n) == "model" ) then
             call file_history_add_variable( name, desc, unit, standard_name_,    & ! (in)
                                             dimid,                               & ! (in)
                                             file_history_dims(dimid)%zcoords(n), & ! (in)
                                             iid,                                 & ! (out)
                                             cell_measures = cell_measures_,      & ! (in)
                                             fill_halo     = fill_halo            ) ! (in)
          else
             call file_history_add_variable( name, desc, unit, standard_name_,    & ! (in)
                                             dimid,                               & ! (in)
                                             file_history_dims(dimid)%zcoords(n), & ! (in)
                                             iid,                                 & ! (out)
                                             fill_halo     = fill_halo            ) ! (in)
          end if
          if ( iid > 0 ) itemid = iid
       end do
 
    else
 
       call file_history_add_variable( name, desc, unit, standard_name_, & ! (in)
                                       dimid,                            & ! (in)
                                       "model",                          & ! (in)
                                       itemid,                           & ! (out)
                                       cell_measures = cell_measures_,   & ! (in)
                                       fill_halo     = fill_halo         ) ! (in)
 
    end if
 
    call prof_rapend('FILE_HISTORY_OUT', 2)
 
    return

References scale_const::const_eps, scale_const::const_undef, scale_file_h::file_rmiss, scale_io::h_short, i, scale_prc::prc_abort(), scale_prof::prof_rapend(), and scale_prof::prof_rapstart().

Referenced by scale_atmos_dyn_tstep_large_fvm_heve::atmos_dyn_tstep_large_fvm_heve_setup(), mod_atmos_phy_ae_vars::atmos_phy_ae_vars_setup(), scale_atmos_phy_cp_kf::atmos_phy_cp_kf_setup(), mod_atmos_phy_lt_driver::atmos_phy_lt_driver_setup(), scale_atmos_phy_lt_sato2019::atmos_phy_lt_sato2019_setup(), mod_atmos_phy_mp_driver::atmos_phy_mp_driver_setup(), scale_atmos_phy_mp_tomita08::atmos_phy_mp_tomita08_setup(), mod_atmos_phy_mp_vars::atmos_phy_mp_vars_setup(), mod_atmos_vars::atmos_vars_setup(), file_history_in_0d(), file_history_in_1d(), file_history_in_2d(), file_history_in_3d(), file_history_in_4d(), and scale_urban_dyn_kusaka01::urban_dyn_kusaka01_setup().

Here is the call graph for this function:

Here is the caller graph for this function:

file_history_in_0d()

subroutine scale_file_history::file_history_in_0d	(	real(rp), intent(in)	var,
		character(len=*), intent(in)	name,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	unit,
		character(len=*), intent(in), optional	standard_name,
		character(len=*), intent(in), optional	dim_type
	)

Wrapper routine of FILE_HISTORY_reg + FILE_HISTORY_put.

Parameters

[in]	var	value
[in]	name	name of the item
[in]	desc	description of the item
[in]	unit	unit of the item

Definition at line 892 of file scale_file_history.F90.

    implicit none
 
    real(RP),         intent(in) :: var
    character(len=*), intent(in) :: name
    character(len=*), intent(in) :: desc
    character(len=*), intent(in) :: unit
 
    character(len=*), intent(in), optional :: standard_name
    character(len=*), intent(in), optional :: dim_type
 
    logical, parameter     :: fill_halo = .false.
 
    integer, parameter :: ndim = 0
    integer :: itemid
    logical :: do_put
    !---------------------------------------------------------------------------
 
    if ( file_history_disabled ) return
 
    ! Check whether the item has been already registered
    call file_history_reg( name, desc, unit,            & ! [IN]
                           itemid,                      & ! [OUT]
                           standard_name=standard_name, & ! [IN]
                           ndims=ndim,                  & ! [IN]
                           dim_type=dim_type,           & ! [IN]
                           fill_halo=fill_halo          ) ! [IN]
 
    if ( itemid < 0 ) return
 
    ! Check whether it is time to input the item
    call file_history_query( itemid, do_put ) ! [IN], [OUT]
 
    if ( do_put ) call file_history_put( itemid, var )
 
    return

References scale_const::const_eps, scale_const::const_undef, file_history_reg(), file_history_truncate_1d, scale_file_h::file_rmiss, scale_prc::prc_abort(), scale_prof::prof_rapend(), and scale_prof::prof_rapstart().

Here is the call graph for this function:

file_history_in_1d()

subroutine scale_file_history::file_history_in_1d	(	real(rp), dimension(:), intent(in)	var,
		character(len=*), intent(in)	name,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	unit,
		character(len=*), intent(in), optional	standard_name,
		character(len=*), intent(in), optional	dim_type
	)

Wrapper routine of FILE_HISTORY_reg + FILE_HISTORY_put.

Parameters

[in]	var	value
[in]	name	name of the item
[in]	desc	description of the item
[in]	unit	unit of the item

Definition at line 1024 of file scale_file_history.F90.

    implicit none
 
    real(RP),         intent(in) :: var(:)
    character(len=*), intent(in) :: name
    character(len=*), intent(in) :: desc
    character(len=*), intent(in) :: unit
 
    character(len=*), intent(in), optional :: standard_name
    character(len=*), intent(in), optional :: dim_type
 
    logical, parameter     :: fill_halo = .false.
 
    integer, parameter :: ndim = 1
    integer :: itemid
    logical :: do_put
    !---------------------------------------------------------------------------
 
    if ( file_history_disabled ) return
 
    ! Check whether the item has been already registered
    call file_history_reg( name, desc, unit,            & ! [IN]
                           itemid,                      & ! [OUT]
                           standard_name=standard_name, & ! [IN]
                           ndims=ndim,                  & ! [IN]
                           dim_type=dim_type,           & ! [IN]
                           fill_halo=fill_halo          ) ! [IN]
 
    if ( itemid < 0 ) return
 
    ! Check whether it is time to input the item
    call file_history_query( itemid, do_put ) ! [IN], [OUT]
 
    if ( do_put ) call file_history_put( itemid, var(:) )
 
    return

References scale_const::const_eps, scale_const::const_undef, file_history_reg(), file_history_truncate_2d, scale_file_h::file_rmiss, scale_prc::prc_abort(), scale_prof::prof_rapend(), and scale_prof::prof_rapstart().

Here is the call graph for this function:

file_history_in_2d()

subroutine scale_file_history::file_history_in_2d	(	real(rp), dimension(:,:), intent(in)	var,
		character(len=*), intent(in)	name,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	unit,
		character(len=*), intent(in), optional	standard_name,
		character(len=*), intent(in), optional	dim_type,
		logical, intent(in), optional	fill_halo
	)

Wrapper routine of FILE_HISTORY_reg + FILE_HISTORY_put.

Parameters

[in]	var	value
[in]	name	name of the item
[in]	desc	description of the item
[in]	unit	unit of the item

Definition at line 1157 of file scale_file_history.F90.

    implicit none
 
    real(RP),         intent(in) :: var(:,:)
    character(len=*), intent(in) :: name
    character(len=*), intent(in) :: desc
    character(len=*), intent(in) :: unit
 
    character(len=*), intent(in), optional :: standard_name
    character(len=*), intent(in), optional :: dim_type
    logical,          intent(in), optional :: fill_halo
 
    integer, parameter :: ndim = 2
    integer :: itemid
    logical :: do_put
    !---------------------------------------------------------------------------
 
    if ( file_history_disabled ) return
 
    ! Check whether the item has been already registered
    call file_history_reg( name, desc, unit,            & ! [IN]
                           itemid,                      & ! [OUT]
                           standard_name=standard_name, & ! [IN]
                           ndims=ndim,                  & ! [IN]
                           dim_type=dim_type,           & ! [IN]
                           fill_halo=fill_halo          ) ! [IN]
 
    if ( itemid < 0 ) return
 
    ! Check whether it is time to input the item
    call file_history_query( itemid, do_put ) ! [IN], [OUT]
 
    if ( do_put ) call file_history_put( itemid, var(:,:) )
 
    return

References scale_const::const_eps, scale_const::const_undef, file_history_reg(), file_history_truncate_3d, scale_file_h::file_rmiss, scale_prc::prc_abort(), scale_prof::prof_rapend(), and scale_prof::prof_rapstart().

Here is the call graph for this function:

file_history_in_3d()

subroutine scale_file_history::file_history_in_3d	(	real(rp), dimension(:,:,:), intent(in)	var,
		character(len=*), intent(in)	name,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	unit,
		character(len=*), intent(in), optional	standard_name,
		character(len=*), intent(in), optional	dim_type,
		logical, intent(in), optional	fill_halo
	)

Wrapper routine of FILE_HISTORY_reg + FILE_HISTORY_put.

Parameters

[in]	var	value
[in]	name	name of the item
[in]	desc	description of the item
[in]	unit	unit of the item

Definition at line 1289 of file scale_file_history.F90.

    implicit none
 
    real(RP),         intent(in) :: var(:,:,:)
    character(len=*), intent(in) :: name
    character(len=*), intent(in) :: desc
    character(len=*), intent(in) :: unit
 
    character(len=*), intent(in), optional :: standard_name
    character(len=*), intent(in), optional :: dim_type
    logical,          intent(in), optional :: fill_halo
 
    integer, parameter :: ndim = 3
    integer :: itemid
    logical :: do_put
    !---------------------------------------------------------------------------
 
    if ( file_history_disabled ) return
 
    ! Check whether the item has been already registered
    call file_history_reg( name, desc, unit,            & ! [IN]
                           itemid,                      & ! [OUT]
                           standard_name=standard_name, & ! [IN]
                           ndims=ndim,                  & ! [IN]
                           dim_type=dim_type,           & ! [IN]
                           fill_halo=fill_halo          ) ! [IN]
 
    if ( itemid < 0 ) return
 
    ! Check whether it is time to input the item
    call file_history_query( itemid, do_put ) ! [IN], [OUT]
 
    if ( do_put ) call file_history_put( itemid, var(:,:,:) )
 
    return

References scale_const::const_eps, scale_const::const_undef, file_history_reg(), file_history_truncate_4d, scale_file_h::file_rmiss, scale_prc::prc_abort(), scale_prof::prof_rapend(), and scale_prof::prof_rapstart().

Here is the call graph for this function:

file_history_in_4d()

subroutine scale_file_history::file_history_in_4d	(	real(rp), dimension(:,:,:,:), intent(in)	var,
		character(len=*), intent(in)	name,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	unit,
		character(len=*), intent(in), optional	standard_name,
		character(len=*), intent(in), optional	dim_type,
		logical, intent(in), optional	fill_halo
	)

Wrapper routine of FILE_HISTORY_reg + FILE_HISTORY_put.

Parameters

[in]	var	value
[in]	name	name of the item
[in]	desc	description of the item
[in]	unit	unit of the item

Definition at line 1421 of file scale_file_history.F90.

    implicit none
 
    real(RP),         intent(in) :: var(:,:,:,:)
    character(len=*), intent(in) :: name
    character(len=*), intent(in) :: desc
    character(len=*), intent(in) :: unit
 
    character(len=*), intent(in), optional :: standard_name
    character(len=*), intent(in), optional :: dim_type
    logical,          intent(in), optional :: fill_halo
 
    integer, parameter :: ndim = 4
    integer :: itemid
    logical :: do_put
    !---------------------------------------------------------------------------
 
    if ( file_history_disabled ) return
 
    ! Check whether the item has been already registered
    call file_history_reg( name, desc, unit,            & ! [IN]
                           itemid,                      & ! [OUT]
                           standard_name=standard_name, & ! [IN]
                           ndims=ndim,                  & ! [IN]
                           dim_type=dim_type,           & ! [IN]
                           fill_halo=fill_halo          ) ! [IN]
 
    if ( itemid < 0 ) return
 
    ! Check whether it is time to input the item
    call file_history_query( itemid, do_put ) ! [IN], [OUT]
 
    if ( do_put ) call file_history_put( itemid, var(:,:,:,:) )
 
    return

References file_history_reg().

Here is the call graph for this function:

file_history_set_dim()

subroutine, public scale_file_history::file_history_set_dim	(	character(len=*), intent(in)	name,
		integer, intent(in)	ndims,
		integer, intent(in)	nzcoords,
		character(len=*), dimension(ndims,nzcoords), intent(in)	dims,
		character(len=*), dimension(nzcoords), intent(in)	zcoords,
		integer, dimension(ndims,nzcoords), intent(in)	start,
		integer, dimension(ndims,nzcoords), intent(in)	count,
		character(len=*), intent(in), optional	mapping,
		character(len=*), intent(in), optional	area,
		character(len=*), intent(in), optional	area_x,
		character(len=*), intent(in), optional	area_y,
		character(len=*), intent(in), optional	volume,
		character(len=*), intent(in), optional	location,
		character(len=*), intent(in), optional	grid
	)

set dimension information

Definition at line 1470 of file scale_file_history.F90.

    implicit none
 
    character(len=*), intent(in) :: name
    integer,          intent(in) :: ndims
    integer,          intent(in) :: nzcoords
    character(len=*), intent(in) :: dims(ndims,nzcoords)
    character(len=*), intent(in) :: zcoords(nzcoords)
    integer,          intent(in) :: start(ndims,nzcoords)
    integer,          intent(in) :: count(ndims,nzcoords)
 
    character(len=*), intent(in), optional :: mapping
    character(len=*), intent(in), optional :: area
    character(len=*), intent(in), optional :: area_x
    character(len=*), intent(in), optional :: area_y
    character(len=*), intent(in), optional :: volume
    character(len=*), intent(in), optional :: location
    character(len=*), intent(in), optional :: grid
 
    integer :: id
    integer :: size, n, m
 
    if ( file_history_ndims >= file_history_dim_max ) then
       log_error("FILE_HISTORY_Set_Dim",*) 'number of dimension exceed max limit: ', file_history_dim_max
       call prc_abort
    end if
    file_history_ndims = file_history_ndims + 1
    id = file_history_ndims
 
    allocate( file_history_dims(id)%dims (max(ndims,1),nzcoords) )
    allocate( file_history_dims(id)%start(max(ndims,1),nzcoords) )
    allocate( file_history_dims(id)%count(max(ndims,1),nzcoords) )
    allocate( file_history_dims(id)%zcoords(nzcoords) )
    allocate( file_history_dims(id)%size(nzcoords) )
 
    file_history_dims(id)%name       = name
    file_history_dims(id)%ndims      = ndims
    file_history_dims(id)%nzcoords   = nzcoords
    file_history_dims(id)%zcoords(:) = zcoords(:)
    if ( ndims > 0 ) then
       file_history_dims(id)%dims(:,:)  = dims(:,:)
       file_history_dims(id)%start(:,:) = start(:,:)
       file_history_dims(id)%count(:,:) = count(:,:)
    else ! 0D
       file_history_dims(id)%dims(1,1)  = ""
       file_history_dims(id)%start(1,1) = 1
       file_history_dims(id)%count(1,1) = 1
    end if
 
    do m = 1, nzcoords
       size = 1
       do n = 1, ndims
          size = size * count(n,m)
       end do
       file_history_dims(id)%size(m) = size
    end do
 
    if ( present(mapping) ) then
       file_history_dims(id)%mapping = mapping
    else
       file_history_dims(id)%mapping = ""
    end if
 
    if ( present(area) ) then
       file_history_dims(id)%area = area
    else
       file_history_dims(id)%area = ""
    end if
    if ( present(area_x) ) then
       file_history_dims(id)%area_x = area_x
    else
       file_history_dims(id)%area_x = ""
    end if
    if ( present(area_y) ) then
       file_history_dims(id)%area_y = area_y
    else
       file_history_dims(id)%area_y = ""
    end if
    if ( present(volume) ) then
       file_history_dims(id)%volume = volume
    else
       file_history_dims(id)%volume = ""
    end if
 
    if ( present(location) ) then
       file_history_dims(id)%location = location
       if ( present(grid) ) then
          file_history_dims(id)%grid = "grid_"//trim(grid)
       else
          file_history_dims(id)%grid = "grid"
       end if
    else
       file_history_dims(id)%location = ""
       file_history_dims(id)%grid     = ""
    end if
 
    return

References scale_prc::prc_abort().

Referenced by scale_file_history_cartesc::file_history_cartesc_set_pres().

Here is the call graph for this function:

Here is the caller graph for this function:

file_history_set_axis()

subroutine, public scale_file_history::file_history_set_axis	(	character(len=*), intent(in)	name,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	units,
		character(len=*), intent(in)	dim,
		real(rp), dimension(:), intent(in)	var,
		real(rp), dimension(:,:), intent(in), optional	bounds,
		logical, intent(in), optional	down,
		integer, intent(in), optional	gsize,
		integer, intent(in), optional	start
	)

set axis information

Definition at line 1579 of file scale_file_history.F90.

    implicit none
 
    character(len=*), intent(in) :: name
    character(len=*), intent(in) :: desc
    character(len=*), intent(in) :: units
    character(len=*), intent(in) :: dim
    real(RP),         intent(in) :: var(:)
 
    real(RP),         intent(in), optional :: bounds(:,:)
    logical,          intent(in), optional :: down
    integer,          intent(in), optional :: gsize ! global dim size
    integer,          intent(in), optional :: start ! global subarray start indices
 
    integer :: dim_size
    integer :: id
 
    intrinsic size
    !---------------------------------------------------------------------------
 
    dim_size = size(var)
 
    if ( file_history_naxes >= file_history_axis_max ) then
       log_error("FILE_HISTORY_Set_Axis",*) 'Number of axis exceeds the limit.'
       call prc_abort
    endif
 
    file_history_naxes = file_history_naxes + 1
    id                 = file_history_naxes
 
    allocate( file_history_axes(id)%var(dim_size) )
 
    file_history_axes(id)%name     = name
    file_history_axes(id)%desc     = desc
    file_history_axes(id)%units    = units
    file_history_axes(id)%dim      = dim
    file_history_axes(id)%dim_size = dim_size
    file_history_axes(id)%var(:)   = var(:)
 
    if ( present(down) ) then
       file_history_axes(id)%down = down
    else
       file_history_axes(id)%down = .false.
    endif
    if ( present(gsize) ) then ! global dimension size
         file_history_axes(id)%gdim_size = gsize
    else
         file_history_axes(id)%gdim_size = -1
    end if
    if ( present(start) ) then  ! global subarray starting indices
       file_history_axes(id)%start = start
    else
       file_history_axes(id)%start = 1
    end if
 
    if ( present(bounds) ) then
       allocate( file_history_axes(id)%bounds(2,dim_size) )
       file_history_axes(id)%bounds(:,:) = bounds(:,:)
    end if
 
    return

References scale_prc::prc_abort().

Referenced by scale_file_history_cartesc::file_history_cartesc_truncate_3d().

Here is the call graph for this function:

Here is the caller graph for this function:

file_history_write()

subroutine, public scale_file_history::file_history_write

Definition at line 1643 of file scale_file_history.F90.

    use scale_file, only: &
       file_enddef, &
       file_flush
    implicit none
 
    integer :: fid, prev_fid
    integer :: id
    !---------------------------------------------------------------------------
 
    if ( file_history_disabled ) return
 
    call prof_rapstart('FILE_HISTORY_OUT', 2)
 
    ! Write registered history variables to history file
    do id = 1, file_history_nitems
       call file_history_write_onevar( id, file_history_nowstep ) ! [IN]
    enddo
 
    ! when using PnetCDF, the above FILE_HISTORY_Write() only posts write requests
    ! Now we need to commit the requests to the file
    prev_fid = -1
    do id = 1, file_history_nitems
       fid = file_history_vars(id)%fid
       if ( fid > 0 .AND. fid /= prev_fid ) then
          call file_flush( fid )
          prev_fid = fid
       endif
    enddo
 
    ! check time to switching output file
    if (       file_history_output_switch_step >= 0                                      &
         .AND. file_history_nowstep-file_history_output_switch_laststep > file_history_output_switch_step ) then
 
       call file_history_close
 
       log_info("FILE_HISTORY_Write",*) 'FILE_HISTORY file is switched.'
 
       do id = 1, file_history_nitems
          file_history_vars(id)%fid = -1 ! reset
          file_history_vars(id)%vid = -1 ! reset
       enddo
 
       file_history_output_switch_laststep = file_history_nowstep - 1
    endif
 
    call prof_rapend('FILE_HISTORY_OUT', 2)
 
    return

References scale_file::file_enddef(), scale_file::file_flush(), 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:

file_history_set_nowdate()

subroutine, public scale_file_history::file_history_set_nowdate	(	integer, dimension(:), intent(in)	NOWDATE,
		real(dp), intent(in)	NOWSUBSEC,
		integer, intent(in)	NOWSTEP
	)

set now step

Definition at line 1697 of file scale_file_history.F90.

    integer,  intent(in) :: NOWDATE(:)
    real(DP), intent(in) :: NOWSUBSEC
    integer,  intent(in) :: NOWSTEP
 
    file_history_nowdate(:) = nowdate(:)
    file_history_nowsubsec  = nowsubsec
    file_history_nowstep    = nowstep
 
    return

Referenced by scale_file_history_cartesc::file_history_cartesc_setup(), and mod_rm_driver::rm_driver().

Here is the caller graph for this function:

file_history_set_disable()

subroutine, public scale_file_history::file_history_set_disable

(

logical, intent(in)

switch

)

set switch to turn on/off history

Definition at line 1712 of file scale_file_history.F90.

    implicit none
 
    logical, intent(in) :: switch
    !---------------------------------------------------------------------------
 
    file_history_disabled = switch
 
    return

References switch.

Referenced by scale_atmos_dyn_tstep_large_fvm_heve::atmos_dyn_tstep_large_fvm_heve().

Here is the caller graph for this function:

file_history_finalize()

subroutine, public scale_file_history::file_history_finalize

finalization

Definition at line 1726 of file scale_file_history.F90.

 
    call file_history_close
 
    return

References aggregate, scale_precision::dp, scale_file::file_add_associatedvariable(), scale_file::file_attach_buffer(), scale_file::file_close(), scale_file::file_create(), scale_file::file_def_associatedcoordinate(), scale_file::file_def_axis(), scale_file::file_detach_buffer(), scale_file_h::file_dtypelist, scale_file::file_flush(), file_history_aggregate, scale_file_h::file_real4, scale_file_h::file_real8, scale_file::file_redef(), scale_file::file_set_option(), i, scale_prc::prc_abort(), scale_precision::rp, and scale_time::time_time2label().

Referenced by mod_rm_driver::rm_driver().

Here is the call graph for this function:

Here is the caller graph for this function:

file_history_set_associatedcoordinate_1d()

subroutine scale_file_history::file_history_set_associatedcoordinate_1d	(	character(len=*), intent(in)	name,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	units,
		character(len=*), dimension(:), intent(in)	dims,
		real(rp), dimension(:), intent(in)	var,
		character(len=*), intent(in), optional	datatype,
		integer, dimension(:), intent(in), optional	start
	)

Definition at line 2198 of file scale_file_history.F90.

    use scale_file_h, only: &
       file_real4, &
       file_real8
    implicit none
 
    character(len=*), intent(in) :: name
    character(len=*), intent(in) :: desc
    character(len=*), intent(in) :: units
    character(len=*), intent(in) :: dims(:)
    real(RP),         intent(in) :: var(:)
    character(len=*), intent(in), optional :: datatype
    integer,          intent(in), optional :: start(:)
 
    integer :: dtype
    integer :: dim_size
    integer :: id
 
    intrinsic size, shape, reshape
    !---------------------------------------------------------------------------
 
    if ( present(datatype) ) then
       if    ( datatype == 'REAL4' ) then
          dtype = file_real4
       elseif( datatype == 'REAL8' ) then
          dtype = file_real8
       else
          log_error("FILE_HISTORY_Set_AssociatedCoordinate_1D",*) 'Not appropriate datatype. Check!', datatype
          call prc_abort
       endif
    else if ( rp == sp ) then
       dtype = file_real4
    else
       dtype = file_real8
    endif
 
    dim_size = size(var)
 
    if ( file_history_nassocs < file_history_assoc_max ) then
       file_history_nassocs = file_history_nassocs + 1
       id                   = file_history_nassocs
 
       allocate( file_history_assocs(id)%var(dim_size) )
 
       file_history_assocs(id)%name      = name
       file_history_assocs(id)%desc      = desc
       file_history_assocs(id)%units     = units
       file_history_assocs(id)%ndims     = 1
       file_history_assocs(id)%dims(:)   = ''
       file_history_assocs(id)%dims(1:1) = dims(1:1)
       file_history_assocs(id)%dtype     = dtype
       file_history_assocs(id)%var(:)    = real(reshape( var, (/ dim_size /) ),kind=dp)
 
       ! start and count are used for parallel I/O to a single shared file
       ! since var is reshaped into 1D array, we need to preserve its original shape in count
       file_history_assocs(id)%count(1:1) = shape(var)
       if ( present(start) ) then
          file_history_assocs(id)%start(1:1) = start(1:1)
       else
          file_history_assocs(id)%start = (/ 1, 1, 1, 1 /)
       end if
    else
       log_error("FILE_HISTORY_Set_AssociatedCoordinate_1D",*) 'Number of associate coordinates exceeds the limit.'
       call prc_abort
    endif
 
    return

References scale_precision::dp, scale_file_h::file_real4, scale_file_h::file_real8, scale_prc::prc_abort(), and scale_precision::sp.

Here is the call graph for this function:

file_history_set_associatedcoordinate_2d()

subroutine scale_file_history::file_history_set_associatedcoordinate_2d	(	character(len=*), intent(in)	name,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	units,
		character(len=*), dimension(:), intent(in)	dims,
		real(rp), dimension(:,:), intent(in)	var,
		character(len=*), intent(in), optional	datatype,
		integer, dimension(:), intent(in), optional	start
	)

Definition at line 2275 of file scale_file_history.F90.

    use scale_file_h, only: &
       file_real4, &
       file_real8
    implicit none
 
    character(len=*), intent(in) :: name
    character(len=*), intent(in) :: desc
    character(len=*), intent(in) :: units
    character(len=*), intent(in) :: dims(:)
    real(RP),         intent(in) :: var(:,:)
    character(len=*), intent(in), optional :: datatype
    integer,          intent(in), optional :: start(:)
 
    integer :: dtype
    integer :: dim_size
    integer :: id
 
    intrinsic size, shape, reshape
    !---------------------------------------------------------------------------
 
    if ( present(datatype) ) then
       if    ( datatype == 'REAL4' ) then
          dtype = file_real4
       elseif( datatype == 'REAL8' ) then
          dtype = file_real8
       else
          log_error("FILE_HISTORY_Set_AssociatedCoordinate_2D",*) 'Not appropriate datatype. Check!', datatype
          call prc_abort
       endif
    else if ( rp == sp ) then
       dtype = file_real4
    else
       dtype = file_real8
    endif
 
    dim_size = size(var)
 
    if ( file_history_nassocs < file_history_assoc_max ) then
       file_history_nassocs = file_history_nassocs + 1
       id                   = file_history_nassocs
 
       allocate( file_history_assocs(id)%var(dim_size) )
 
       file_history_assocs(id)%name      = name
       file_history_assocs(id)%desc      = desc
       file_history_assocs(id)%units     = units
       file_history_assocs(id)%ndims     = 2
       file_history_assocs(id)%dims(:)   = ''
       file_history_assocs(id)%dims(1:2) = dims(1:2)
       file_history_assocs(id)%dtype     = dtype
       file_history_assocs(id)%var(:)    = real(reshape( var, (/ dim_size /) ),kind=dp)
 
       ! start and count are used for parallel I/O to a single shared file
       ! since var is reshaped into 1D array, we need to preserve its original shape in count
       file_history_assocs(id)%count(1:2) = shape(var)
       if ( present(start) ) then
          file_history_assocs(id)%start(1:2) = start(1:2)
       else
          file_history_assocs(id)%start = (/ 1, 1, 1, 1 /)
       end if
    else
       log_error("FILE_HISTORY_Set_AssociatedCoordinate_2D",*) 'Number of associate coordinates exceeds the limit.'
       call prc_abort
    endif
 
    return

References scale_precision::dp, scale_file_h::file_real4, scale_file_h::file_real8, scale_prc::prc_abort(), and scale_precision::sp.

Here is the call graph for this function:

file_history_set_associatedcoordinate_3d()

subroutine scale_file_history::file_history_set_associatedcoordinate_3d	(	character(len=*), intent(in)	name,
		character(len=*), intent(in)	desc,
		character(len=*), intent(in)	units,
		character(len=*), dimension(:), intent(in)	dims,
		real(rp), dimension(:,:,:), intent(in)	var,
		character(len=*), intent(in), optional	datatype,
		integer, dimension(:), intent(in), optional	start
	)

Definition at line 2352 of file scale_file_history.F90.

    use scale_file_h, only: &
       file_real4, &
       file_real8
    implicit none
 
    character(len=*), intent(in) :: name
    character(len=*), intent(in) :: desc
    character(len=*), intent(in) :: units
    character(len=*), intent(in) :: dims(:)
    real(RP),         intent(in) :: var(:,:,:)
    character(len=*), intent(in), optional :: datatype
    integer,          intent(in), optional :: start(:)
 
    integer :: dtype
    integer :: dim_size
    integer :: id
 
    intrinsic size, shape, reshape
    !---------------------------------------------------------------------------
 
    if ( present(datatype) ) then
       if    ( datatype == 'REAL4' ) then
          dtype = file_real4
       elseif( datatype == 'REAL8' ) then
          dtype = file_real8
       else
          log_error("FILE_HISTORY_Set_AssociatedCoordinate_3D",*) 'Not appropriate datatype. Check!', datatype
          call prc_abort
       endif
    else if ( rp == sp ) then
       dtype = file_real4
    else
       dtype = file_real8
    endif
 
    dim_size = size(var)
 
    if ( file_history_nassocs < file_history_assoc_max ) then
       file_history_nassocs = file_history_nassocs + 1
       id                   = file_history_nassocs
 
       allocate( file_history_assocs(id)%var(dim_size) )
 
       file_history_assocs(id)%name      = name
       file_history_assocs(id)%desc      = desc
       file_history_assocs(id)%units     = units
       file_history_assocs(id)%ndims     = 3
       file_history_assocs(id)%dims(:)   = ''
       file_history_assocs(id)%dims(1:3) = dims(1:3)
       file_history_assocs(id)%dtype     = dtype
       file_history_assocs(id)%var(:)    = real(reshape( var, (/ dim_size /) ),kind=dp)
 
       ! start and count are used for parallel I/O to a single shared file
       ! since var is reshaped into 1D array, we need to preserve its original shape in count
       file_history_assocs(id)%count(1:3) = shape(var)
       if ( present(start) ) then
          file_history_assocs(id)%start(1:3) = start(1:3)
       else
          file_history_assocs(id)%start = (/ 1, 1, 1, 1 /)
       end if
    else
       log_error("FILE_HISTORY_Set_AssociatedCoordinate_3D",*) 'Number of associate coordinates exceeds the limit.'
       call prc_abort
    endif
 
    return

References scale_precision::dp, scale_file_h::file_real4, scale_file_h::file_real8, scale_prc::prc_abort(), and scale_precision::sp.

Here is the call graph for this function:

file_history_set_attribute_text()

subroutine scale_file_history::file_history_set_attribute_text	(	character(len=*), intent(in)	varname,
		character(len=*), intent(in)	key,
		character(len=*), intent(in)	val,
		logical, intent(in), optional	add_variable
	)

Definition at line 2427 of file scale_file_history.F90.

    use scale_prc, only: &
       prc_abort
    use scale_file, only: &
       file_set_attribute
    implicit none
    character(len=*), intent(in) :: varname
    character(len=*), intent(in) :: key
    character(len=*), intent(in) :: val
    logical,          intent(in), optional :: add_variable
 
    integer :: id
    !---------------------------------------------------------------------------
 
    file_history_nattrs = file_history_nattrs + 1
    if ( file_history_nattrs > file_history_attr_max ) then
       log_error("FILE_HISTORY_Set_Attribute_Text",*) 'number of attributes exceeds the limit'
       call prc_abort
    end if
 
    id = file_history_nattrs
 
    file_history_attrs(id)%varname = varname
    file_history_attrs(id)%key     = key
    file_history_attrs(id)%text    = val
    file_history_attrs(id)%type    = i_text
 
    if ( present(add_variable) ) then
       file_history_attrs(id)%add_variable = add_variable
    else
       file_history_attrs(id)%add_variable = .false.
    end if
 
    return

References scale_prc::prc_abort().

Referenced by file_history_set_attribute_logical().

Here is the call graph for this function:

Here is the caller graph for this function:

file_history_set_attribute_logical()

subroutine scale_file_history::file_history_set_attribute_logical	(	character(len=*), intent(in)	varname,
		character(len=*), intent(in)	key,
		logical, intent(in)	val,
		logical, intent(in), optional	add_variable
	)

Definition at line 2466 of file scale_file_history.F90.

    use scale_file, only: &
       file_set_attribute
    implicit none
    character(len=*), intent(in) :: varname
    character(len=*), intent(in) :: key
    logical,          intent(in) :: val
    logical,          intent(in), optional :: add_variable
 
    character(len=5) :: buf
    !---------------------------------------------------------------------------
 
    if ( val ) then
       buf = "true"
    else
       buf = "false"
    end if
 
    call file_history_set_attribute_text( varname, key, buf, add_variable=add_variable )
 
    return

References file_history_set_attribute_text().

Here is the call graph for this function:

file_history_set_attribute_int_ary()

subroutine scale_file_history::file_history_set_attribute_int_ary	(	character(len=*), intent(in)	varname,
		character(len=*), intent(in)	key,
		integer, dimension(:), intent(in)	val,
		logical, intent(in), optional	add_variable
	)

Definition at line 2493 of file scale_file_history.F90.

    use scale_prc, only: &
       prc_abort
    use scale_file, only: &
       file_set_attribute
    implicit none
    character(len=*), intent(in) :: varname
    character(len=*), intent(in) :: key
    integer,          intent(in) :: val(:)
    logical,          intent(in), optional :: add_variable
 
    integer :: id
 
    intrinsic size
    !---------------------------------------------------------------------------
 
    file_history_nattrs = file_history_nattrs + 1
    if ( file_history_nattrs > file_history_attr_max ) then
       log_error("FILE_HISTORY_Set_Attribute_Int",*) 'number of attributes exceeds the limit'
       call prc_abort
    end if
 
    id = file_history_nattrs
 
    allocate( file_history_attrs(id)%int( size(val) ) )
 
    file_history_attrs(id)%varname = varname
    file_history_attrs(id)%key     = key
    file_history_attrs(id)%int(:)    = val(:)
    file_history_attrs(id)%type    = i_int
 
    if ( present(add_variable) ) then
       file_history_attrs(id)%add_variable = add_variable
    else
       file_history_attrs(id)%add_variable = .false.
    end if
 
    return

References scale_prc::prc_abort().

Referenced by file_history_set_attribute_int().

Here is the call graph for this function:

Here is the caller graph for this function:

file_history_set_attribute_int()

subroutine scale_file_history::file_history_set_attribute_int	(	character(len=*), intent(in)	varname,
		character(len=*), intent(in)	key,
		integer, intent(in)	val,
		logical, intent(in), optional	add_variable
	)

Definition at line 2537 of file scale_file_history.F90.

    implicit none
    character(len=*), intent(in) :: varname
    character(len=*), intent(in) :: key
    integer,          intent(in) :: val
    logical,          intent(in), optional :: add_variable
 
    integer :: ary(1)
    !---------------------------------------------------------------------------
 
    ary(1) = val
    call file_history_set_attribute_int_ary( varname,                  & ! (in)
                                             key, ary(:),              & ! (in)
                                             add_variable=add_variable ) ! (in)
 
    return

References file_history_set_attribute_int_ary(), and scale_prc::prc_abort().

Here is the call graph for this function:

file_history_set_attribute_float()

subroutine scale_file_history::file_history_set_attribute_float	(	character(len=*), intent(in)	varname,
		character(len=*), intent(in)	key,
		real(sp), intent(in)	val,
		logical, intent(in), optional	add_variable
	)

Definition at line 2602 of file scale_file_history.F90.

    implicit none
    character(len=*), intent(in) :: varname
    character(len=*), intent(in) :: key
    real(SP),         intent(in) :: val
    logical,          intent(in), optional :: add_variable
 
    real(SP) :: ary(1)
 
    ary(1) = val
    call file_history_set_attribute_float_ary( varname,     & ! (in)
                                                   key, ary(:), & ! (in)
                                                   add_variable ) ! (in)
 
    return

References scale_prc::prc_abort().

Here is the call graph for this function:

file_history_set_attribute_double()

subroutine scale_file_history::file_history_set_attribute_double	(	character(len=*), intent(in)	varname,
		character(len=*), intent(in)	key,
		real(dp), intent(in)	val,
		logical, intent(in), optional	add_variable
	)

Definition at line 2665 of file scale_file_history.F90.

    implicit none
    character(len=*), intent(in) :: varname
    character(len=*), intent(in) :: key
    real(DP),         intent(in) :: val
    logical,          intent(in), optional :: add_variable
 
    real(DP) :: ary(1)
 
    ary(1) = val
    call file_history_set_attribute_double_ary( varname,     & ! (in)
                                                   key, ary(:), & ! (in)
                                                   add_variable ) ! (in)
 
    return

References scale_calendar::calendar_sec2unit(), scale_file::file_enddef(), scale_file::file_flush(), scale_file_h::file_rmiss, and scale_prc::prc_abort().

Here is the call graph for this function:

Variable Documentation

file_history_truncate_1d

procedure(truncate_1d), pointer, public scale_file_history::file_history_truncate_1d => NULL()

Definition at line 77 of file scale_file_history.F90.

  procedure(truncate_1D), pointer :: FILE_HISTORY_truncate_1D => null()

Referenced by scale_file_history_cartesc::file_history_cartesc_setup(), file_history_in_0d(), and file_history_setup().

file_history_truncate_2d

procedure(truncate_2d), pointer, public scale_file_history::file_history_truncate_2d => NULL()

Definition at line 89 of file scale_file_history.F90.

  procedure(truncate_2D), pointer :: FILE_HISTORY_truncate_2D => null()

Referenced by scale_file_history_cartesc::file_history_cartesc_setup(), file_history_in_1d(), and file_history_setup().

file_history_truncate_3d

procedure(truncate_3d), pointer, public scale_file_history::file_history_truncate_3d => NULL()

Definition at line 101 of file scale_file_history.F90.

  procedure(truncate_3D), pointer :: FILE_HISTORY_truncate_3D => null()

Referenced by scale_file_history_cartesc::file_history_cartesc_setup(), file_history_in_2d(), and file_history_setup().

file_history_truncate_4d

procedure(truncate_4d), pointer, public scale_file_history::file_history_truncate_4d => NULL()

Definition at line 113 of file scale_file_history.F90.

  procedure(truncate_4D), pointer :: FILE_HISTORY_truncate_4D => null()

Referenced by file_history_in_3d(), and file_history_setup().

file_history_aggregate

logical, public scale_file_history::file_history_aggregate

Definition at line 143 of file scale_file_history.F90.

  logical, public :: FILE_HISTORY_AGGREGATE

Referenced by scale_file_history_cartesc::file_history_cartesc_truncate_3d(), file_history_finalize(), and file_history_setup().

switch

integer public scale_file_history::switch

Definition at line 143 of file scale_file_history.F90.

Referenced by file_history_set_disable().

to

integer public scale_file_history::to

Definition at line 143 of file scale_file_history.F90.

use

logical, public scale_file_history::use

Definition at line 143 of file scale_file_history.F90.

aggregate

logical, public scale_file_history::aggregate

Definition at line 143 of file scale_file_history.F90.

Referenced by file_history_finalize().

file

integer public scale_file_history::file

Definition at line 143 of file scale_file_history.F90.

i

logical, public scale_file_history::i

Definition at line 143 of file scale_file_history.F90.

Referenced by file_history_finalize(), and file_history_reg().

o

logical, public scale_file_history::o

Definition at line 143 of file scale_file_history.F90.