Keystring period block loader. More...

Inheritance diagram for mf6filekeystringmodule::keystringloadtype:

Collaboration diagram for mf6filekeystringmodule::keystringloadtype:

Private Member Functions
procedure	ainit

procedure	df

procedure	ts_advance

procedure	rp

procedure	allocate_subindex

procedure	allocate_permanent_array

procedure	allocate_items

procedure, private	valid_address

procedure	apply_auxiliary

procedure	apply_subindex

procedure	apply_items

procedure	resolve_row_addr

procedure	resolve_subindex_offsets

procedure	resolve_subindex_address

procedure	reset

procedure	destroy

procedure	create_structarray

procedure	init => dynamic_init

Private Attributes
type(timeseriesmanagertype), pointer	tsmanager => null()

type(structarraytype), pointer	structarray => null()

type(loadcontexttype)	ctx
	input load context More...

type(loadmf6filetype)	static_loader
	persistent static loader More...

logical(lgp)	ts_active
	.true. if TS files are loaded More...

integer(i4b)	nleading
	number of leading (pre-keystring) columns More...

integer(i4b), dimension(:), allocatable	subindex_nfeatures
	per-column feature count (0 = n/a) More...

type(intarraytype), dimension(:), allocatable	subindex_offsets
	per-column offset table More...

integer(i4b), dimension(:), allocatable	subindex_icol
	per-column subindex SA column More...

integer(i4b), dimension(:), allocatable	subindex_head_icol
	per-column subindex head SA column More...

character(len=lenvarname)	subindex_id_varname = ''
	leading column's mf6varname More...

type(modflowinputtype)	mf6_input
	description of modflow6 input More...

type(ncpackagevarstype), pointer	nc_vars => null()

character(len=lencomponentname)	component_name
	name of component More...

character(len=linelength)	component_input_name
	component input name, e.g. model name file More...

character(len=linelength)	input_name
	input name, e.g. package *.chd file More...

character(len=linelength), dimension(:), allocatable	param_names
	dynamic param tagnames More...

logical(lgp)	readasarrays
	readasarrays style input package More...

logical(lgp)	readarraygrid
	readarraygrid style input package More...

logical(lgp)	has_keystring
	period block uses keystring-based dispatch More...

integer(i4b)	iperblock
	index of period block on block definition list More...

integer(i4b)	iout
	inunit number for logging More...

integer(i4b)	nparam
	number of in scope params More...

Detailed Description

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.

Member Function/Subroutine Documentation

◆ ainit()

procedure mf6filekeystringmodule::keystringloadtype::ainit

private

Definition at line 66 of file Mf6FileKeystring.f90.

◆ allocate_items()

procedure mf6filekeystringmodule::keystringloadtype::allocate_items

private

Definition at line 72 of file Mf6FileKeystring.f90.

◆ allocate_permanent_array()

procedure mf6filekeystringmodule::keystringloadtype::allocate_permanent_array

private

Definition at line 71 of file Mf6FileKeystring.f90.

◆ allocate_subindex()

procedure mf6filekeystringmodule::keystringloadtype::allocate_subindex

private

Definition at line 70 of file Mf6FileKeystring.f90.

◆ apply_auxiliary()

procedure mf6filekeystringmodule::keystringloadtype::apply_auxiliary

private

Definition at line 74 of file Mf6FileKeystring.f90.

◆ apply_items()

procedure mf6filekeystringmodule::keystringloadtype::apply_items

private

Definition at line 76 of file Mf6FileKeystring.f90.

◆ apply_subindex()

procedure mf6filekeystringmodule::keystringloadtype::apply_subindex

private

Definition at line 75 of file Mf6FileKeystring.f90.

◆ create_structarray()

procedure mf6filekeystringmodule::keystringloadtype::create_structarray

private

Definition at line 82 of file Mf6FileKeystring.f90.

◆ destroy()

procedure mf6filekeystringmodule::keystringloadtype::destroy

private

Definition at line 81 of file Mf6FileKeystring.f90.

◆ df()

procedure mf6filekeystringmodule::keystringloadtype::df

private

Definition at line 67 of file Mf6FileKeystring.f90.

◆ init()

procedure inputloadtypemodule::dynamicpkgloadtype::init

privateinherited

