![]() |
MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
|
Keystring period block loader. More...


Public Member Functions | |
| procedure | ainit (this, mf6_input, component_name, component_input_name, input_name, iperblock, parser, iout) |
| procedure | df (this) |
| procedure | ts_advance (this) |
| procedure | rp (this, parser) |
| procedure | allocate_subindex (this) |
| Allocate ctxsubindex_dependency targets (subindex params excluded from allocate_items), and cache everything apply_subindex needs every period. | |
| procedure | allocate_permanent_array (this, name, nfeatures, init_value) |
| Allocate a permanent per-feature array named name with init_value, unless already allocated. | |
| procedure | allocate_items (this) |
| Allocate a permanent array for every IDM-managed item, using the descriptor's per-item feature count and init value. | |
| procedure | apply_auxiliary (this) |
| Apply PERIOD AUXILIARY settings to the permanent AUX array. TS-linked rows resolve via the struct array's own ts_strlocs; literal rows resolve AUXNAME here and clear any stale TS link. | |
| procedure | apply_subindex (this) |
| Apply PERIOD settings for ctxsubindex_dependency's targets, via ts_update_indexed – same mechanism as BEDK/MANNING, but each row's target index comes from a named subindex field through the cached offset table rather than the leading id column alone. | |
| procedure | apply_items (this) |
| Apply IDM-managed feature- and node-addressed settings to their permanent arrays; each row's address comes from resolve_row_addr. Indexed-body and AUX are handled in their own routines. | |
| procedure | resolve_row_addr (this, item, irow, period_ifno, cellid, ndim, leading_tag) |
| Resolve one row's target index for an item, dispatching on addr_mode. Returns 0 (skip) if out of range. | |
| procedure | resolve_subindex_offsets (this, dimname) |
| Per-feature cumulative offset table from an array-valued dimension, permuted into feature-index order first. Indexed by feature (not the dimension's own summed total). | |
| procedure | resolve_subindex_address (this, id_mf6varname, head_mf6varname, subindex_icol, offsets, nfeatures, nbound) |
| Row -> resolved feature index for an item whose local position comes from a subindex field, via the offset table. | |
| procedure | reset (this) |
| procedure | destroy (this) |
| procedure | create_structarray (this) |
| procedure(load_init_if), deferred | ainit (this, mf6_input, component_name, component_input_name, input_name, iperblock, parser, iout) |
| procedure(period_load_if), deferred | rp (this, parser) |
| procedure | init (this, mf6_input, component_name, component_input_name, input_name, iperblock, iout) |
| initialize dynamic package loader | |
| procedure | df (this) |
| dynamic package loader define | |
| procedure | ts_advance (this) |
| dynamic package loader advance | |
| procedure | destroy (this) |
| dynamic package loader destroy | |
Public Attributes | |
| type(timeseriesmanagertype), pointer | tsmanager => null() |
| type(structarraytype), pointer | structarray => null() |
| type(loadcontexttype) | ctx |
| input load context | |
| type(loadmf6filetype) | static_loader |
| persistent static loader | |
| logical(lgp) | ts_active |
| .true. if TS files are loaded | |
| integer(i4b) | nleading |
| number of leading (pre-keystring) columns | |
| integer(i4b), dimension(:), allocatable | subindex_nfeatures |
| per-column feature count (0 = n/a) | |
| type(intarraytype), dimension(:), allocatable | subindex_offsets |
| per-column offset table | |
| integer(i4b), dimension(:), allocatable | subindex_icol |
| per-column subindex SA column | |
| integer(i4b), dimension(:), allocatable | subindex_head_icol |
| per-column subindex head SA column | |
| character(len=lenvarname) | subindex_id_varname = '' |
| leading column's mf6varname | |
| type(modflowinputtype) | mf6_input |
| description of modflow6 input | |
| type(ncpackagevarstype), pointer | nc_vars => null() |
| character(len=lencomponentname) | component_name |
| name of component | |
| character(len=linelength) | component_input_name |
| component input name, e.g. model name file | |
| character(len=linelength) | input_name |
| input name, e.g. package *.chd file | |
| character(len=linelength), dimension(:), allocatable | param_names |
| dynamic param tagnames | |
| logical(lgp) | readasarrays |
| readasarrays style input package | |
| logical(lgp) | readarraygrid |
| readarraygrid style input package | |
| logical(lgp) | has_keystring |
| period block uses keystring-based dispatch | |
| integer(i4b) | iperblock |
| index of period block on block definition list | |
| integer(i4b) | iout |
| inunit number for logging | |
| integer(i4b) | nparam |
| number of in scope params | |
Private Member Functions | |
| procedure, private | valid_address (this, ifno, nfeatures, ifno_tagname, row) |
| Validate ifno against nfeatures, storing an error keyed by ifno_tagname (the leading column's public tag) if out of range. | |
Leading fixed columns (e.g. CELLID) followed by a dispatch keyword that routes each input row to a typed item column.
Definition at line 51 of file Mf6FileKeystring.f90.
|
pure virtualinherited |
| [in] | mf6_input | description of input |
| [in] | component_name | component name |
| [in] | component_input_name | component input name, e.g. model name file |
| [in] | input_name | input name, e.g. package *.chd file |
| [in] | iperblock | index of period block on block definition list |
| [in,out] | parser | block parser |
Definition at line 24 of file AsciiInputLoadType.f90.
| procedure mf6filekeystringmodule::keystringloadtype::ainit | ( | class(keystringloadtype), intent(inout) | this, |
| type(modflowinputtype), intent(in) | mf6_input, | ||
| character(len=*), intent(in) | component_name, | ||
| character(len=*), intent(in) | component_input_name, | ||
| character(len=*), intent(in) | input_name, | ||
| integer(i4b), intent(in) | iperblock, | ||
| type(blockparsertype), intent(inout), pointer | parser, | ||
| integer(i4b), intent(in) | iout ) |
Definition at line 66 of file Mf6FileKeystring.f90.
| procedure mf6filekeystringmodule::keystringloadtype::allocate_items | ( | class(keystringloadtype), intent(inout) | this | ) |
Definition at line 72 of file Mf6FileKeystring.f90.
| procedure mf6filekeystringmodule::keystringloadtype::allocate_permanent_array | ( | class(keystringloadtype), intent(inout) | this, |
| character(len=*), intent(in) | name, | ||
| integer(i4b), intent(in) | nfeatures, | ||
| real(dp), intent(in) | init_value ) |
Definition at line 71 of file Mf6FileKeystring.f90.
| procedure mf6filekeystringmodule::keystringloadtype::allocate_subindex | ( | class(keystringloadtype), intent(inout) | this | ) |
Definition at line 70 of file Mf6FileKeystring.f90.
| procedure mf6filekeystringmodule::keystringloadtype::apply_auxiliary | ( | class(keystringloadtype), intent(inout) | this | ) |
Definition at line 74 of file Mf6FileKeystring.f90.
| procedure mf6filekeystringmodule::keystringloadtype::apply_items | ( | class(keystringloadtype), intent(inout) | this | ) |
Definition at line 76 of file Mf6FileKeystring.f90.
| procedure mf6filekeystringmodule::keystringloadtype::apply_subindex | ( | class(keystringloadtype), intent(inout) | this | ) |
Definition at line 75 of file Mf6FileKeystring.f90.
| procedure mf6filekeystringmodule::keystringloadtype::create_structarray | ( | class(keystringloadtype), intent(inout) | this | ) |
Definition at line 82 of file Mf6FileKeystring.f90.
|
inherited |
Definition at line 99 of file InputLoadType.f90.
| procedure mf6filekeystringmodule::keystringloadtype::destroy | ( | class(keystringloadtype), intent(inout) | this | ) |
Definition at line 81 of file Mf6FileKeystring.f90.
|
inherited |
Definition at line 97 of file InputLoadType.f90.
| procedure mf6filekeystringmodule::keystringloadtype::df | ( | class(keystringloadtype), intent(inout) | this | ) |
Definition at line 67 of file Mf6FileKeystring.f90.
|
inherited |
Any managed memory pointed to from model/package context must be allocated when dynamic loader is initialized.
Definition at line 96 of file InputLoadType.f90.
| procedure mf6filekeystringmodule::keystringloadtype::reset | ( | class(keystringloadtype), intent(inout) | this | ) |
Definition at line 80 of file Mf6FileKeystring.f90.
| procedure mf6filekeystringmodule::keystringloadtype::resolve_row_addr | ( | class(keystringloadtype), intent(inout) | this, |
| type(keystringitemtype), intent(in) | item, | ||
| integer(i4b), intent(in) | irow, | ||
| integer(i4b), dimension(:), intent(in), pointer, contiguous | period_ifno, | ||
| integer(i4b), dimension(:, :), intent(in), pointer, contiguous | cellid, | ||
| integer(i4b), intent(in) | ndim, | ||
| character(len=*), intent(in) | leading_tag ) |
| [in] | leading_tag | leading id column's public tag (for the out-of-range message) |
Definition at line 77 of file Mf6FileKeystring.f90.
| procedure mf6filekeystringmodule::keystringloadtype::resolve_subindex_address | ( | class(keystringloadtype), intent(inout) | this, |
| character(len=*), intent(in) | id_mf6varname, | ||
| character(len=*), intent(in) | head_mf6varname, | ||
| integer(i4b), intent(in) | subindex_icol, | ||
| integer(i4b), dimension(:), intent(in) | offsets, | ||
| integer(i4b), intent(in) | nfeatures, | ||
| integer(i4b), intent(in) | nbound ) |
| [in] | subindex_icol | SA column holding the subindex (e.g. IDV) |
Definition at line 79 of file Mf6FileKeystring.f90.
| procedure mf6filekeystringmodule::keystringloadtype::resolve_subindex_offsets | ( | class(keystringloadtype), intent(inout) | this, |
| character(len=*), intent(in) | dimname ) |
Definition at line 78 of file Mf6FileKeystring.f90.
|
pure virtualinherited |
| [in,out] | parser | block parser |
Definition at line 25 of file AsciiInputLoadType.f90.
| procedure mf6filekeystringmodule::keystringloadtype::rp | ( | class(keystringloadtype), intent(inout) | this, |
| type(blockparsertype), intent(inout), pointer | parser ) |
Definition at line 69 of file Mf6FileKeystring.f90.
|
inherited |
Definition at line 98 of file InputLoadType.f90.
| procedure mf6filekeystringmodule::keystringloadtype::ts_advance | ( | class(keystringloadtype), intent(inout) | this | ) |
Definition at line 68 of file Mf6FileKeystring.f90.
|
private |
Definition at line 73 of file Mf6FileKeystring.f90.
|
inherited |
Definition at line 86 of file InputLoadType.f90.
|
inherited |
Definition at line 85 of file InputLoadType.f90.
| type(loadcontexttype) mf6filekeystringmodule::keystringloadtype::ctx |
Definition at line 54 of file Mf6FileKeystring.f90.
|
inherited |
Definition at line 91 of file InputLoadType.f90.
|
inherited |
Definition at line 87 of file InputLoadType.f90.
|
inherited |
Definition at line 93 of file InputLoadType.f90.
|
inherited |
Definition at line 92 of file InputLoadType.f90.
|
inherited |
Definition at line 83 of file InputLoadType.f90.
|
inherited |
Definition at line 84 of file InputLoadType.f90.
| integer(i4b) mf6filekeystringmodule::keystringloadtype::nleading |
Definition at line 57 of file Mf6FileKeystring.f90.
|
inherited |
Definition at line 94 of file InputLoadType.f90.
|
inherited |
Definition at line 88 of file InputLoadType.f90.
|
inherited |
Definition at line 90 of file InputLoadType.f90.
|
inherited |
Definition at line 89 of file InputLoadType.f90.
| type(loadmf6filetype) mf6filekeystringmodule::keystringloadtype::static_loader |
Definition at line 55 of file Mf6FileKeystring.f90.
| type(structarraytype), pointer mf6filekeystringmodule::keystringloadtype::structarray => null() |
Definition at line 53 of file Mf6FileKeystring.f90.
| integer(i4b), dimension(:), allocatable mf6filekeystringmodule::keystringloadtype::subindex_head_icol |
Definition at line 63 of file Mf6FileKeystring.f90.
| integer(i4b), dimension(:), allocatable mf6filekeystringmodule::keystringloadtype::subindex_icol |
Definition at line 62 of file Mf6FileKeystring.f90.
| character(len=lenvarname) mf6filekeystringmodule::keystringloadtype::subindex_id_varname = '' |
Definition at line 64 of file Mf6FileKeystring.f90.
| integer(i4b), dimension(:), allocatable mf6filekeystringmodule::keystringloadtype::subindex_nfeatures |
Definition at line 60 of file Mf6FileKeystring.f90.
| type(intarraytype), dimension(:), allocatable mf6filekeystringmodule::keystringloadtype::subindex_offsets |
Definition at line 61 of file Mf6FileKeystring.f90.
| logical(lgp) mf6filekeystringmodule::keystringloadtype::ts_active |
Definition at line 56 of file Mf6FileKeystring.f90.
| type(timeseriesmanagertype), pointer mf6filekeystringmodule::keystringloadtype::tsmanager => null() |
Definition at line 52 of file Mf6FileKeystring.f90.