MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
headfilereadermodule::headfilereadertype Type Referenceabstract
Inheritance diagram for headfilereadermodule::headfilereadertype:
Inheritance graph
Collaboration diagram for headfilereadermodule::headfilereadertype:
Collaboration graph

Public Member Functions

procedure initialize (this, iu, iout)
procedure read_header (this, success, iout)
procedure read_record (this, success, iout)
procedure rewind (this)
procedure finalize (this)
procedure(read_header_if), deferred read_header (this, success, iout)
procedure(read_record_if), deferred read_record (this, success, iout)
procedure build_index (this)
 Build an index of record positions in the file.
procedure peek_record (this)
 Peek to see if another record is available.
procedure rewind (this)
 Rewind the file to the beginning.
procedure seek_to_index (this, index)
 Position the file at the start of an indexed record.

Public Attributes

integer(i4b) nlay
real(dp), dimension(:), allocatable head
integer(i4b) inunit
integer(i4b) nrecords = 0
logical(lgp) indexed = .false.
logical(lgp) endoffile = .false.
integer(i8b), dimension(:), allocatable record_positions
 record start positions
class(binaryfileheadertype), allocatable header
class(binaryfileheadertype), allocatable headernext

Detailed Description

Definition at line 19 of file HeadFileReader.f90.

Member Function/Subroutine Documentation

◆ build_index()

procedure binaryfilereadermodule::binaryfilereadertype::build_index ( class(binaryfilereadertype), intent(inout) this)
inherited

Definition at line 27 of file BinaryFileReader.f90.

◆ finalize()

procedure headfilereadermodule::headfilereadertype::finalize ( class(headfilereadertype) this)

Definition at line 27 of file HeadFileReader.f90.

◆ initialize()

procedure headfilereadermodule::headfilereadertype::initialize ( class(headfilereadertype) this,
integer(i4b), intent(in) iu,
integer(i4b), intent(in) iout )

Definition at line 23 of file HeadFileReader.f90.

◆ peek_record()

procedure binaryfilereadermodule::binaryfilereadertype::peek_record ( class(binaryfilereadertype), intent(inout) this)
inherited

Definition at line 28 of file BinaryFileReader.f90.

◆ read_header() [1/2]

procedure(read_header_if), deferred binaryfilereadermodule::binaryfilereadertype::read_header ( class(binaryfilereadertype), intent(inout) this,
logical(lgp), intent(out) success,
integer(i4b), intent(in), optional iout )
pure virtualinherited

Definition at line 25 of file BinaryFileReader.f90.

◆ read_header() [2/2]

procedure headfilereadermodule::headfilereadertype::read_header ( class(headfilereadertype), intent(inout) this,
logical, intent(out) success,
integer(i4b), intent(in), optional iout )

Definition at line 24 of file HeadFileReader.f90.

◆ read_record() [1/2]

procedure(read_record_if), deferred binaryfilereadermodule::binaryfilereadertype::read_record ( class(binaryfilereadertype), intent(inout) this,
logical(lgp), intent(out) success,
integer(i4b), intent(in), optional iout )
pure virtualinherited

Definition at line 26 of file BinaryFileReader.f90.

◆ read_record() [2/2]

procedure headfilereadermodule::headfilereadertype::read_record ( class(headfilereadertype), intent(inout) this,
logical, intent(out) success,
integer(i4b), intent(in), optional iout )

Definition at line 25 of file HeadFileReader.f90.

◆ rewind() [1/2]

procedure binaryfilereadermodule::binaryfilereadertype::rewind ( class(binaryfilereadertype), intent(inout) this)
inherited

Definition at line 29 of file BinaryFileReader.f90.

◆ rewind() [2/2]

procedure headfilereadermodule::headfilereadertype::rewind ( class(headfilereadertype), intent(inout) this)

Definition at line 26 of file HeadFileReader.f90.

◆ seek_to_index()

procedure binaryfilereadermodule::binaryfilereadertype::seek_to_index ( class(binaryfilereadertype), intent(inout) this,
integer(i4b), intent(in) index )
inherited

Definition at line 30 of file BinaryFileReader.f90.

Member Data Documentation

◆ endoffile

logical(lgp) binaryfilereadermodule::binaryfilereadertype::endoffile = .false.
inherited

Definition at line 20 of file BinaryFileReader.f90.

◆ head

real(dp), dimension(:), allocatable headfilereadermodule::headfilereadertype::head

Definition at line 21 of file HeadFileReader.f90.

21 real(DP), dimension(:), allocatable :: head

◆ header

class(binaryfileheadertype), allocatable binaryfilereadermodule::binaryfilereadertype::header
inherited

Definition at line 22 of file BinaryFileReader.f90.

22 class(BinaryFileHeaderType), allocatable :: header

◆ headernext

class(binaryfileheadertype), allocatable binaryfilereadermodule::binaryfilereadertype::headernext
inherited

Definition at line 23 of file BinaryFileReader.f90.

23 class(BinaryFileHeaderType), allocatable :: headernext

◆ indexed

logical(lgp) binaryfilereadermodule::binaryfilereadertype::indexed = .false.
inherited

Definition at line 19 of file BinaryFileReader.f90.

◆ inunit

integer(i4b) binaryfilereadermodule::binaryfilereadertype::inunit
inherited

Definition at line 17 of file BinaryFileReader.f90.

17 integer(I4B) :: inunit

◆ nlay

integer(i4b) headfilereadermodule::headfilereadertype::nlay

Definition at line 20 of file HeadFileReader.f90.

20 integer(I4B) :: nlay

◆ nrecords

integer(i4b) binaryfilereadermodule::binaryfilereadertype::nrecords = 0
inherited

Definition at line 18 of file BinaryFileReader.f90.

◆ record_positions

integer(i8b), dimension(:), allocatable binaryfilereadermodule::binaryfilereadertype::record_positions
inherited

Definition at line 21 of file BinaryFileReader.f90.

21 integer(I8B), allocatable :: record_positions(:) !< record start positions

The documentation for this type was generated from the following file: