Data Types
type	gwemodeltype

Functions/Subroutines
subroutine, public	gwe_cr (filename, id, modelname)
	Create a new groundwater energy transport model object. More...

subroutine	gwe_df (this)
	Define packages of the GWE model. More...

subroutine	gwe_ac (this, sparse)
	Add the internal connections of this model to the sparse matrix. More...

subroutine	gwe_mc (this, matrix_sln)
	Map the positions of the GWE model connections in the numerical solution coefficient matrix. More...

subroutine	gwe_ar (this)
	GWE Model Allocate and Read. More...

subroutine	gwe_rp (this)
	GWE Model Read and Prepare. More...

subroutine	gwe_dt (this)
	GWT Model time step size. More...

subroutine	gwe_ad (this)
	GWE Model Time Step Advance. More...

subroutine	gwe_cf (this, kiter)
	GWE Model calculate coefficients. More...

subroutine	gwe_fc (this, kiter, matrix_sln, inwtflag)
	GWE Model fill coefficients. More...

subroutine	gwe_cc (this, innertot, kiter, iend, icnvgmod, cpak, ipak, dpak)
	GWE Model Final Convergence Check. More...

subroutine	gwe_cq (this, icnvg, isuppress_output)
	GWE Model calculate flow. More...

subroutine	gwe_bd (this, icnvg, isuppress_output)
	GWE Model Budget. More...

subroutine	gwe_ot_flow (this, icbcfl, ibudfl, icbcun)
	GWE model output routine. More...

subroutine	gwe_da (this)
	Deallocate. More...

subroutine	gwe_bdentry (this, budterm, budtxt, rowlabel)
	GroundWater Energy Transport Model Budget Entry. More...

integer(i4b) function	gwe_get_iasym (this)
	return 1 if any package causes the matrix to be asymmetric. Otherwise return 0. More...

subroutine	allocate_scalars (this, modelname)
	Allocate memory for non-allocatable members. More...

subroutine	package_create (this, filtyp, ipakid, ipaknum, pakname, mempath, inunit, iout)
	Create boundary condition packages for this model. More...

class(gwemodeltype) function, pointer, public	castasgwemodel (model)
	Cast to GweModelType. More...

subroutine	create_bndpkgs (this, bndpkgs, pkgtypes, pkgnames, mempaths, inunits)
	Source package info and begin to process. More...

subroutine	create_gwe_packages (this, indis)
	Source package info and begin to process. More...

Variables
character(len=lenvarname), parameter	dvt = 'TEMPERATURE '
	dependent variable type, varies based on model type More...

character(len=lenvarname), parameter	dvu = 'ENERGY '
	dependent variable unit of measure, either "mass" or "energy" More...

character(len=lenvarname), parameter	dvua = 'E '
	abbreviation of the dependent variable unit of measure, either "M" or "E" More...

integer(i4b), parameter, public	gwe_nbasepkg = 50
	GWE base package array descriptors. More...

character(len=lenpackagetype), dimension(gwe_nbasepkg), public	gwe_basepkg

integer(i4b), parameter, public	gwe_nmultipkg = 50
	GWE multi package array descriptors. More...

character(len=lenpackagetype), dimension(gwe_nmultipkg), public	gwe_multipkg

integer(i4b), parameter	niunit_gwe = GWE_NBASEPKG + GWE_NMULTIPKG

Function/Subroutine Documentation

◆ allocate_scalars()

subroutine gwemodule::allocate_scalars	(	class(gwemodeltype)	this,
		character(len=*), intent(in)	modelname
	)

private

A subroutine for allocating the scalars specific to the GWE model type. Additional scalars used by the parent class are allocated by the parent class.

Definition at line 697 of file gwe.f90.

     ! -- modules
     use memorymanagermodule, only: mem_allocate
     ! -- dummy
     class(GweModelType) :: this
     character(len=*), intent(in) :: modelname
     !
     ! -- Allocate parent class scalars
     call this%allocate_tsp_scalars(modelname)
     !
     ! -- Allocate members that are part of model class
     call mem_allocate(this%inest, 'INEST', this%memoryPath)
     call mem_allocate(this%incnd, 'INCND', this%memoryPath)
     !
     this%inest = 0
     this%incnd = 0

◆ castasgwemodel()

class(gwemodeltype) function, pointer, public gwemodule::castasgwemodel ( class(*), pointer model )

Parameters

model The object to be cast

Returns: The GWE model

Definition at line 794 of file gwe.f90.

     ! -- dummy
     class(*), pointer :: model !< The object to be cast
     ! -- return
     class(GweModelType), pointer :: gwemodel !< The GWE model
     !
     gwemodel => null()
     if (.not. associated(model)) return
     select type (model)
     type is (gwemodeltype)
       gwemodel => model
     end select

Here is the caller graph for this function:

◆ create_bndpkgs()

subroutine gwemodule::create_bndpkgs	(	class(gwemodeltype)	this,
		integer(i4b), dimension(:), intent(inout), allocatable	bndpkgs,
		type(characterstringtype), dimension(:), intent(inout), pointer, contiguous	pkgtypes,
		type(characterstringtype), dimension(:), intent(inout), pointer, contiguous	pkgnames,
		type(characterstringtype), dimension(:), intent(inout), pointer, contiguous	mempaths,
		integer(i4b), dimension(:), intent(inout), pointer, contiguous	inunits
	)

