MODFLOW 6 version 6.9.0.dev0
USGS Modular Hydrologic Model
Loading...
Searching...
No Matches
explicitsolutionmodule::explicitsolutiontype Type Referenceabstract

Manages and solves explicit models. More...

Inheritance diagram for explicitsolutionmodule::explicitsolutiontype:
Inheritance graph
Collaboration diagram for explicitsolutionmodule::explicitsolutiontype:
Collaboration graph

Public Member Functions

procedure sln_df (this)
 Define the solution.
procedure sln_ar (this)
 Allocate and read.
procedure sln_dt (this)
 Calculate time step length.
procedure sln_ad (this)
 Advance the solution.
procedure sln_ot (this)
 Output.
procedure sln_ca (this, isgcnvg, isuppress_output)
 Calculate.
procedure sln_fp (this)
procedure sln_da (this)
 Deallocate.
procedure add_model (this, mp)
 Add explicit model to list.
procedure add_exchange (this, exchange)
 Add exchange to list of exchanges.
procedure get_models (this)
 Get a pointer to a list of models in the solution.
procedure get_exchanges (this)
 Get list of exchanges.
procedure, public preparesolve (this)
 Prepare to solve.
procedure, public solve (this, kiter, isuppress_output)
 Solve models.
procedure, public finalizesolve (this, kiter, isgcnvg, isuppress_output)
 Finalize solve.
procedure(sln_df), deferred sln_df (this)
procedure(sln_ar), deferred sln_ar (this)
procedure(sln_dt), deferred sln_dt (this)
procedure(sln_ad), deferred sln_ad (this)
procedure(sln_ca), deferred sln_ca (this, isgcnvg, isuppress_output)
procedure(sln_ot), deferred sln_ot (this)
procedure(sln_fp), deferred sln_fp (this)
procedure(sln_da), deferred sln_da (this)
procedure(slnaddmodel), deferred add_model (this, mp)
procedure(slnaddexchange), deferred add_exchange (this, exchange)
procedure(slngetmodels), deferred get_models (this)
procedure(slngetexchanges), deferred get_exchanges (this)
procedure(preparesolve), deferred preparesolve (this)
procedure(solve), deferred solve (this, kiter, isuppress_output)
procedure(finalizesolve), deferred finalizesolve (this, kiter, isgcnvg, isuppress_output)

Public Attributes

character(len=lenmempath) memorypath
 the path for storing solution variables in the memory manager
type(listtype), pointer modellist
 list of models in solution
type(listtype), pointer exchangelist
 list of exchanges in solution
integer(i4b), pointer id
 solution number
integer(i4b), pointer iu
 input file unit
real(dp), pointer ttsoln
 timer - total solution time
integer(i4b), pointer icnvg => null()
 convergence flag
type(blockparsertype) parser
 block parser object
character(len=lensolutionname) name

Private Member Functions

procedure, private allocate_scalars (this)
 Allocate scalars.

Detailed Description

Definition at line 41 of file ExplicitSolution.f90.

Member Function/Subroutine Documentation

◆ add_exchange() [1/2]

procedure(slnaddexchange), deferred basesolutionmodule::basesolutiontype::add_exchange ( class(basesolutiontype) this,
class(baseexchangetype), intent(in), pointer exchange )
pure virtualinherited

Definition at line 28 of file BaseSolution.f90.

◆ add_exchange() [2/2]

procedure explicitsolutionmodule::explicitsolutiontype::add_exchange ( class(explicitsolutiontype) this,
class(baseexchangetype), intent(in), pointer exchange )

Definition at line 60 of file ExplicitSolution.f90.

◆ add_model() [1/2]

procedure(slnaddmodel), deferred basesolutionmodule::basesolutiontype::add_model ( class(basesolutiontype) this,
class(basemodeltype), intent(in), pointer mp )
pure virtualinherited

Definition at line 27 of file BaseSolution.f90.

◆ add_model() [2/2]

procedure explicitsolutionmodule::explicitsolutiontype::add_model ( class(explicitsolutiontype) this,
class(basemodeltype), intent(in), pointer mp )
Parameters
thisExplicitSolutionType instance
[in]mpmodel instance

Definition at line 59 of file ExplicitSolution.f90.

◆ allocate_scalars()

procedure, private explicitsolutionmodule::explicitsolutiontype::allocate_scalars ( class(explicitsolutiontype) this)
private
Parameters
thisExplicitSolutionType instance

Definition at line 65 of file ExplicitSolution.f90.

◆ finalizesolve() [1/2]

