SCALE-RM
Functions/Subroutines | Variables
mod_atmos_phy_ch_vars Module Reference

module Atmosphere / Physics Chemistry More...

Functions/Subroutines

subroutine, public atmos_phy_ch_vars_setup
 Setup. More...
 
subroutine, public atmos_phy_ch_vars_fillhalo
 HALO Communication. More...
 
subroutine, public atmos_phy_ch_vars_restart_read
 Read restart. More...
 
subroutine, public atmos_phy_ch_vars_restart_write
 Write restart. More...
 

Variables

logical, public atmos_phy_ch_restart_output = .false.
 output restart file? More...
 
character(len=h_long), public atmos_phy_ch_restart_in_basename = ''
 basename of the restart file More...
 
character(len=h_long), public atmos_phy_ch_restart_out_basename = ''
 basename of the output file More...
 
character(len=h_mid), public atmos_phy_ch_restart_out_title = 'ATMOS_PHY_CH restart'
 title of the output file More...
 
character(len=h_mid), public atmos_phy_ch_restart_out_dtype = 'DEFAULT'
 REAL4 or REAL8. More...
 
real(rp), dimension(:,:,:,:), allocatable, public atmos_phy_ch_rhoq_t
 
real(rp), dimension(:,:,:), allocatable, public atmos_phy_ch_o3
 

Detailed Description

module Atmosphere / Physics Chemistry

Description
Container for mod_atmos_phy_ch
Author
Team SCALE
History
  • 2014-05-04 (H.Yashiro) [new]
NAMELIST
  • PARAM_ATMOS_PHY_CH_VARS
    nametypedefault valuecomment
    ATMOS_PHY_CH_RESTART_IN_BASENAME character(len=H_LONG) '' basename of the restart file
    ATMOS_PHY_CH_RESTART_OUTPUT logical .false. output restart file?
    ATMOS_PHY_CH_RESTART_OUT_BASENAME character(len=H_LONG) '' basename of the output file
    ATMOS_PHY_CH_RESTART_OUT_TITLE character(len=H_MID) 'ATMOS_PHY_CH restart' title of the output file
    ATMOS_PHY_CH_RESTART_OUT_DTYPE character(len=H_MID) 'DEFAULT' REAL4 or REAL8

History Output
No history output

Function/Subroutine Documentation

◆ atmos_phy_ch_vars_setup()

subroutine, public mod_atmos_phy_ch_vars::atmos_phy_ch_vars_setup ( )

Setup.

Definition at line 75 of file mod_atmos_phy_ch_vars.f90.

References atmos_phy_ch_o3, atmos_phy_ch_restart_in_basename, atmos_phy_ch_restart_out_basename, atmos_phy_ch_restart_out_dtype, atmos_phy_ch_restart_out_title, atmos_phy_ch_restart_output, atmos_phy_ch_rhoq_t, scale_const::const_undef, scale_grid_index::ia, scale_stdio::io_fid_conf, scale_stdio::io_fid_log, scale_stdio::io_l, scale_stdio::io_lnml, scale_grid_index::ja, scale_grid_index::ka, scale_process::prc_mpistop(), and scale_tracer::qa.

Referenced by mod_atmos_vars::atmos_vars_setup().

