SCALE-RM
Data Types | Functions/Subroutines | Variables
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, NOWMS, 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 (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)
 
subroutine file_history_query_id (itemid, answer)
 

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
    nametypedefault valuecomment
    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
    nametypedefault valuecomment
    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 341 of file scale_file_history.F90.

References scale_calendar::calendar_unit2sec(), 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().

341  use scale_file_h, only: &
342  file_real4, &
343  file_real8
344  use scale_file, only: &
345  file_aggregate
346  use scale_calendar, only: &
347  calendar_unit2sec
348  implicit none
349 
350  character(len=*), intent(in) :: title
351  character(len=*), intent(in) :: source
352  character(len=*), intent(in) :: institution
353  real(DP), intent(in) :: time_start
354  real(DP), intent(in) :: time_interval
355 
356  character(len=*), intent(in), optional :: time_units
357  character(len=*), intent(in), optional :: time_since
358  character(len=*), intent(in), optional :: calendar
359  character(len=*), intent(in), optional :: default_basename
360  logical, intent(in), optional :: default_postfix_timelabel
361  character(len=*), intent(in), optional :: default_zcoord
362  real(DP), intent(in), optional :: default_tinterval
363  character(len=*), intent(in), optional :: default_tunit
364  logical, intent(in), optional :: default_taverage
365  character(len=*), intent(in), optional :: default_datatype
366  integer, intent(in), optional :: myrank
367 
368  character(len=H_LONG) :: file_history_default_basename
369  logical :: file_history_default_postfix_timelabel
370  character(len=H_SHORT) :: file_history_default_zcoord
371  real(DP) :: file_history_default_tinterval
372  character(len=H_SHORT) :: file_history_default_tunit
373  logical :: file_history_default_taverage
374  character(len=H_SHORT) :: file_history_default_datatype
377  real(DP) :: file_history_output_wait
378  character(len=H_SHORT) :: file_history_output_wait_tunit
379  real(DP) :: file_history_output_switch_tinterval
380  character(len=H_SHORT) :: file_history_output_switch_tunit
381 
382  namelist / param_file_history / &
383  file_history_title, &
384  file_history_source, &
385  file_history_institution, &
386  file_history_time_units, &
387  file_history_default_basename, &
388  file_history_default_postfix_timelabel, &
389  file_history_default_zcoord, &
390  file_history_default_tinterval, &
391  file_history_default_tunit, &
392  file_history_default_taverage, &
393  file_history_default_datatype, &
394  file_history_output_step0, &
395  file_history_output_wait, &
396  file_history_output_wait_tunit, &
397  file_history_output_switch_tinterval, &
398  file_history_output_switch_tunit, &
399  file_history_error_putmiss, &
400  file_history_aggregate, &
401  file_history_options, &
402  debug
403 
404  character(len=H_SHORT) :: name
405  character(len=H_SHORT) :: outname
406  character(len=H_LONG) :: basename
407  logical :: postfix_timelabel
408  character(len=H_SHORT) :: zcoord
409  real(DP) :: tinterval
410  character(len=H_SHORT) :: tunit
411  logical :: taverage
412  character(len=H_SHORT) :: datatype
413 
414  namelist / history_item / &
415  name, &
416  outname, &
417  basename, &
418  postfix_timelabel, &
419  zcoord, &
420  tinterval, &
421  tunit, &
422  taverage, &
423  datatype
424 
425 
426  integer :: reqid
427  real(DP) :: dtsec
428  integer :: dstep
429 
430  integer :: ierr
431  integer :: n, id
432 
433  intrinsic size
434  !---------------------------------------------------------------------------
435 
436  log_newline
437  log_info("FILE_HISTORY_Setup",*) 'Setup'
438 
439  ! setup
440  file_history_myrank = myrank
441 
442  file_history_startdaysec = time_start
443  file_history_dtsec = time_interval
444  if ( present(time_since) ) then
445  file_history_time_since = time_since
446  else
447  file_history_time_since = ''
448  endif
449 
450  if ( present(calendar) ) then
451  file_history_calendar = calendar
452  else
453  file_history_calendar = ""
454  end if
455 
456  file_history_time_units = 'seconds'
457  file_history_default_basename = ''
458  file_history_default_postfix_timelabel = .false.
459  file_history_default_zcoord = ''
460  file_history_default_tinterval = -1.0_dp
461  file_history_default_tunit = 'SEC'
462  file_history_default_taverage = .false.
463  file_history_default_datatype = 'REAL4'
464  file_history_output_wait = 0.0_dp
465  file_history_output_wait_tunit = 'SEC'
466  file_history_output_switch_tinterval = -1.0_dp
467  file_history_output_switch_tunit = 'SEC'
468 
469  file_history_aggregate = file_aggregate
470 
471  !--- read namelist
472  file_history_title = title
473  file_history_source = source
474  file_history_institution = institution
475  if( present(time_units) ) file_history_time_units = time_units
476  if( present(default_basename) ) file_history_default_basename = default_basename
477  if( present(default_postfix_timelabel) ) file_history_default_postfix_timelabel = default_postfix_timelabel
478  if( present(default_zcoord) ) file_history_default_zcoord = default_zcoord
479  if( present(default_tinterval) ) file_history_default_tinterval = default_tinterval
480  if( present(default_tunit) ) file_history_default_tunit = default_tunit
481  if( present(default_taverage) ) file_history_default_taverage = default_taverage
482  if( present(default_datatype) ) file_history_default_datatype = default_datatype
483 
484  !--- read namelist
485  rewind(io_fid_conf)
486  read(io_fid_conf,nml=param_file_history,iostat=ierr)
487  if( ierr < 0 ) then !--- missing
488  log_info("FILE_HISTORY_Setup",*) 'Not found namelist. Default used.'
489  elseif( ierr > 0 ) then !--- fatal error
490  log_error("FILE_HISTORY_Setup",*) 'Not appropriate names in namelist PARAM_FILE_HISTORY. Check!'
491  call prc_abort
492  endif
493  log_nml(param_file_history)
494 
495 
496 
497  if ( file_history_output_wait >= 0.0_dp ) then
498  call calendar_unit2sec( dtsec, file_history_output_wait, file_history_output_wait_tunit )
499  file_history_output_wait_step = int( dtsec / file_history_dtsec )
500  else
501  log_error("FILE_HISTORY_Setup",*) 'FILE_HISTORY_OUTPUT_WAIT must be positive. STOP'
502  call prc_abort
503  endif
504 
505  if ( file_history_output_switch_tinterval >= 0.0_dp ) then
506  call calendar_unit2sec( dtsec, file_history_output_switch_tinterval, file_history_output_switch_tunit )
507  file_history_output_switch_step = int( dtsec / file_history_dtsec )
508  else
509  file_history_output_switch_step = -1
510  endif
511  file_history_output_switch_laststep = 0
512 
513 
514  ! count history request
515  file_history_nreqs = 0
516  if ( io_fid_conf > 0 ) rewind(io_fid_conf)
517  do n = 1, file_history_req_max
518  name = ''
519  outname = 'undefined'
520  basename = file_history_default_basename
521 
522  read(io_fid_conf,nml=history_item,iostat=ierr)
523  if( ierr /= 0 ) exit
524  if( basename == '' .OR. name == '' .OR. outname == '' ) cycle ! invalid HISTORY_ITEM
525 
526  file_history_nreqs = file_history_nreqs + 1
527  enddo
528 
529  if ( file_history_nreqs > file_history_req_max ) then
530  log_error("FILE_HISTORY_Setup",*) 'request of history file is exceed! n >', file_history_req_max
531  call prc_abort
532  elseif( file_history_nreqs == 0 ) then
533  log_info("FILE_HISTORY_Setup",*) 'No history file specified.'
534  return
535  endif
536 
537  allocate( file_history_req(file_history_nreqs) )
538 
539  ! read history request
540  reqid = 0
541  if ( io_fid_conf > 0 ) rewind(io_fid_conf)
542  do n = 1, file_history_req_max
543  ! set default
544  name = ''
545  outname = 'undefined'
546  basename = file_history_default_basename
547  postfix_timelabel = file_history_default_postfix_timelabel
548  zcoord = file_history_default_zcoord
549  tinterval = file_history_default_tinterval
550  tunit = file_history_default_tunit
551  taverage = file_history_default_taverage
552  datatype = file_history_default_datatype
553 
554  read(io_fid_conf,nml=history_item,iostat=ierr)
555  if ( ierr < 0 ) then
556  exit ! no more items
557  elseif( ierr > 0 ) then
558  log_error("FILE_HISTORY_Setup",*) 'Not appropriate names in namelist HISTORY_ITEM. Check!'
559  call prc_abort
560  endif
561  if( basename == '' .OR. name == '' .OR. outname == '' ) cycle ! invalid HISTORY_ITEM
562 
563  log_nml(history_item)
564 
565  ! check duplicated request
566  if ( outname == 'undefined' ) outname = name ! set default name
567  do id = 1, reqid
568  if ( file_history_req(id)%outname == outname ) then
569  log_error("FILE_HISTORY_Setup",*) 'Same name of history output is already registered. Check!', trim(outname)
570  call prc_abort
571  endif
572  enddo
573 
574  reqid = reqid + 1
575 
576  file_history_req(reqid)%name = name
577  file_history_req(reqid)%outname = outname
578  file_history_req(reqid)%basename = basename
579  file_history_req(reqid)%postfix_timelabel = postfix_timelabel
580  if( file_history_output_switch_step >= 0 ) file_history_req(reqid)%postfix_timelabel = .true. ! force true
581  file_history_req(reqid)%zcoord = zcoord
582  file_history_req(reqid)%taverage = taverage
583 
584  call calendar_unit2sec( dtsec, tinterval, tunit )
585  dstep = int( dtsec / file_history_dtsec )
586 
587  if ( dtsec <= 0.d0 ) then
588  log_error("FILE_HISTORY_Setup",*) 'Not appropriate time interval. Check!', trim(name), tinterval, trim(tunit)
589  call prc_abort
590  endif
591 
592  if ( abs(dtsec-real(dstep,kind=dp)*file_history_dtsec) > dtsec*1.e-3_dp ) then
593  log_error("FILE_HISTORY_Setup",*) 'time interval must be a multiple of delta t. (interval,dt)=', dtsec, file_history_dtsec
594  call prc_abort
595  endif
596 
597  file_history_req(reqid)%dstep = dstep
598 
599  if ( datatype == 'REAL4' ) then
600  file_history_req(reqid)%dtype = file_real4
601  elseif( datatype == 'REAL8' ) then
602  file_history_req(reqid)%dtype = file_real8
603  else
604  log_error("FILE_HISTORY_Setup",*) 'Not appropriate DATATYPE. Check!', datatype
605  call prc_abort
606  endif
607 
608  file_history_req(reqid)%registered = .false.
609  enddo
610 
611  log_newline
612  log_info("FILE_HISTORY_Setup",*) 'Number of requested history item : ', file_history_nreqs
613  log_info("FILE_HISTORY_Setup",*) 'Output default data type : ', trim(file_history_default_datatype)
614  log_info("FILE_HISTORY_Setup",*) 'Output value at the initial step? : ', file_history_output_step0
615  if ( file_history_output_wait_step > 0 ) then
616  log_info("FILE_HISTORY_Setup",*) 'Time when the output is suppressed [step] : ', file_history_output_wait_step
617  end if
618  if ( file_history_output_switch_step >= 0 ) then
619  log_info("FILE_HISTORY_Setup",*) 'Interval for switching the file [step] : ', file_history_output_switch_step
620  end if
621  log_info("FILE_HISTORY_Setup",*) 'Check if requested item is not registered? : ', file_history_error_putmiss
622 
623  file_history_nitems = 0
624  allocate( file_history_vars(file_history_nreqs) )
625 
626  file_history_nvar_inputs = 0
627  allocate( file_history_var_inputs(file_history_nreqs) )
628 
629  file_history_truncate_1d => file_history_truncate_1d_default
630  file_history_truncate_2d => file_history_truncate_2d_default
631  file_history_truncate_3d => file_history_truncate_3d_default
632  file_history_truncate_4d => file_history_truncate_4d_default
633 
634  file_history_disabled = .false.
635 
636  return
scale_calendar::calendar_unit2sec
subroutine, public calendar_unit2sec(second, value, unit)
Convert several units to second.
Definition: scale_calendar.F90:424
scale_file_h::file_real4
integer, parameter, public file_real4
Definition: scale_file_h.F90:24
scale_file::file_aggregate
logical, public file_aggregate
Definition: scale_file.F90:171
scale_io::io_fid_conf
integer, public io_fid_conf
Config file ID.
Definition: scale_io.F90:55
scale_file_h::file_real8
integer, parameter, public file_real8
Definition: scale_file_h.F90:25
scale_file
module file
Definition: scale_file.F90:15
scale_prc::prc_abort
subroutine, public prc_abort
Abort Process.
Definition: scale_prc.F90:338
scale_calendar
module CALENDAR
Definition: scale_calendar.F90:13
scale_precision::dp
integer, parameter, public dp
Definition: scale_precision.F90:32
scale_file_h
module file_h
Definition: scale_file_h.F90:11
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]namename of the item
[in]descdescription of the item
[in]unitunit of the item
[out]itemidindex number of the item
[in]ndimsif 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 649 of file scale_file_history.F90.

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