Definition at line 96 of file InputLoadType.f90.

◆ reset()

procedure mf6filekeystringmodule::keystringloadtype::reset

private

Definition at line 80 of file Mf6FileKeystring.f90.

◆ resolve_row_addr()

procedure mf6filekeystringmodule::keystringloadtype::resolve_row_addr

private

Definition at line 77 of file Mf6FileKeystring.f90.

◆ resolve_subindex_address()

procedure mf6filekeystringmodule::keystringloadtype::resolve_subindex_address

private

Definition at line 79 of file Mf6FileKeystring.f90.

◆ resolve_subindex_offsets()

procedure mf6filekeystringmodule::keystringloadtype::resolve_subindex_offsets

private

Definition at line 78 of file Mf6FileKeystring.f90.

◆ rp()

procedure mf6filekeystringmodule::keystringloadtype::rp

private

Definition at line 69 of file Mf6FileKeystring.f90.

◆ ts_advance()

procedure mf6filekeystringmodule::keystringloadtype::ts_advance

private

Definition at line 68 of file Mf6FileKeystring.f90.

◆ valid_address()

procedure, private mf6filekeystringmodule::keystringloadtype::valid_address

private

Definition at line 73 of file Mf6FileKeystring.f90.

Member Data Documentation

◆ component_input_name

character(len=linelength) inputloadtypemodule::dynamicpkgloadtype::component_input_name

privateinherited

Definition at line 86 of file InputLoadType.f90.

86 character(len=LINELENGTH) :: component_input_name !< component input name, e.g. model name file

◆ component_name

character(len=lencomponentname) inputloadtypemodule::dynamicpkgloadtype::component_name

privateinherited

Definition at line 85 of file InputLoadType.f90.

85 character(len=LENCOMPONENTNAME) :: component_name !< name of component

◆ ctx

type(loadcontexttype) mf6filekeystringmodule::keystringloadtype::ctx

private

Definition at line 54 of file Mf6FileKeystring.f90.

54 type(LoadContextType) :: ctx !< input load context

◆ has_keystring

logical(lgp) inputloadtypemodule::dynamicpkgloadtype::has_keystring

privateinherited

Definition at line 91 of file InputLoadType.f90.

91 logical(LGP) :: has_keystring !< period block uses keystring-based dispatch

◆ input_name

character(len=linelength) inputloadtypemodule::dynamicpkgloadtype::input_name

privateinherited

Definition at line 87 of file InputLoadType.f90.

87 character(len=LINELENGTH) :: input_name !< input name, e.g. package *.chd file

◆ iout

integer(i4b) inputloadtypemodule::dynamicpkgloadtype::iout

privateinherited

Definition at line 93 of file InputLoadType.f90.

93 integer(I4B) :: iout !< inunit number for logging

◆ iperblock

integer(i4b) inputloadtypemodule::dynamicpkgloadtype::iperblock

privateinherited

Definition at line 92 of file InputLoadType.f90.

92 integer(I4B) :: iperblock !< index of period block on block definition list

◆ mf6_input

type(modflowinputtype) inputloadtypemodule::dynamicpkgloadtype::mf6_input

privateinherited

Definition at line 83 of file InputLoadType.f90.

83 type(ModflowInputType) :: mf6_input !< description of modflow6 input

◆ nc_vars

type(ncpackagevarstype), pointer inputloadtypemodule::dynamicpkgloadtype::nc_vars => null()

privateinherited

Definition at line 84 of file InputLoadType.f90.

84 type(NCPackageVarsType), pointer :: nc_vars => null()

◆ nleading

integer(i4b) mf6filekeystringmodule::keystringloadtype::nleading

private

Definition at line 57 of file Mf6FileKeystring.f90.

57 integer(I4B) :: nleading !< number of leading (pre-keystring) columns

◆ nparam

integer(i4b) inputloadtypemodule::dynamicpkgloadtype::nparam

privateinherited

Definition at line 94 of file InputLoadType.f90.

94 integer(I4B) :: nparam !< number of in scope params

◆ param_names

character(len=linelength), dimension(:), allocatable inputloadtypemodule::dynamicpkgloadtype::param_names

privateinherited

Definition at line 88 of file InputLoadType.f90.

88 character(len=LINELENGTH), dimension(:), allocatable :: param_names !< dynamic param tagnames