75  use scale_process, only: &
77  use scale_const, only: &
78  undef => const_undef
79  implicit none
80 
81  namelist / param_atmos_phy_ch_vars / &
82  atmos_phy_ch_restart_in_basename, &
83  atmos_phy_ch_restart_output, &
84  atmos_phy_ch_restart_out_basename, &
85  atmos_phy_ch_restart_out_title, &
86  atmos_phy_ch_restart_out_dtype
87 
88  integer :: ierr
89  integer :: iv
90  !---------------------------------------------------------------------------
91 
92  if( io_l ) write(io_fid_log,*)
93  if( io_l ) write(io_fid_log,*) '++++++ Module[VARS] / Categ[ATMOS PHY_CH] / Origin[SCALE-RM]'
94 
95  allocate( atmos_phy_ch_rhoq_t(ka,ia,ja,qa) )
96  atmos_phy_ch_rhoq_t(:,:,:,:) = undef
97 
98  allocate( atmos_phy_ch_o3(ka,ia,ja) )
99  atmos_phy_ch_o3(:,:,:) = undef
100 
101  !--- read namelist
102  rewind(io_fid_conf)
103  read(io_fid_conf,nml=param_atmos_phy_ch_vars,iostat=ierr)
104  if( ierr < 0 ) then !--- missing
105  if( io_l ) write(io_fid_log,*) '*** Not found namelist. Default used.'
106  elseif( ierr > 0 ) then !--- fatal error
107  write(*,*) 'xxx Not appropriate names in namelist PARAM_ATMOS_PHY_CH_VARS. Check!'
108  call prc_mpistop
109  endif
110  if( io_lnml ) write(io_fid_log,nml=param_atmos_phy_ch_vars)
111 
112  if( io_l ) write(io_fid_log,*)
113  if( io_l ) write(io_fid_log,*) '*** [ATMOS_PHY_CH] prognostic/diagnostic variables'
114  if( io_l ) write(io_fid_log,'(1x,A,A15,A,A32,3(A))') &
115  '*** |','VARNAME ','|', 'DESCRIPTION ','[', 'UNIT ',']'
116  do iv = 1, vmax
117  if( io_l ) write(io_fid_log,'(1x,A,i3,A,A15,A,A32,3(A))') &
118  '*** NO.',iv,'|',var_name(iv),'|',var_desc(iv),'[',var_unit(iv),']'
119  enddo
120 
121  if( io_l ) write(io_fid_log,*)
122  if ( atmos_phy_ch_restart_in_basename /= '' ) then
123  if( io_l ) write(io_fid_log,*) '*** Restart input? : ', trim(atmos_phy_ch_restart_in_basename)
124  else
125  if( io_l ) write(io_fid_log,*) '*** Restart input? : NO'
126  endif
127  if ( atmos_phy_ch_restart_output &
128  .AND. atmos_phy_ch_restart_out_basename /= '' ) then
129  if( io_l ) write(io_fid_log,*) '*** Restart output? : ', trim(atmos_phy_ch_restart_out_basename)
130  else
131  if( io_l ) write(io_fid_log,*) '*** Restart output? : NO'
132  atmos_phy_ch_restart_output = .false.
133  endif
134 
135  return
subroutine, public prc_mpistop
Abort MPI.
logical, public io_l
output log or not? (this process)
Definition: scale_stdio.F90:59
integer, public qa
real(rp), dimension(:,:,:), allocatable, public atmos_phy_ch_o3
real(rp), public const_undef
Definition: scale_const.F90:43
integer, public ia
of x whole cells (local, with HALO)
integer, public ka
of z whole cells (local, with HALO)
module PROCESS
module CONSTANT
Definition: scale_const.F90:14
real(rp), dimension(:,:,:,:), allocatable, public atmos_phy_ch_rhoq_t
logical, public io_lnml
output log or not? (for namelist, this process)
Definition: scale_stdio.F90:60
integer, public io_fid_conf
Config file ID.
Definition: scale_stdio.F90:55
integer, public io_fid_log
Log file ID.
Definition: scale_stdio.F90:56
integer, public ja
of y whole cells (local, with HALO)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ atmos_phy_ch_vars_fillhalo()

subroutine, public mod_atmos_phy_ch_vars::atmos_phy_ch_vars_fillhalo ( )

HALO Communication.

Definition at line 141 of file mod_atmos_phy_ch_vars.f90.

References atmos_phy_ch_o3, scale_grid_index::ie, scale_grid_index::is, scale_grid_index::je, scale_grid_index::js, scale_grid_index::ka, scale_grid_index::ke, and scale_grid_index::ks.

Referenced by atmos_phy_ch_vars_restart_read().

141  use scale_comm, only: &
142  comm_vars8, &
143  comm_wait
144  implicit none
145 
146  integer :: i, j
147  !---------------------------------------------------------------------------
148 
149  do j = js, je
150  do i = is, ie
151  atmos_phy_ch_o3( 1:ks-1,i,j) = atmos_phy_ch_o3(ks,i,j)
152  atmos_phy_ch_o3(ke+1:ka, i,j) = atmos_phy_ch_o3(ke,i,j)
153  enddo
154  enddo
155 
156  call comm_vars8( atmos_phy_ch_o3(:,:,:), 1 )
157  call comm_wait ( atmos_phy_ch_o3(:,:,:), 1 )
158 
159  return
integer, public is
start point of inner domain: x, local
integer, public je
end point of inner domain: y, local
integer, public ke
end point of inner domain: z, local
real(rp), dimension(:,:,:), allocatable, public atmos_phy_ch_o3
integer, public ka
of z whole cells (local, with HALO)
module COMMUNICATION
Definition: scale_comm.F90:23
integer, public js
start point of inner domain: y, local
integer, public ks
start point of inner domain: z, local
integer, public ie
end point of inner domain: x, local
Here is the caller graph for this function:

