SCALE-RM
Functions/Subroutines
scale_file_external_input_cartesc Module Reference

module file / external_input_cartesC More...

Functions/Subroutines

subroutine, public file_external_input_cartesc_setup
 Setup. More...
 
subroutine, public file_external_input_cartesc_finalize
 Finalize. More...
 
subroutine file_external_input_cartesc_read_1d (fid, varname, dim_type, var, step)
 
subroutine file_external_input_cartesc_read_2d (fid, varname, dim_type, var, step)
 
subroutine file_external_input_cartesc_read_3d (fid, varname, dim_type, var, step)
 

Detailed Description

module file / external_input_cartesC

Description
External file input module for the cartesian-C grid
Author
Team SCALE

Function/Subroutine Documentation

◆ file_external_input_cartesc_setup()

subroutine, public scale_file_external_input_cartesc::file_external_input_cartesc_setup

Setup.

Definition at line 55 of file scale_file_external_input_cartesC.F90.

55  use scale_file_external_input, only: &
63 
65 
66  file_external_input_get_dims1d => file_external_input_cartesc_get_dims1d
67  file_external_input_get_dims2d => file_external_input_cartesc_get_dims2d
68  file_external_input_get_dims3d => file_external_input_cartesc_get_dims3d
69 
70  file_external_input_read_1d => file_external_input_cartesc_read_1d
71  file_external_input_read_2d => file_external_input_cartesc_read_2d
72  file_external_input_read_3d => file_external_input_cartesc_read_3d
73 
74  return

References file_external_input_cartesc_read_1d(), file_external_input_cartesc_read_2d(), file_external_input_cartesc_read_3d(), scale_file_external_input::file_external_input_get_dims1d, scale_file_external_input::file_external_input_get_dims2d, scale_file_external_input::file_external_input_get_dims3d, scale_file_external_input::file_external_input_read_1d, scale_file_external_input::file_external_input_read_2d, scale_file_external_input::file_external_input_read_3d, and scale_file_external_input::file_external_input_setup().

Referenced by mod_rm_driver::rm_driver().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ file_external_input_cartesc_finalize()

subroutine, public scale_file_external_input_cartesc::file_external_input_cartesc_finalize

◆ file_external_input_cartesc_read_1d()

subroutine scale_file_external_input_cartesc::file_external_input_cartesc_read_1d ( integer, intent(in)  fid,
character(len=*), intent(in)  varname,
character(len=*), intent(in)  dim_type,
real(rp), dimension(:), intent(out)  var,
integer, intent(in), optional  step 
)
Parameters
[in]fidfile ID
[in]varnamename of the variable
[in]dim_typedimension type
[out]varvalue of the variable
[in]stepstep number

Definition at line 318 of file scale_file_external_input_cartesC.F90.

318  use scale_file_cartesc, only: &
319  file_cartesc_read, &
321  implicit none
322  integer, intent(in) :: fid
323  character(len=*), intent(in) :: varname
324  character(len=*), intent(in) :: dim_type
325  real(RP), intent(out) :: var(:)
326  integer, intent(in), optional :: step
327 
328  call file_cartesc_read( fid, varname, dim_type, & ! [IN]
329  var(:), & ! [OUT]
330  step = step ) ! [IN]
331 
332  call file_cartesc_flush( fid )
333 
334  return

References scale_file_cartesc::file_cartesc_flush().

Referenced by file_external_input_cartesc_setup().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ file_external_input_cartesc_read_2d()

subroutine scale_file_external_input_cartesc::file_external_input_cartesc_read_2d ( integer, intent(in)  fid,
character(len=*), intent(in)  varname,
character(len=*), intent(in)  dim_type,
real(rp), dimension(:,:), intent(out)  var,
integer, intent(in), optional  step 
)
Parameters
[in]fidfile ID
[in]varnamename of the variable
[in]dim_typedimension type
[out]varvalue of the variable
[in]stepstep number

Definition at line 342 of file scale_file_external_input_cartesC.F90.

342  use scale_file_cartesc, only: &
343  file_cartesc_read, &
345  implicit none
346  integer, intent(in) :: fid
347  character(len=*), intent(in) :: varname
348  character(len=*), intent(in) :: dim_type
349  real(RP), intent(out) :: var(:,:)
350  integer, intent(in), optional :: step
351 
352  call file_cartesc_read( fid, varname, dim_type, & ! [IN]
353  var(:,:), & ! [OUT]
354  step = step ) ! [IN]
355 
356  call file_cartesc_flush( fid )
357 
358  return

References scale_file_cartesc::file_cartesc_flush().

Referenced by file_external_input_cartesc_setup().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ file_external_input_cartesc_read_3d()

subroutine scale_file_external_input_cartesc::file_external_input_cartesc_read_3d ( integer, intent(in)  fid,
character(len=*), intent(in)  varname,
character(len=*), intent(in)  dim_type,
real(rp), dimension(:,:,:), intent(out)  var,
integer, intent(in), optional  step 
)
Parameters
[in]fidfile ID
[in]varnamename of the variable
[in]dim_typedimension type
[out]varvalue of the variable
[in]stepstep number

Definition at line 366 of file scale_file_external_input_cartesC.F90.

366  use scale_file_cartesc, only: &
367  file_cartesc_read, &
369  implicit none
370  integer, intent(in) :: fid
371  character(len=*), intent(in) :: varname
372  character(len=*), intent(in) :: dim_type
373  real(RP), intent(out) :: var(:,:,:)
374  integer, intent(in), optional :: step
375 
376  call file_cartesc_read( fid, varname, dim_type, & ! [IN]
377  var(:,:,:), & ! [OUT]
378  step = step ) ! [IN]
379 
380  call file_cartesc_flush( fid )
381 
382  return

References scale_file_cartesc::file_cartesc_flush().

Referenced by file_external_input_cartesc_setup().

Here is the call graph for this function:
Here is the caller graph for this function:
scale_file_external_input::file_external_input_read_3d
procedure(read3d), pointer, public file_external_input_read_3d
Definition: scale_file_external_input.F90:166
scale_file_external_input::file_external_input_finalize
subroutine, public file_external_input_finalize
finalize
Definition: scale_file_external_input.F90:335
scale_file_external_input::file_external_input_setup
subroutine, public file_external_input_setup
Setup.
Definition: scale_file_external_input.F90:236
scale_file_external_input::file_external_input_get_dims3d
procedure(get_dims3d), pointer, public file_external_input_get_dims3d
Definition: scale_file_external_input.F90:159
scale_file_external_input::file_external_input_read_2d
procedure(read2d), pointer, public file_external_input_read_2d
Definition: scale_file_external_input.F90:165
scale_file_external_input::file_external_input_get_dims2d
procedure(get_dims2d), pointer, public file_external_input_get_dims2d
Definition: scale_file_external_input.F90:158
scale_file_external_input::file_external_input_read_1d
procedure(read1d), pointer, public file_external_input_read_1d
Definition: scale_file_external_input.F90:164
scale_file_cartesc::file_cartesc_flush
subroutine, public file_cartesc_flush(fid)
Flush all pending requests to a netCDF file (PnetCDF only)
Definition: scale_file_cartesC.F90:1018
scale_file_external_input
module file / external_input
Definition: scale_file_external_input.F90:12
scale_file_external_input::file_external_input_get_dims1d
procedure(get_dims1d), pointer, public file_external_input_get_dims1d
Definition: scale_file_external_input.F90:157
scale_file_cartesc
module file / cartesianC
Definition: scale_file_cartesC.F90:11