MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
gweinterfacemodelmodule::gweinterfacemodeltype Type Reference

The GWE Interface Model is a utility to calculate the solution's exchange coefficients from the interface between a GWE model and its GWE neighbors. The interface model itself will not be part of the solution, it is not being solved. More...

Inheritance diagram for gweinterfacemodelmodule::gweinterfacemodeltype:
Inheritance graph
Collaboration diagram for gweinterfacemodelmodule::gweinterfacemodeltype:
Collaboration graph

Public Member Functions

procedure, pass(this) gweifmod_cr (this, name, iout, gridconn)
 Create the interface model, analogously to what.
procedure model_df (this)
 Define the GWE interface model.
procedure model_ar (this)
 Override allocate and read the GWE interface model and its packages so that we can create stuff from memory instead of input files.
procedure model_da (this)
 Clean up resources.
procedure, public allocate_fmi (this)
 Allocate a Flow Model Interface (FMI) object for the interface model.
procedure allocate_scalars (this, modelname)
 Allocate scalars associated with the interface model object.
procedure model_df (this)
 Define packages of the GWE model.
procedure model_df (this)
procedure model_df (this)
 Define the model.
procedure model_ac (this, sparse)
 Add the internal connections of this model to the sparse matrix.
procedure model_ac (this, sparse)
procedure model_mc (this, matrix_sln)
 Map the positions of the GWE model connections in the numerical solution coefficient matrix.
procedure model_mc (this, matrix_sln)
procedure model_ar (this)
 GWE Model Allocate and Read.
procedure model_ar (this)
procedure model_ar (this)
 Allocate and read.
procedure model_rp (this)
 GWE Model Read and Prepare.
procedure model_rp (this)
procedure model_rp (this)
 Read and prepare.
procedure model_dt (this)
 GWT Model time step size.
procedure model_dt (this)
 Calculate time step length.
procedure model_ad (this)
 GWE Model Time Step Advance.
procedure model_ad (this)
procedure model_cf (this, kiter)
 GWE Model calculate coefficients.
procedure model_cf (this, kiter)
procedure model_fc (this, kiter, matrix_sln, inwtflag)
 GWE Model fill coefficients.
procedure model_fc (this, kiter, matrix_sln, inwtflag)
procedure model_cc (this, innertot, kiter, iend, icnvgmod, cpak, ipak, dpak)
 GWE Model Final Convergence Check.
procedure model_cc (this, innertot, kiter, iend, icnvgmod, cpak, ipak, dpak)
procedure model_cq (this, icnvg, isuppress_output)
 GWE Model calculate flow.
procedure model_cq (this, icnvg, isuppress_output)
procedure model_bd (this, icnvg, isuppress_output)
 GWE Model Budget.
procedure model_bd (this, icnvg, isuppress_output)
procedure tsp_ot_flow (this, icbcfl, ibudfl, icbcun)
 GWE model output routine.
procedure, public tsp_ot_flow (this, icbcfl, ibudfl, icbcun)
 Generalized transport model output routine.
procedure model_da (this)
 Deallocate.
procedure model_da (this)
procedure model_da (this)
 Deallocate.
procedure model_bdentry (this, budterm, budtxt, rowlabel)
 GroundWater Energy Transport Model Budget Entry.
procedure model_bdentry (this, budterm, budtxt, rowlabel)
procedure allocate_scalars (this, modelname)
 Allocate memory for non-allocatable members.
procedure allocate_scalars (this, modelname)
procedure allocate_scalars (this, modelname)
 Allocate scalar variables.
procedure get_iasym (this)
 return 1 if any package causes the matrix to be asymmetric. Otherwise return 0.
procedure get_iasym (this)
procedure create_packages (this, indis)
 Source package info and begin to process.
procedure, public tsp_cr (this, filename, id, modelname, macronym, indis)
 Create a new generalized transport model object.
procedure, public tsp_df (this)
 Generalized transport model define model.
procedure, public tsp_da (this)
 Deallocate memory.
procedure, public tsp_ac (this, sparse)
 Generalized transport model add connections.
procedure, public tsp_mc (this, matrix_sln)
 Generalized transport model map coefficients.
procedure, public tsp_ar (this)
 Generalized transport model allocate and read.
procedure, public tsp_rp (this)
 Generalized transport model read and prepare.
procedure, public tsp_ad (this)
 Generalized transport model time step advance.
procedure, public tsp_fc (this, kiter, matrix_sln, inwtflag)
 Generalized transport model fill coefficients.
procedure, public tsp_cc (this, innertot, kiter, iend, icnvgmod, cpak, ipak, dpak)
 Generalized transport model final convergence check.
procedure, public tsp_cq (this, icnvg, isuppress_output)
 Generalized transport model calculate flows.
procedure, public tsp_bd (this, icnvg, isuppress_output)
 Generalized transport model budget.
procedure, public model_ot (this)
 Generalized transport model output routine.
procedure model_ot (this)
procedure model_ot (this)
 Output results.
procedure, public tsp_ot_dv (this, idvsave, idvprint, ipflag)
 Generalized transport model output routine.
procedure, public allocate_tsp_scalars (this, modelname)
 Allocate scalar variables for transport model.
procedure, public set_tsp_labels (this, tsptype, depvartype, depvarunit, depvarunitabbrev)
 Define the labels corresponding to the flavor of transport model.
procedure, public ftype_check (this, indis, inmst)
 Generalized transport model routine.
procedure, public get_idv_scale (this)
 return 1 if option to normalize the x and rhs has been specified. Otherwise return 0.
procedure get_idv_scale (this)
procedure model_fp (this)
procedure model_fp (this)
 Final processing.
