MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
Inheritance diagram for gwfhfbmodule::gwfhfbtype:
Inheritance graph
Collaboration diagram for gwfhfbmodule::gwfhfbtype:
Collaboration graph

Public Member Functions

procedure hfb_ar (this, ibound, xt3d, dis, invsc, vsc)
 Allocate and read.
procedure hfb_rp (this)
 Check for new HFB stress period data.
procedure hfb_fc (this, kiter, matrix_sln, idxglo, rhs, hnew)
 Fill matrix terms.
procedure hfb_cq (this, hnew, flowja)
 flowja will automatically include the effects of the hfb for confined and newton cases when xt3d is not used.
procedure hfb_da (this)
 Deallocate memory.
procedure allocate_scalars (this)
 Allocate package scalars.
procedure set_names (this, ibcnum, name_model, pakname, ftype, input_mempath)
 Set package names.
procedure allocate_scalars (this)
 Allocate package scalars.
procedure da (this)
 Deallocate package scalars.
procedure read_check_ionper (this)
 Check ionper.
procedure get_block_data (this, tags, lfound, varinames)
 Read griddata block for a package.

Public Attributes

type(gwfvsctype), pointer vsc => null()
 viscosity object
integer(i4b), pointer maxhfb => null()
 max number of hfb's
integer(i4b), pointer nhfb => null()
 number of hfb's
integer(i4b), dimension(:), pointer, contiguous noden => null()
 first cell
integer(i4b), dimension(:), pointer, contiguous nodem => null()
 second cell
integer(i4b), dimension(:), pointer, contiguous idxloc => null()
 position in model ja
real(dp), dimension(:), pointer, contiguous hydchr => null()
 hydraulic characteristic of the barrier
real(dp), dimension(:), pointer, contiguous csatsav => null()
 value of condsat prior to hfb modification
real(dp), dimension(:), pointer, contiguous condsav => null()
 saved conductance of combined npf and hfb
type(xt3dtype), pointer xt3d => null()
 pointer to xt3d object
integer(i4b), dimension(:), pointer, contiguous ibound => null()
 pointer to model ibound
integer(i4b), dimension(:), pointer, contiguous icelltype => null()
 pointer to model icelltype
integer(i4b), dimension(:), pointer, contiguous ihc => null()
 pointer to model ihc
integer(i4b), dimension(:), pointer, contiguous ia => null()
 pointer to model ia
integer(i4b), dimension(:), pointer, contiguous ja => null()
 pointer to model ja
integer(i4b), dimension(:), pointer, contiguous jas => null()
 pointer to model jas
integer(i4b), dimension(:), pointer, contiguous isym => null()
 pointer to model isym
real(dp), dimension(:), pointer, contiguous condsat => null()
 pointer to model condsat
real(dp), dimension(:), pointer, contiguous top => null()
 pointer to model top
real(dp), dimension(:), pointer, contiguous bot => null()
 pointer to model bot
real(dp), dimension(:), pointer, contiguous hwva => null()
 pointer to model hwva
real(dp), dimension(:), pointer, contiguous hnew => null()
 pointer to model xnew
integer(i4b), pointer ivsc => null()
 flag indicating if viscosity is active in the model
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

Private Member Functions

procedure, private allocate_arrays (this)
 Allocate package arrays.
procedure, private source_options (this)
 Source hfb input options.
procedure, private source_dimensions (this)
 Source hfb input options.
procedure, private source_data (this)
 source hfb period data
procedure, private check_data (this)
 Check the hfb input data.
procedure, private condsat_reset (this)
 Reset condsat to its value prior to being modified by hfb's.
procedure, private condsat_modify (this)
 Modify condsat.

Detailed Description

Definition at line 19 of file gwf-hfb.f90.

Member Function/Subroutine Documentation

◆ allocate_arrays()

procedure, private gwfhfbmodule::gwfhfbtype::allocate_arrays ( class(gwfhfbtype) this)
private

Definition at line 56 of file gwf-hfb.f90.

◆ allocate_scalars() [1/2]

procedure gwfhfbmodule::gwfhfbtype::allocate_scalars ( class(gwfhfbtype) this)

Definition at line 55 of file gwf-hfb.f90.

◆ allocate_scalars() [2/2]

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

Allocate and initialize base numerical package scalars.

Parameters
thisNumericalPackageType object