private

Definition at line 810 of file gwe.f90.

     ! -- modules
     use constantsmodule, only: lenpackagename
     use characterstringmodule, only: characterstringtype
     ! -- dummy
     class(GweModelType) :: this
     integer(I4B), dimension(:), allocatable, intent(inout) :: bndpkgs
     type(CharacterStringType), dimension(:), contiguous, &
       pointer, intent(inout) :: pkgtypes
     type(CharacterStringType), dimension(:), contiguous, &
       pointer, intent(inout) :: pkgnames
     type(CharacterStringType), dimension(:), contiguous, &
       pointer, intent(inout) :: mempaths
     integer(I4B), dimension(:), contiguous, &
       pointer, intent(inout) :: inunits
     ! -- local
     integer(I4B) :: ipakid, ipaknum
     character(len=LENFTYPE) :: pkgtype, bndptype
     character(len=LENPACKAGENAME) :: pkgname
     character(len=LENMEMPATH) :: mempath
     integer(I4B), pointer :: inunit
     integer(I4B) :: n
     !
     if (allocated(bndpkgs)) then
       !
       ! -- Create stress packages
       ipakid = 1
       bndptype = ''
       do n = 1, size(bndpkgs)
         !
         pkgtype = pkgtypes(bndpkgs(n))
         pkgname = pkgnames(bndpkgs(n))
         mempath = mempaths(bndpkgs(n))
         inunit => inunits(bndpkgs(n))
         !
         if (bndptype /= pkgtype) then
           ipaknum = 1
           bndptype = pkgtype
         end if
         !
         call this%package_create(pkgtype, ipakid, ipaknum, pkgname, mempath, &
                                  inunit, this%iout)
         ipakid = ipakid + 1
         ipaknum = ipaknum + 1
       end do
       !
       ! -- Cleanup
       deallocate (bndpkgs)
     end if

◆ create_gwe_packages()

subroutine gwemodule::create_gwe_packages	(	class(gwemodeltype)	this,
		integer(i4b), intent(in)	indis
	)

Definition at line 864 of file gwe.f90.

     ! -- modules
     use constantsmodule, only: lenpackagename
     use characterstringmodule, only: characterstringtype
     use arrayhandlersmodule, only: expandarray
     use memorymanagermodule, only: mem_setptr
     use memoryhelpermodule, only: create_mem_path
     use simvariablesmodule, only: idm_context
     use gweestmodule, only: est_cr
     use gwecndmodule, only: cnd_cr
     ! -- dummy
     class(GweModelType) :: this
     integer(I4B), intent(in) :: indis
     ! -- local
     type(CharacterStringType), dimension(:), contiguous, &
       pointer :: pkgtypes => null()
     type(CharacterStringType), dimension(:), contiguous, &
       pointer :: pkgnames => null()
     type(CharacterStringType), dimension(:), contiguous, &
       pointer :: mempaths => null()
     integer(I4B), dimension(:), contiguous, &
       pointer :: inunits => null()
     character(len=LENMEMPATH) :: model_mempath
     character(len=LENFTYPE) :: pkgtype
     character(len=LENPACKAGENAME) :: pkgname
     character(len=LENMEMPATH) :: mempath
     integer(I4B), pointer :: inunit
     integer(I4B), dimension(:), allocatable :: bndpkgs
     integer(I4B) :: n
     character(len=LENMEMPATH) :: mempathcnd = ''
     character(len=LENMEMPATH) :: mempathest = ''
     !
     ! -- Set input memory paths, input/model and input/model/namfile
     model_mempath = create_mem_path(component=this%name, context=idm_context)
     !
     ! -- Set pointers to model path package info
     call mem_setptr(pkgtypes, 'PKGTYPES', model_mempath)
     call mem_setptr(pkgnames, 'PKGNAMES', model_mempath)
     call mem_setptr(mempaths, 'MEMPATHS', model_mempath)
     call mem_setptr(inunits, 'INUNITS', model_mempath)
     !
     do n = 1, size(pkgtypes)
       !
       ! -- Attributes for this input package
       pkgtype = pkgtypes(n)
       pkgname = pkgnames(n)
       mempath = mempaths(n)
       inunit => inunits(n)
       !
       ! -- Create dis package as it is a prerequisite for other packages
       select case (pkgtype)
       case ('EST6')
         this%inest = 1
         mempathest = mempath
       case ('CND6')
         this%incnd = 1
         mempathcnd = mempath
       case ('CTP6', 'ESL6', 'LKE6', 'SFE6', &
             'MWE6', 'UZE6', 'API6')
         call expandarray(bndpkgs)
         bndpkgs(size(bndpkgs)) = n
       case default
         ! TODO
       end select
     end do
     !
     ! -- Create packages that are tied directly to model
     call est_cr(this%est, this%name, mempathest, this%inest, this%iout, &
                 this%fmi, this%eqnsclfac, this%gwecommon)
     call cnd_cr(this%cnd, this%name, mempathcnd, this%incnd, this%iout, &
                 this%fmi, this%eqnsclfac, this%gwecommon)
     !
     ! -- Check to make sure that required ftype's have been specified
     call this%ftype_check(indis, this%inest)
     !
     call this%create_bndpkgs(bndpkgs, pkgtypes, pkgnames, mempaths, inunits)

