numericalpackagemodule::numericalpackagetype Type Reference

Inheritance diagram for numericalpackagemodule::numericalpackagetype:

Collaboration diagram for numericalpackagemodule::numericalpackagetype:

Public Member Functions
procedure	set_names (this, ibcnum, name_model, pakname, ftype, input_mempath)
	@ brief Set package names
procedure	allocate_scalars (this)
	@ brief Allocate package scalars
procedure	da (this)
	@ brief Deallocate package scalars
procedure	read_check_ionper (this)
	@ brief Check ionper
procedure	get_block_data (this, tags, lfound, varinames)
	@ brief Read griddata block for a package

Public Attributes
character(len=lenmodelname)	name_model = ''
	the name of the model that contains this package
character(len=lenpackagename)	packname = ''
	name of the package
character(len=lenmempath)	memorypath = ''
	the location in the memory manager where the variables are stored
character(len=lenmempath)	memorypathmodel = ''
	the location in the memory manager where the variables of the parent model are stored
character(len=lenmempath)	input_mempath = ''
	input context mempath
character(len=linelength), pointer	input_fname => null()
	input file name
character(len=lenftype)	filtyp = ''
	file type (CHD, DRN, RIV, etc.)
character(len=lenftype), pointer	package_type => null()
	package type (same as filtyp) stored in memory manager
integer(i4b), pointer	id => null()
	consecutive package number in model
integer(i4b), pointer	inunit => null()
	unit number for input file
integer(i4b), pointer	iout => null()
	unit number for writing package output
integer(i4b), pointer	inewton => null()
	newton flag
integer(i4b), pointer	iasym => null()
	package causes matrix asymmetry
integer(i4b), pointer	iprpak => null()
	integer flag to echo input
integer(i4b), pointer	iprflow => null()
	flag to print simulated flows
integer(i4b), pointer	ipakcb => null()
	output flows (-1, 0, 1) - save_flows
integer(i4b), pointer	ionper => null()
	stress period for next data
integer(i4b), pointer	lastonper => null()
	last value of ionper (for checking)
type(blockparsertype)	parser
	parser object for reading blocks of information
class(disbasetype), pointer	dis => null()
	model discretization object

Detailed Description

Definition at line 23 of file NumericalPackage.f90.

Member Function/Subroutine Documentation

allocate_scalars()

procedure numericalpackagemodule::numericalpackagetype::allocate_scalars

(

class(numericalpackagetype)

this

)

Allocate and initialize base numerical package scalars.

Parameters

this	NumericalPackageType object

Definition at line 54 of file NumericalPackage.f90.

da()

procedure numericalpackagemodule::numericalpackagetype::da

(

class(numericalpackagetype)

this

)

Deallocate and initialize base numerical package scalars.

Parameters

this	NumericalPackageType object

Definition at line 55 of file NumericalPackage.f90.

get_block_data()

procedure numericalpackagemodule::numericalpackagetype::get_block_data	(	class(numericalpackagetype)	this,
		character(len=24), dimension(:), intent(in)	tags,
		logical, dimension(:), intent(inout)	lfound,
		character(len=24), dimension(:), intent(in), optional	varinames )

Generic method to read data in the GRIDDATA block for a package.

Parameters

	this	NumericalPackageType object
[in]	tags	vector with variable tags
[in,out]	lfound	boolean vector indicating of a variable tag was found
[in]	varinames	optional vector of variable names

Definition at line 57 of file NumericalPackage.f90.

read_check_ionper()

procedure numericalpackagemodule::numericalpackagetype::read_check_ionper

(

class(numericalpackagetype), intent(inout)

this

)

Generic method to read and check ionperiod, which is used to determine if new period data should be read from the input file. The check of ionperiod also makes sure periods are increasing in subsequent period data blocks.

Parameters

[in,out]

this

NumericalPackageType object

Definition at line 56 of file NumericalPackage.f90.

set_names()

procedure numericalpackagemodule::numericalpackagetype::set_names	(	class(numericalpackagetype), intent(inout)	this,
		integer(i4b), intent(in)	ibcnum,
		character(len=*), intent(in)	name_model,
		character(len=*), intent(in)	pakname,
		character(len=*), intent(in)	ftype,
		character(len=*), intent(in), optional	input_mempath )

Method to assign the filtyp (ftype), the model name, and package name for a package. This method also creates the memoryPath and memoryPathModel that is used by the memory manager when variables are allocated.

Parameters

[in,out]	this	NumericalPackageType object
[in]	ibcnum	unique package number
[in]	name_model	name of the model
[in]	pakname	name of the package
[in]	ftype	package type

Definition at line 53 of file NumericalPackage.f90.

Member Data Documentation

dis

class(disbasetype), pointer numericalpackagemodule::numericalpackagetype::dis => null()

Definition at line 50 of file NumericalPackage.f90.

filtyp

character(len=lenftype) numericalpackagemodule::numericalpackagetype::filtyp = ''

Definition at line 33 of file NumericalPackage.f90.

iasym

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::iasym => null()

Definition at line 41 of file NumericalPackage.f90.

id

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::id => null()

Definition at line 37 of file NumericalPackage.f90.

inewton

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::inewton => null()

Definition at line 40 of file NumericalPackage.f90.

input_fname

character(len=linelength), pointer numericalpackagemodule::numericalpackagetype::input_fname => null()

Definition at line 32 of file NumericalPackage.f90.

input_mempath

character(len=lenmempath) numericalpackagemodule::numericalpackagetype::input_mempath = ''

Definition at line 31 of file NumericalPackage.f90.

inunit

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::inunit => null()

Definition at line 38 of file NumericalPackage.f90.

ionper

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::ionper => null()

Definition at line 45 of file NumericalPackage.f90.

iout

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::iout => null()

Definition at line 39 of file NumericalPackage.f90.

ipakcb

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::ipakcb => null()

Definition at line 44 of file NumericalPackage.f90.

iprflow

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::iprflow => null()

Definition at line 43 of file NumericalPackage.f90.

iprpak

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::iprpak => null()

Definition at line 42 of file NumericalPackage.f90.

lastonper

integer(i4b), pointer numericalpackagemodule::numericalpackagetype::lastonper => null()

Definition at line 46 of file NumericalPackage.f90.

memorypath

character(len=lenmempath) numericalpackagemodule::numericalpackagetype::memorypath = ''

Definition at line 28 of file NumericalPackage.f90.

memorypathmodel

character(len=lenmempath) numericalpackagemodule::numericalpackagetype::memorypathmodel = ''

Definition at line 29 of file NumericalPackage.f90.

name_model

character(len=lenmodelname) numericalpackagemodule::numericalpackagetype::name_model = ''

Definition at line 26 of file NumericalPackage.f90.

package_type

character(len=lenftype), pointer numericalpackagemodule::numericalpackagetype::package_type => null()

Definition at line 34 of file NumericalPackage.f90.

packname

character(len=lenpackagename) numericalpackagemodule::numericalpackagetype::packname = ''

Definition at line 27 of file NumericalPackage.f90.

parser

type(blockparsertype) numericalpackagemodule::numericalpackagetype::parser

Definition at line 49 of file NumericalPackage.f90.

    type(BlockParserType) :: parser !< parser object for reading blocks of information

---

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

• /home/runner/work/modflow6/modflow6/src/Model/NumericalPackage.f90