utils_infiles

Module

Description

This module contains utility routines for reading

and writing of input files

References:

None

Owner:

Daniel Price

Runtime parameters:

None

Dependencies:

None

Quick access

Types:

inopts

Variables:

contains_loop, formatreal, get_format_string, get_inopt, get_inopt_int, get_inopt_logical, get_inopt_real, get_inopt_string, get_loopinfo_int, get_loopinfo_real, get_options_interactive, ierr_inread, ierr_notfound, ierr_rangemax, ierr_rangemin, inopts, isintloop, isrealloop, match_inopt_in_db, maxlen, maxlenline, maxlenstring, maxlenval, read_inopt, read_inopt_from_line, read_inopt_int, read_inopt_logical, read_inopt_real4, read_inopt_real8, read_inopt_string, read_next_inopt, strip_zeros, write_infile_lines, write_infile_series, write_inopt, write_inopt_int, write_inopt_logical, write_inopt_real4, write_inopt_real8, write_inopt_string

Routines:

check_and_unroll_infile(), check_infile(), close_db(), errtext(), get_options(), get_optstring(), infile_exists(), int_to_string(), open_db_from_file()

Types

• type  infile_utils/inopts

  Type fields:

  • % retrieved [logical]

  • % tag [character]

  • % val [character]

Variables

• infile_utils/contains_loop [private]

• infile_utils/formatreal [private]

• infile_utils/get_format_string [private]

• infile_utils/get_inopt [public]

• infile_utils/get_inopt_int [private]

• infile_utils/get_inopt_logical [private]

• infile_utils/get_inopt_real [private]

• infile_utils/get_inopt_string [private]

• infile_utils/get_loopinfo_int [private]

• infile_utils/get_loopinfo_real [private]

• infile_utils/get_options_interactive [private]

• infile_utils/ierr_inread [integer,private/parameter/optional/default=1]

• infile_utils/ierr_notfound [integer,private/parameter/optional/default=-1]

• infile_utils/ierr_rangemax [integer,private/parameter/optional/default=3]

• infile_utils/ierr_rangemin [integer,private/parameter/optional/default=2]

• infile_utils/inopts [public]

• infile_utils/isintloop [private]

• infile_utils/isrealloop [private]

• infile_utils/match_inopt_in_db [private]

• infile_utils/maxlen [integer,private/parameter/optional/default=100]

  max length of string containing variable

• infile_utils/maxlenline [integer,private/parameter/optional/default=120]

  maximum line length

• infile_utils/maxlenstring [integer,private/parameter/optional/default=120]

  max length of string variable

• infile_utils/maxlenval [integer,private/parameter/optional/default=100]

  max length of string containing value

• infile_utils/read_inopt [public]

• infile_utils/read_inopt_from_line [private]

• infile_utils/read_inopt_int [private]

• infile_utils/read_inopt_logical [private]

• infile_utils/read_inopt_real4 [private]

• infile_utils/read_inopt_real8 [private]

• infile_utils/read_inopt_string [private]

• infile_utils/read_next_inopt [private]

• infile_utils/strip_zeros [private]

• infile_utils/unknown_abstract_interface [private]

• infile_utils/write_infile_lines [private]

• infile_utils/write_infile_series [private]

• infile_utils/write_inopt [public]

• infile_utils/write_inopt_int [private]

• infile_utils/write_inopt_logical [private]

• infile_utils/write_inopt_real4 [private]

• infile_utils/write_inopt_real8 [private]

• infile_utils/write_inopt_string [private]

Subroutines and functions

subroutine  infile_utils/open_db_from_file(db, filename[, iunit, ierr])

Parameters:

• db (*) [inopts,out,allocatable]

• filename [character,in]

• iunit [integer,in,]

• ierr [integer,out]

subroutine  infile_utils/close_db(db)

Parameters:

db (*) [inopts,inout,allocatable]

function  infile_utils/errtext(ierr)

Parameters:

ierr [integer,in]

Return:

errtext [character]

subroutine  infile_utils/check_infile(infile, containsloop, ierrline, nlines)

Parameters:

• infile [character,in]

• containsloop [logical,out]

• ierrline [integer,out]

• nlines [integer,out]

Called from:

check_and_unroll_infile()

subroutine  infile_utils/check_and_unroll_infile(infile, igotloops, ierr)

Parameters:

• infile [character,in]

• igotloops [logical,out]

• ierr [integer,out]

Call to:

check_infile()

subroutine  infile_utils/get_optstring(nopts, optstring, string_bn[, maxlen[, from_zero]])

Parameters:

• nopts [integer,in,]

• optstring (nopts) [character,in]

• string_bn [character,out]

• maxlen [integer,in,]

• from_zero [logical,in,]

function  infile_utils/int_to_string(num)

Parameters:

num [integer,in]

Return:

str [character] :: Handle the case for zero

subroutine  infile_utils/get_options(filename, iallow_write, ierr, read_pars, write_pars)

Parameters:

• filename [character,in]

• iallow_write [logical,in]

• ierr [integer,out]

• read_pars [external]

• write_pars [external]

Use :

get_options__user__routines

Called from:

get_options_slab()

function  infile_utils/infile_exists(fileprefix)

Parameters:

fileprefix [character,in]

Return:

infile_exists [logical] :: avoid compiler warning