Here is the call graph for this function:

◆ gwe_ac()

subroutine gwemodule::gwe_ac	(	class(gwemodeltype)	this,
		type(sparsematrix), intent(inout)	sparse
	)

Definition at line 199 of file gwe.f90.

     ! -- modules
     use sparsemodule, only: sparsematrix
     ! -- dummy
     class(GweModelType) :: this
     type(sparsematrix), intent(inout) :: sparse
     ! -- local
     class(BndType), pointer :: packobj
     integer(I4B) :: ip
     !
     ! -- Add the internal connections of this model to sparse
     call this%dis%dis_ac(this%moffset, sparse)
     if (this%incnd > 0) &
       call this%cnd%cnd_ac(this%moffset, sparse)
     !
     ! -- Add any package connections
     do ip = 1, this%bndlist%Count()
       packobj => getbndfromlist(this%bndlist, ip)
       call packobj%bnd_ac(this%moffset, sparse)
     end do

Here is the call graph for this function:

◆ gwe_ad()

subroutine gwemodule::gwe_ad ( class(gwemodeltype) this )

This subroutine calls the attached packages' advance subroutines

Definition at line 348 of file gwe.f90.

     ! -- modules
     use simvariablesmodule, only: isimcheck, ifailedstepretry
     ! -- dummy
     class(GweModelType) :: this
     class(BndType), pointer :: packobj
     ! -- local
     integer(I4B) :: irestore
     integer(I4B) :: ip, n
     !
     ! -- Reset state variable
     irestore = 0
     if (ifailedstepretry > 0) irestore = 1
     if (irestore == 0) then
       !
       ! -- Copy x into xold
       do n = 1, this%dis%nodes
         if (this%ibound(n) == 0) then
           this%xold(n) = dzero
         else
           this%xold(n) = this%x(n)
         end if
       end do
     else
       !
       ! -- Copy xold into x if this time step is a redo
       do n = 1, this%dis%nodes
         this%x(n) = this%xold(n)
       end do
     end if
     !
     ! -- Advance fmi
     call this%fmi%fmi_ad(this%x)
     !
     ! -- Advance
     if (this%incnd > 0) call this%cnd%cnd_ad()
     if (this%inssm > 0) call this%ssm%ssm_ad()
     do ip = 1, this%bndlist%Count()
       packobj => getbndfromlist(this%bndlist, ip)
       call packobj%bnd_ad()
       if (isimcheck > 0) then
         call packobj%bnd_ck()
       end if
     end do
     !
     ! -- Push simulated values to preceding time/subtime step
     call this%obs%obs_ad()

Here is the call graph for this function:

◆ gwe_ar()

subroutine gwemodule::gwe_ar ( class(gwemodeltype) this )

private

This subroutine:

allocates and reads packages that are part of this model,
allocates memory for arrays used by this model object

Definition at line 251 of file gwe.f90.

     ! -- modules
     use constantsmodule, only: dhnoflo
     ! -- dummy
     class(GweModelType) :: this
     ! -- locals
     integer(I4B) :: ip
     class(BndType), pointer :: packobj
     !
     ! -- Allocate and read modules attached to model
     call this%fmi%fmi_ar(this%ibound)
     if (this%inmvt > 0) call this%mvt%mvt_ar()
     if (this%inic > 0) call this%ic%ic_ar(this%x)
     if (this%inest > 0) call this%est%est_ar(this%dis, this%ibound)
     if (this%inadv > 0) call this%adv%adv_ar(this%dis, this%ibound)
     if (this%incnd > 0) call this%cnd%cnd_ar(this%ibound, this%est%porosity)
     if (this%inssm > 0) call this%ssm%ssm_ar(this%dis, this%ibound, this%x)
     if (this%inobs > 0) call this%obs%tsp_obs_ar(this%ic, this%x, this%flowja)
     !
     ! -- Set governing equation scale factor
     this%eqnsclfac = this%gwecommon%gwerhow * this%gwecommon%gwecpw
     !
     ! -- Call dis_ar to write binary grid file
     !call this%dis%dis_ar(this%npf%icelltype)
     !
     ! -- Set up output control
     call this%oc%oc_ar(this%x, this%dis, dhnoflo, this%depvartype)
     call this%budget%set_ibudcsv(this%oc%ibudcsv)
     !
     ! -- Package input files now open, so allocate and read
     do ip = 1, this%bndlist%Count()
       packobj => getbndfromlist(this%bndlist, ip)
       call packobj%set_pointers(this%dis%nodes, this%ibound, this%x, &
                                 this%xold, this%flowja)
       ! -- Read and allocate package
       call packobj%bnd_ar()
     end do

Here is the call graph for this function:

◆ gwe_bd()

subroutine gwemodule::gwe_bd	(	class(gwemodeltype)	this,
		integer(i4b), intent(in)	icnvg,
		integer(i4b), intent(in)	isuppress_output
	)

This subroutine:

calculates intercell flows (flowja)
calculates package contributions to the model budget

