Inheritance diagram for swfcxsmodule::swfcxstype:

Collaboration diagram for swfcxsmodule::swfcxstype:

Public Member Functions
procedure	allocate_scalars (this)
	@ brief Allocate scalars
procedure	allocate_arrays (this)
	allocate memory for arrays
procedure	source_options (this)
	Copy options from IDM into package.
procedure	log_options (this, found)
	Write user options to list file.
procedure	source_dimensions (this)
	Copy options from IDM into package.
procedure	log_dimensions (this, found)
	Write user options to list file.
procedure	source_packagedata (this)
	Copy options from IDM into package.
procedure	log_packagedata (this, found)
	Write user packagedata to list file.
procedure	check_packagedata (this)
	Check packagedata.
procedure	source_crosssectiondata (this)
	Copy options from IDM into package.
procedure	check_crosssectiondata (this, ifno)
	Check crosssectiondata IFNO against PACKAGEDATA section groupings.
procedure	log_crosssectiondata (this, found)
	Write user packagedata to list file.
procedure	cxs_da (this)
	deallocate memory
procedure	get_cross_section_info (this, idcxs, i0, i1, npts, icalcmeth)
procedure	get_area (this, idcxs, width, depth)
procedure	get_wetted_perimeter (this, idcxs, width, depth)
procedure	get_roughness (this, idcxs, width, depth, rough, slope)
procedure	get_conveyance (this, idcxs, width, depth, rough)
	Calculate and return conveyance.
procedure	get_hydraulic_radius (this, idcxs, width, depth, area)
procedure	get_wetted_top_width (this, idcxs, width, depth)
procedure	get_maximum_top_width (this, idcxs, width)
procedure	write_cxs_table (this, idcxs, width, slope, rough, unitconv)
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
integer(i4b), pointer	nsections => null()
	number of cross section
integer(i4b), pointer	npoints => null()
	total number of cross-section points
integer(i4b), dimension(:), pointer, contiguous	idcxs => null()
	cross section id number, size nsections
integer(i4b), dimension(:), pointer, contiguous	nxspoints => null()
	number of cross section points for section, size nsections
real(dp), dimension(:), pointer, contiguous	xfraction => null()
	cross-section relative x distance, of size npoints
real(dp), dimension(:), pointer, contiguous	height => null()
	cross-section heights, of size npoints
real(dp), dimension(:), pointer, contiguous	manfraction => null()
	cross-section roughness data, of size npoints
integer(i4b), dimension(:), pointer, contiguous	iacross => null()
	pointers to cross-section data for each section, of size nsections + 1
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 45 of file swf-cxs.f90.

Member Function/Subroutine Documentation

◆ allocate_arrays()

procedure swfcxsmodule::swfcxstype::allocate_arrays ( class(swfcxstype) this )

Definition at line 62 of file swf-cxs.f90.

◆ allocate_scalars() [1/2]

procedure numericalpackagemodule::numericalpackagetype::allocate_scalars ( class(numericalpackagetype) this )

inherited

Allocate and initialize base numerical package scalars.

Parameters

this	NumericalPackageType object

Definition at line 54 of file NumericalPackage.f90.

◆ allocate_scalars() [2/2]

procedure swfcxsmodule::swfcxstype::allocate_scalars ( class(swfcxstype) this )

Allocate and initialize scalars for the package. The base model allocate scalars method is also called.

Definition at line 61 of file swf-cxs.f90.

◆ check_crosssectiondata()

procedure swfcxsmodule::swfcxstype::check_crosssectiondata	(	class(swfcxstype)	this,
		integer(i4b), dimension(:), intent(in)	ifno )

Parameters

	this	this instance
[in]	ifno	cross section number for each point

Definition at line 71 of file swf-cxs.f90.

◆ check_packagedata()

procedure swfcxsmodule::swfcxstype::check_packagedata ( class(swfcxstype) this )

Parameters

this	this instance

Definition at line 69 of file swf-cxs.f90.

