![]() |
MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
|
Static parser based input loader. More...

Public Member Functions | |
| procedure | load (this, parser, mf6_input, nc_vars, filename, iout) |
| load all static input blocks | |
| procedure | init (this, parser, mf6_input, filename, iout) |
| init | |
| procedure | load_block (this, iblk) |
| load a single block | |
| procedure | finalize (this) |
| finalize | |
| procedure | parse_block (this, iblk, recursive_call) |
| parse block | |
| procedure | block_post_process (this, iblk) |
| Post parse block handling. | |
| procedure | parse_io_tag (this, iblk, pkgtype, which, tag) |
| procedure | parse_record_tag (this, iblk, inidt, recursive_call) |
| procedure | load_tag (this, iblk, idt) |
| load input keyword Load input associated with tag key into the memory manager. | |
| procedure | block_index_dfn (this, iblk) |
| procedure | parse_structarray_block (this, iblk) |
| parse a structured array record into memory manager | |
| procedure | save_ts_sa (this) |
| Save structarray pointer for deferred TS linking. | |
| procedure | ts_sa_count (this) |
| Return number of saved static StructArrays with deferred TS strlocs. | |
| procedure | get_ts_sa (this, n) |
| Return the n-th saved static StructArray pointer. | |
| procedure | alloc_tslink (this, iblk) |
| Allocate time series link flags for a static block. | |
| procedure | cleanup (this) |
| Clean up saved static structarrays. | |
Public Attributes | |
| type(blockparsertype), pointer | parser |
| ascii block parser | |
| integer(i4b), dimension(:), pointer, contiguous | mshape => null() |
| model shape | |
| type(structarraytype), pointer | structarray => null() |
| structarray for loading list input | |
| type(staticsatype), dimension(:), allocatable | ts_sas |
| saved structarrays for deferred TS linking | |
| type(modflowinputtype) | mf6_input |
| description of input | |
| type(ncpackagevarstype), pointer | nc_vars => null() |
| character(len=linelength) | filename |
| name of ascii input file | |
| character(len=linelength), dimension(:), allocatable | block_tags |
| read block tags | |
| logical(lgp) | ts_active |
| is timeseries active | |
| logical(lgp) | export |
| is array export active | |
| logical(lgp) | readasarrays |
| logical(lgp) | readarraygrid |
| integer(i4b) | inamedbound |
| integer(i4b) | iauxiliary |
| integer(i4b) | iout |
| inunit for list log | |
This type defines a static input context loader for traditional mf6 ascii input files.
Definition at line 54 of file LoadMf6File.f90.
| procedure loadmf6filemodule::loadmf6filetype::alloc_tslink | ( | class(loadmf6filetype), intent(inout) | this, |
| integer(i4b), intent(in) | iblk ) |
For a block with time series capable double columns, allocate TSLINK_<id>, an integer array (ncol, nrow) that is nonzero where a row's value is linked to a time series, and TSLINKVARS_<id>, the names of its columns, where <id> identifies the block (see tslink_id). Packages use these to apply time series updates to linked values only.
Definition at line 85 of file LoadMf6File.f90.
| procedure loadmf6filemodule::loadmf6filetype::block_index_dfn | ( | class(loadmf6filetype) | this, |
| integer(i4b), intent(in) | iblk ) |
Definition at line 80 of file LoadMf6File.f90.
| procedure loadmf6filemodule::loadmf6filetype::block_post_process | ( | class(loadmf6filetype) | this, |
| integer(i4b), intent(in) | iblk ) |
Definition at line 76 of file LoadMf6File.f90.
| procedure loadmf6filemodule::loadmf6filetype::cleanup | ( | class(loadmf6filetype), intent(inout) | this | ) |
Called from destroy() of dynamic loaders.
Definition at line 86 of file LoadMf6File.f90.
| procedure loadmf6filemodule::loadmf6filetype::finalize | ( | class(loadmf6filetype) | this | ) |
init / finalize are only used when load_block() will be called
Definition at line 74 of file LoadMf6File.f90.
| procedure loadmf6filemodule::loadmf6filetype::get_ts_sa | ( | class(loadmf6filetype), intent(in) | this, |
| integer(i4b), intent(in) | n ) |
Definition at line 84 of file LoadMf6File.f90.
| procedure loadmf6filemodule::loadmf6filetype::init | ( | class(loadmf6filetype) | this, |
| type(blockparsertype), intent(inout), target | parser, | ||
| type(modflowinputtype), intent(in) | mf6_input, | ||
| character(len=*), intent(in) | filename, | ||
| integer(i4b), intent(in) | iout ) |
init / finalize are only used when load_block() will be called
Definition at line 72 of file LoadMf6File.f90.
| procedure loadmf6filemodule::loadmf6filetype::load | ( | class(loadmf6filetype) | this, |
| type(blockparsertype), intent(inout), target | parser, | ||
| type(modflowinputtype), intent(in) | mf6_input, | ||
| type(ncpackagevarstype), intent(in), pointer | nc_vars, | ||
| character(len=*), intent(in) | filename, | ||
| integer(i4b), intent(in) | iout ) |
Invoke this routine to load all static input blocks in single call.
Definition at line 71 of file LoadMf6File.f90.
| procedure loadmf6filemodule::loadmf6filetype::load_block | ( | class(loadmf6filetype) | this, |
| integer(i4b), intent(in) | iblk ) |
Assumed in order load of single (next) block. If a StructArray object is allocated to load this block it persists until this routine (or finalize) is called again.
Definition at line 73 of file LoadMf6File.f90.
| procedure loadmf6filemodule::loadmf6filetype::load_tag | ( | class(loadmf6filetype) | this, |
| integer(i4b), intent(in) | iblk, | ||
| type(inputparamdefinitiontype), intent(in), pointer | idt ) |
| [in] | idt | input data type object describing this record |
Definition at line 79 of file LoadMf6File.f90.
| procedure loadmf6filemodule::loadmf6filetype::parse_block | ( | class(loadmf6filetype) | this, |
| integer(i4b), intent(in) | iblk, | ||
| logical(lgp), intent(in) | recursive_call ) |
| [in] | recursive_call | true if recursive call |
Definition at line 75 of file LoadMf6File.f90.
| procedure loadmf6filemodule::loadmf6filetype::parse_io_tag | ( | class(loadmf6filetype) | this, |
| integer(i4b), intent(in) | iblk, | ||
| character(len=*), intent(in) | pkgtype, | ||
| character(len=*), intent(in) | which, | ||
| character(len=*), intent(in) | tag ) |
Definition at line 77 of file LoadMf6File.f90.
| procedure loadmf6filemodule::loadmf6filetype::parse_record_tag | ( | class(loadmf6filetype) | this, |
| integer(i4b), intent(in) | iblk, | ||
| type(inputparamdefinitiontype), intent(in), pointer | inidt, | ||
| logical(lgp), intent(in) | recursive_call ) |
| [in] | recursive_call | true if recursive call |
Definition at line 78 of file LoadMf6File.f90.
| procedure loadmf6filemodule::loadmf6filetype::parse_structarray_block | ( | class(loadmf6filetype) | this, |
| integer(i4b), intent(in) | iblk ) |
A structarray is similar to a numpy recarray. It it used to load a list of data in which each column in the list may be a different type. Each column in the list is stored as a 1d vector.
Definition at line 81 of file LoadMf6File.f90.
| procedure loadmf6filemodule::loadmf6filetype::save_ts_sa | ( | class(loadmf6filetype), intent(inout) | this | ) |
Saves the current structarray pointer when it contains TS string locs, then nullifies the pointer so load_block does not destroy it.
Definition at line 82 of file LoadMf6File.f90.
| procedure loadmf6filemodule::loadmf6filetype::ts_sa_count | ( | class(loadmf6filetype), intent(in) | this | ) |
Definition at line 83 of file LoadMf6File.f90.
| character(len=linelength), dimension(:), allocatable loadmf6filemodule::loadmf6filetype::block_tags |
Definition at line 62 of file LoadMf6File.f90.
| logical(lgp) loadmf6filemodule::loadmf6filetype::export |
Definition at line 64 of file LoadMf6File.f90.
| character(len=linelength) loadmf6filemodule::loadmf6filetype::filename |
Definition at line 61 of file LoadMf6File.f90.
| integer(i4b) loadmf6filemodule::loadmf6filetype::iauxiliary |
Definition at line 68 of file LoadMf6File.f90.
| integer(i4b) loadmf6filemodule::loadmf6filetype::inamedbound |
Definition at line 67 of file LoadMf6File.f90.
| integer(i4b) loadmf6filemodule::loadmf6filetype::iout |
Definition at line 69 of file LoadMf6File.f90.
| type(modflowinputtype) loadmf6filemodule::loadmf6filetype::mf6_input |
Definition at line 59 of file LoadMf6File.f90.
| integer(i4b), dimension(:), pointer, contiguous loadmf6filemodule::loadmf6filetype::mshape => null() |
Definition at line 56 of file LoadMf6File.f90.
| type(ncpackagevarstype), pointer loadmf6filemodule::loadmf6filetype::nc_vars => null() |
Definition at line 60 of file LoadMf6File.f90.
| type(blockparsertype), pointer loadmf6filemodule::loadmf6filetype::parser |
Definition at line 55 of file LoadMf6File.f90.
| logical(lgp) loadmf6filemodule::loadmf6filetype::readarraygrid |
Definition at line 66 of file LoadMf6File.f90.
| logical(lgp) loadmf6filemodule::loadmf6filetype::readasarrays |
Definition at line 65 of file LoadMf6File.f90.
| type(structarraytype), pointer loadmf6filemodule::loadmf6filetype::structarray => null() |
Definition at line 57 of file LoadMf6File.f90.
| logical(lgp) loadmf6filemodule::loadmf6filetype::ts_active |
Definition at line 63 of file LoadMf6File.f90.
| type(staticsatype), dimension(:), allocatable loadmf6filemodule::loadmf6filetype::ts_sas |
Definition at line 58 of file LoadMf6File.f90.