MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
numericalmodelmodule::numericalmodeltype Type Reference
Inheritance diagram for numericalmodelmodule::numericalmodeltype:
Inheritance graph
Collaboration diagram for numericalmodelmodule::numericalmodeltype:
Collaboration graph

Public Member Functions

procedure model_df (this)
procedure model_ar (this)
procedure model_fp (this)
procedure model_da (this)
procedure model_ac (this, sparse)
procedure model_mc (this, matrix_sln)
procedure model_rp (this)
procedure model_ad (this)
procedure model_reset (this)
procedure model_solve (this)
procedure model_cf (this, kiter)
procedure model_fc (this, kiter, matrix_sln, inwtflag)
procedure model_ptcchk (this, iptc)
procedure model_ptc (this, vec_residual, iptc, ptcf)
procedure model_nr (this, kiter, matrix, inwtflag)
procedure model_cc (this, innertot, kiter, iend, icnvgmod, cpak, ipak, dpak)
procedure model_nur (this, neqmod, x, xtemp, dx, inewtonur, dxmax, locmax)
procedure model_cq (this, icnvg, isuppress_output)
procedure model_bd (this, icnvg, isuppress_output)
procedure model_bdcalc (this, icnvg)
procedure model_bdsave (this, icnvg)
procedure model_ot (this)
procedure model_bdentry (this, budterm, budtxt, rowlabel)
procedure allocate_scalars (this, modelname)
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 get_iasym (this)
procedure get_idv_scale (this)
procedure model_df (this)
 Define the model.
procedure model_ar (this)
 Allocate and read.
procedure model_rp (this)
 Read and prepare.
procedure model_dt (this)
 Calculate time step length.
procedure model_ot (this)
 Output results.
procedure model_fp (this)
 Final processing.
procedure model_da (this)
 Deallocate.
procedure allocate_scalars (this, modelname)
 Allocate scalar variables.
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 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

Detailed Description

Definition at line 17 of file NumericalModel.f90.

Member Function/Subroutine Documentation

◆ allocate_arrays()

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

Definition at line 57 of file NumericalModel.f90.

◆ allocate_scalars() [1/2]

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/2]

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

Definition at line 56 of file NumericalModel.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.

◆ get_iasym()

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

Definition at line 66 of file NumericalModel.f90.

◆ get_idv_scale()

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

Definition at line 67 of file NumericalModel.f90.

◆ get_mcellid()

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

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 )

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 )

Definition at line 63 of file NumericalModel.f90.

◆ model_ac()

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

Definition at line 36 of file NumericalModel.f90.

◆ model_ad()

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

Definition at line 39 of file NumericalModel.f90.

◆ model_ar() [1/2]

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

Definition at line 35 of file BaseModel.f90.

◆ model_ar() [2/2]

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

Definition at line 32 of file NumericalModel.f90.

◆ model_bd()

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

Definition at line 50 of file NumericalModel.f90.

◆ model_bdcalc()

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

Definition at line 51 of file NumericalModel.f90.

◆ model_bdentry()

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 )

Definition at line 54 of file NumericalModel.f90.

◆ model_bdsave()

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

Definition at line 52 of file NumericalModel.f90.

◆ model_cc()

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 )

Definition at line 47 of file NumericalModel.f90.

◆ model_cf()

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

Definition at line 42 of file NumericalModel.f90.

◆ model_cq()

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

Definition at line 49 of file NumericalModel.f90.

◆ model_da() [1/2]

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

Definition at line 40 of file BaseModel.f90.

◆ model_da() [2/2]

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

Definition at line 34 of file NumericalModel.f90.

◆ model_df() [1/2]

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

Definition at line 34 of file BaseModel.f90.

◆ model_df() [2/2]

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

Definition at line 31 of file NumericalModel.f90.

◆ model_dt()

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

Definition at line 37 of file BaseModel.f90.

◆ model_fc()

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

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)

Definition at line 33 of file NumericalModel.f90.

◆ model_mc()

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

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 )

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 )

Definition at line 48 of file NumericalModel.f90.

◆ model_ot() [1/2]

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

Definition at line 38 of file BaseModel.f90.

◆ model_ot() [2/2]

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

Definition at line 53 of file NumericalModel.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 )

Definition at line 45 of file NumericalModel.f90.

◆ model_ptcchk()

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

Definition at line 44 of file NumericalModel.f90.

◆ model_reset()

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

Definition at line 40 of file NumericalModel.f90.

◆ model_rp() [1/2]

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

Definition at line 36 of file BaseModel.f90.

◆ model_rp() [2/2]

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

Definition at line 38 of file NumericalModel.f90.

◆ model_solve()

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

Definition at line 41 of file NumericalModel.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 )

Definition at line 62 of file NumericalModel.f90.

◆ set_idsoln()

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

Definition at line 59 of file NumericalModel.f90.

◆ set_moffset()

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

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 )

Definition at line 61 of file NumericalModel.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 )

Definition at line 60 of file NumericalModel.f90.

Member Data Documentation

◆ bndlist

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

Definition at line 31 of file BaseModel.f90.

◆ cond

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

Definition at line 25 of file NumericalModel.f90.

◆ dis

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

Definition at line 32 of file BaseModel.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.

◆ ia

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

Definition at line 21 of file NumericalModel.f90.

◆ ibound

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

Definition at line 29 of file BaseModel.f90.

◆ icnvg

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

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.

◆ idxglo

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

Definition at line 26 of file NumericalModel.f90.

◆ inewton

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

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

◆ ja

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

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()

Definition at line 19 of file NumericalModel.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()

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.

◆ rhs

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

Definition at line 24 of file NumericalModel.f90.

◆ x

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

Definition at line 23 of file NumericalModel.f90.

◆ xold

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

Definition at line 27 of file NumericalModel.f90.


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