◆ cxs_da()

procedure swfcxsmodule::swfcxstype::cxs_da ( class(swfcxstype) this )

Definition at line 73 of file swf-cxs.f90.

◆ da()

procedure numericalpackagemodule::numericalpackagetype::da ( class(numericalpackagetype) this )

inherited

Deallocate and initialize base numerical package scalars.

Parameters

this	NumericalPackageType object

Definition at line 55 of file NumericalPackage.f90.

◆ get_area()

procedure swfcxsmodule::swfcxstype::get_area	(	class(swfcxstype)	this,
		integer(i4b), intent(in)	idcxs,
		real(dp), intent(in)	width,
		real(dp), intent(in)	depth )

Parameters

[in]	idcxs	cross section id
[in]	width	width in reach
[in]	depth	stage in reach

Definition at line 75 of file swf-cxs.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 )

inherited

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.

◆ get_conveyance()

procedure swfcxsmodule::swfcxstype::get_conveyance	(	class(swfcxstype)	this,
		integer(i4b), intent(in)	idcxs,
		real(dp), intent(in)	width,
		real(dp), intent(in)	depth,
		real(dp), intent(in)	rough )

Conveyance = area * hydraulic_radius ** (2/3) / mannings_roughness If idcxs = 0 (no cross section specified) then reach is

Parameters

[in]	idcxs	cross section id
[in]	width	width in reach
[in]	depth	stage in reach
[in]	rough	mannings value provided for the reach

Returns: calculated composite roughness

Definition at line 78 of file swf-cxs.f90.

◆ get_cross_section_info()

procedure swfcxsmodule::swfcxstype::get_cross_section_info	(	class(swfcxstype)	this,
		integer(i4b), intent(in)	idcxs,
		integer(i4b), intent(inout)	i0,
		integer(i4b), intent(inout)	i1,
		integer(i4b), intent(inout)	npts,
		integer(i4b), intent(inout)	icalcmeth )

Parameters

[in]	idcxs	cross section id number
[in,out]	i0	starting cross section point number
[in,out]	i1	ending cross section point number
[in,out]	npts	number of points in cross section
[in,out]	icalcmeth	calculation method for mannings roughness

Definition at line 74 of file swf-cxs.f90.

◆ get_hydraulic_radius()

procedure swfcxsmodule::swfcxstype::get_hydraulic_radius	(	class(swfcxstype)	this,
		integer(i4b), intent(in)	idcxs,
		real(dp), intent(in)	width,
		real(dp), intent(in)	depth,
		real(dp), intent(in), optional	area )

Parameters

[in]	idcxs	cross section id
[in]	width	width in reach
[in]	depth	stage in reach
[in]	area	area of the reach

Returns: calculated hydraulic radius

Definition at line 79 of file swf-cxs.f90.

◆ get_maximum_top_width()

procedure swfcxsmodule::swfcxstype::get_maximum_top_width	(	class(swfcxstype)	this,
		integer(i4b), intent(in)	idcxs,
		real(dp), intent(in)	width )

Parameters

[in]	idcxs	cross section id
[in]	width	width in reach

Returns: calculated hydraulic radius

Definition at line 81 of file swf-cxs.f90.

◆ get_roughness()

procedure swfcxsmodule::swfcxstype::get_roughness	(	class(swfcxstype)	this,
		integer(i4b), intent(in)	idcxs,
		real(dp), intent(in)	width,
		real(dp), intent(in)	depth,
		real(dp), intent(in)	rough,
		real(dp), intent(in)	slope )

Parameters

[in]	idcxs	cross section id
[in]	width	width in reach
[in]	depth	stage in reach
[in]	rough	mannings value provided for the reach
[in]	slope	slope value provided for the reach

Returns: calculated composite roughness

Definition at line 77 of file swf-cxs.f90.

◆ get_wetted_perimeter()