◆ readarraygrid

logical(lgp) inputloadtypemodule::dynamicpkgloadtype::readarraygrid

privateinherited

Definition at line 90 of file InputLoadType.f90.

90 logical(LGP) :: readarraygrid !< readarraygrid style input package

◆ readasarrays

logical(lgp) inputloadtypemodule::dynamicpkgloadtype::readasarrays

privateinherited

Definition at line 89 of file InputLoadType.f90.

89 logical(LGP) :: readasarrays !< readasarrays style input package

◆ static_loader

type(loadmf6filetype) mf6filekeystringmodule::keystringloadtype::static_loader

private

Definition at line 55 of file Mf6FileKeystring.f90.

55 type(LoadMf6FileType) :: static_loader !< persistent static loader

◆ structarray

type(structarraytype), pointer mf6filekeystringmodule::keystringloadtype::structarray => null()

private

Definition at line 53 of file Mf6FileKeystring.f90.

53 type(StructArrayType), pointer :: structarray => null()

◆ subindex_head_icol

integer(i4b), dimension(:), allocatable mf6filekeystringmodule::keystringloadtype::subindex_head_icol

private

Definition at line 63 of file Mf6FileKeystring.f90.

63 integer(I4B), dimension(:), allocatable :: subindex_head_icol !< per-column subindex head SA column

◆ subindex_icol

integer(i4b), dimension(:), allocatable mf6filekeystringmodule::keystringloadtype::subindex_icol

private

Definition at line 62 of file Mf6FileKeystring.f90.

62 integer(I4B), dimension(:), allocatable :: subindex_icol !< per-column subindex SA column

◆ subindex_id_varname

character(len=lenvarname) mf6filekeystringmodule::keystringloadtype::subindex_id_varname = ''

private

Definition at line 64 of file Mf6FileKeystring.f90.

64 character(len=LENVARNAME) :: subindex_id_varname = '' !< leading column's mf6varname

◆ subindex_nfeatures

integer(i4b), dimension(:), allocatable mf6filekeystringmodule::keystringloadtype::subindex_nfeatures

private

Definition at line 60 of file Mf6FileKeystring.f90.

60 integer(I4B), dimension(:), allocatable :: subindex_nfeatures !< per-column feature count (0 = n/a)

◆ subindex_offsets

type(intarraytype), dimension(:), allocatable mf6filekeystringmodule::keystringloadtype::subindex_offsets

private

Definition at line 61 of file Mf6FileKeystring.f90.

61 type(IntArrayType), dimension(:), allocatable :: subindex_offsets !< per-column offset table

◆ ts_active

logical(lgp) mf6filekeystringmodule::keystringloadtype::ts_active

private

Definition at line 56 of file Mf6FileKeystring.f90.

56 logical(LGP) :: ts_active !< .true. if TS files are loaded

◆ tsmanager

type(timeseriesmanagertype), pointer mf6filekeystringmodule::keystringloadtype::tsmanager => null()

private

Definition at line 52 of file Mf6FileKeystring.f90.

52 type(TimeSeriesManagerType), pointer :: tsmanager => null()

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

/home/runner/work/modflow6/modflow6/src/Utilities/Idm/mf6blockfile/Mf6FileKeystring.f90

Private Member Functions

Private Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ ainit()

◆ allocate_items()

◆ allocate_permanent_array()

◆ allocate_subindex()

◆ apply_auxiliary()

◆ apply_items()

◆ apply_subindex()

◆ create_structarray()

◆ destroy()

◆ df()

◆ init()

◆ reset()

◆ resolve_row_addr()

◆ resolve_subindex_address()

◆ resolve_subindex_offsets()

◆ rp()

◆ ts_advance()

◆ valid_address()

Member Data Documentation

◆ component_input_name

◆ component_name

◆ ctx

◆ has_keystring

◆ input_name

◆ iout

◆ iperblock

◆ mf6_input

◆ nc_vars

◆ nleading

◆ nparam

◆ param_names

◆ readarraygrid

◆ readasarrays

◆ static_loader

◆ structarray

◆ subindex_head_icol

◆ subindex_icol

◆ subindex_id_varname

◆ subindex_nfeatures

◆ subindex_offsets

◆ ts_active

◆ tsmanager