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

Default storage formulation. More...

Inheritance diagram for gwfstomodule::defaultstorageformulationtype:
Inheritance graph
Collaboration diagram for gwfstomodule::defaultstorageformulationtype:
Collaboration graph

Public Member Functions

procedure is_active (this, n)
 The default formulation uses the claim mask, not is_active.
procedure fc (this, kiter, matrix_sln, rhs, idxglo, h_old, h_new)
 Fill coefficients for the default storage formulation.
procedure fn (this, kiter, matrix_sln, rhs, idxglo, h_old, h_new)
 Fill newton terms for the default storage formulation.
procedure cq (this, flowja, h_new, h_old)
 Calculate flows for the default storage formulation.
procedure bd (this, isuppress_output, model_budget)
 Default storage budget is handled directly by sto_bd.
procedure save_flows (this, iprint, ibinun)
 Default storage flows are saved directly by sto_save_model_flows.
procedure(is_active_if), deferred is_active (this, n)
procedure(fc_if), deferred fc (this, kiter, matrix_sln, rhs, idxglo, h_old, h_new)
procedure(fn_if), deferred fn (this, kiter, matrix_sln, rhs, idxglo, h_old, h_new)
procedure(cq_if), deferred cq (this, flowja, h_new, h_old)
procedure(bd_if), deferred bd (this, isuppress_output, model_budget)
procedure(save_flows_if), deferred save_flows (this, iprint, ibinun)

Public Attributes

class(gwfstotype), pointer sto => null()
 owning STO package

Detailed Description

Wraps the standard STO fill so it participates in the additive list of storage formulations. Nodes claimed by an exclusive formulation are skipped.

Definition at line 90 of file gwf-sto.f90.

Member Function/Subroutine Documentation

◆ bd() [1/2]

procedure(bd_if), deferred gwfstoextmodule::gwfstoformulationtype::bd ( class(gwfstoformulationtype), intent(inout) this,
integer(i4b), intent(in) isuppress_output,
type(budgettype), intent(inout) model_budget )
pure virtualinherited

Definition at line 19 of file GwfStoExt.f90.

◆ bd() [2/2]

procedure gwfstomodule::defaultstorageformulationtype::bd ( class(defaultstorageformulationtype), intent(inout) this,
integer(i4b), intent(in) isuppress_output,
type(budgettype), intent(inout) model_budget )
Parameters
[in,out]thisdefault formulation
[in]isuppress_outputflag to suppress model output
[in,out]model_budgetmodel budget object

Definition at line 97 of file gwf-sto.f90.

◆ cq() [1/2]

procedure(cq_if), deferred gwfstoextmodule::gwfstoformulationtype::cq ( class(gwfstoformulationtype), intent(inout) this,
real(dp), dimension(:), intent(inout) flowja,
real(dp), dimension(:), intent(in) h_new,
real(dp), dimension(:), intent(in) h_old )
pure virtualinherited

Definition at line 18 of file GwfStoExt.f90.

◆ cq() [2/2]

procedure gwfstomodule::defaultstorageformulationtype::cq ( class(defaultstorageformulationtype), intent(inout) this,
real(dp), dimension(:), intent(inout) flowja,
real(dp), dimension(:), intent(in) h_new,
real(dp), dimension(:), intent(in) h_old )

Runs over all cells and stores the standard STO change in storage, skipping cells claimed by an exclusive formulation.

Parameters
[in,out]thisdefault formulation
[in,out]flowjaconnection flows
[in]h_newcurrent head
[in]h_oldprevious head

Definition at line 96 of file gwf-sto.f90.

◆ fc() [1/2]

procedure(fc_if), deferred gwfstoextmodule::gwfstoformulationtype::fc ( class(gwfstoformulationtype), intent(inout) this,
integer(i4b), intent(in) kiter,
class(matrixbasetype), intent(inout), pointer matrix_sln,
real(dp), dimension(:), intent(inout) rhs,
integer(i4b), dimension(:), intent(in) idxglo,
real(dp), dimension(:), intent(in) h_old,
real(dp), dimension(:), intent(in) h_new )
pure virtualinherited

