Block-Structured AMR Software Framework
amrex_io_module Module Reference

Functions/Subroutines

integer function unit_new ()
 Several routines are written so that they can be conveniently called in routines that have optional arguments. For example, `` subroutine print_box(box, unit) optional :: unit write(unit=unit_stdout(unit), fmt *) box `` This routine will print on the stdout if UNIT is not passed to print_box, but will print to UNIT if UNIT is passed. More...
 
pure integer function unit_stdin (unit)
 Returns the stdin unit number if no argument is passed, or else unit if it is passed. More...
 
pure integer function unit_stdout (unit)
 Returns the stdout unit number if no argument is passed, or else unit if it is passed. More...
 
pure character(len=3) function unit_advance (advance)
 Returns the string 'YES' if no argument is passed other wise returns the argument advance. More...
 
subroutine unit_skip (unit, skip)
 Puts skip spaces of output, without advancing to the next record onto UNIT. If no skip argument is given, then no advance is done. More...
 
pure integer function unit_get_skip (skip)
 A convenience function that returns 0 if SKIP is not present, otherwise it returns SKIP. More...
 

Variables

integer, parameter, private io_stdin = 5
 Default input and output units: More...
 
integer, parameter, private io_stdout = 6
 
integer, parameter, private io_num_precon = 3
 Number and value of pre-connected units. More...
 
integer, dimension(io_num_precon), parameter, private io_precon_units = (/ 0, 5, 6 /)
 
integer, parameter, private io_max_unit = 1000
 Largest allowed unit number (or a large number, if none) More...
 

Function/Subroutine Documentation

◆ unit_advance()

pure character(len=3) function amrex_io_module::unit_advance ( character(len=*), intent(in), optional  advance)

Returns the string 'YES' if no argument is passed other wise returns the argument advance.

◆ unit_get_skip()

pure integer function amrex_io_module::unit_get_skip ( integer, intent(in), optional  skip)

A convenience function that returns 0 if SKIP is not present, otherwise it returns SKIP.

◆ unit_new()

integer function amrex_io_module::unit_new

Several routines are written so that they can be conveniently called in routines that have optional arguments. For example, `` subroutine print_box(box, unit) optional :: unit write(unit=unit_stdout(unit), fmt *) box `` This routine will print on the stdout if UNIT is not passed to print_box, but will print to UNIT if UNIT is passed.

Returns a unit number of a unit that exists and is not connected

◆ unit_skip()

subroutine amrex_io_module::unit_skip ( integer, intent(in)  unit,
integer, intent(in), optional  skip 
)

Puts skip spaces of output, without advancing to the next record onto UNIT. If no skip argument is given, then no advance is done.

◆ unit_stdin()

pure integer function amrex_io_module::unit_stdin ( integer, intent(in), optional  unit)

Returns the stdin unit number if no argument is passed, or else unit if it is passed.

◆ unit_stdout()

pure integer function amrex_io_module::unit_stdout ( integer, intent(in), optional  unit)

Returns the stdout unit number if no argument is passed, or else unit if it is passed.

Variable Documentation

◆ io_max_unit

integer, parameter, private amrex_io_module::io_max_unit = 1000
private

Largest allowed unit number (or a large number, if none)

◆ io_num_precon

integer, parameter, private amrex_io_module::io_num_precon = 3
private

Number and value of pre-connected units.

◆ io_precon_units

integer, dimension(io_num_precon), parameter, private amrex_io_module::io_precon_units = (/ 0, 5, 6 /)
private

◆ io_stdin

integer, parameter, private amrex_io_module::io_stdin = 5
private

Default input and output units:

◆ io_stdout

integer, parameter, private amrex_io_module::io_stdout = 6
private