scale_file_history_meshfield Module Reference

module FElib / File / History More...

Data Types
interface	file_history_meshfield_in
interface	file_history_meshfield_put

Functions/Subroutines
subroutine, public	file_history_meshfield_setup (mesh1d_, mesh2d_, mesh3d_, meshcubedsphere2d_, meshcubedsphere3d_, dim_name_postfix_, registered_comp_id)
	Setup a module for file history.
subroutine, public	file_history_meshfield_write ()
	Write history data to the file.
subroutine, public	file_history_meshfield_finalize ()
	Finalize the file history module.

Variables
integer, parameter	component_num_max = 32

Detailed Description

module FElib / File / History

Description

A module for managing file history

Author

Yuta Kawai, Team SCALE

Function/Subroutine Documentation

file_history_meshfield_setup()

subroutine, public scale_file_history_meshfield::file_history_meshfield_setup	(	class(meshbase1d), intent(in), optional, target	mesh1d_,
		class(meshrectdom2d), intent(in), optional, target	mesh2d_,
		class(meshcubedom3d), intent(in), optional, target	mesh3d_,
		class(meshcubedspheredom2d), intent(in), optional, target	meshcubedsphere2d_,
		class(meshcubedspheredom3d), intent(in), optional, target	meshcubedsphere3d_,
		character(len=*), intent(in), optional	dim_name_postfix_,
		integer, intent(out), optional	registered_comp_id )

Setup a module for file history.

Parameters

[in]	mesh1d_	An object of 1D mesh when the computational domain is 1D
[in]	mesh2d_	An object of 2D mesh when the computational domain is rectangular
[in]	mesh3d_	An object of 3D mesh when the computational domain is cubed
[in]	meshcubedsphere2d_	An object of 2D mesh when the computational domain is 2D cubed-sphere
[in]	meshcubedsphere3d_	An object of 3D mesh when the computational domain is 3D cubed-sphere
[in]	dim_name_postfix_	Postfix for dimension names

Definition at line 196 of file scale_file_history_meshfield.F90.

 
    use scale_file_h, only: &
      file_hshort
    use scale_prc, only: &
      prc_masterrank, &
      prc_myrank,     &
      prc_abort
    use scale_time, only: &
      time_nowdate,       &
      time_nowsubsec,     &
      time_startdaysec,   &
      time_dtsec,         &
      time_nowstep
    use scale_calendar, only: &
      calendar_get_name
    implicit none
 
    class(MeshBase1d), intent(in), target, optional :: mesh1D_     !< An object of 1D mesh when the computational domain is 1D
    class(MeshRectDom2d)       , intent(in), target, optional :: mesh2D_            !< An object of 2D mesh when the computational domain is rectangular
    class(MeshCubeDom3D)       , intent(in), target, optional :: mesh3D_            !< An object of 3D mesh when the computational domain is cubed
    class(MeshCubedSphereDom2D), intent(in), target, optional :: meshCubedsphere2D_ !< An object of 2D mesh when the computational domain is 2D cubed-sphere
    class(MeshCubedSphereDom3D), intent(in), target, optional :: meshCubedsphere3D_ !< An object of 3D mesh when the computational domain is 3D cubed-sphere
    character(len=*), intent(in), optional :: dim_name_postfix_    !< Postfix for dimension names
    integer, intent(out), optional :: registered_comp_id
 
    character(len=H_MID) :: FILE_HISTORY_MESHFILED_H_TITLE = 'SCALE-DG FILE_HISTORY_MESHFIELD' !< title of the output file
    character(len=H_MID) :: FILE_HISTORY_MESHFIELD_T_SINCE
    
    character(len=FILE_HSHORT) :: calendar
    real(DP) :: start_daysec
 
    type(FileHistoryMeshFieldComp), pointer :: target_comp
    integer :: registered_comp_id_
    !---------------------------------------------------------------------------
 
    !-
    if ( comp_num >= component_num_max ) then
      log_error("FILE_base_meshfield_register_comp",*) 'Exceeding maximum number of components. Check!'
      call prc_abort
    end if
 
    comp_num = comp_num + 1
    registered_comp_id_ = comp_num
    if ( present(registered_comp_id) ) then
      registered_comp_id = registered_comp_id_
    end if
 
    target_comp => comp(registered_comp_id_)
    call target_comp%Init( mesh1d_, mesh2d_, mesh3d_, &
      meshcubedsphere2d_, meshcubedsphere3d_ ,        &
      dim_name_postfix_ )
 
    !-
    if ( registered_comp_id_ == 1 ) then
      default_comp => comp(registered_comp_id_)
 
      file_history_meshfield_startdate(:) = time_nowdate
      file_history_meshfield_startsubsec  = time_nowsubsec
 
      start_daysec = time_startdaysec
      if ( time_nowdate(1) > 0 ) then
        write(file_history_meshfield_t_since,'(I4.4,5(A1,I2.2))') time_nowdate(1), &
                                                            '-', time_nowdate(2), &
                                                            '-', time_nowdate(3), &
                                                            ' ', time_nowdate(4), &
                                                            ':', time_nowdate(5), &
                                                            ':', time_nowdate(6)
        start_daysec = time_nowsubsec
      else
        file_history_meshfield_t_since = ''
      endif
 
      ! get calendar name
      call calendar_get_name( calendar )
 
      call file_history_setup( file_history_meshfiled_h_title,        & ! [IN]
        h_source, h_institute,                                        & ! [IN]
        start_daysec, time_dtsec,                                     & ! [IN]
        time_since = file_history_meshfield_t_since,                  & ! [IN]
        calendar = calendar,                                          & ! [IN]
        default_zcoord = 'model',                                     & ! [IN]
        myrank = prc_myrank                        )                    ! [IN]
 
      call file_history_set_nowdate( time_nowdate, time_nowsubsec, time_nowstep )
 
      file_history_filemeshfiled_disable = .false. 
    end if
 
    return

References component_num_max.

Referenced by mod_atmos_component::atmos_setup(), and mod_ocean_component::ocean_setup().

file_history_meshfield_write()

subroutine, public scale_file_history_meshfield::file_history_meshfield_write

Write history data to the file.

Definition at line 294 of file scale_file_history_meshfield.F90.

    implicit none
    !-------------------------------------------------
 
    call file_history_write
    return

Referenced by mod_dg_driver::dg_driver().

file_history_meshfield_finalize()

subroutine, public scale_file_history_meshfield::file_history_meshfield_finalize

Finalize the file history module.

Definition at line 304 of file scale_file_history_meshfield.F90.

    implicit none
    !-------------------------------------------------
 
    call file_history_finalize()
    call default_comp%Final()
    return

Referenced by mod_dg_driver::dg_driver(), and mod_dg_prep::dg_prep().

Variable Documentation

component_num_max

integer, parameter scale_file_history_meshfield::component_num_max = 32

Definition at line 82 of file scale_file_history_meshfield.F90.

  integer, parameter :: COMPONENT_NUM_MAX = 32

Referenced by file_history_meshfield_setup().