Referenced by mod_atmos_phy_ae_vars::atmos_phy_ae_vars_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().

649  implicit none
650 
651  character(len=*), intent(in) :: name
652  character(len=*), intent(in) :: desc
653  character(len=*), intent(in) :: unit
654 
655  integer, intent(out) :: itemid
656 
657  character(len=*), intent(in), optional :: standard_name
658  integer, intent(in), optional :: ndims
659  character(len=*), intent(in), optional :: dim_type
660  character(len=*), intent(in), optional :: cell_measures
661  logical, intent(in), optional :: fill_halo
662 
663  character(len=H_SHORT) :: standard_name_
664  character(len=H_SHORT) :: cell_measures_
665  integer :: dimid, iid
666  integer :: n
667  !---------------------------------------------------------------------------
668 
669  itemid = -1
670  if ( file_history_nreqs == 0 ) return
671 
672  itemid = file_history_find_id( name )
673  if ( itemid > 0 ) return ! already registered
674 
675  call prof_rapstart('FILE_HISTORY_OUT', 2)
676 
677  if ( len_trim(name) >= h_short ) then
678  log_error("FILE_HISTORY_reg",'(1x,A,I2,A,A)') 'Length of history name should be <= ', h_short-1 ,' chars. name=', trim(name)
679  call prc_abort
680  endif
681 
682  ! standard_name
683  if ( present(standard_name) ) then
684  standard_name_ = standard_name
685  else
686  standard_name_ = ""
687  end if
688 
689  ! get dimension id
690  if ( file_history_ndims < 1 ) then
691  log_error("FILE_HISTORY_reg",*) 'at least one dim_type must be registerd with FILE_HISTORY_set_dim. name=', trim(name)
692  call prc_abort
693  end if
694  if ( present(dim_type) ) then
695  dimid = -1
696  do n = 1, file_history_ndims
697  if ( file_history_dims(n)%name == dim_type ) then
698  dimid = n
699  exit
700  end if
701  end do
702  if ( dimid == -1 ) then
703  log_error("FILE_HISTORY_reg",*) 'dim_type must be registerd with FILE_HISTORY_set_dim: ', trim(dim_type) ,' name=', trim(name)
704  call prc_abort
705  end if
706  else if ( present(ndims) ) then
707  do n = 1, file_history_ndims
708  if ( file_history_dims(n)%ndims == ndims ) then
709  dimid = n
710  exit
711  end if
712  end do
713  if ( dimid == -1 ) then
714  log_error("FILE_HISTORY_reg",'(a,i1,a)') 'dim_type of ', ndims, 'D must be registerd with FILE_HISTORY_set_dim. name=', trim(name)
715  call prc_abort
716  end if
717  else
718  ! ndims = 3 is assumed as default
719  do n = 1, file_history_ndims
720  if ( file_history_dims(n)%ndims == 3 ) then
721  dimid = n
722  exit
723  end if
724  end do
725  if ( dimid == -1 ) then
726  log_error("FILE_HISTORY_reg",'(a,i1,a)') 'dim_type or ndims must be specified. name=', trim(name)
727  call prc_abort
728  end if
729  end if
730 
731  if ( present(cell_measures) ) then
732  select case ( cell_measures )
733  case ( "area" )
734  if ( file_history_dims(dimid)%area == "" ) then
735  log_error("FILE_HISTORY_reg",*) 'area is not supported for cell_measures. name=', trim(name)
736  call prc_abort
737  end if
738  case ( "area_z" )
739  if ( file_history_dims(dimid)%area == "" ) then
740  log_error("FILE_HISTORY_reg",*) 'area_z is not supported for cell_measures. name=', trim(name)
741  call prc_abort
742  end if
743  case ( "area_x" )
744  if ( file_history_dims(dimid)%area_x == "" ) then
745  log_error("FILE_HISTORY_reg",*) 'area_x is not supported for cell_measures. name=', trim(name)
746  call prc_abort
747  end if
748  case ( "area_y" )
749  if ( file_history_dims(dimid)%area_y == "" ) then
750  log_error("FILE_HISTORY_reg",*) 'area_y is not supported for cell_measures. name=', trim(name)
751  call prc_abort
752  end if
753  case ( "volume" )
754  if ( file_history_dims(dimid)%volume == "" ) then
755  log_error("FILE_HISTORY_reg",*) 'volume is not supported for cell_measures. name=', trim(name)
756  call prc_abort
757  end if
758  case default
759  log_error("FILE_HISTORY_reg",*) 'cell_measures must be "area" or "volume". name=', trim(name)
760  call prc_abort
761  end select
762  cell_measures_ = cell_measures
763  else if ( file_history_dims(dimid)%ndims == 2 ) then
764  cell_measures_ = "area"
765  else if ( file_history_dims(dimid)%ndims == 3 ) then
766  cell_measures_ = "volume"
767  else
768  cell_measures_ = ""
769  end if
770 
771  if ( file_history_dims(dimid)%nzcoords > 1 ) then
772 
773  itemid = -1
774  do n = 1, file_history_dims(dimid)%nzcoords
775  if ( file_history_dims(dimid)%zcoords(n) == "model" ) then
776  call file_history_add_variable( name, desc, unit, standard_name_, & ! (in)
777  dimid, & ! (in)
778  file_history_dims(dimid)%zcoords(n), & ! (in)
779  iid, & ! (out)
780  cell_measures = cell_measures_, & ! (in)
781  fill_halo = fill_halo ) ! (in)
782  else
783  call file_history_add_variable( name, desc, unit, standard_name_, & ! (in)
784  dimid, & ! (in)
785  file_history_dims(dimid)%zcoords(n), & ! (in)
786  iid, & ! (out)
787  fill_halo = fill_halo ) ! (in)
788  end if
789  if ( iid > 0 ) itemid = iid
790  end do
791 
792  else
793 
794  call file_history_add_variable( name, desc, unit, standard_name_, & ! (in)
795  dimid, & ! (in)
796  "model", & ! (in)
797  itemid, & ! (out)
798  cell_measures = cell_measures_, & ! (in)
799  fill_halo = fill_halo ) ! (in)
800 
801  end if
802 
803  call prof_rapend('FILE_HISTORY_OUT', 2)
804 
805  return
scale_prc::prc_abort
subroutine, public prc_abort
Abort Process.
Definition: scale_prc.F90:338
scale_io::h_short
integer, parameter, public h_short
Character length (short=16)
Definition: scale_io.F90:43
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]varvalue
[in]namename of the item
[in]descdescription of the item
[in]unitunit of the item