Definition at line 533 of file gwe.f90.

     ! -- dummy
     class(GweModelType) :: this
     integer(I4B), intent(in) :: icnvg
     integer(I4B), intent(in) :: isuppress_output
     ! -- local
     integer(I4B) :: ip
     class(BndType), pointer :: packobj
     !
     ! -- Save the solution convergence flag
     this%icnvg = icnvg
     !
     ! -- Budget routines (start by resetting).  Sole purpose of this section
     !    is to add in and outs to model budget.  All ins and out for a model
     !    should be added here to this%budget.  In a subsequent exchange call,
     !    exchange flows might also be added.
     call this%budget%reset()
     if (this%inest > 0) call this%est%est_bd(isuppress_output, this%budget)
     if (this%inssm > 0) call this%ssm%ssm_bd(isuppress_output, this%budget)
     if (this%infmi > 0) call this%fmi%fmi_bd(isuppress_output, this%budget)
     if (this%inmvt > 0) call this%mvt%mvt_bd(this%x, this%x)
     do ip = 1, this%bndlist%Count()
       packobj => getbndfromlist(this%bndlist, ip)
       call packobj%bnd_bd(this%budget)
     end do

Here is the call graph for this function:

◆ gwe_bdentry()

subroutine gwemodule::gwe_bdentry	(	class(gwemodeltype)	this,
		real(dp), dimension(:, :), intent(in)	budterm,
		character(len=lenbudtxt), dimension(:), intent(in)	budtxt,
		character(len=*), intent(in)	rowlabel
	)

This subroutine adds a budget entry to the flow budget. It was added as a method for the gwe model object so that the exchange object could add its contributions.

Definition at line 648 of file gwe.f90.

     ! -- modules
     use constantsmodule, only: lenbudtxt
     use tdismodule, only: delt
     ! -- dummy
     class(GweModelType) :: this
     real(DP), dimension(:, :), intent(in) :: budterm
     character(len=LENBUDTXT), dimension(:), intent(in) :: budtxt
     character(len=*), intent(in) :: rowlabel
     !
     call this%budget%addentry(budterm, delt, budtxt, rowlabel=rowlabel)

◆ gwe_cc()

subroutine gwemodule::gwe_cc	(	class(gwemodeltype)	this,
		integer(i4b), intent(in)	innertot,
		integer(i4b), intent(in)	kiter,
		integer(i4b), intent(in)	iend,
		integer(i4b), intent(in)	icnvgmod,
		character(len=lenpakloc), intent(inout)	cpak,
		integer(i4b), intent(inout)	ipak,
		real(dp), intent(inout)	dpak
	)

private

If MVR/MVT is active, this subroutine calls the MVR convergence check subroutines.

Definition at line 466 of file gwe.f90.

     ! -- dummy
     class(GweModelType) :: this
     integer(I4B), intent(in) :: innertot
     integer(I4B), intent(in) :: kiter
     integer(I4B), intent(in) :: iend
     integer(I4B), intent(in) :: icnvgmod
     character(len=LENPAKLOC), intent(inout) :: cpak
     integer(I4B), intent(inout) :: ipak
     real(DP), intent(inout) :: dpak
     !
     ! -- If mover is on, then at least 2 outers required
     if (this%inmvt > 0) call this%mvt%mvt_cc(kiter, iend, icnvgmod, cpak, dpak)

◆ gwe_cf()

subroutine gwemodule::gwe_cf	(	class(gwemodeltype)	this,
		integer(i4b), intent(in)	kiter
	)

This subroutine calls the attached packages' calculate coefficients subroutines

Definition at line 402 of file gwe.f90.

     ! -- dummy
     class(GweModelType) :: this
     integer(I4B), intent(in) :: kiter
     ! -- local
     class(BndType), pointer :: packobj
     integer(I4B) :: ip
     !
     ! -- Call package cf routines
     do ip = 1, this%bndlist%Count()
       packobj => getbndfromlist(this%bndlist, ip)
       call packobj%bnd_cf()
     end do

Here is the call graph for this function:

◆ gwe_cq()

subroutine gwemodule::gwe_cq	(	class(gwemodeltype)	this,
		integer(i4b), intent(in)	icnvg,
		integer(i4b), intent(in)	isuppress_output
	)

private

This subroutine calls the attached packages' intercell flows (flow ja)

Definition at line 485 of file gwe.f90.

     ! -- modules
     use sparsemodule, only: csr_diagsum
     ! -- dummy
     class(GweModelType) :: this
     integer(I4B), intent(in) :: icnvg
     integer(I4B), intent(in) :: isuppress_output
     ! -- local
     integer(I4B) :: i
     integer(I4B) :: ip
     class(BndType), pointer :: packobj
     !
     ! -- Construct the flowja array.  Flowja is calculated each time, even if
     !    output is suppressed.  (flowja is positive into a cell.)  The diagonal
     !    position of the flowja array will contain the flow residual after
     !    these routines are called, so each package is responsible for adding
     !    its flow to this diagonal position.
     do i = 1, this%nja
       this%flowja(i) = dzero
     end do
     if (this%inadv > 0) call this%adv%adv_cq(this%x, this%flowja)
     if (this%incnd > 0) call this%cnd%cnd_cq(this%x, this%flowja)
     if (this%inest > 0) call this%est%est_cq(this%dis%nodes, this%x, this%xold, &
                                              this%flowja)
     if (this%inssm > 0) call this%ssm%ssm_cq(this%flowja)
     if (this%infmi > 0) call this%fmi%fmi_cq(this%x, this%flowja)
     !
     ! -- Go through packages and call cq routines.  cf() routines are called
     !    first to regenerate non-linear terms to be consistent with the final
     !    conc solution.
     do ip = 1, this%bndlist%Count()
       packobj => getbndfromlist(this%bndlist, ip)
       call packobj%bnd_cf()
       call packobj%bnd_cq(this%x, this%flowja)
     end do
     !
     ! -- Finalize calculation of flowja by adding face flows to the diagonal.
     !    This results in the flow residual being stored in the diagonal
     !    position for each cell.
     call csr_diagsum(this%dis%con%ia, this%flowja)