procedure model_reset (this)
procedure model_solve (this)
procedure model_ptcchk (this, iptc)
procedure model_ptc (this, vec_residual, iptc, ptcf)
procedure model_nr (this, kiter, matrix, inwtflag)
procedure model_nur (this, neqmod, x, xtemp, dx, inewtonur, dxmax, locmax)
procedure model_bdcalc (this, icnvg)
procedure model_bdsave (this, icnvg)
procedure allocate_arrays (this)
procedure set_moffset (this, moffset)
procedure set_idsoln (this, id)
procedure set_xptr (this, xsln, sln_offset, varnametgt, mempathtgt)
procedure set_rhsptr (this, rhssln, sln_offset, varnametgt, mempathtgt)
procedure set_iboundptr (this, iboundsln, sln_offset, varnametgt, mempathtgt)
procedure get_mrange (this, mstart, mend)
procedure get_mcellid (this, node, mcellid)
procedure get_mnodeu (this, node, nodeu)
procedure model_message (this, line, fmt)
 Write line to model iout.
procedure create_lstfile (this, lst_fname, model_fname, defined, headertxt)

Public Attributes

integer(i4b), pointer iadvscheme => null()
 the advection scheme: 0 = up, 1 = central, 2 = tvd
integer(i4b), pointer ixt3d => null()
 xt3d setting: 0 = off, 1 = lhs, 2 = rhs
real(dp), pointer ieqnsclfac => null()
 governing eqn scaling factor: 1: GWT, >1: GWE
class(gridconnectiontype), pointer gridconnection => null()
 The grid connection class will provide the interface grid.
real(dp), dimension(:), pointer, contiguous porosity => null()
 to be filled with EST porosity
type(gweinputdatatype), pointer gwecommon => null()
 container for data shared with multiple packages
type(gweesttype), pointer est => null()
 mass storage and transfer package
type(gwecndtype), pointer cnd => null()
 dispersion package
integer(i4b), pointer inest => null()
integer(i4b), pointer incnd => null()
type(tspadvtype), pointer adv => null()
 advection package
type(tspfmitype), pointer fmi => null()
 flow model interface
type(tspictype), pointer ic => null()
 initial conditions package
type(tspmvttype), pointer mvt => null()
 mover transport package
type(tspobstype), pointer obs => null()
 observation package
type(tspoctype), pointer oc => null()
 output control package
type(tspssmtype), pointer ssm => null()
 source sink mixing package
type(budgettype), pointer budget => null()
 budget object
integer(i4b), pointer infmi => null()
integer(i4b), pointer inadv => null()
 unit number ADV
integer(i4b), pointer inic => null()
 unit number IC
integer(i4b), pointer inmvt => null()
 unit number MVT
integer(i4b), pointer inoc => null()
 unit number OC
integer(i4b), pointer inobs => null()
 unit number OBS
integer(i4b), pointer inssm => null()
 unit number SSM
real(dp), pointer eqnsclfac => null()
 constant factor by which all terms in the model's governing equation are scaled (divided) for formulation and solution
character(len=lenvarname) tsptype = ''
 "solute" or "heat"
character(len=lenvarname) depvartype = ''
 "concentration" or "temperature"
character(len=lenvarname) depvarunit = ''
 "mass" or "energy"
character(len=lenvarname) depvarunitabbrev = ''
 "M" or "E"
integer(i4b), pointer idv_scale => null()
integer(i4b), pointer neq => null()
 number of equations
integer(i4b), pointer moffset => null()
 offset of this model in the solution
integer(i4b), pointer icnvg => null()
 convergence flag
integer(i4b), dimension(:), pointer, contiguous ia => null()
 csr row pointer
integer(i4b), dimension(:), pointer, contiguous ja => null()
 csr columns
real(dp), dimension(:), pointer, contiguous x => null()
 dependent variable (head, conc, etc)
real(dp), dimension(:), pointer, contiguous rhs => null()
 right-hand side vector
real(dp), dimension(:), pointer, contiguous cond => null()
 conductance matrix
integer(i4b), dimension(:), pointer, contiguous idxglo => null()
 pointer to position in solution matrix
real(dp), dimension(:), pointer, contiguous xold => null()
 dependent variable for previous timestep
character(len=lenmempath) memorypath
 the location in the memory manager where the variables are stored
character(len=lenmodelname), pointer name => null()
 name of the model
character(len=linelength), pointer filename => null()
 input file name
character(len=3), pointer macronym => null()
 3 letter model acronym (GWF, GWT, ...)
integer(i4b), pointer idsoln => null()
 id of the solution model is in
integer(i4b), pointer id => null()
 model id
integer(i4b), pointer iout => null()
 output unit number
integer(i4b), pointer inewton => null()
 newton-raphson flag
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()
 save_flows flag
integer(i4b), pointer nja => null()
 number of connections
integer(i4b), dimension(:), pointer, contiguous ibound => null()
 ibound
real(dp), dimension(:), pointer, contiguous flowja => null()
 intercell flows
type(listtype), pointer bndlist => null()
 array of boundary packages
class(disbasetype), pointer dis => null()
 discretization object

Private Member Functions

procedure, private create_bndpkgs (this, bndpkgs, pkgtypes, pkgnames, mempaths, inunits)
 Source package info and begin to process.
procedure, private package_create (this, filtyp, ipakid, ipaknum, pakname, mempath, inunit, iout)
 Create boundary condition packages for this model.
procedure, private tsp_ot_obs (this)
 Generalized transport model output routine.
procedure, private tsp_ot_flowja (this, nja, flowja, icbcfl, icbcun)
 Generalized transport model output routine.
procedure, private tsp_ot_bdsummary (this, ibudfl, ipflag)
 Generalized transport model output budget summary.
procedure, private create_tsp_packages (this, indis)
 Source package info and begin to process.
procedure, private log_namfile_options (this, found)
 Write model name file options to list file.

Private Attributes

class(gwemodeltype), pointer, private owner => null()
 the real GWE model for which the exchange coefficients are calculated with this interface model

Detailed Description

Definition at line 27 of file GweInterfaceModel.f90.

Member Function/Subroutine Documentation

◆ allocate_arrays()

procedure numericalmodelmodule::numericalmodeltype::allocate_arrays ( class(numericalmodeltype) this)
inherited

Definition at line 57 of file NumericalModel.f90.