Definition at line 54 of file NumericalPackage.f90.

◆ check_data()

procedure, private gwfhfbmodule::gwfhfbtype::check_data ( class(gwfhfbtype) this)
private

Check that the two cells of each hfb are connected and that no more than one hfb is assigned to any one cell connection. Store ipos in idxloc.

Definition at line 60 of file gwf-hfb.f90.

◆ condsat_modify()

procedure, private gwfhfbmodule::gwfhfbtype::condsat_modify ( class(gwfhfbtype) this)
private

Modify condsat for the following conditions:

  1. If Newton is active
  2. If icelltype for n and icelltype for m is 0

Definition at line 62 of file gwf-hfb.f90.

◆ condsat_reset()

procedure, private gwfhfbmodule::gwfhfbtype::condsat_reset ( class(gwfhfbtype) this)
private

Definition at line 61 of file gwf-hfb.f90.

◆ da()

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

Deallocate and initialize base numerical package scalars.

Parameters
thisNumericalPackageType 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 )
inherited

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

Parameters
thisNumericalPackageType object
[in]tagsvector with variable tags
[in,out]lfoundboolean vector indicating of a variable tag was found
[in]varinamesoptional vector of variable names

Definition at line 57 of file NumericalPackage.f90.

◆ hfb_ar()

procedure gwfhfbmodule::gwfhfbtype::hfb_ar ( class(gwfhfbtype) this,
integer(i4b), dimension(:), pointer, contiguous ibound,
type(xt3dtype), pointer xt3d,
class(disbasetype), intent(inout), pointer dis,
integer(i4b), pointer invsc,
type(gwfvsctype), intent(in), pointer vsc )
Parameters
[in,out]disdiscretization package
invscindicates if viscosity package is active
[in]vscviscosity package

Definition at line 50 of file gwf-hfb.f90.

◆ hfb_cq()

procedure gwfhfbmodule::gwfhfbtype::hfb_cq ( class(gwfhfbtype) this,
real(dp), dimension(:), intent(inout) hnew,
real(dp), dimension(:), intent(inout) flowja )

This method recalculates flowja for the other cases.

Definition at line 53 of file gwf-hfb.f90.

◆ hfb_da()

procedure gwfhfbmodule::gwfhfbtype::hfb_da ( class(gwfhfbtype) this)

Definition at line 54 of file gwf-hfb.f90.

◆ hfb_fc()

procedure gwfhfbmodule::gwfhfbtype::hfb_fc ( class(gwfhfbtype) this,
integer(i4b) kiter,
class(matrixbasetype), pointer matrix_sln,
integer(i4b), dimension(:), intent(in) idxglo,
real(dp), dimension(:), intent(inout) rhs,
real(dp), dimension(:), intent(inout) hnew )

Fill amatsln for the following conditions:

  1. XT3D OR
  2. Not Newton, and
  3. Cell type n is convertible or cell type m is convertible

Definition at line 52 of file gwf-hfb.f90.

◆ hfb_rp()

procedure gwfhfbmodule::gwfhfbtype::hfb_rp ( class(gwfhfbtype) this)

Definition at line 51 of file gwf-hfb.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]thisNumericalPackageType 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]thisNumericalPackageType object
[in]ibcnumunique package number
[in]name_modelname of the model
[in]paknamename of the package
[in]ftypepackage type

Definition at line 53 of file NumericalPackage.f90.

◆ source_data()

procedure, private gwfhfbmodule::gwfhfbtype::source_data ( class(gwfhfbtype), intent(inout) this)
private

Definition at line 59 of file gwf-hfb.f90.

◆ source_dimensions()

procedure, private gwfhfbmodule::gwfhfbtype::source_dimensions ( class(gwfhfbtype) this)
private

Definition at line 58 of file gwf-hfb.f90.

◆ source_options()

procedure, private gwfhfbmodule::gwfhfbtype::source_options ( class(gwfhfbtype) this)
private

Definition at line 57 of file gwf-hfb.f90.

Member Data Documentation

◆ bot

real(dp), dimension(:), pointer, contiguous gwfhfbmodule::gwfhfbtype::bot => null()

Definition at line 41 of file gwf-hfb.f90.

◆ condsat

real(dp), dimension(:), pointer, contiguous gwfhfbmodule::gwfhfbtype::condsat => null()