procedure swfcxsmodule::swfcxstype::get_wetted_perimeter	(	class(swfcxstype)	this,
		integer(i4b), intent(in)	idcxs,
		real(dp), intent(in)	width,
		real(dp), intent(in)	depth )

Parameters

[in]	idcxs	cross section id
[in]	width	width in reach
[in]	depth	stage in reach

Definition at line 76 of file swf-cxs.f90.

◆ get_wetted_top_width()

procedure swfcxsmodule::swfcxstype::get_wetted_top_width	(	class(swfcxstype)	this,
		integer(i4b), intent(in)	idcxs,
		real(dp), intent(in)	width,
		real(dp), intent(in)	depth )

Parameters

[in]	idcxs	cross section id
[in]	width	width in reach
[in]	depth	stage in reach

Returns: calculated hydraulic radius

Definition at line 80 of file swf-cxs.f90.

◆ log_crosssectiondata()

procedure swfcxsmodule::swfcxstype::log_crosssectiondata	(	class(swfcxstype)	this,
		type(cxscrosssectiondatafoundtype), intent(in)	found )

Definition at line 72 of file swf-cxs.f90.

◆ log_dimensions()

procedure swfcxsmodule::swfcxstype::log_dimensions	(	class(swfcxstype)	this,
		type(cxsdimensionsfoundtype), intent(in)	found )

Definition at line 66 of file swf-cxs.f90.

◆ log_options()

procedure swfcxsmodule::swfcxstype::log_options	(	class(swfcxstype)	this,
		type(cxsoptionsfoundtype), intent(in)	found )

Definition at line 64 of file swf-cxs.f90.

◆ log_packagedata()

procedure swfcxsmodule::swfcxstype::log_packagedata	(	class(swfcxstype)	this,
		type(cxspackagedatafoundtype), intent(in)	found )

Definition at line 68 of file swf-cxs.f90.

◆ read_check_ionper()

procedure numericalpackagemodule::numericalpackagetype::read_check_ionper ( class(numericalpackagetype), intent(inout) this )

inherited

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 )

inherited

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.

◆ source_crosssectiondata()

procedure swfcxsmodule::swfcxstype::source_crosssectiondata ( class(swfcxstype) this )

Definition at line 70 of file swf-cxs.f90.

◆ source_dimensions()

procedure swfcxsmodule::swfcxstype::source_dimensions ( class(swfcxstype) this )

Definition at line 65 of file swf-cxs.f90.

◆ source_options()

procedure swfcxsmodule::swfcxstype::source_options ( class(swfcxstype) this )

Definition at line 63 of file swf-cxs.f90.

◆ source_packagedata()

procedure swfcxsmodule::swfcxstype::source_packagedata ( class(swfcxstype) this )

Definition at line 67 of file swf-cxs.f90.

◆ write_cxs_table()

procedure swfcxsmodule::swfcxstype::write_cxs_table	(	class(swfcxstype)	this,
		integer(i4b), intent(in)	idcxs,
		real(dp), intent(in)	width,
		real(dp), intent(in)	slope,
		real(dp), intent(in)	rough,
		real(dp), intent(in)	unitconv )

Definition at line 82 of file swf-cxs.f90.

Member Data Documentation

◆ dis

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

inherited

Definition at line 50 of file NumericalPackage.f90.

◆ filtyp

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

inherited

Definition at line 33 of file NumericalPackage.f90.

◆ height

real(dp), dimension(:), pointer, contiguous swfcxsmodule::swfcxstype::height => null()

Definition at line 53 of file swf-cxs.f90.

◆ iacross

integer(i4b), dimension(:), pointer, contiguous swfcxsmodule::swfcxstype::iacross => null()

Definition at line 57 of file swf-cxs.f90.

◆ iasym

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

inherited

Definition at line 41 of file NumericalPackage.f90.

◆ id

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

inherited

Definition at line 37 of file NumericalPackage.f90.

◆ idcxs

integer(i4b), dimension(:), pointer, contiguous swfcxsmodule::swfcxstype::idcxs => null()