◆ allocate_fmi()

procedure, public gweinterfacemodelmodule::gweinterfacemodeltype::allocate_fmi ( class(gweinterfacemodeltype) this)
Parameters
thisthe GWT interface model

Definition at line 45 of file GweInterfaceModel.f90.

◆ allocate_scalars() [1/4]

procedure basemodelmodule::basemodeltype::allocate_scalars ( class(basemodeltype) this,
character(len=*), intent(in) modelname )
inherited

Definition at line 41 of file BaseModel.f90.

◆ allocate_scalars() [2/4]

procedure gweinterfacemodelmodule::gweinterfacemodeltype::allocate_scalars ( class(gweinterfacemodeltype) this,
character(len=*), intent(in) modelname )
Parameters
thisthe GWE interface model
[in]modelnamethe model name

Definition at line 46 of file GweInterfaceModel.f90.

◆ allocate_scalars() [3/4]

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

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 58 of file gwe.f90.

◆ allocate_scalars() [4/4]

procedure numericalmodelmodule::numericalmodeltype::allocate_scalars ( class(numericalmodeltype) this,
character(len=*), intent(in) modelname )
inherited

Definition at line 56 of file NumericalModel.f90.

◆ allocate_tsp_scalars()

procedure, public transportmodelmodule::transportmodeltype::allocate_tsp_scalars ( class(transportmodeltype) this,
character(len=*), intent(in) modelname )
inherited

Method to allocate memory for non-allocatable members.

Definition at line 76 of file tsp.f90.

◆ create_bndpkgs()

procedure, private gwemodule::gwemodeltype::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 )
privateinherited

Definition at line 61 of file gwe.f90.

◆ create_lstfile()

procedure basemodelmodule::basemodeltype::create_lstfile ( class(basemodeltype) this,
character(len=*), intent(inout) lst_fname,
character(len=*), intent(in) model_fname,
logical(lgp), intent(in) defined,
character(len=*), intent(in) headertxt )
inherited

Definition at line 43 of file BaseModel.f90.

◆ create_packages()

procedure gwemodule::gwemodeltype::create_packages ( class(gwemodeltype) this,
integer(i4b), intent(in) indis )
inherited

Definition at line 60 of file gwe.f90.

◆ create_tsp_packages()

procedure, private transportmodelmodule::transportmodeltype::create_tsp_packages ( class(transportmodeltype) this,
integer(i4b), intent(inout) indis )
privateinherited

Definition at line 84 of file tsp.f90.

◆ ftype_check()

procedure, public transportmodelmodule::transportmodeltype::ftype_check ( class(transportmodeltype) this,
integer(i4b), intent(in) indis,
integer(i4b), intent(in) inmst )
inherited

Check to make sure required input files have been specified

Parameters
[in]inmstrepresentative of both inmst and inest depending on model type

Definition at line 78 of file tsp.f90.

◆ get_iasym() [1/2]

procedure gwemodule::gwemodeltype::get_iasym ( class(gwemodeltype) this)
inherited

Definition at line 59 of file gwe.f90.

◆ get_iasym() [2/2]

procedure numericalmodelmodule::numericalmodeltype::get_iasym ( class(numericalmodeltype) this)
inherited

Definition at line 66 of file NumericalModel.f90.

◆ get_idv_scale() [1/2]

procedure numericalmodelmodule::numericalmodeltype::get_idv_scale ( class(numericalmodeltype) this)
inherited

Definition at line 67 of file NumericalModel.f90.

◆ get_idv_scale() [2/2]

procedure, public transportmodelmodule::transportmodeltype::get_idv_scale ( class(transportmodeltype) this)
inherited

Definition at line 79 of file tsp.f90.

◆ get_mcellid()

procedure numericalmodelmodule::numericalmodeltype::get_mcellid ( class(numericalmodeltype) this,
integer(i4b), intent(in) node,
character(len=*), intent(inout) mcellid )
inherited

Definition at line 64 of file NumericalModel.f90.

◆ get_mnodeu()

procedure numericalmodelmodule::numericalmodeltype::get_mnodeu ( class(numericalmodeltype) this,
integer(i4b), intent(in) node,
integer(i4b), intent(inout) nodeu )
inherited

Definition at line 65 of file NumericalModel.f90.

◆ get_mrange()

procedure numericalmodelmodule::numericalmodeltype::get_mrange ( class(numericalmodeltype) this,
integer(i4b), intent(inout) mstart,
integer(i4b), intent(inout) mend )
inherited

Definition at line 63 of file NumericalModel.f90.

◆ gweifmod_cr()

procedure, pass(this) gweinterfacemodelmodule::gweinterfacemodeltype::gweifmod_cr ( class(gweinterfacemodeltype) this,
character(len=*), intent(in) name,
integer(i4b), intent(in) iout,
class(gridconnectiontype), intent(in), pointer gridconn )
Parameters
thisthe GWE interface model
[in]namethe interface model's name
[in]ioutthe output unit
[in]gridconnthe grid connection data for creating a DISU

Definition at line 41 of file GweInterfaceModel.f90.

◆ log_namfile_options()

procedure, private transportmodelmodule::transportmodeltype::log_namfile_options ( class(transportmodeltype) this,
type(gwtnamparamfoundtype), intent(in) found )
privateinherited

Definition at line 85 of file tsp.f90.

◆ model_ac() [1/2]

procedure gwemodule::gwemodeltype::model_ac ( class(gwemodeltype) this,
type(sparsematrix), intent(inout) sparse )
inherited

Definition at line 44 of file gwe.f90.

◆ model_ac() [2/2]

procedure numericalmodelmodule::numericalmodeltype::model_ac ( class(numericalmodeltype) this,
type(sparsematrix), intent(inout) sparse )
inherited

Definition at line 36 of file NumericalModel.f90.

◆ model_ad() [1/2]

procedure gwemodule::gwemodeltype::model_ad ( class(gwemodeltype) this)
inherited

This subroutine calls the attached packages' advance subroutines