Here is the call graph for this function:

◆ gwe_cr()

subroutine, public gwemodule::gwe_cr	(	character(len=*), intent(in)	filename,
		integer(i4b), intent(in)	id,
		character(len=*), intent(in)	modelname
	)

Parameters

[in]	filename	input file
[in]	id	consecutive model number listed in mfsim.nam
[in]	modelname	name of the model

Definition at line 97 of file gwe.f90.

     ! -- modules
     use listsmodule, only: basemodellist
     use basemodelmodule, only: addbasemodeltolist
     use constantsmodule, only: lenpackagename
     use memoryhelpermodule, only: create_mem_path
     use memorymanagerextmodule, only: mem_set_value
     use gwenaminputmodule, only: gwenamparamfoundtype
     use budgetmodule, only: budget_cr
     use gweinputdatamodule, only: gweshared_dat_cr
     ! -- dummy
     character(len=*), intent(in) :: filename !< input file
     integer(I4B), intent(in) :: id !< consecutive model number listed in mfsim.nam
     character(len=*), intent(in) :: modelname !< name of the model
     ! -- local
     integer(I4B) :: indis
     type(GweModelType), pointer :: this
     class(BaseModelType), pointer :: model
     !
     ! -- Allocate a new GWE Model (this) and add it to basemodellist
     allocate (this)
     !
     ! -- Set memory path before allocation in memory manager can be done
     this%memoryPath = create_mem_path(modelname)
     !
     ! -- Allocate scalars and add model to basemodellist
     call this%allocate_scalars(modelname)
     !
     ! -- Set labels for transport model - needed by create_packages() below
     call this%set_tsp_labels(this%macronym, dvt, dvu, dvua)
     !
     model => this
     call addbasemodeltolist(basemodellist, model)
     !
     ! -- Instantiate shared data container
     call gweshared_dat_cr(this%gwecommon)
     !
     ! -- Call parent class routine
     call this%tsp_cr(filename, id, modelname, 'GWE', indis)
     !
     ! -- Create model packages
     call this%create_packages(indis)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gwe_da()

subroutine gwemodule::gwe_da ( class(gwemodeltype) this )

private

Deallocate memory at conclusion of model run

Definition at line 581 of file gwe.f90.

     ! -- modules
     use memorymanagermodule, only: mem_deallocate
     use memorymanagerextmodule, only: memorystore_remove
     use simvariablesmodule, only: idm_context
     ! -- dummy
     class(GweModelType) :: this
     ! -- local
     integer(I4B) :: ip
     class(BndType), pointer :: packobj
     !
     ! -- Deallocate idm memory
     call memorystore_remove(this%name, 'NAM', idm_context)
     call memorystore_remove(component=this%name, context=idm_context)
     !
     ! -- Internal flow packages deallocate
     call this%dis%dis_da()
     call this%ic%ic_da()
     call this%fmi%fmi_da()
     call this%adv%adv_da()
     call this%cnd%cnd_da()
     call this%ssm%ssm_da()
     call this%est%est_da()
     call this%mvt%mvt_da()
     call this%budget%budget_da()
     call this%oc%oc_da()
     call this%obs%obs_da()
     call this%gwecommon%gweshared_dat_da()
     !
     ! -- Internal package objects
     deallocate (this%dis)
     deallocate (this%ic)
     deallocate (this%fmi)
     deallocate (this%adv)
     deallocate (this%cnd)
     deallocate (this%ssm)
     deallocate (this%est)
     deallocate (this%mvt)
     deallocate (this%budget)
     deallocate (this%oc)
     deallocate (this%obs)
     nullify (this%gwecommon)
     !
     ! -- Boundary packages
     do ip = 1, this%bndlist%Count()
       packobj => getbndfromlist(this%bndlist, ip)
       call packobj%bnd_da()
       deallocate (packobj)
     end do
     !
     ! -- Scalars
     call mem_deallocate(this%inest)
     call mem_deallocate(this%incnd)
     !
     ! -- Parent class members
     call this%TransportModelType%tsp_da()
     !
     ! -- NumericalModelType
     call this%NumericalModelType%model_da()

Here is the call graph for this function:

◆ gwe_df()

subroutine gwemodule::gwe_df ( class(gwemodeltype) this )

This subroutine defines a gwe model type. Steps include:

call df routines for each package
set variables and pointers