Definition at line 891 of file scale_file_history.F90.

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().

891  implicit none
892 
893  real(RP), intent(in) :: var
894  character(len=*), intent(in) :: name
895  character(len=*), intent(in) :: desc
896  character(len=*), intent(in) :: unit
897 
898  character(len=*), intent(in), optional :: standard_name
899  character(len=*), intent(in), optional :: dim_type
900 
901  logical, parameter :: fill_halo = .false.
902 
903  integer, parameter :: ndim = 0
904  integer :: itemid
905  logical :: do_put
906  !---------------------------------------------------------------------------
907 
908  if ( file_history_disabled ) return
909 
910  ! Check whether the item has been already registered
911  call file_history_reg( name, desc, unit, & ! [IN]
912  itemid, & ! [OUT]
913  standard_name=standard_name, & ! [IN]
914  ndims=ndim, & ! [IN]
915  dim_type=dim_type, & ! [IN]
916  fill_halo=fill_halo ) ! [IN]
917 
918  if ( itemid < 0 ) return
919 
920  ! Check whether it is time to input the item
921  call file_history_query( itemid, do_put ) ! [IN], [OUT]
922 
923  if ( do_put ) call file_history_put( itemid, var )
924 
925  return
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]varvalue
[in]namename of the item
[in]descdescription of the item
[in]unitunit of the item