Definition at line 49 of file gwe.f90.

◆ model_ad() [2/2]

procedure numericalmodelmodule::numericalmodeltype::model_ad ( class(numericalmodeltype) this)
inherited

Definition at line 39 of file NumericalModel.f90.

◆ model_ar() [1/4]

procedure basemodelmodule::basemodeltype::model_ar ( class(basemodeltype) this)
inherited

Definition at line 35 of file BaseModel.f90.

◆ model_ar() [2/4]

procedure gweinterfacemodelmodule::gweinterfacemodeltype::model_ar ( class(gweinterfacemodeltype) this)
Parameters
thisthe GWE interface model

Definition at line 43 of file GweInterfaceModel.f90.

◆ model_ar() [3/4]

procedure gwemodule::gwemodeltype::model_ar ( class(gwemodeltype) this)
inherited

This subroutine:

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

Definition at line 46 of file gwe.f90.

◆ model_ar() [4/4]

procedure numericalmodelmodule::numericalmodeltype::model_ar ( class(numericalmodeltype) this)
inherited

Definition at line 32 of file NumericalModel.f90.

◆ model_bd() [1/2]

procedure gwemodule::gwemodeltype::model_bd ( class(gwemodeltype) this,
integer(i4b), intent(in) icnvg,
integer(i4b), intent(in) isuppress_output )
inherited

This subroutine:

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

Definition at line 54 of file gwe.f90.

◆ model_bd() [2/2]

procedure numericalmodelmodule::numericalmodeltype::model_bd ( class(numericalmodeltype) this,
integer(i4b), intent(in) icnvg,
integer(i4b), intent(in) isuppress_output )
inherited

Definition at line 50 of file NumericalModel.f90.

◆ model_bdcalc()

procedure numericalmodelmodule::numericalmodeltype::model_bdcalc ( class(numericalmodeltype) this,
integer(i4b), intent(in) icnvg )
inherited

Definition at line 51 of file NumericalModel.f90.

◆ model_bdentry() [1/2]

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

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 57 of file gwe.f90.

◆ model_bdentry() [2/2]

procedure numericalmodelmodule::numericalmodeltype::model_bdentry ( class(numericalmodeltype) this,
real(dp), dimension(:, :), intent(in) budterm,
character(len=lenbudtxt), dimension(:), intent(in) budtxt,
character(len=*), intent(in) rowlabel )
inherited

Definition at line 54 of file NumericalModel.f90.

◆ model_bdsave()

procedure numericalmodelmodule::numericalmodeltype::model_bdsave ( class(numericalmodeltype) this,
integer(i4b), intent(in) icnvg )
inherited

Definition at line 52 of file NumericalModel.f90.

◆ model_cc() [1/2]

procedure gwemodule::gwemodeltype::model_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 )
inherited

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

Definition at line 52 of file gwe.f90.

◆ model_cc() [2/2]

procedure numericalmodelmodule::numericalmodeltype::model_cc ( class(numericalmodeltype) 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 )
inherited

Definition at line 47 of file NumericalModel.f90.

◆ model_cf() [1/2]

procedure gwemodule::gwemodeltype::model_cf ( class(gwemodeltype) this,
integer(i4b), intent(in) kiter )
inherited

This subroutine calls the attached packages' calculate coefficients subroutines

Definition at line 50 of file gwe.f90.

◆ model_cf() [2/2]

procedure numericalmodelmodule::numericalmodeltype::model_cf ( class(numericalmodeltype) this,
integer(i4b), intent(in) kiter )
inherited

Definition at line 42 of file NumericalModel.f90.

◆ model_cq() [1/2]

procedure gwemodule::gwemodeltype::model_cq ( class(gwemodeltype) this,
integer(i4b), intent(in) icnvg,
integer(i4b), intent(in) isuppress_output )
inherited

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

Definition at line 53 of file gwe.f90.

◆ model_cq() [2/2]

procedure numericalmodelmodule::numericalmodeltype::model_cq ( class(numericalmodeltype) this,
integer(i4b), intent(in) icnvg,
integer(i4b), intent(in) isuppress_output )
inherited

Definition at line 49 of file NumericalModel.f90.

◆ model_da() [1/4]

procedure basemodelmodule::basemodeltype::model_da ( class(basemodeltype) this)
inherited

Definition at line 40 of file BaseModel.f90.

◆ model_da() [2/4]

procedure gweinterfacemodelmodule::gweinterfacemodeltype::model_da ( class(gweinterfacemodeltype) this)
Parameters
thisthe GWE interface model

Definition at line 44 of file GweInterfaceModel.f90.

◆ model_da() [3/4]

procedure gwemodule::gwemodeltype::model_da ( class(gwemodeltype) this)
inherited

Deallocate memory at conclusion of model run

Definition at line 56 of file gwe.f90.

◆ model_da() [4/4]

procedure numericalmodelmodule::numericalmodeltype::model_da ( class(numericalmodeltype) this)
inherited

Definition at line 34 of file NumericalModel.f90.

◆ model_df() [1/4]

procedure basemodelmodule::basemodeltype::model_df ( class(basemodeltype) this)
inherited

Definition at line 34 of file BaseModel.f90.

◆ model_df() [2/4]

procedure gweinterfacemodelmodule::gweinterfacemodeltype::model_df ( class(gweinterfacemodeltype) this)
Parameters
thisthe GWE interface model

Definition at line 42 of file GweInterfaceModel.f90.

◆ model_df() [3/4]

procedure gwemodule::gwemodeltype::model_df ( class(gwemodeltype) this)
inherited

This subroutine defines a gwe model type. Steps include:

  • call df routines for each package
  • set variables and pointers

Definition at line 43 of file gwe.f90.

◆ model_df() [4/4]

procedure numericalmodelmodule::numericalmodeltype::model_df ( class(numericalmodeltype) this)
inherited

Definition at line 31 of file NumericalModel.f90.

◆ model_dt() [1/2]