Definition at line 39 of file gwf-hfb.f90.

◆ condsav

real(dp), dimension(:), pointer, contiguous gwfhfbmodule::gwfhfbtype::condsav => null()

Definition at line 29 of file gwf-hfb.f90.

◆ csatsav

real(dp), dimension(:), pointer, contiguous gwfhfbmodule::gwfhfbtype::csatsav => null()

Definition at line 28 of file gwf-hfb.f90.

◆ 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.

◆ hnew

real(dp), dimension(:), pointer, contiguous gwfhfbmodule::gwfhfbtype::hnew => null()

Definition at line 43 of file gwf-hfb.f90.

◆ hwva

real(dp), dimension(:), pointer, contiguous gwfhfbmodule::gwfhfbtype::hwva => null()

Definition at line 42 of file gwf-hfb.f90.

◆ hydchr

real(dp), dimension(:), pointer, contiguous gwfhfbmodule::gwfhfbtype::hydchr => null()

Definition at line 27 of file gwf-hfb.f90.

◆ ia

integer(i4b), dimension(:), pointer, contiguous gwfhfbmodule::gwfhfbtype::ia => null()

Definition at line 35 of file gwf-hfb.f90.

◆ iasym

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

Definition at line 41 of file NumericalPackage.f90.

◆ ibound

integer(i4b), dimension(:), pointer, contiguous gwfhfbmodule::gwfhfbtype::ibound => null()

Definition at line 32 of file gwf-hfb.f90.

◆ icelltype

integer(i4b), dimension(:), pointer, contiguous gwfhfbmodule::gwfhfbtype::icelltype => null()

Definition at line 33 of file gwf-hfb.f90.

◆ id

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

Definition at line 37 of file NumericalPackage.f90.

◆ idxloc

integer(i4b), dimension(:), pointer, contiguous gwfhfbmodule::gwfhfbtype::idxloc => null()

Definition at line 26 of file gwf-hfb.f90.

◆ ihc

integer(i4b), dimension(:), pointer, contiguous gwfhfbmodule::gwfhfbtype::ihc => null()

Definition at line 34 of file gwf-hfb.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.

◆ isym

integer(i4b), dimension(:), pointer, contiguous gwfhfbmodule::gwfhfbtype::isym => null()

Definition at line 38 of file gwf-hfb.f90.

◆ ivsc

integer(i4b), pointer gwfhfbmodule::gwfhfbtype::ivsc => null()

Definition at line 46 of file gwf-hfb.f90.

◆ ja

integer(i4b), dimension(:), pointer, contiguous gwfhfbmodule::gwfhfbtype::ja => null()

Definition at line 36 of file gwf-hfb.f90.

◆ jas

integer(i4b), dimension(:), pointer, contiguous gwfhfbmodule::gwfhfbtype::jas => null()

Definition at line 37 of file gwf-hfb.f90.

◆ lastonper

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

Definition at line 46 of file NumericalPackage.f90.

◆ maxhfb

integer(i4b), pointer gwfhfbmodule::gwfhfbtype::maxhfb => null()

Definition at line 22 of file gwf-hfb.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.

◆ nhfb

integer(i4b), pointer gwfhfbmodule::gwfhfbtype::nhfb => null()

Definition at line 23 of file gwf-hfb.f90.

◆ nodem

integer(i4b), dimension(:), pointer, contiguous gwfhfbmodule::gwfhfbtype::nodem => null()

Definition at line 25 of file gwf-hfb.f90.

◆ noden

integer(i4b), dimension(:), pointer, contiguous gwfhfbmodule::gwfhfbtype::noden => null()

Definition at line 24 of file gwf-hfb.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

◆ top

real(dp), dimension(:), pointer, contiguous gwfhfbmodule::gwfhfbtype::top => null()

Definition at line 40 of file gwf-hfb.f90.

◆ vsc

type(gwfvsctype), pointer gwfhfbmodule::gwfhfbtype::vsc => null()

Definition at line 21 of file gwf-hfb.f90.

◆ xt3d

type(xt3dtype), pointer gwfhfbmodule::gwfhfbtype::xt3d => null()

Definition at line 30 of file gwf-hfb.f90.


The documentation for this type was generated from the following file:
  • /home/runner/work/modflow6/modflow6/src/Model/GroundWaterFlow/gwf-hfb.f90