Definition at line 1023 of file scale_file_history.F90.

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().

1023  implicit none
1024 
1025  real(RP), intent(in) :: var(:)
1026  character(len=*), intent(in) :: name
1027  character(len=*), intent(in) :: desc
1028  character(len=*), intent(in) :: unit
1029 
1030  character(len=*), intent(in), optional :: standard_name
1031  character(len=*), intent(in), optional :: dim_type
1032 
1033  logical, parameter :: fill_halo = .false.
1034 
1035  integer, parameter :: ndim = 1
1036  integer :: itemid
1037  logical :: do_put
1038  !---------------------------------------------------------------------------
1039 
1040  if ( file_history_disabled ) return
1041 
1042  ! Check whether the item has been already registered
1043  call file_history_reg( name, desc, unit, & ! [IN]
1044  itemid, & ! [OUT]
1045  standard_name=standard_name, & ! [IN]
1046  ndims=ndim, & ! [IN]
1047  dim_type=dim_type, & ! [IN]
1048  fill_halo=fill_halo ) ! [IN]
1049 
1050  if ( itemid < 0 ) return
1051 
1052  ! Check whether it is time to input the item
1053  call file_history_query( itemid, do_put ) ! [IN], [OUT]
1054 
1055  if ( do_put ) call file_history_put( itemid, var(:) )
1056 
1057  return
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]varvalue
[in]namename of the item
[in]descdescription of the item
[in]unitunit of the item

Definition at line 1156 of file scale_file_history.F90.

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().

1156  implicit none
1157 
1158  real(RP), intent(in) :: var(:,:)
1159  character(len=*), intent(in) :: name
1160  character(len=*), intent(in) :: desc
1161  character(len=*), intent(in) :: unit
1162 
1163  character(len=*), intent(in), optional :: standard_name
1164  character(len=*), intent(in), optional :: dim_type
1165  logical, intent(in), optional :: fill_halo
1166 
1167  integer, parameter :: ndim = 2
1168  integer :: itemid
1169  logical :: do_put
1170  !---------------------------------------------------------------------------
1171 
1172  if ( file_history_disabled ) return
1173 
1174  ! Check whether the item has been already registered
1175  call file_history_reg( name, desc, unit, & ! [IN]
1176  itemid, & ! [OUT]
1177  standard_name=standard_name, & ! [IN]
1178  ndims=ndim, & ! [IN]
1179  dim_type=dim_type, & ! [IN]
1180  fill_halo=fill_halo ) ! [IN]
1181 
1182  if ( itemid < 0 ) return
1183 
1184  ! Check whether it is time to input the item
1185  call file_history_query( itemid, do_put ) ! [IN], [OUT]
1186 
1187  if ( do_put ) call file_history_put( itemid, var(:,:) )
1188 
1189  return
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]varvalue
[in]namename of the item
[in]descdescription of the item
[in]unitunit of the item

Definition at line 1288 of file scale_file_history.F90.

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().

1288  implicit none
1289 
1290  real(RP), intent(in) :: var(:,:,:)
1291  character(len=*), intent(in) :: name
1292  character(len=*), intent(in) :: desc
1293  character(len=*), intent(in) :: unit
1294 
1295  character(len=*), intent(in), optional :: standard_name
1296  character(len=*), intent(in), optional :: dim_type
1297  logical, intent(in), optional :: fill_halo
1298 
1299  integer, parameter :: ndim = 3
1300  integer :: itemid
1301  logical :: do_put
1302  !---------------------------------------------------------------------------
1303 
1304  if ( file_history_disabled ) return
1305 
1306  ! Check whether the item has been already registered
1307  call file_history_reg( name, desc, unit, & ! [IN]
1308  itemid, & ! [OUT]
1309  standard_name=standard_name, & ! [IN]
1310  ndims=ndim, & ! [IN]
1311  dim_type=dim_type, & ! [IN]
1312  fill_halo=fill_halo ) ! [IN]
1313 
1314  if ( itemid < 0 ) return
1315 
1316  ! Check whether it is time to input the item
1317  call file_history_query( itemid, do_put ) ! [IN], [OUT]
1318 
1319  if ( do_put ) call file_history_put( itemid, var(:,:,:) )
1320 
1321  return
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]varvalue
[in]namename of the item
[in]descdescription of the item
[in]unitunit of the item

Definition at line 1420 of file scale_file_history.F90.

References file_history_reg().

1420  implicit none
1421 
1422  real(RP), intent(in) :: var(:,:,:,:)
1423  character(len=*), intent(in) :: name
1424  character(len=*), intent(in) :: desc
1425  character(len=*), intent(in) :: unit
1426 
1427  character(len=*), intent(in), optional :: standard_name
1428  character(len=*), intent(in), optional :: dim_type
1429  logical, intent(in), optional :: fill_halo
1430 
1431  integer, parameter :: ndim = 4
1432  integer :: itemid
1433  logical :: do_put
1434  !---------------------------------------------------------------------------
1435 
1436  if ( file_history_disabled ) return
1437 
1438  ! Check whether the item has been already registered
1439  call file_history_reg( name, desc, unit, & ! [IN]
1440  itemid, & ! [OUT]
1441  standard_name=standard_name, & ! [IN]
1442  ndims=ndim, & ! [IN]
1443  dim_type=dim_type, & ! [IN]
1444  fill_halo=fill_halo ) ! [IN]
1445 
1446  if ( itemid < 0 ) return
1447 
1448  ! Check whether it is time to input the item
1449  call file_history_query( itemid, do_put ) ! [IN], [OUT]
1450 
1451  if ( do_put ) call file_history_put( itemid, var(:,:,:,:) )
1452 
1453  return
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 1469 of file scale_file_history.F90.

References scale_prc::prc_abort().

Referenced by scale_file_history_cartesc::file_history_cartesc_set_pres().