procedure basemodelmodule::basemodeltype::model_dt ( class(basemodeltype) this)
inherited

Definition at line 37 of file BaseModel.f90.

◆ model_dt() [2/2]

procedure gwemodule::gwemodeltype::model_dt ( class(gwemodeltype) this)
inherited

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 48 of file gwe.f90.

◆ model_fc() [1/2]

procedure gwemodule::gwemodeltype::model_fc ( class(gwemodeltype) this,
integer(i4b), intent(in) kiter,
class(matrixbasetype), pointer matrix_sln,
integer(i4b), intent(in) inwtflag )
inherited

This subroutine calls the attached packages' fill coefficients subroutines

Definition at line 51 of file gwe.f90.

◆ model_fc() [2/2]

procedure numericalmodelmodule::numericalmodeltype::model_fc ( class(numericalmodeltype) this,
integer(i4b), intent(in) kiter,
class(matrixbasetype), pointer matrix_sln,
integer(i4b), intent(in) inwtflag )
inherited

Definition at line 43 of file NumericalModel.f90.

◆ model_fp() [1/2]

procedure basemodelmodule::basemodeltype::model_fp ( class(basemodeltype) this)
inherited

Definition at line 39 of file BaseModel.f90.

◆ model_fp() [2/2]

procedure numericalmodelmodule::numericalmodeltype::model_fp ( class(numericalmodeltype) this)
inherited

Definition at line 33 of file NumericalModel.f90.

◆ model_mc() [1/2]

procedure gwemodule::gwemodeltype::model_mc ( class(gwemodeltype) this,
class(matrixbasetype), pointer matrix_sln )
inherited
Parameters
matrix_slnglobal system matrix

Definition at line 45 of file gwe.f90.

◆ model_mc() [2/2]

procedure numericalmodelmodule::numericalmodeltype::model_mc ( class(numericalmodeltype) this,
class(matrixbasetype), pointer matrix_sln )
inherited

Definition at line 37 of file NumericalModel.f90.

◆ model_message()

procedure basemodelmodule::basemodeltype::model_message ( class(basemodeltype) this,
character(len=*), intent(in) line,
character(len=*), intent(in), optional fmt )
inherited

Definition at line 42 of file BaseModel.f90.

◆ model_nr()

procedure numericalmodelmodule::numericalmodeltype::model_nr ( class(numericalmodeltype) this,
integer(i4b), intent(in) kiter,
class(matrixbasetype), pointer matrix,
integer(i4b), intent(in) inwtflag )
inherited

Definition at line 46 of file NumericalModel.f90.

◆ model_nur()

procedure numericalmodelmodule::numericalmodeltype::model_nur ( class(numericalmodeltype) this,
integer(i4b), intent(in) neqmod,
real(dp), dimension(neqmod), intent(inout) x,
real(dp), dimension(neqmod), intent(in) xtemp,
real(dp), dimension(neqmod), intent(inout) dx,
integer(i4b), intent(inout) inewtonur,
real(dp), intent(inout) dxmax,
integer(i4b), intent(inout) locmax )
inherited

Definition at line 48 of file NumericalModel.f90.

◆ model_ot() [1/3]

procedure basemodelmodule::basemodeltype::model_ot ( class(basemodeltype) this)
inherited

Definition at line 38 of file BaseModel.f90.

◆ model_ot() [2/3]

procedure numericalmodelmodule::numericalmodeltype::model_ot ( class(numericalmodeltype) this)
inherited

Definition at line 53 of file NumericalModel.f90.

◆ model_ot() [3/3]

procedure, public transportmodelmodule::transportmodeltype::model_ot ( class(transportmodeltype) this)
inherited

Generalized transport model output

Definition at line 73 of file tsp.f90.

◆ model_ptc()

procedure numericalmodelmodule::numericalmodeltype::model_ptc ( class(numericalmodeltype) this,
class(vectorbasetype), pointer vec_residual,
integer(i4b), intent(inout) iptc,
real(dp), intent(inout) ptcf )
inherited

Definition at line 45 of file NumericalModel.f90.

◆ model_ptcchk()

procedure numericalmodelmodule::numericalmodeltype::model_ptcchk ( class(numericalmodeltype) this,
integer(i4b), intent(inout) iptc )
inherited

Definition at line 44 of file NumericalModel.f90.

◆ model_reset()

procedure numericalmodelmodule::numericalmodeltype::model_reset ( class(numericalmodeltype) this)
inherited

Definition at line 40 of file NumericalModel.f90.

◆ model_rp() [1/3]

procedure basemodelmodule::basemodeltype::model_rp ( class(basemodeltype) this)
inherited

Definition at line 36 of file BaseModel.f90.

◆ model_rp() [2/3]

procedure gwemodule::gwemodeltype::model_rp ( class(gwemodeltype) this)
inherited

This subroutine calls the attached packages' read and prepare routines

Definition at line 47 of file gwe.f90.

◆ model_rp() [3/3]

procedure numericalmodelmodule::numericalmodeltype::model_rp ( class(numericalmodeltype) this)
inherited

Definition at line 38 of file NumericalModel.f90.

◆ model_solve()

procedure numericalmodelmodule::numericalmodeltype::model_solve ( class(numericalmodeltype) this)
inherited

Definition at line 41 of file NumericalModel.f90.

◆ package_create()

procedure, private gwemodule::gwemodeltype::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 )
privateinherited

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

Definition at line 62 of file gwe.f90.

◆ set_iboundptr()

procedure numericalmodelmodule::numericalmodeltype::set_iboundptr ( class(numericalmodeltype) this,
integer(i4b), dimension(:), intent(in), pointer, contiguous iboundsln,
integer(i4b) sln_offset,
character(len=*), intent(in) varnametgt,
character(len=*), intent(in) mempathtgt )
inherited

Definition at line 62 of file NumericalModel.f90.

◆ set_idsoln()

procedure numericalmodelmodule::numericalmodeltype::set_idsoln ( class(numericalmodeltype) this,
integer(i4b), intent(in) id )
inherited