◆ atmos_phy_ch_vars_restart_read()

subroutine, public mod_atmos_phy_ch_vars::atmos_phy_ch_vars_restart_read ( )

Read restart.

Definition at line 165 of file mod_atmos_phy_ch_vars.f90.

References atmos_phy_ch_o3, atmos_phy_ch_restart_in_basename, atmos_phy_ch_vars_fillhalo(), scale_stdio::io_fid_log, and scale_stdio::io_l.

Referenced by mod_atmos_vars::atmos_vars_restart_read().

165  use scale_fileio, only: &
166  fileio_read
167  use scale_rm_statistics, only: &
168  stat_total
169  implicit none
170 
171  real(RP) :: total
172  !---------------------------------------------------------------------------
173 
174  if( io_l ) write(io_fid_log,*)
175  if( io_l ) write(io_fid_log,*) '*** Input restart file (ATMOS_PHY_CH) ***'
176 
177  if ( atmos_phy_ch_restart_in_basename /= '' ) then
178  if( io_l ) write(io_fid_log,*) '*** basename: ', trim(atmos_phy_ch_restart_in_basename)
179 
180  call fileio_read( atmos_phy_ch_o3(:,:,:), & ! [OUT]
181  atmos_phy_ch_restart_in_basename, var_name(1), 'ZXY', step=1 ) ! [IN]
182 
183  call atmos_phy_ch_vars_fillhalo
184 
185  call stat_total( total, atmos_phy_ch_o3(:,:,:), var_name(1) )
186  else
187  if( io_l ) write(io_fid_log,*) '*** restart file for ATMOS_PHY_CH is not specified.'
188  endif
189 
190  return
logical, public io_l
output log or not? (this process)
Definition: scale_stdio.F90:59
real(rp), dimension(:,:,:), allocatable, public atmos_phy_ch_o3
module FILE I/O (netcdf)
module Statistics
integer, public io_fid_log
Log file ID.
Definition: scale_stdio.F90:56
Here is the call graph for this function:
Here is the caller graph for this function:

◆ atmos_phy_ch_vars_restart_write()

subroutine, public mod_atmos_phy_ch_vars::atmos_phy_ch_vars_restart_write ( )

Write restart.

Definition at line 196 of file mod_atmos_phy_ch_vars.f90.

References atmos_phy_ch_o3, atmos_phy_ch_restart_out_basename, atmos_phy_ch_restart_out_dtype, atmos_phy_ch_restart_out_title, scale_stdio::io_fid_log, scale_stdio::io_l, and scale_time::time_gettimelabel().

Referenced by mod_atmos_vars::atmos_vars_restart_write().

196  use scale_time, only: &
198  use scale_fileio, only: &
199  fileio_write
200  implicit none
201 
202  character(len=20) :: timelabel
203  character(len=H_LONG) :: basename
204  !---------------------------------------------------------------------------
205 
206  if ( atmos_phy_ch_restart_out_basename /= '' ) then
207 
208  call time_gettimelabel( timelabel )
209  write(basename,'(A,A,A)') trim(atmos_phy_ch_restart_out_basename), '_', trim(timelabel)
210 
211  if( io_l ) write(io_fid_log,*)
212  if( io_l ) write(io_fid_log,*) '*** Output restart file (ATMOS_PHY_CH) ***'
213  if( io_l ) write(io_fid_log,*) '*** basename: ', trim(basename)
214 
215  call fileio_write( atmos_phy_ch_o3(:,:,:), basename, atmos_phy_ch_restart_out_title, & ! [IN]
216  var_name(1), var_desc(1), var_unit(1), 'ZXY', atmos_phy_ch_restart_out_dtype ) ! [IN]
217 
218  endif
219 
220  return
logical, public io_l
output log or not? (this process)
Definition: scale_stdio.F90:59
real(rp), dimension(:,:,:), allocatable, public atmos_phy_ch_o3
module FILE I/O (netcdf)
subroutine, public time_gettimelabel(timelabel)
generate time label
Definition: scale_time.F90:90
module TIME
Definition: scale_time.F90:15
integer, public io_fid_log
Log file ID.
Definition: scale_stdio.F90:56
Here is the call graph for this function:
Here is the caller graph for this function:

