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:

formatreal, get_inopt, get_inopt_int, get_inopt_logical, get_inopt_real, get_inopt_string, get_loopinfo_int, get_loopinfo_real, 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_real, read_inopt_string, strip_zeros, write_infile_lines, write_inopt, write_inopt_int, write_inopt_logical, write_inopt_real4, write_inopt_real8, write_inopt_string

Routines:

check_infile(), close_db(), contains_loop(), errtext(), get_optstring(), open_db_from_file(), read_next_inopt(), write_infile_series()

Types

  • type  infile_utils/inopts
    Type fields:

    • % retrieved [logical]

    • % tag [character]

    • % val [character]

Variables

  • infile_utils/formatreal [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/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_real [private]
  • infile_utils/read_inopt_string [private]
  • infile_utils/strip_zeros [private]
  • infile_utils/write_infile_lines [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]

Call to:

read_next_inopt()

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/read_next_inopt(tag, valstring, iunit, ierr[, nlinesread])
Parameters:

  • tag [character,out]

  • valstring [character,out]

  • iunit [integer,in]

  • ierr [integer,out] :: not optional for reads

  • nlinesread [integer,out,]

Called from:

open_db_from_file(), check_infile()

subroutine  infile_utils/check_infile(infile, lu_read, containsloop, ierrline)
Parameters:

  • infile [character,in]

  • lu_read [integer,in] :: unit to read file on

  • containsloop [logical,out]

  • ierrline [integer,out]

Call to:

read_next_inopt(), contains_loop()

function  infile_utils/contains_loop(valstring)
Parameters:

valstring [character,in]

Return:

contains_loop [logical]

Called from:

check_infile(), write_infile_series()

subroutine  infile_utils/write_infile_series(lu_read, lu_write, infile, nlines, ierr)
Parameters:

  • lu_read [integer,in]

  • lu_write [integer,in]

  • infile [character,in]

  • nlines [integer,in]

  • ierr [integer]

Call to:

contains_loop()

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

  • nopts [integer,in,]

  • optstring (nopts) [character,in]

  • string_bn [character,out]

  • maxlen [integer,in,]