Definition at line 59 of file NumericalModel.f90.

◆ set_moffset()

procedure numericalmodelmodule::numericalmodeltype::set_moffset ( class(numericalmodeltype) this,
integer(i4b), intent(in) moffset )
inherited

Definition at line 58 of file NumericalModel.f90.

◆ set_rhsptr()

procedure numericalmodelmodule::numericalmodeltype::set_rhsptr ( class(numericalmodeltype) this,
real(dp), dimension(:), intent(in), pointer, contiguous rhssln,
integer(i4b) sln_offset,
character(len=*), intent(in) varnametgt,
character(len=*), intent(in) mempathtgt )
inherited

Definition at line 61 of file NumericalModel.f90.

◆ set_tsp_labels()

procedure, public transportmodelmodule::transportmodeltype::set_tsp_labels ( class(transportmodeltype) this,
character(len=*), intent(in), pointer tsptype,
character(len=*), intent(in) depvartype,
character(len=*), intent(in) depvarunit,
character(len=*), intent(in) depvarunitabbrev )
inherited

Set variable names according to type of transport model

Parameters
[in]tsptypetype of model, default is GWT (alternative is GWE)
[in]depvartypedependent variable type, default is "CONCENTRATION"
[in]depvarunitunits of dependent variable for writing to list file
[in]depvarunitabbrevabbreviation of associated units

Definition at line 77 of file tsp.f90.

◆ set_xptr()

procedure numericalmodelmodule::numericalmodeltype::set_xptr ( class(numericalmodeltype) this,
real(dp), dimension(:), intent(in), pointer, contiguous xsln,
integer(i4b) sln_offset,
character(len=*), intent(in) varnametgt,
character(len=*), intent(in) mempathtgt )
inherited

Definition at line 60 of file NumericalModel.f90.

◆ tsp_ac()

procedure, public transportmodelmodule::transportmodeltype::tsp_ac ( class(transportmodeltype) this,
type(sparsematrix), intent(inout) sparse )
inherited

This subroutine extended by either GWT or GWE. This routine adds the internal connections of this model to the sparse matrix

Definition at line 64 of file tsp.f90.

◆ tsp_ad()

procedure, public transportmodelmodule::transportmodeltype::tsp_ad ( class(transportmodeltype) this)
inherited

This subroutine extended by either GWT or GWE. This routine calls the advance time step (ad) routines of attached packages.

Definition at line 68 of file tsp.f90.

◆ tsp_ar()

procedure, public transportmodelmodule::transportmodeltype::tsp_ar ( class(transportmodeltype) this)
inherited

This subroutine extended by either GWT or GWE. This routine calls the allocate and reads (ar) routines of attached packages and allocates memory for arrays required by the model object.

Definition at line 66 of file tsp.f90.

◆ tsp_bd()

procedure, public transportmodelmodule::transportmodeltype::tsp_bd ( class(transportmodeltype) this,
integer(i4b), intent(in) icnvg,
integer(i4b), intent(in) isuppress_output )
inherited

This subroutine extended by either GWT or GWE. This routine calculates package contributions to model budget

Definition at line 72 of file tsp.f90.

◆ tsp_cc()

procedure, public transportmodelmodule::transportmodeltype::tsp_cc ( class(transportmodeltype) 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 )
inherited

This subroutine extended by either GWT or GWE. This routine calls the convergence check (cc) routines of attached packages.

Definition at line 70 of file tsp.f90.

◆ tsp_cq()

procedure, public transportmodelmodule::transportmodeltype::tsp_cq ( class(transportmodeltype) this,
integer(i4b), intent(in) icnvg,
integer(i4b), intent(in) isuppress_output )
inherited

This subroutine extended by either GWT or GWE. This routine calculates intercell flows (flowja)

Definition at line 71 of file tsp.f90.

◆ tsp_cr()

procedure, public transportmodelmodule::transportmodeltype::tsp_cr ( class(transportmodeltype) this,
character(len=*), intent(in) filename,
integer(i4b), intent(in) id,
character(len=*), intent(in) modelname,
character(len=*), intent(in) macronym,
integer(i4b), intent(inout) indis )
inherited

Create a new transport model that will be further refined into GWT or GWE

Definition at line 61 of file tsp.f90.

◆ tsp_da()

procedure, public transportmodelmodule::transportmodeltype::tsp_da ( class(transportmodeltype) this)
inherited

Deallocate memory at conclusion of model run

Definition at line 63 of file tsp.f90.

◆ tsp_df()

procedure, public transportmodelmodule::transportmodeltype::tsp_df ( class(transportmodeltype) this)
inherited

This subroutine extended by either GWT or GWE. This routine calls the define (df) routines for each attached package and sets variables and pointers.

Definition at line 62 of file tsp.f90.

◆ tsp_fc()

procedure, public transportmodelmodule::transportmodeltype::tsp_fc ( class(transportmodeltype) this,
integer(i4b), intent(in) kiter,
class(matrixbasetype), pointer matrix_sln,
integer(i4b), intent(in) inwtflag )
inherited

This subroutine extended by either GWT or GWE. This routine calls the fill coefficients (fc) routines of attached packages.

Definition at line 69 of file tsp.f90.

◆ tsp_mc()

procedure, public transportmodelmodule::transportmodeltype::tsp_mc ( class(transportmodeltype) this,
class(matrixbasetype), pointer matrix_sln )
inherited

This subroutine extended by either GWT or GWE. This routine maps the positions of this models connections in the numerical solution coefficient matrix.

Parameters
matrix_slnglobal system matrix

Definition at line 65 of file tsp.f90.

◆ tsp_ot_bdsummary()

procedure, private transportmodelmodule::transportmodeltype::tsp_ot_bdsummary ( class(transportmodeltype) this,
integer(i4b), intent(in) ibudfl,
integer(i4b), intent(inout) ipflag )
privateinherited

Loop through attached packages and write budget summaries

Definition at line 83 of file tsp.f90.

◆ tsp_ot_dv()