1469  implicit none
1470 
1471  character(len=*), intent(in) :: name
1472  integer, intent(in) :: ndims
1473  integer, intent(in) :: nzcoords
1474  character(len=*), intent(in) :: dims(ndims,nzcoords)
1475  character(len=*), intent(in) :: zcoords(nzcoords)
1476  integer, intent(in) :: start(ndims,nzcoords)
1477  integer, intent(in) :: count(ndims,nzcoords)
1478 
1479  character(len=*), intent(in), optional :: mapping
1480  character(len=*), intent(in), optional :: area
1481  character(len=*), intent(in), optional :: area_x
1482  character(len=*), intent(in), optional :: area_y
1483  character(len=*), intent(in), optional :: volume
1484  character(len=*), intent(in), optional :: location
1485  character(len=*), intent(in), optional :: grid
1486 
1487  integer :: id
1488  integer :: size, n, m
1489 
1490  if ( file_history_ndims >= file_history_dim_max ) then
1491  log_error("FILE_HISTORY_Set_Dim",*) 'number of dimension exceed max limit: ', file_history_dim_max
1492  call prc_abort
1493  end if
1494  file_history_ndims = file_history_ndims + 1
1495  id = file_history_ndims
1496 
1497  allocate( file_history_dims(id)%dims(ndims,nzcoords) )
1498  allocate( file_history_dims(id)%start(ndims,nzcoords) )
1499  allocate( file_history_dims(id)%count(ndims,nzcoords) )
1500  allocate( file_history_dims(id)%zcoords(nzcoords) )
1501  allocate( file_history_dims(id)%size(nzcoords) )
1502 
1503  file_history_dims(id)%name = name
1504  file_history_dims(id)%ndims = ndims
1505  file_history_dims(id)%dims(:,:) = dims(:,:)
1506  file_history_dims(id)%nzcoords = nzcoords
1507  file_history_dims(id)%zcoords(:) = zcoords(:)
1508  file_history_dims(id)%start(:,:) = start(:,:)
1509  file_history_dims(id)%count(:,:) = count(:,:)
1510 
1511  do m = 1, nzcoords
1512  size = 1
1513  do n = 1, ndims
1514  size = size * count(n,m)
1515  end do
1516  file_history_dims(id)%size(m) = size
1517  end do
1518 
1519  if ( present(mapping) ) then
1520  file_history_dims(id)%mapping = mapping
1521  else
1522  file_history_dims(id)%mapping = ""
1523  end if
1524 
1525  if ( present(area) ) then
1526  file_history_dims(id)%area = area
1527  else
1528  file_history_dims(id)%area = ""
1529  end if
1530  if ( present(area_x) ) then
1531  file_history_dims(id)%area_x = area_x
1532  else
1533  file_history_dims(id)%area_x = ""
1534  end if
1535  if ( present(area_y) ) then
1536  file_history_dims(id)%area_y = area_y
1537  else
1538  file_history_dims(id)%area_y = ""
1539  end if
1540  if ( present(volume) ) then
1541  file_history_dims(id)%volume = volume
1542  else
1543  file_history_dims(id)%volume = ""
1544  end if
1545 
1546  if ( present(location) ) then
1547  file_history_dims(id)%location = location
1548  if ( present(grid) ) then
1549  file_history_dims(id)%grid = "grid_"//trim(grid)
1550  else
1551  file_history_dims(id)%grid = "grid"
1552  end if
1553  else
1554  file_history_dims(id)%location = ""
1555  file_history_dims(id)%grid = ""
1556  end if
1557 
1558  return
scale_prc::prc_abort
subroutine, public prc_abort
Abort Process.
Definition: scale_prc.F90:338
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 1572 of file scale_file_history.F90.

References scale_prc::prc_abort().

Referenced by scale_file_history_cartesc::file_history_cartesc_truncate_3d().

1572  implicit none
1573 
1574  character(len=*), intent(in) :: name
1575  character(len=*), intent(in) :: desc
1576  character(len=*), intent(in) :: units
1577  character(len=*), intent(in) :: dim
1578  real(RP), intent(in) :: var(:)
1579 
1580  real(RP), intent(in), optional :: bounds(:,:)
1581  logical, intent(in), optional :: down
1582  integer, intent(in), optional :: gsize ! global dim size
1583  integer, intent(in), optional :: start ! global subarray start indices
1584 
1585  integer :: dim_size
1586  integer :: id
1587 
1588  intrinsic size
1589  !---------------------------------------------------------------------------
1590 
1591  dim_size = size(var)
1592 
1593  if ( file_history_naxes >= file_history_axis_max ) then
1594  log_error("FILE_HISTORY_Set_Axis",*) 'Number of axis exceeds the limit.'
1595  call prc_abort
1596  endif
1597 
1598  file_history_naxes = file_history_naxes + 1
1599  id = file_history_naxes
1600 
1601  allocate( file_history_axes(id)%var(dim_size) )
1602 
1603  file_history_axes(id)%name = name
1604  file_history_axes(id)%desc = desc
1605  file_history_axes(id)%units = units
1606  file_history_axes(id)%dim = dim
1607  file_history_axes(id)%dim_size = dim_size
1608  file_history_axes(id)%var(:) = var(:)
1609 
1610  if ( present(down) ) then
1611  file_history_axes(id)%down = down
1612  else
1613  file_history_axes(id)%down = .false.
1614  endif
1615  if ( present(gsize) ) then ! global dimension size
1616  file_history_axes(id)%gdim_size = gsize
1617  else
1618  file_history_axes(id)%gdim_size = -1
1619  end if
1620  if ( present(start) ) then ! global subarray starting indices
1621  file_history_axes(id)%start = start
1622  else
1623  file_history_axes(id)%start = 1
1624  end if
1625 
1626  if ( present(bounds) ) then
1627  allocate( file_history_axes(id)%bounds(2,dim_size) )
1628  file_history_axes(id)%bounds(:,:) = bounds(:,:)
1629  end if
1630 
1631  return
scale_prc::prc_abort
subroutine, public prc_abort
Abort Process.
Definition: scale_prc.F90:338
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 1636 of file scale_file_history.F90.

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().

1636  use scale_file, only: &
1637  file_enddef, &
1638  file_flush
1639  implicit none
1640 
1641  integer :: fid, prev_fid
1642  integer :: id
1643  !---------------------------------------------------------------------------
1644 
1645  if ( file_history_disabled ) return
1646 
1647  call prof_rapstart('FILE_HISTORY_OUT', 2)
1648 
1649  ! Write registered history variables to history file
1650  do id = 1, file_history_nitems
1651  call file_history_write_onevar( id, file_history_nowstep ) ! [IN]
1652  enddo
1653 
1654  ! when using PnetCDF, the above FILE_HISTORY_Write() only posts write requests
1655  ! Now we need to commit the requests to the file
1656  prev_fid = -1
1657  do id = 1, file_history_nitems
1658  fid = file_history_vars(id)%fid
1659  if ( fid > 0 .AND. fid /= prev_fid ) then
1660  call file_flush( fid )
1661  prev_fid = fid
1662  endif
1663  enddo
1664 
1665  ! check time to switching output file
1666  if ( file_history_output_switch_step >= 0 &
1667  .AND. file_history_nowstep-file_history_output_switch_laststep > file_history_output_switch_step ) then
1668 
1669  call file_history_close
1670 
1671  log_info("FILE_HISTORY_Write",*) 'FILE_HISTORY file is switched.'
1672 
1673  do id = 1, file_history_nitems
1674  file_history_vars(id)%fid = -1 ! reset
1675  file_history_vars(id)%vid = -1 ! reset
1676  enddo
1677 
1678  file_history_output_switch_laststep = file_history_nowstep - 1
1679  endif
1680 
1681  call prof_rapend('FILE_HISTORY_OUT', 2)
1682 
1683  return
scale_file::file_flush
subroutine, public file_flush(fid)
Definition: scale_file.F90:4482
scale_file
module file
Definition: scale_file.F90:15
scale_file::file_enddef
subroutine, public file_enddef(fid)
Definition: scale_file.F90:4393
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)  NOWMS,
integer, intent(in)  NOWSTEP 
)