Definition at line 147 of file gwe.f90.

     ! -- modules
     use simmodule, only: store_error
     ! -- dummy
     class(GweModelType) :: this
     ! -- local
     integer(I4B) :: ip
     class(BndType), pointer :: packobj
     !
     ! -- Define packages and utility objects
     call this%dis%dis_df()
     call this%fmi%fmi_df(this%dis, 0)
     if (this%inmvt > 0) call this%mvt%mvt_df(this%dis)
     if (this%inadv > 0) call this%adv%adv_df()
     if (this%incnd > 0) call this%cnd%cnd_df(this%dis)
     if (this%inssm > 0) call this%ssm%ssm_df()
     call this%oc%oc_df()
     call this%budget%budget_df(niunit_gwe, this%depvarunit, &
                                this%depvarunitabbrev)
     !
     ! -- Check for SSM package
     if (this%inssm == 0) then
       if (this%fmi%nflowpack > 0) then
         call store_error('Flow model has boundary packages, but there &
           &is no SSM package.  The SSM package must be activated.', &
           terminate=.true.)
       end if
     end if
     !
     ! -- Assign or point model members to dis members
     this%neq = this%dis%nodes
     this%nja = this%dis%nja
     this%ia => this%dis%con%ia
     this%ja => this%dis%con%ja
     !
     ! -- Allocate model arrays, now that neq and nja are assigned
     call this%allocate_arrays()
     !
     ! -- Define packages and assign iout for time series managers
     do ip = 1, this%bndlist%Count()
       packobj => getbndfromlist(this%bndlist, ip)
       call packobj%bnd_df(this%neq, this%dis)
       packobj%TsManager%iout = this%iout
       packobj%TasManager%iout = this%iout
     end do
     !
     ! -- Store information needed for observations
     call this%obs%obs_df(this%iout, this%name, 'GWE', this%dis)

Here is the call graph for this function:

◆ gwe_dt()

subroutine gwemodule::gwe_dt ( class(gwemodeltype) this )

Calculate the maximum allowable time step size subject to time-step constraints. If adaptive time steps are used, then the time step used will be no larger than dtmax calculated here.

Definition at line 327 of file gwe.f90.

     use tdismodule, only: kstp, kper
     use adaptivetimestepmodule, only: ats_submit_delt
     ! dummy
     class(GweModelType) :: this
     ! local
     real(DP) :: dtmax
     character(len=LINELENGTH) :: msg
     dtmax = dnodata
  
     ! advection package courant stability
     call this%adv%adv_dt(dtmax, msg, this%est%porosity)
     if (msg /= '') then
       call ats_submit_delt(kstp, kper, dtmax, msg)
     end if

Here is the call graph for this function:

◆ gwe_fc()

subroutine gwemodule::gwe_fc	(	class(gwemodeltype)	this,
		integer(i4b), intent(in)	kiter,
		class(matrixbasetype), pointer	matrix_sln,
		integer(i4b), intent(in)	inwtflag
	)

private

This subroutine calls the attached packages' fill coefficients subroutines

Definition at line 422 of file gwe.f90.

     ! -- dummy
     class(GweModelType) :: this
     integer(I4B), intent(in) :: kiter
     class(MatrixBaseType), pointer :: matrix_sln
     integer(I4B), intent(in) :: inwtflag
     ! -- local
     class(BndType), pointer :: packobj
     integer(I4B) :: ip
     !
     ! -- Call fc routines
     call this%fmi%fmi_fc(this%dis%nodes, this%xold, this%nja, matrix_sln, &
                          this%idxglo, this%rhs)
     if (this%inmvt > 0) then
       call this%mvt%mvt_fc(this%x, this%x)
     end if
     if (this%inest > 0) then
       call this%est%est_fc(this%dis%nodes, this%xold, this%nja, matrix_sln, &
                            this%idxglo, this%x, this%rhs, kiter)
     end if
     if (this%inadv > 0) then
       call this%adv%adv_fc(this%dis%nodes, matrix_sln, this%idxglo, this%x, &
                            this%rhs)
     end if
     if (this%incnd > 0) then
       call this%cnd%cnd_fc(kiter, this%dis%nodes, this%nja, matrix_sln, &
                            this%idxglo, this%rhs, this%x)
     end if
     if (this%inssm > 0) then
       call this%ssm%ssm_fc(matrix_sln, this%idxglo, this%rhs)
     end if
     !
     ! -- Packages
     do ip = 1, this%bndlist%Count()
       packobj => getbndfromlist(this%bndlist, ip)
       call packobj%bnd_fc(this%rhs, this%ia, this%idxglo, matrix_sln)
     end do

Here is the call graph for this function:

◆ gwe_get_iasym()

integer(i4b) function gwemodule::gwe_get_iasym ( class(gwemodeltype) this )

Definition at line 664 of file gwe.f90.

     class(GweModelType) :: this
     ! -- local
     integer(I4B) :: iasym
     integer(I4B) :: ip
     class(BndType), pointer :: packobj
     !
     ! -- Start by setting iasym to zero
     iasym = 0
     !
     ! -- ADV
     if (this%inadv > 0) then
       if (this%adv%iasym /= 0) iasym = 1
     end if
     !
     ! -- CND
     if (this%incnd > 0) then
       if (this%cnd%ixt3d /= 0) iasym = 1
     end if
     !
     ! -- Check for any packages that introduce matrix asymmetry
     do ip = 1, this%bndlist%Count()
       packobj => getbndfromlist(this%bndlist, ip)
       if (packobj%iasym /= 0) iasym = 1
     end do