procedure, public transportmodelmodule::transportmodeltype::tsp_ot_dv ( class(transportmodeltype) this,
integer(i4b), intent(in) idvsave,
integer(i4b), intent(in) idvprint,
integer(i4b), intent(inout) ipflag )
inherited

Loop through attached packages saving and printing dependent variables

Definition at line 75 of file tsp.f90.

◆ tsp_ot_flow() [1/2]

procedure gwemodule::gwemodeltype::tsp_ot_flow ( class(gwemodeltype) this,
integer(i4b), intent(in) icbcfl,
integer(i4b), intent(in) ibudfl,
integer(i4b), intent(in) icbcun )
inherited

Save and print flows

Definition at line 55 of file gwe.f90.

◆ tsp_ot_flow() [2/2]

procedure, public transportmodelmodule::transportmodeltype::tsp_ot_flow ( class(transportmodeltype) this,
integer(i4b), intent(in) icbcfl,
integer(i4b), intent(in) ibudfl,
integer(i4b), intent(in) icbcun )
inherited

Save and print flows

Definition at line 74 of file tsp.f90.

◆ tsp_ot_flowja()

procedure, private transportmodelmodule::transportmodeltype::tsp_ot_flowja ( class(transportmodeltype) this,
integer(i4b), intent(in) nja,
real(dp), dimension(nja), intent(in) flowja,
integer(i4b), intent(in) icbcfl,
integer(i4b), intent(in) icbcun )
privateinherited

Write intercell flows for the transport model

Definition at line 82 of file tsp.f90.

◆ tsp_ot_obs()

procedure, private transportmodelmodule::transportmodeltype::tsp_ot_obs ( class(transportmodeltype) this)
privateinherited

Calculate and save observations

Definition at line 81 of file tsp.f90.

◆ tsp_rp()

procedure, public transportmodelmodule::transportmodeltype::tsp_rp ( class(transportmodeltype) this)
inherited

This subroutine extended by either GWT or GWE. This routine calls the read and prepare (rp) routines of attached packages.

Definition at line 67 of file tsp.f90.

Member Data Documentation

◆ adv

type(tspadvtype), pointer transportmodelmodule::transportmodeltype::adv => null()
inherited

Definition at line 33 of file tsp.f90.

◆ bndlist

type(listtype), pointer basemodelmodule::basemodeltype::bndlist => null()
inherited

Definition at line 31 of file BaseModel.f90.

◆ budget

type(budgettype), pointer transportmodelmodule::transportmodeltype::budget => null()
inherited

Definition at line 40 of file tsp.f90.

◆ cnd

type(gwecndtype), pointer gwemodule::gwemodeltype::cnd => null()
inherited

Definition at line 37 of file gwe.f90.

◆ cond

real(dp), dimension(:), pointer, contiguous numericalmodelmodule::numericalmodeltype::cond => null()
inherited

Definition at line 25 of file NumericalModel.f90.

◆ depvartype

character(len=lenvarname) transportmodelmodule::transportmodeltype::depvartype = ''
inherited

Definition at line 52 of file tsp.f90.

◆ depvarunit

character(len=lenvarname) transportmodelmodule::transportmodeltype::depvarunit = ''
inherited

Definition at line 53 of file tsp.f90.

◆ depvarunitabbrev

character(len=lenvarname) transportmodelmodule::transportmodeltype::depvarunitabbrev = ''
inherited

Definition at line 54 of file tsp.f90.

◆ dis

class(disbasetype), pointer basemodelmodule::basemodeltype::dis => null()
inherited

Definition at line 32 of file BaseModel.f90.

◆ eqnsclfac

real(dp), pointer transportmodelmodule::transportmodeltype::eqnsclfac => null()
inherited

Definition at line 49 of file tsp.f90.

◆ est

type(gweesttype), pointer gwemodule::gwemodeltype::est => null()
inherited

Definition at line 36 of file gwe.f90.

◆ filename

character(len=linelength), pointer basemodelmodule::basemodeltype::filename => null()
inherited

Definition at line 19 of file BaseModel.f90.

◆ flowja

real(dp), dimension(:), pointer, contiguous basemodelmodule::basemodeltype::flowja => null()
inherited

Definition at line 30 of file BaseModel.f90.

◆ fmi

type(tspfmitype), pointer transportmodelmodule::transportmodeltype::fmi => null()
inherited

Definition at line 34 of file tsp.f90.

◆ gridconnection

class(gridconnectiontype), pointer gweinterfacemodelmodule::gweinterfacemodeltype::gridconnection => null()

Definition at line 33 of file GweInterfaceModel.f90.

◆ gwecommon

type(gweinputdatatype), pointer gwemodule::gwemodeltype::gwecommon => null()
inherited

Definition at line 35 of file gwe.f90.

◆ ia

integer(i4b), dimension(:), pointer, contiguous numericalmodelmodule::numericalmodeltype::ia => null()
inherited

Definition at line 21 of file NumericalModel.f90.

◆ iadvscheme

integer(i4b), pointer gweinterfacemodelmodule::gweinterfacemodeltype::iadvscheme => null()

Definition at line 29 of file GweInterfaceModel.f90.

◆ ibound

integer(i4b), dimension(:), pointer, contiguous basemodelmodule::basemodeltype::ibound => null()
inherited

Definition at line 29 of file BaseModel.f90.

◆ ic

type(tspictype), pointer transportmodelmodule::transportmodeltype::ic => null()
inherited

Definition at line 35 of file tsp.f90.

◆ icnvg

integer(i4b), pointer numericalmodelmodule::numericalmodeltype::icnvg => null()
inherited

Definition at line 20 of file NumericalModel.f90.

◆ id

integer(i4b), pointer basemodelmodule::basemodeltype::id => null()
inherited

Definition at line 22 of file BaseModel.f90.

◆ idsoln

integer(i4b), pointer basemodelmodule::basemodeltype::idsoln => null()
inherited

Definition at line 21 of file BaseModel.f90.