Definition at line 50 of file swf-cxs.f90.

◆ inewton

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

inherited

Definition at line 40 of file NumericalPackage.f90.

◆ input_fname

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

inherited

Definition at line 32 of file NumericalPackage.f90.

◆ input_mempath

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

inherited

Definition at line 31 of file NumericalPackage.f90.

◆ inunit

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

inherited

Definition at line 38 of file NumericalPackage.f90.

◆ ionper

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

inherited

Definition at line 45 of file NumericalPackage.f90.

◆ iout

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

inherited

Definition at line 39 of file NumericalPackage.f90.

◆ ipakcb

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

inherited

Definition at line 44 of file NumericalPackage.f90.

◆ iprflow

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

inherited

Definition at line 43 of file NumericalPackage.f90.

◆ iprpak

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

inherited

Definition at line 42 of file NumericalPackage.f90.

◆ lastonper

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

inherited

Definition at line 46 of file NumericalPackage.f90.

◆ manfraction

real(dp), dimension(:), pointer, contiguous swfcxsmodule::swfcxstype::manfraction => null()

Definition at line 54 of file swf-cxs.f90.

◆ memorypath

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

inherited

Definition at line 28 of file NumericalPackage.f90.

◆ memorypathmodel

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

inherited

Definition at line 29 of file NumericalPackage.f90.

◆ name_model

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

inherited

Definition at line 26 of file NumericalPackage.f90.

◆ npoints

integer(i4b), pointer swfcxsmodule::swfcxstype::npoints => null()

Definition at line 49 of file swf-cxs.f90.

◆ nsections

integer(i4b), pointer swfcxsmodule::swfcxstype::nsections => null()

Definition at line 48 of file swf-cxs.f90.

◆ nxspoints

integer(i4b), dimension(:), pointer, contiguous swfcxsmodule::swfcxstype::nxspoints => null()

Definition at line 51 of file swf-cxs.f90.

◆ package_type

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

inherited

Definition at line 34 of file NumericalPackage.f90.

◆ packname

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

inherited

Definition at line 27 of file NumericalPackage.f90.

◆ parser

type(blockparsertype) numericalpackagemodule::numericalpackagetype::parser

inherited

Definition at line 49 of file NumericalPackage.f90.

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

◆ xfraction

real(dp), dimension(:), pointer, contiguous swfcxsmodule::swfcxstype::xfraction => null()

Definition at line 52 of file swf-cxs.f90.

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

/home/runner/work/modflow6/modflow6/src/Model/SurfaceWaterFlow/swf-cxs.f90

Public Member Functions

Public Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ allocate_arrays()

◆ allocate_scalars() [1/2]

◆ allocate_scalars() [2/2]

◆ check_crosssectiondata()

◆ check_packagedata()

◆ cxs_da()

◆ da()

◆ get_area()

◆ get_block_data()

◆ get_conveyance()

◆ get_cross_section_info()

◆ get_hydraulic_radius()

◆ get_maximum_top_width()

◆ get_roughness()

◆ get_wetted_perimeter()

◆ get_wetted_top_width()

◆ log_crosssectiondata()

◆ log_dimensions()

◆ log_options()

◆ log_packagedata()

◆ read_check_ionper()

◆ set_names()

◆ source_crosssectiondata()

◆ source_dimensions()

◆ source_options()

◆ source_packagedata()

◆ write_cxs_table()

Member Data Documentation

◆ dis

◆ filtyp

◆ height

◆ iacross

◆ iasym

◆ id

◆ idcxs

◆ inewton

◆ input_fname

◆ input_mempath

◆ inunit

◆ ionper

◆ iout

◆ ipakcb

◆ iprflow

◆ iprpak

◆ lastonper

◆ manfraction

◆ memorypath

◆ memorypathmodel

◆ name_model

◆ npoints

◆ nsections

◆ nxspoints

◆ package_type

◆ packname

◆ parser

◆ xfraction