procedure(finalizesolve), deferred basesolutionmodule::basesolutiontype::finalizesolve ( class(basesolutiontype) this,
integer(i4b), intent(in) kiter,
integer(i4b), intent(inout) isgcnvg,
integer(i4b), intent(in) isuppress_output )
pure virtualinherited

Definition at line 35 of file BaseSolution.f90.

◆ finalizesolve() [2/2]

procedure, public explicitsolutionmodule::explicitsolutiontype::finalizesolve ( class(explicitsolutiontype) this,
integer(i4b), intent(in) kiter,
integer(i4b), intent(inout) isgcnvg,
integer(i4b), intent(in) isuppress_output )
Parameters
thisExplicitSolutionType instance
[in]kiterPicard iteration number (always 1 for explicit)
[in,out]isgcnvgsolution group convergence flag
[in]isuppress_outputflag for suppressing output

Definition at line 70 of file ExplicitSolution.f90.

◆ get_exchanges() [1/2]

procedure(slngetexchanges), deferred basesolutionmodule::basesolutiontype::get_exchanges ( class(basesolutiontype) this)
pure virtualinherited

Definition at line 30 of file BaseSolution.f90.

◆ get_exchanges() [2/2]

procedure explicitsolutionmodule::explicitsolutiontype::get_exchanges ( class(explicitsolutiontype) this)

Definition at line 62 of file ExplicitSolution.f90.

◆ get_models() [1/2]

procedure(slngetmodels), deferred basesolutionmodule::basesolutiontype::get_models ( class(basesolutiontype) this)
pure virtualinherited

Definition at line 29 of file BaseSolution.f90.

◆ get_models() [2/2]

procedure explicitsolutionmodule::explicitsolutiontype::get_models ( class(explicitsolutiontype) this)
Returns
pointer to the model list
Parameters
thisExplicitSolutionType instance

Definition at line 61 of file ExplicitSolution.f90.

◆ preparesolve() [1/2]

procedure(preparesolve), deferred basesolutionmodule::basesolutiontype::preparesolve ( class(basesolutiontype) this)
pure virtualinherited

Definition at line 33 of file BaseSolution.f90.

◆ preparesolve() [2/2]

procedure, public explicitsolutionmodule::explicitsolutiontype::preparesolve ( class(explicitsolutiontype) this)
Parameters
thisExplicitSolutionType instance

Definition at line 68 of file ExplicitSolution.f90.

◆ sln_ad() [1/2]

procedure(sln_ad), deferred basesolutionmodule::basesolutiontype::sln_ad ( class(basesolutiontype) this)
pure virtualinherited

Definition at line 21 of file BaseSolution.f90.

◆ sln_ad() [2/2]

procedure explicitsolutionmodule::explicitsolutiontype::sln_ad ( class(explicitsolutiontype) this)
Parameters
thisExplicitSolutionType instance

Definition at line 54 of file ExplicitSolution.f90.

◆ sln_ar() [1/2]

procedure(sln_ar), deferred basesolutionmodule::basesolutiontype::sln_ar ( class(basesolutiontype) this)
pure virtualinherited

Definition at line 19 of file BaseSolution.f90.

◆ sln_ar() [2/2]

procedure explicitsolutionmodule::explicitsolutiontype::sln_ar ( class(explicitsolutiontype) this)
Parameters
thisExplicitSolutionType instance

Definition at line 52 of file ExplicitSolution.f90.

◆ sln_ca() [1/2]

procedure(sln_ca), deferred basesolutionmodule::basesolutiontype::sln_ca ( class(basesolutiontype) this,
integer(i4b), intent(inout) isgcnvg,
integer(i4b), intent(in) isuppress_output )
pure virtualinherited

Definition at line 22 of file BaseSolution.f90.

◆ sln_ca() [2/2]

procedure explicitsolutionmodule::explicitsolutiontype::sln_ca ( class(explicitsolutiontype) this,
integer(i4b), intent(inout) isgcnvg,
integer(i4b), intent(in) isuppress_output )
Parameters
thisExplicitSolutionType instance
[in,out]isgcnvgsolution group convergence flag
[in]isuppress_outputflag for suppressing output

Definition at line 56 of file ExplicitSolution.f90.

◆ sln_da() [1/2]

procedure(sln_da), deferred basesolutionmodule::basesolutiontype::sln_da ( class(basesolutiontype) this)
pure virtualinherited

Definition at line 25 of file BaseSolution.f90.

◆ sln_da() [2/2]

procedure explicitsolutionmodule::explicitsolutiontype::sln_da ( class(explicitsolutiontype) this)
Parameters
thisExplicitSolutionType instance

Definition at line 58 of file ExplicitSolution.f90.

◆ sln_df() [1/2]