Here is the call graph for this function:

◆ gwe_mc()

subroutine gwemodule::gwe_mc	(	class(gwemodeltype)	this,
		class(matrixbasetype), pointer	matrix_sln
	)

Parameters

matrix_sln global system matrix

Definition at line 224 of file gwe.f90.

     ! -- dummy
     class(GweModelType) :: this
     class(MatrixBaseType), pointer :: matrix_sln !< global system matrix
     ! -- local
     class(BndType), pointer :: packobj
     integer(I4B) :: ip
     !
     ! -- Find the position of each connection in the global ia, ja structure
     !    and store them in idxglo.
     call this%dis%dis_mc(this%moffset, this%idxglo, matrix_sln)
     !
     if (this%incnd > 0) call this%cnd%cnd_mc(this%moffset, matrix_sln)
     !
     ! -- Map any package connections
     do ip = 1, this%bndlist%Count()
       packobj => getbndfromlist(this%bndlist, ip)
       call packobj%bnd_mc(this%moffset, matrix_sln)
     end do

Here is the call graph for this function:

◆ gwe_ot_flow()

subroutine gwemodule::gwe_ot_flow	(	class(gwemodeltype)	this,
		integer(i4b), intent(in)	icbcfl,
		integer(i4b), intent(in)	ibudfl,
		integer(i4b), intent(in)	icbcun
	)

private

Save and print flows

Definition at line 564 of file gwe.f90.

     ! dummy
     class(GweModelType) :: this
     integer(I4B), intent(in) :: icbcfl
     integer(I4B), intent(in) :: ibudfl
     integer(I4B), intent(in) :: icbcun
     ! local
  
     if (this%inest > 0) call this%est%est_ot_flow(icbcfl, icbcun)
     call this%TransportModelType%tsp_ot_flow(icbcfl, ibudfl, icbcun)
  

◆ gwe_rp()

subroutine gwemodule::gwe_rp ( class(gwemodeltype) this )

This subroutine calls the attached packages' read and prepare routines

Definition at line 294 of file gwe.f90.

     ! -- modules
     use tdismodule, only: readnewdata
     ! -- dummy
     class(GweModelType) :: this
     ! -- local
     class(BndType), pointer :: packobj
     integer(I4B) :: ip
     !
     ! -- In fmi, check for mvt and mvrbudobj consistency
     call this%fmi%fmi_rp(this%inmvt)
     if (this%inmvt > 0) call this%mvt%mvt_rp()
     !
     ! -- Check with TDIS on whether or not it is time to RP
     if (.not. readnewdata) return
     !
     ! -- Read and prepare
     if (this%inoc > 0) call this%oc%oc_rp()
     if (this%inssm > 0) call this%ssm%ssm_rp()
     do ip = 1, this%bndlist%Count()
       packobj => getbndfromlist(this%bndlist, ip)
       call packobj%bnd_rp()
       call packobj%bnd_rp_log()
       call packobj%bnd_rp_obs()
     end do

Here is the call graph for this function:

◆ package_create()

subroutine gwemodule::package_create	(	class(gwemodeltype)	this,
		character(len=*), intent(in)	filtyp,
		integer(i4b), intent(in)	ipakid,
		integer(i4b), intent(in)	ipaknum,
		character(len=*), intent(in)	pakname,
		character(len=*), intent(in)	mempath,
		integer(i4b), intent(in)	inunit,
		integer(i4b), intent(in)	iout
	)

This subroutine calls the package create routines for packages activated by the user.