◆ idv_scale

integer(i4b), pointer transportmodelmodule::transportmodeltype::idv_scale => null()
inherited

Definition at line 56 of file tsp.f90.

◆ idxglo

integer(i4b), dimension(:), pointer, contiguous numericalmodelmodule::numericalmodeltype::idxglo => null()
inherited

Definition at line 26 of file NumericalModel.f90.

◆ ieqnsclfac

real(dp), pointer gweinterfacemodelmodule::gweinterfacemodeltype::ieqnsclfac => null()

Definition at line 31 of file GweInterfaceModel.f90.

◆ inadv

integer(i4b), pointer transportmodelmodule::transportmodeltype::inadv => null()
inherited

Definition at line 42 of file tsp.f90.

◆ incnd

integer(i4b), pointer gwemodule::gwemodeltype::incnd => null()
inherited

Definition at line 39 of file gwe.f90.

◆ inest

integer(i4b), pointer gwemodule::gwemodeltype::inest => null()
inherited

Definition at line 38 of file gwe.f90.

◆ inewton

integer(i4b), pointer basemodelmodule::basemodeltype::inewton => null()
inherited

Definition at line 24 of file BaseModel.f90.

◆ infmi

integer(i4b), pointer transportmodelmodule::transportmodeltype::infmi => null()
inherited

Definition at line 41 of file tsp.f90.

◆ inic

integer(i4b), pointer transportmodelmodule::transportmodeltype::inic => null()
inherited

Definition at line 43 of file tsp.f90.

◆ inmvt

integer(i4b), pointer transportmodelmodule::transportmodeltype::inmvt => null()
inherited

Definition at line 44 of file tsp.f90.

◆ inobs

integer(i4b), pointer transportmodelmodule::transportmodeltype::inobs => null()
inherited

Definition at line 46 of file tsp.f90.

◆ inoc

integer(i4b), pointer transportmodelmodule::transportmodeltype::inoc => null()
inherited

Definition at line 45 of file tsp.f90.

◆ inssm

integer(i4b), pointer transportmodelmodule::transportmodeltype::inssm => null()
inherited

Definition at line 48 of file tsp.f90.

◆ iout

integer(i4b), pointer basemodelmodule::basemodeltype::iout => null()
inherited

Definition at line 23 of file BaseModel.f90.

◆ ipakcb

integer(i4b), pointer basemodelmodule::basemodeltype::ipakcb => null()
inherited

Definition at line 27 of file BaseModel.f90.

◆ iprflow

integer(i4b), pointer basemodelmodule::basemodeltype::iprflow => null()
inherited

Definition at line 26 of file BaseModel.f90.

◆ iprpak

integer(i4b), pointer basemodelmodule::basemodeltype::iprpak => null()
inherited

Definition at line 25 of file BaseModel.f90.

◆ ixt3d

integer(i4b), pointer gweinterfacemodelmodule::gweinterfacemodeltype::ixt3d => null()

Definition at line 30 of file GweInterfaceModel.f90.

◆ ja

integer(i4b), dimension(:), pointer, contiguous numericalmodelmodule::numericalmodeltype::ja => null()
inherited

Definition at line 22 of file NumericalModel.f90.

◆ macronym

character(len=3), pointer basemodelmodule::basemodeltype::macronym => null()
inherited

Definition at line 20 of file BaseModel.f90.

◆ memorypath

character(len=lenmempath) basemodelmodule::basemodeltype::memorypath
inherited

Definition at line 17 of file BaseModel.f90.

17 character(len=LENMEMPATH) :: memoryPath !< the location in the memory manager where the variables are stored

◆ moffset

integer(i4b), pointer numericalmodelmodule::numericalmodeltype::moffset => null()
inherited

Definition at line 19 of file NumericalModel.f90.

◆ mvt

type(tspmvttype), pointer transportmodelmodule::transportmodeltype::mvt => null()
inherited

Definition at line 36 of file tsp.f90.

◆ name

character(len=lenmodelname), pointer basemodelmodule::basemodeltype::name => null()
inherited

Definition at line 18 of file BaseModel.f90.

◆ neq

integer(i4b), pointer numericalmodelmodule::numericalmodeltype::neq => null()
inherited

Definition at line 18 of file NumericalModel.f90.

◆ nja

integer(i4b), pointer basemodelmodule::basemodeltype::nja => null()
inherited

Definition at line 28 of file BaseModel.f90.

◆ obs

type(tspobstype), pointer transportmodelmodule::transportmodeltype::obs => null()
inherited

Definition at line 37 of file tsp.f90.

◆ oc

type(tspoctype), pointer transportmodelmodule::transportmodeltype::oc => null()
inherited

Definition at line 38 of file tsp.f90.

◆ owner

class(gwemodeltype), pointer, private gweinterfacemodelmodule::gweinterfacemodeltype::owner => null()
private

Definition at line 34 of file GweInterfaceModel.f90.

◆ porosity

real(dp), dimension(:), pointer, contiguous gweinterfacemodelmodule::gweinterfacemodeltype::porosity => null()

Definition at line 37 of file GweInterfaceModel.f90.

◆ rhs

real(dp), dimension(:), pointer, contiguous numericalmodelmodule::numericalmodeltype::rhs => null()
inherited

Definition at line 24 of file NumericalModel.f90.

◆ ssm

type(tspssmtype), pointer transportmodelmodule::transportmodeltype::ssm => null()
inherited

Definition at line 39 of file tsp.f90.

◆ tsptype

character(len=lenvarname) transportmodelmodule::transportmodeltype::tsptype = ''
inherited

Definition at line 51 of file tsp.f90.

◆ x

real(dp), dimension(:), pointer, contiguous numericalmodelmodule::numericalmodeltype::x => null()
inherited

Definition at line 23 of file NumericalModel.f90.

◆ xold

real(dp), dimension(:), pointer, contiguous numericalmodelmodule::numericalmodeltype::xold => null()
inherited

Definition at line 27 of file NumericalModel.f90.


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