procedure(sln_df), deferred basesolutionmodule::basesolutiontype::sln_df ( class(basesolutiontype) this)
pure virtualinherited

Definition at line 18 of file BaseSolution.f90.

◆ sln_df() [2/2]

procedure explicitsolutionmodule::explicitsolutiontype::sln_df ( class(explicitsolutiontype) this)

Definition at line 51 of file ExplicitSolution.f90.

◆ sln_dt() [1/2]

procedure(sln_dt), deferred basesolutionmodule::basesolutiontype::sln_dt ( class(basesolutiontype) this)
pure virtualinherited

Definition at line 20 of file BaseSolution.f90.

◆ sln_dt() [2/2]

procedure explicitsolutionmodule::explicitsolutiontype::sln_dt ( class(explicitsolutiontype) this)
Parameters
thisExplicitSolutionType instance

Definition at line 53 of file ExplicitSolution.f90.

◆ sln_fp() [1/2]

procedure(sln_fp), deferred basesolutionmodule::basesolutiontype::sln_fp ( class(basesolutiontype) this)
pure virtualinherited

Definition at line 24 of file BaseSolution.f90.

◆ sln_fp() [2/2]

procedure explicitsolutionmodule::explicitsolutiontype::sln_fp ( class(explicitsolutiontype) this)
Parameters
thisExplicitSolutionType instance

Definition at line 57 of file ExplicitSolution.f90.

◆ sln_ot() [1/2]

procedure(sln_ot), deferred basesolutionmodule::basesolutiontype::sln_ot ( class(basesolutiontype) this)
pure virtualinherited

Definition at line 23 of file BaseSolution.f90.

◆ sln_ot() [2/2]

procedure explicitsolutionmodule::explicitsolutiontype::sln_ot ( class(explicitsolutiontype) this)
Parameters
thisExplicitSolutionType instance

Definition at line 55 of file ExplicitSolution.f90.

◆ solve() [1/2]

procedure(solve), deferred basesolutionmodule::basesolutiontype::solve ( class(basesolutiontype) this,
integer(i4b), intent(in) kiter,
integer(i4b), intent(in) isuppress_output )
pure virtualinherited

Definition at line 34 of file BaseSolution.f90.

◆ solve() [2/2]

procedure, public explicitsolutionmodule::explicitsolutiontype::solve ( class(explicitsolutiontype) this,
integer(i4b), intent(in) kiter,
integer(i4b), intent(in) isuppress_output )
Parameters
thisExplicitSolutionType instance
[in]kiterPicard iteration (1 for explicit)
[in]isuppress_outputflag for suppressing output

Definition at line 69 of file ExplicitSolution.f90.

Member Data Documentation

◆ exchangelist

type(listtype), pointer explicitsolutionmodule::explicitsolutiontype::exchangelist

Definition at line 44 of file ExplicitSolution.f90.

44 type(ListType), pointer :: exchangelist !< list of exchanges in solution

◆ icnvg

integer(i4b), pointer explicitsolutionmodule::explicitsolutiontype::icnvg => null()

Definition at line 48 of file ExplicitSolution.f90.

◆ id

integer(i4b), pointer explicitsolutionmodule::explicitsolutiontype::id

Definition at line 45 of file ExplicitSolution.f90.

45 integer(I4B), pointer :: id !< solution number

◆ iu

integer(i4b), pointer explicitsolutionmodule::explicitsolutiontype::iu

Definition at line 46 of file ExplicitSolution.f90.

46 integer(I4B), pointer :: iu !< input file unit

◆ memorypath

character(len=lenmempath) explicitsolutionmodule::explicitsolutiontype::memorypath

Definition at line 42 of file ExplicitSolution.f90.

42 character(len=LENMEMPATH) :: memoryPath !< the path for storing solution variables in the memory manager

◆ modellist

type(listtype), pointer explicitsolutionmodule::explicitsolutiontype::modellist

Definition at line 43 of file ExplicitSolution.f90.

43 type(ListType), pointer :: modellist !< list of models in solution

◆ name

character(len=lensolutionname) basesolutionmodule::basesolutiontype::name
inherited

Definition at line 16 of file BaseSolution.f90.

16 character(len=LENSOLUTIONNAME) :: name

◆ parser

type(blockparsertype) explicitsolutionmodule::explicitsolutiontype::parser

Definition at line 49 of file ExplicitSolution.f90.

49 type(BlockParserType) :: parser !< block parser object

◆ ttsoln

real(dp), pointer explicitsolutionmodule::explicitsolutiontype::ttsoln

Definition at line 47 of file ExplicitSolution.f90.

47 real(DP), pointer :: ttsoln !< timer - total solution time

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