Definition at line 720 of file gwe.f90.

     ! -- modules
     use simmodule, only: store_error
     use gwectpmodule, only: ctp_create
     use gweeslmodule, only: esl_create
     use gwelkemodule, only: lke_create
     use gwesfemodule, only: sfe_create
     use gwemwemodule, only: mwe_create
     use gweuzemodule, only: uze_create
     use apimodule, only: api_create
     ! -- dummy
     class(GweModelType) :: this
     character(len=*), intent(in) :: filtyp
     character(len=LINELENGTH) :: errmsg
     integer(I4B), intent(in) :: ipakid
     integer(I4B), intent(in) :: ipaknum
     character(len=*), intent(in) :: pakname
     character(len=*), intent(in) :: mempath
     integer(I4B), intent(in) :: inunit
     integer(I4B), intent(in) :: iout
     ! -- local
     class(BndType), pointer :: packobj
     class(BndType), pointer :: packobj2
     integer(I4B) :: ip
     !
     ! -- This part creates the package object
     select case (filtyp)
     case ('CTP6')
       call ctp_create(packobj, ipakid, ipaknum, inunit, iout, this%name, &
                       pakname, this%depvartype, mempath)
     case ('ESL6')
       call esl_create(packobj, ipakid, ipaknum, inunit, iout, this%name, &
                       pakname, this%gwecommon, mempath)
     case ('LKE6')
       call lke_create(packobj, ipakid, ipaknum, inunit, iout, this%name, &
                       pakname, this%fmi, this%eqnsclfac, this%gwecommon, &
                       this%depvartype, this%depvarunit, this%depvarunitabbrev)
     case ('SFE6')
       call sfe_create(packobj, ipakid, ipaknum, inunit, iout, this%name, &
                       pakname, this%fmi, this%eqnsclfac, this%gwecommon, &
                       this%depvartype, this%depvarunit, this%depvarunitabbrev)
     case ('MWE6')
       call mwe_create(packobj, ipakid, ipaknum, inunit, iout, this%name, &
                       pakname, this%fmi, this%eqnsclfac, this%gwecommon, &
                       this%depvartype, this%depvarunit, this%depvarunitabbrev)
     case ('UZE6')
       call uze_create(packobj, ipakid, ipaknum, inunit, iout, this%name, &
                       pakname, this%fmi, this%eqnsclfac, this%gwecommon, &
                       this%depvartype, this%depvarunit, this%depvarunitabbrev)
       !case('API6')
       !  call api_create(packobj, ipakid, ipaknum, inunit, iout, this%name, &
       !                  pakname)
     case default
       write (errmsg, *) 'Invalid package type: ', filtyp
       call store_error(errmsg, terminate=.true.)
     end select
     !
     ! -- Packages is the bndlist that is associated with the parent model
     ! -- The following statement puts a pointer to this package in the ipakid
     ! -- position of packages.
     do ip = 1, this%bndlist%Count()
       packobj2 => getbndfromlist(this%bndlist, ip)
       if (packobj2%packName == pakname) then
         write (errmsg, '(a,a)') 'Cannot create package.  Package name  '// &
           'already exists: ', trim(pakname)
         call store_error(errmsg, terminate=.true.)
       end if
     end do
     call addbndtolist(this%bndlist, packobj)

Here is the call graph for this function:

Variable Documentation

◆ dvt

character(len=lenvarname), parameter gwemodule::dvt = 'TEMPERATURE '

private

Definition at line 29 of file gwe.f90.

29 character(len=LENVARNAME), parameter :: dvt = 'TEMPERATURE ' !< dependent variable type, varies based on model type

◆ dvu

character(len=lenvarname), parameter gwemodule::dvu = 'ENERGY '

private

Definition at line 30 of file gwe.f90.

30 character(len=LENVARNAME), parameter :: dvu = 'ENERGY ' !< dependent variable unit of measure, either "mass" or "energy"

◆ dvua

character(len=lenvarname), parameter gwemodule::dvua = 'E '

private

Definition at line 31 of file gwe.f90.

31 character(len=LENVARNAME), parameter :: dvua = 'E ' !< abbreviation of the dependent variable unit of measure, either "M" or "E"

◆ gwe_basepkg

character(len=lenpackagetype), dimension(gwe_nbasepkg), public gwemodule::gwe_basepkg

Definition at line 72 of file gwe.f90.

72 character(len=LENPACKAGETYPE), dimension(GWE_NBASEPKG) :: GWE_BASEPKG

◆ gwe_multipkg

character(len=lenpackagetype), dimension(gwe_nmultipkg), public gwemodule::gwe_multipkg

Definition at line 85 of file gwe.f90.

85 character(len=LENPACKAGETYPE), dimension(GWE_NMULTIPKG) :: GWE_MULTIPKG

◆ gwe_nbasepkg

integer(i4b), parameter, public gwemodule::gwe_nbasepkg = 50

GWE6 model base package types. Only listed packages are candidates for input and these will be loaded in the order specified.

Definition at line 71 of file gwe.f90.

71 integer(I4B), parameter :: GWE_NBASEPKG = 50

◆ gwe_nmultipkg

integer(i4b), parameter, public gwemodule::gwe_nmultipkg = 50

GWE6 model multi-instance package types. Only listed packages are candidates for input and these will be loaded in the order specified.

Definition at line 84 of file gwe.f90.

84 integer(I4B), parameter :: GWE_NMULTIPKG = 50

◆ niunit_gwe

integer(i4b), parameter gwemodule::niunit_gwe = GWE_NBASEPKG + GWE_NMULTIPKG

private

Definition at line 91 of file gwe.f90.

91 integer(I4B), parameter :: NIUNIT_GWE = gwe_nbasepkg + gwe_nmultipkg

Data Types

Functions/Subroutines

Variables

Function/Subroutine Documentation

◆ allocate_scalars()

◆ castasgwemodel()

◆ create_bndpkgs()

◆ create_gwe_packages()

◆ gwe_ac()

◆ gwe_ad()

◆ gwe_ar()

◆ gwe_bd()

◆ gwe_bdentry()

◆ gwe_cc()

◆ gwe_cf()

◆ gwe_cq()

◆ gwe_cr()

◆ gwe_da()

◆ gwe_df()

◆ gwe_dt()

◆ gwe_fc()

◆ gwe_get_iasym()

◆ gwe_mc()

◆ gwe_ot_flow()

◆ gwe_rp()

◆ package_create()

Variable Documentation

◆ dvt

◆ dvu

◆ dvua

◆ gwe_basepkg

◆ gwe_multipkg

◆ gwe_nbasepkg

◆ gwe_nmultipkg

◆ niunit_gwe