set now step

Definition at line 1690 of file scale_file_history.F90.

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

1690  integer, intent(in) :: nowdate(:)
1691  real(DP), intent(in) :: nowms
1692  integer, intent(in) :: nowstep
1693 
1694  file_history_nowdate(:) = nowdate(:)
1695  file_history_nowms = nowms
1696  file_history_nowstep = nowstep
1697 
1698  return
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 1705 of file scale_file_history.F90.

1705  implicit none
1706 
1707  logical, intent(in) :: switch
1708  !---------------------------------------------------------------------------
1709 
1710  file_history_disabled = switch
1711 
1712  return

◆ file_history_finalize()

subroutine, public scale_file_history::file_history_finalize ( )

finalization

Definition at line 1719 of file scale_file_history.F90.

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, file_history_aggregate, scale_file_h::file_real4, scale_file_h::file_real8, scale_file::file_set_option(), scale_prc::prc_abort(), scale_precision::rp, and scale_time::time_time2label().

Referenced by mod_rm_driver::rm_driver().

1719 
1720  call file_history_close
1721 
1722  return
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 2183 of file scale_file_history.F90.

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

2183  use scale_file_h, only: &
2184  file_real4, &
2185  file_real8
2186  implicit none
2187 
2188  character(len=*), intent(in) :: name
2189  character(len=*), intent(in) :: desc
2190  character(len=*), intent(in) :: units
2191  character(len=*), intent(in) :: dims(:)
2192  real(RP), intent(in) :: var(:)
2193  character(len=*), intent(in), optional :: datatype
2194  integer, intent(in), optional :: start(:)
2195 
2196  integer :: dtype
2197  integer :: dim_size
2198  integer :: id
2199 
2200  intrinsic size, shape, reshape
2201  !---------------------------------------------------------------------------
2202 
2203  if ( present(datatype) ) then
2204  if ( datatype == 'REAL4' ) then
2205  dtype = file_real4
2206  elseif( datatype == 'REAL8' ) then
2207  dtype = file_real8
2208  else
2209  log_error("FILE_HISTORY_Set_AssociatedCoordinate_1D",*) 'Not appropriate datatype. Check!', datatype
2210  call prc_abort
2211  endif
2212  else if ( rp == sp ) then
2213  dtype = file_real4
2214  else
2215  dtype = file_real8
2216  endif
2217 
2218  dim_size = size(var)
2219 
2220  if ( file_history_nassocs < file_history_assoc_max ) then
2221  file_history_nassocs = file_history_nassocs + 1
2222  id = file_history_nassocs
2223 
2224  allocate( file_history_assocs(id)%var(dim_size) )
2225 
2226  file_history_assocs(id)%name = name
2227  file_history_assocs(id)%desc = desc
2228  file_history_assocs(id)%units = units
2229  file_history_assocs(id)%ndims = 1
2230  file_history_assocs(id)%dims(:) = ''
2231  file_history_assocs(id)%dims(1:1) = dims(1:1)
2232  file_history_assocs(id)%dtype = dtype
2233  file_history_assocs(id)%var(:) = real(reshape( var, (/ dim_size /) ),kind=dp)
2234 
2235  ! start and count are used for parallel I/O to a single shared file
2236  ! since var is reshaped into 1D array, we need to preserve its original shape in count
2237  file_history_assocs(id)%count(1:1) = shape(var)
2238  if ( present(start) ) then
2239  file_history_assocs(id)%start(1:1) = start(1:1)
2240  else
2241  file_history_assocs(id)%start = (/ 1, 1, 1, 1 /)
2242  end if
2243  else
2244  log_error("FILE_HISTORY_Set_AssociatedCoordinate_1D",*) 'Number of associate coordinates exceeds the limit.'
2245  call prc_abort
2246  endif
2247 
2248  return
scale_file_h::file_real4
integer, parameter, public file_real4
Definition: scale_file_h.F90:24
scale_file_h::file_real8
integer, parameter, public file_real8
Definition: scale_file_h.F90:25
scale_prc::prc_abort
subroutine, public prc_abort
Abort Process.
Definition: scale_prc.F90:338
scale_precision::sp
integer, parameter, public sp
Definition: scale_precision.F90:31
scale_precision::rp
integer, parameter, public rp
Definition: scale_precision.F90:41
scale_precision::dp
integer, parameter, public dp
Definition: scale_precision.F90:32
scale_file_h
module file_h
Definition: scale_file_h.F90:11
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 2260 of file scale_file_history.F90.

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

2260  use scale_file_h, only: &
2261  file_real4, &
2262  file_real8
2263  implicit none
2264 
2265  character(len=*), intent(in) :: name
2266  character(len=*), intent(in) :: desc
2267  character(len=*), intent(in) :: units
2268  character(len=*), intent(in) :: dims(:)
2269  real(RP), intent(in) :: var(:,:)
2270  character(len=*), intent(in), optional :: datatype
2271  integer, intent(in), optional :: start(:)
2272 
2273  integer :: dtype
2274  integer :: dim_size
2275  integer :: id
2276 
2277  intrinsic size, shape, reshape
2278  !---------------------------------------------------------------------------
2279 
2280  if ( present(datatype) ) then
2281  if ( datatype == 'REAL4' ) then
2282  dtype = file_real4
2283  elseif( datatype == 'REAL8' ) then
2284  dtype = file_real8
2285  else
2286  log_error("FILE_HISTORY_Set_AssociatedCoordinate_2D",*) 'Not appropriate datatype. Check!', datatype
2287  call prc_abort
2288  endif
2289  else if ( rp == sp ) then
2290  dtype = file_real4
2291  else
2292  dtype = file_real8
2293  endif
2294 
2295  dim_size = size(var)
2296 
2297  if ( file_history_nassocs < file_history_assoc_max ) then
2298  file_history_nassocs = file_history_nassocs + 1
2299  id = file_history_nassocs
2300 
2301  allocate( file_history_assocs(id)%var(dim_size) )
2302 
2303  file_history_assocs(id)%name = name
2304  file_history_assocs(id)%desc = desc
2305  file_history_assocs(id)%units = units
2306  file_history_assocs(id)%ndims = 2
2307  file_history_assocs(id)%dims(:) = ''
2308  file_history_assocs(id)%dims(1:2) = dims(1:2)
2309  file_history_assocs(id)%dtype = dtype
2310  file_history_assocs(id)%var(:) = real(reshape( var, (/ dim_size /) ),kind=dp)
2311 
2312  ! start and count are used for parallel I/O to a single shared file
2313  ! since var is reshaped into 1D array, we need to preserve its original shape in count
2314  file_history_assocs(id)%count(1:2) = shape(var)
2315  if ( present(start) ) then
2316  file_history_assocs(id)%start(1:2) = start(1:2)
2317  else
2318  file_history_assocs(id)%start = (/ 1, 1, 1, 1 /)
2319  end if
2320  else
2321  log_error("FILE_HISTORY_Set_AssociatedCoordinate_2D",*) 'Number of associate coordinates exceeds the limit.'
2322  call prc_abort
2323  endif
2324 
2325  return
scale_file_h::file_real4
integer, parameter, public file_real4
Definition: scale_file_h.F90:24
scale_file_h::file_real8
integer, parameter, public file_real8
Definition: scale_file_h.F90:25
scale_prc::prc_abort
subroutine, public prc_abort
Abort Process.
Definition: scale_prc.F90:338
scale_precision::sp
integer, parameter, public sp
Definition: scale_precision.F90:31
scale_precision::rp
integer, parameter, public rp
Definition: scale_precision.F90:41
scale_precision::dp
integer, parameter, public dp
Definition: scale_precision.F90:32
scale_file_h
module file_h
Definition: scale_file_h.F90:11
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 2337 of file scale_file_history.F90.

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