Variable Documentation

◆ atmos_phy_ch_restart_output

logical, public mod_atmos_phy_ch_vars::atmos_phy_ch_restart_output = .false.

output restart file?

Definition at line 40 of file mod_atmos_phy_ch_vars.f90.

Referenced by mod_admin_restart::admin_restart_setup(), and atmos_phy_ch_vars_setup().

40  logical, public :: atmos_phy_ch_restart_output = .false.

◆ atmos_phy_ch_restart_in_basename

character(len=h_long), public mod_atmos_phy_ch_vars::atmos_phy_ch_restart_in_basename = ''

basename of the restart file

Definition at line 42 of file mod_atmos_phy_ch_vars.f90.

Referenced by mod_admin_restart::admin_restart_setup(), atmos_phy_ch_vars_restart_read(), and atmos_phy_ch_vars_setup().

42  character(len=H_LONG), public :: atmos_phy_ch_restart_in_basename = ''

◆ atmos_phy_ch_restart_out_basename

character(len=h_long), public mod_atmos_phy_ch_vars::atmos_phy_ch_restart_out_basename = ''

basename of the output file

Definition at line 43 of file mod_atmos_phy_ch_vars.f90.

Referenced by mod_admin_restart::admin_restart_setup(), atmos_phy_ch_vars_restart_write(), and atmos_phy_ch_vars_setup().

43  character(len=H_LONG), public :: atmos_phy_ch_restart_out_basename = ''

◆ atmos_phy_ch_restart_out_title

character(len=h_mid), public mod_atmos_phy_ch_vars::atmos_phy_ch_restart_out_title = 'ATMOS_PHY_CH restart'

title of the output file

Definition at line 44 of file mod_atmos_phy_ch_vars.f90.

Referenced by mod_admin_restart::admin_restart_setup(), atmos_phy_ch_vars_restart_write(), and atmos_phy_ch_vars_setup().

44  character(len=H_MID), public :: atmos_phy_ch_restart_out_title = 'ATMOS_PHY_CH restart'

◆ atmos_phy_ch_restart_out_dtype

character(len=h_mid), public mod_atmos_phy_ch_vars::atmos_phy_ch_restart_out_dtype = 'DEFAULT'

REAL4 or REAL8.

Definition at line 45 of file mod_atmos_phy_ch_vars.f90.

Referenced by mod_admin_restart::admin_restart_setup(), atmos_phy_ch_vars_restart_write(), and atmos_phy_ch_vars_setup().

45  character(len=H_MID), public :: atmos_phy_ch_restart_out_dtype = 'DEFAULT'

◆ atmos_phy_ch_rhoq_t

real(rp), dimension(:,:,:,:), allocatable, public mod_atmos_phy_ch_vars::atmos_phy_ch_rhoq_t

Definition at line 47 of file mod_atmos_phy_ch_vars.f90.

Referenced by mod_atmos_phy_ch_driver::atmos_phy_ch_driver(), and atmos_phy_ch_vars_setup().

47  real(RP), public, allocatable :: atmos_phy_ch_rhoq_t(:,:,:,:) ! tendency QTRC [kg/kg/s]
real(rp), dimension(:,:,:,:), allocatable, public atmos_phy_ch_rhoq_t

◆ atmos_phy_ch_o3

real(rp), dimension(:,:,:), allocatable, public mod_atmos_phy_ch_vars::atmos_phy_ch_o3

Definition at line 49 of file mod_atmos_phy_ch_vars.f90.

Referenced by mod_atmos_phy_ch_driver::atmos_phy_ch_driver(), atmos_phy_ch_vars_fillhalo(), atmos_phy_ch_vars_restart_read(), atmos_phy_ch_vars_restart_write(), and atmos_phy_ch_vars_setup().

49  real(RP), public, allocatable :: atmos_phy_ch_o3(:,:,:) ! ozone [PPM]
real(rp), dimension(:,:,:), allocatable, public atmos_phy_ch_o3