gtool_history_nmlinfo_generic::hstnmlinfocreate Interface Reference

More...

Public Member Functions
subroutine	hstnmlinfocreate (gthstnml, interval_value, interval_unit, precision, time_average, average, fileprefix, origin_value, origin_unit, terminus_value, terminus_unit, slice_start, slice_end, slice_stride, space_average, newfile_intvalue, newfile_intunit, err)

Detailed Description

Interface of procedures provided from gtool_history_nmlinfo

See gtool_history_nmlinfo for brief of this module.

Procedures List

• HstNmlInfoCreate : Constructor of gtool_history_nmlinfo_types::GTHST_NMLINFO
• HstNmlInfoClose : Destructor of gtool_history_nmlinfo_types::GTHST_NMLINFO
• HstNmlInfoPutLine : Print information of gtool_history_nmlinfo_types::GTHST_NMLINFO
• HstNmlInfoInitialized : Check initialization of gtool_history_nmlinfo_types::GTHST_NMLINFO
• HstNmlInfoDefineMode : True is returned if current state is define mode
• HstNmlInfoEndDefine : Transit define mode about information of variables to output mode
• HstNmlInfoReDefine : Transit output mode to define mode about information of variables
• HstNmlInfoAdd : Add information of variables
• HstNmlInfoDelete : Delete information of variables
• HstNmlInfoResetDefault : Reset to default settings
• HstNmlInfoInquire : Inquire information of variables
• HstNmlInfoAssocGtHist : gtool_history_types::GT_HISTORY correspond to variable is returned
• HstNmlInfoOutputStepDisable : Configure that output_step returns .false. already
• HstNmlInfoOutputStep : True is returned when a configuration of output is valid
• HstNmlInfoOutputValid : True is returned when current time is output timing
• HstNmlInfoNames : Return list of registered variable identifiers (function)
• HstNmlInfoGetNames : Return list of registered variable identifiers (subroutine)
• HstNmlInfoAllVarIniCheck : Check uninitialized variable names
• HstNmlInfoSetValidName : Set validation to variable names
• HstNmlInfoAllNameValid : Check invalid variable names

Usage

Use this module as follows.

Sample Fortran programs generator (Ruby script) is available from http://www.gfd-dennou.org/library/dcpam/dcpam4/dcpam4_current/script/f90/dcmodel_f90sample_maker.rb . Sample Fortran programs are created by executing this script. It is recommended to see sample Fortran programs actually.

0. Declare gtool_history_nmlinfo_types::GTHST_NMLINFO variable in the module.

1. Initialize gtool_history_nmlinfo_types::GTHST_NMLINFO variable by HstNmlInfoCreate. On this occasion, configure default interval_value, interval_unit, precision, time_average, fileprefix (prefix of output file).
2. Register by using HstNmlInfoAdd when there are variables that the program outputs by default. Variable identifier is given to name. Do not specify same name for different variables because name is used as a key to identify the variable. The output file name is given to file. A suitable file name is set when not giving it.
3. Register information of output variables obtained from NAMELIST by using HstNmlInfoAdd. When registered name is registered again, the setting concerning the name has been overwritten.
4. Shift from the define mode to output mode by using HstNmlInfoEndDefine when registration is completed.

5. Pass HstNmlInfoAssocGtHist variable identifier name and history of gtool_history_types::GT_HISTORY pointer when setting output and data output is performed with gtool_history_generic::HistoryCreate, gtool_history_generic::HistoryAddVariable, gtool_history_generic::HistoryPut, etc. history is associated to gtool_history_types::GT_HISTORY correspond to name stored in gtool_history_nmlinfo_types::GTHST_NMLINFO variable. Necessary output interval and precision for gtool_history_generic::HistoryCreate can be obtained by using HstNmlInfoInquire. Please put history into a null state by NULLIFY after use. (Information of output is lost when DEALLOCATE is used, so do not use it).

   It can know whether the output setting is effective for each variable with HstNmlInfoOutputValid.

   Moreover, it can know whether current time is output timing when gtool_history_generic::HistoryPut is used while integrating time with HstNmlInfoOutputStep.

6. Acquire history of gtool_history_types::GT_HISTORY type as well as the above-mentioned procedure, and terminate that by gtool_history_generic::HistoryClose when the output of the file ends.
7. Finally, the termination of the variable of gtool_history_nmlinfo_types::GTHST_NMLINFO type is done by HstNmlInfoClose.

Definition at line 225 of file gtool_history_nmlinfo_generic.f90.

Constructor & Destructor Documentation

hstnmlinfocreate()

subroutine gtool_history_nmlinfo_generic::hstnmlinfocreate::hstnmlinfocreate	(	type(gthst_nmlinfo), intent(inout)	gthstnml,
		real(dp), intent(in), optional	interval_value,
		character(*), intent(in), optional	interval_unit,
		character(*), intent(in), optional	precision,
		logical, intent(in), optional	time_average,
		logical, intent(in), optional	average,
		character(*), intent(in), optional	fileprefix,
		real(dp), intent(in), optional	origin_value,
		character(*), intent(in), optional	origin_unit,
		real(dp), intent(in), optional	terminus_value,
		character(*), intent(in), optional	terminus_unit,
		integer, dimension(:), intent(in), optional	slice_start,
		integer, dimension(:), intent(in), optional	slice_end,
		integer, dimension(:), intent(in), optional	slice_stride,
		logical, dimension(:), intent(in), optional	space_average,
		integer, intent(in), optional	newfile_intvalue,
		character(*), intent(in), optional	newfile_intunit,
		logical, intent(out), optional	err
	)

Definition at line 226 of file gtool_history_nmlinfo_generic.f90.

      use gtool_history_nmlinfo_types, only: gthst_nmlinfo
      use dc_types, only: dp
      type(GTHST_NMLINFO), intent(inout):: gthstnml
      real(DP), intent(in), optional:: interval_value
      character(*), intent(in), optional:: interval_unit
      character(*), intent(in), optional:: precision
      logical, intent(in), optional:: time_average
      logical, intent(in), optional:: average
      character(*), intent(in), optional:: fileprefix
      real(DP), intent(in), optional:: origin_value
      character(*), intent(in), optional:: origin_unit
      real(DP), intent(in), optional:: terminus_value
      character(*), intent(in), optional:: terminus_unit
      integer, intent(in), optional:: slice_start(:)
      integer, intent(in), optional:: slice_end(:)
      integer, intent(in), optional:: slice_stride(:)
      logical, intent(in), optional:: space_average(:)
      integer, intent(in), optional:: newfile_intvalue
      character(*), intent(in), optional:: newfile_intunit
      logical, intent(out), optional:: err

References dc_types::dp.

---

The documentation for this interface was generated from the following file:

• gtool/gtool_history_nmlinfo/gtool_history_nmlinfo_generic.f90