2337  use scale_file_h, only: &
2338  file_real4, &
2339  file_real8
2340  implicit none
2341 
2342  character(len=*), intent(in) :: name
2343  character(len=*), intent(in) :: desc
2344  character(len=*), intent(in) :: units
2345  character(len=*), intent(in) :: dims(:)
2346  real(RP), intent(in) :: var(:,:,:)
2347  character(len=*), intent(in), optional :: datatype
2348  integer, intent(in), optional :: start(:)
2349 
2350  integer :: dtype
2351  integer :: dim_size
2352  integer :: id
2353 
2354  intrinsic size, shape, reshape
2355  !---------------------------------------------------------------------------
2356 
2357  if ( present(datatype) ) then
2358  if ( datatype == 'REAL4' ) then
2359  dtype = file_real4
2360  elseif( datatype == 'REAL8' ) then
2361  dtype = file_real8
2362  else
2363  log_error("FILE_HISTORY_Set_AssociatedCoordinate_3D",*) 'Not appropriate datatype. Check!', datatype
2364  call prc_abort
2365  endif
2366  else if ( rp == sp ) then
2367  dtype = file_real4
2368  else
2369  dtype = file_real8
2370  endif
2371 
2372  dim_size = size(var)
2373 
2374  if ( file_history_nassocs < file_history_assoc_max ) then
2375  file_history_nassocs = file_history_nassocs + 1
2376  id = file_history_nassocs
2377 
2378  allocate( file_history_assocs(id)%var(dim_size) )
2379 
2380  file_history_assocs(id)%name = name
2381  file_history_assocs(id)%desc = desc
2382  file_history_assocs(id)%units = units
2383  file_history_assocs(id)%ndims = 3
2384  file_history_assocs(id)%dims(:) = ''
2385  file_history_assocs(id)%dims(1:3) = dims(1:3)
2386  file_history_assocs(id)%dtype = dtype
2387  file_history_assocs(id)%var(:) = real(reshape( var, (/ dim_size /) ),kind=dp)
2388 
2389  ! start and count are used for parallel I/O to a single shared file
2390  ! since var is reshaped into 1D array, we need to preserve its original shape in count
2391  file_history_assocs(id)%count(1:3) = shape(var)
2392  if ( present(start) ) then
2393  file_history_assocs(id)%start(1:3) = start(1:3)
2394  else
2395  file_history_assocs(id)%start = (/ 1, 1, 1, 1 /)
2396  end if
2397  else
2398  log_error("FILE_HISTORY_Set_AssociatedCoordinate_3D",*) 'Number of associate coordinates exceeds the limit.'
2399  call prc_abort
2400  endif
2401 
2402  return
scale_file_h::file_real4
integer, parameter, public file_real4
Definition: scale_file_h.F90:24
scale_file_h::file_real8
integer, parameter, public file_real8
Definition: scale_file_h.F90:25
scale_prc::prc_abort
subroutine, public prc_abort
Abort Process.
Definition: scale_prc.F90:338
scale_precision::sp
integer, parameter, public sp
Definition: scale_precision.F90:31
scale_precision::rp
integer, parameter, public rp
Definition: scale_precision.F90:41
scale_precision::dp
integer, parameter, public dp
Definition: scale_precision.F90:32
scale_file_h
module file_h
Definition: scale_file_h.F90:11
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 2412 of file scale_file_history.F90.

References scale_prc::prc_abort().

Referenced by file_history_set_attribute_logical().

2412  use scale_prc, only: &
2413  prc_abort
2414  use scale_file, only: &
2415  file_set_attribute
2416  implicit none
2417  character(len=*), intent(in) :: varname
2418  character(len=*), intent(in) :: key
2419  character(len=*), intent(in) :: val
2420  logical, intent(in), optional :: add_variable
2421 
2422  integer :: id
2423  !---------------------------------------------------------------------------
2424 
2425  file_history_nattrs = file_history_nattrs + 1
2426  if ( file_history_nattrs > file_history_attr_max ) then
2427  log_error("FILE_HISTORY_Set_Attribute_Text",*) 'number of attributes exceeds the limit'
2428  call prc_abort
2429  end if
2430 
2431  id = file_history_nattrs
2432 
2433  file_history_attrs(id)%varname = varname
2434  file_history_attrs(id)%key = key
2435  file_history_attrs(id)%text = val
2436  file_history_attrs(id)%type = i_text
2437 
2438  if ( present(add_variable) ) then
2439  file_history_attrs(id)%add_variable = add_variable
2440  else
2441  file_history_attrs(id)%add_variable = .false.
2442  end if
2443 
2444  return
scale_file
module file
Definition: scale_file.F90:15
scale_prc
module PROCESS
Definition: scale_prc.F90:11
scale_prc::prc_abort
subroutine, public prc_abort
Abort Process.
Definition: scale_prc.F90:338
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 2451 of file scale_file_history.F90.

References file_history_set_attribute_text().

2451  use scale_file, only: &
2452  file_set_attribute
2453  implicit none
2454  character(len=*), intent(in) :: varname
2455  character(len=*), intent(in) :: key
2456  logical, intent(in) :: val
2457  logical, intent(in), optional :: add_variable
2458 
2459  character(len=5) :: buf
2460  !---------------------------------------------------------------------------
2461 
2462  if ( val ) then
2463  buf = "true"
2464  else
2465  buf = "false"
2466  end if
2467 
2468  call file_history_set_attribute_text( varname, key, buf, add_variable=add_variable )
2469 
2470  return
scale_file
module file
Definition: scale_file.F90:15
Here is the call 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, dimension(:), intent(in)  val,
logical, intent(in), optional  add_variable 
)

Definition at line 2478 of file scale_file_history.F90.

References scale_prc::prc_abort().