Definition at line 16 of file GwfStoExt.f90.

◆ fc() [2/2]

procedure gwfstomodule::defaultstorageformulationtype::fc ( class(defaultstorageformulationtype), intent(inout) this,
integer(i4b), intent(in) kiter,
class(matrixbasetype), intent(inout), pointer matrix_sln,
real(dp), dimension(:), intent(inout) rhs,
integer(i4b), dimension(:), intent(in) idxglo,
real(dp), dimension(:), intent(in) h_old,
real(dp), dimension(:), intent(in) h_new )

Runs over all cells and fills the standard STO terms, skipping cells claimed by an exclusive formulation.

Parameters
[in,out]thisdefault formulation
[in]kiterouter iteration number
[in,out]matrix_slnA matrix
[in,out]rhsright-hand side
[in]idxgloglobal index model to solution
[in]h_oldprevious heads
[in]h_newcurrent heads

Definition at line 94 of file gwf-sto.f90.

◆ fn() [1/2]

procedure(fn_if), deferred gwfstoextmodule::gwfstoformulationtype::fn ( class(gwfstoformulationtype), intent(inout) this,
integer(i4b), intent(in) kiter,
class(matrixbasetype), intent(inout), pointer matrix_sln,
real(dp), dimension(:), intent(inout) rhs,
integer(i4b), dimension(:), intent(in) idxglo,
real(dp), dimension(:), intent(in) h_old,
real(dp), dimension(:), intent(in) h_new )
pure virtualinherited

Definition at line 17 of file GwfStoExt.f90.

◆ fn() [2/2]

procedure gwfstomodule::defaultstorageformulationtype::fn ( class(defaultstorageformulationtype), intent(inout) this,
integer(i4b), intent(in) kiter,
class(matrixbasetype), intent(inout), pointer matrix_sln,
real(dp), dimension(:), intent(inout) rhs,
integer(i4b), dimension(:), intent(in) idxglo,
real(dp), dimension(:), intent(in) h_old,
real(dp), dimension(:), intent(in) h_new )

Runs over all cells and fills the standard STO newton terms, skipping cells claimed by an exclusive formulation.

Parameters
[in,out]thisdefault formulation
[in]kiterouter iteration number
[in,out]matrix_slnA matrix
[in,out]rhsright-hand side
[in]idxgloglobal index model to solution
[in]h_oldprevious heads
[in]h_newcurrent heads

Definition at line 95 of file gwf-sto.f90.

◆ is_active() [1/2]

procedure(is_active_if), deferred gwfstoextmodule::gwfstoformulationtype::is_active ( class(gwfstoformulationtype), intent(inout) this,
integer(i4b), intent(in) n )
pure virtualinherited

Definition at line 15 of file GwfStoExt.f90.

◆ is_active() [2/2]

procedure gwfstomodule::defaultstorageformulationtype::is_active ( class(defaultstorageformulationtype), intent(inout) this,
integer(i4b), intent(in) n )
Parameters
[in,out]thisdefault formulation
[in]nnode number
Returns
always false for the default formulation

Definition at line 93 of file gwf-sto.f90.

◆ save_flows() [1/2]

procedure(save_flows_if), deferred gwfstoextmodule::gwfstoformulationtype::save_flows ( class(gwfstoformulationtype), intent(inout) this,
integer(i4b), intent(in) iprint,
integer(i4b), intent(in) ibinun )
pure virtualinherited

Definition at line 20 of file GwfStoExt.f90.

◆ save_flows() [2/2]

procedure gwfstomodule::defaultstorageformulationtype::save_flows ( class(defaultstorageformulationtype), intent(inout) this,
integer(i4b), intent(in) iprint,
integer(i4b), intent(in) ibinun )
Parameters
[in,out]thisdefault formulation
[in]iprintprint flag
[in]ibinuncell-by-cell file unit number

Definition at line 98 of file gwf-sto.f90.

Member Data Documentation

◆ sto

class(gwfstotype), pointer gwfstomodule::defaultstorageformulationtype::sto => null()

Definition at line 91 of file gwf-sto.f90.


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