2478  use scale_prc, only: &
2479  prc_abort
2480  use scale_file, only: &
2481  file_set_attribute
2482  implicit none
2483  character(len=*), intent(in) :: varname
2484  character(len=*), intent(in) :: key
2485  integer, intent(in) :: val(:)
2486  logical, intent(in), optional :: add_variable
2487 
2488  integer :: id
2489 
2490  intrinsic size
2491  !---------------------------------------------------------------------------
2492 
2493  file_history_nattrs = file_history_nattrs + 1
2494  if ( file_history_nattrs > file_history_attr_max ) then
2495  log_error("FILE_HISTORY_Set_Attribute_Int",*) 'number of attributes exceeds the limit'
2496  call prc_abort
2497  end if
2498 
2499  id = file_history_nattrs
2500 
2501  allocate( file_history_attrs(id)%int( size(val) ) )
2502 
2503  file_history_attrs(id)%varname = varname
2504  file_history_attrs(id)%key = key
2505  file_history_attrs(id)%int(:) = val(:)
2506  file_history_attrs(id)%type = i_int
2507 
2508  if ( present(add_variable) ) then
2509  file_history_attrs(id)%add_variable = add_variable
2510  else
2511  file_history_attrs(id)%add_variable = .false.
2512  end if
2513 
2514  return
scale_file
module file
Definition: scale_file.F90:15
scale_prc
module PROCESS
Definition: scale_prc.F90:11
scale_prc::prc_abort
subroutine, public prc_abort
Abort Process.
Definition: scale_prc.F90:338
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), dimension(:), intent(in)  val,
logical, intent(in), optional  add_variable 
)

Definition at line 2522 of file scale_file_history.F90.

References scale_prc::prc_abort().

2522  use scale_prc, only: &
2523  prc_abort
2524  use scale_file, only: &
2525  file_set_attribute
2526  implicit none
2527  character(len=*), intent(in) :: varname
2528  character(len=*), intent(in) :: key
2529  real(SP), intent(in) :: val(:)
2530  logical, intent(in), optional :: add_variable
2531 
2532  integer :: id
2533 
2534  intrinsic size
2535  !---------------------------------------------------------------------------
2536 
2537  file_history_nattrs = file_history_nattrs + 1
2538  if ( file_history_nattrs > file_history_attr_max ) then
2539  log_error("FILE_HISTORY_Set_Attribute_Float",*) 'number of attributes exceeds the limit'
2540  call prc_abort
2541  end if
2542 
2543  id = file_history_nattrs
2544 
2545  allocate( file_history_attrs(id)%float( size(val) ) )
2546 
2547  file_history_attrs(id)%varname = varname
2548  file_history_attrs(id)%key = key
2549  file_history_attrs(id)%float(:) = val(:)
2550  file_history_attrs(id)%type = i_float
2551 
2552  if ( present(add_variable) ) then
2553  file_history_attrs(id)%add_variable = add_variable
2554  else
2555  file_history_attrs(id)%add_variable = .false.
2556  end if
2557 
2558  return
scale_file
module file
Definition: scale_file.F90:15
scale_prc
module PROCESS
Definition: scale_prc.F90:11
scale_prc::prc_abort
subroutine, public prc_abort
Abort Process.
Definition: scale_prc.F90:338
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), dimension(:), intent(in)  val,
logical, intent(in), optional  add_variable 
)

Definition at line 2566 of file scale_file_history.F90.

References scale_prc::prc_abort().

2566  use scale_prc, only: &
2567  prc_abort
2568  use scale_file, only: &
2569  file_set_attribute
2570  implicit none
2571  character(len=*), intent(in) :: varname
2572  character(len=*), intent(in) :: key
2573  real(DP), intent(in) :: val(:)
2574  logical, intent(in), optional :: add_variable
2575 
2576  integer :: id
2577 
2578  intrinsic size
2579  !---------------------------------------------------------------------------
2580 
2581  file_history_nattrs = file_history_nattrs + 1
2582  if ( file_history_nattrs > file_history_attr_max ) then
2583  log_error("FILE_HISTORY_Set_Attribute_Double",*) 'number of attributes exceeds the limit'
2584  call prc_abort
2585  end if
2586 
2587  id = file_history_nattrs
2588 
2589  allocate( file_history_attrs(id)%double( size(val) ) )
2590 
2591  file_history_attrs(id)%varname = varname
2592  file_history_attrs(id)%key = key
2593  file_history_attrs(id)%double(:) = val(:)
2594  file_history_attrs(id)%type = i_double
2595 
2596  if ( present(add_variable) ) then
2597  file_history_attrs(id)%add_variable = add_variable
2598  else
2599  file_history_attrs(id)%add_variable = .false.
2600  end if
2601 
2602  return
scale_file
module file
Definition: scale_file.F90:15
scale_prc
module PROCESS
Definition: scale_prc.F90:11
scale_prc::prc_abort
subroutine, public prc_abort
Abort Process.
Definition: scale_prc.F90:338
Here is the call graph for this function:

◆ file_history_query_id()

subroutine scale_file_history::file_history_query_id ( integer, intent(in)  itemid,
logical, intent(out)  answer 
)

Definition at line 2612 of file scale_file_history.F90.

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

2612  integer, intent(in) :: itemid
2613  logical, intent(out) :: answer
2614 
2615  integer :: id, i
2616 
2617  answer = .false.
2618  if ( file_history_disabled ) return
2619  if ( itemid < 0 ) return
2620 
2621  do i = 1, file_history_var_inputs(itemid)%nvariants
2622  id = file_history_var_inputs(itemid)%variants(i)
2623  if ( file_history_vars(id)%taverage ) then
2624  answer = .true.
2625  return
2626  else if ( file_history_nowstep >= file_history_vars(id)%laststep_write + file_history_vars(id)%dstep ) then
2627  answer = .true.
2628  return
2629  endif
2630  end do
2631 
2632  return
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.

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

77  procedure(truncate_1d), pointer :: file_history_truncate_1d => null()

◆ 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.

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

89  procedure(truncate_2d), pointer :: file_history_truncate_2d => null()

◆ 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.

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

101  procedure(truncate_3d), pointer :: file_history_truncate_3d => null()

◆ 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.

Referenced by file_history_in_3d(), and file_history_setup().

113  procedure(truncate_4d), pointer :: file_history_truncate_4d => null()

◆ file_history_aggregate

logical, public scale_file_history::file_history_aggregate

Definition at line 140 of file scale_file_history.F90.

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

140  logical, public :: file_history_aggregate

◆ switch

integer public scale_file_history::switch

Definition at line 140 of file scale_file_history.F90.

◆ to

integer public scale_file_history::to

Definition at line 140 of file scale_file_history.F90.

◆ use

logical, public scale_file_history::use

Definition at line 140 of file scale_file_history.F90.

◆ aggregate

logical, public scale_file_history::aggregate

Definition at line 140 of file scale_file_history.F90.

Referenced by file_history_finalize().

◆ file

integer public scale_file_history::file

Definition at line 140 of file scale_file_history.F90.

◆ i

logical, public scale_file_history::i

Definition at line 140 of file scale_file_history.F90.

◆ o

logical, public scale_file_history::o

Definition at line 140 of file scale_file_history.F90.

Generated by   doxygen 1.8.13