gwfstorageutilsmodule Module Reference

This module contains stateless storage subroutines and functions. More...

Functions/Subroutines
pure subroutine, public	ssterms (iconvert, iorig_ss, iconf_ss, top, bot, rho1, rho1old, snnew, snold, hnew, hold, aterm, rhsterm, rate)
	Calculate the specific storage terms. More...
pure subroutine, public	syterms (top, bot, rho2, rho2old, snnew, snold, aterm, rhsterm, rate)
	Calculate the specific yield storage terms. More...
pure real(dp) function, public	sscapacity (istor_coef, top, bot, area, ss)
	Calculate the specific storage capacity. More...
pure real(dp) function, public	sycapacity (area, sy)
	Calculate the specific yield capacity. More...

Detailed Description

This module contains the functions to calculate the specific storage (SC1) and specific yield (SC2) capacities that are used in the storage (STO) package. It also contains subroutines to calculate the amat and rhs terms for specific storage and specific yield. This module does not depend on the STO package.

Function/Subroutine Documentation

sscapacity()

pure real(dp) function, public gwfstorageutilsmodule::sscapacity	(	integer(i4b), intent(in)	istor_coef,
		real(dp), intent(in)	top,
		real(dp), intent(in)	bot,
		real(dp), intent(in)	area,
		real(dp), intent(in)	ss
	)

Function to calculate the specific storage capacity using the cell geometry and the specific storage or storage coefficient.

Returns

sc1 specific storage capacity

Parameters

[in]	istor_coef	flag indicating if ss is the storage coefficient
[in]	top	top of cell
[in]	bot	bottom of cell
[in]	area	horizontal cell area
[in]	ss	specific storage or storage coefficient

Definition at line 143 of file GwfStorageUtils.f90.

    ! -- dummy variables
    integer(I4B), intent(in) :: istor_coef !< flag indicating if ss is the storage coefficient
    real(DP), intent(in) :: top !< top of cell
    real(DP), intent(in) :: bot !< bottom of cell
    real(DP), intent(in) :: area !< horizontal cell area
    real(DP), intent(in) :: ss !< specific storage or storage coefficient
    ! -- local variables
    real(DP) :: sc1
    real(DP) :: thick
    ! -- calculate specific storage capacity
    if (istor_coef == 0) then
      thick = top - bot
    else
      thick = done
    end if
    sc1 = ss * thick * area

Here is the caller graph for this function:

ssterms()

pure subroutine, public gwfstorageutilsmodule::ssterms	(	integer(i4b), intent(in)	iconvert,
		integer(i4b), intent(in)	iorig_ss,
		integer(i4b), intent(in)	iconf_ss,
		real(dp), intent(in)	top,
		real(dp), intent(in)	bot,
		real(dp), intent(in)	rho1,
		real(dp), intent(in)	rho1old,
		real(dp), intent(in)	snnew,
		real(dp), intent(in)	snold,
		real(dp), intent(in)	hnew,
		real(dp), intent(in)	hold,
		real(dp), intent(inout)	aterm,
		real(dp), intent(inout)	rhsterm,
		real(dp), intent(inout), optional	rate
	)

Subroutine to calculate the specific storage terms for a cell using the cell geometry, current and previous specific storage capacity, current and previous cell saturation, and the current and previous head. Subroutine can optionally return the flow rate from specific storage.

Parameters

[in]	iconvert	flag indicating if cell is convertible
[in]	iorig_ss	flag indicating if the original MODFLOW 6 specific storage formulation is being used
[in]	iconf_ss	flag indicating if specific storage only applies under confined conditions
[in]	top	top of cell
[in]	bot	bottom of cell
[in]	rho1	current specific storage capacity
[in]	rho1old	previous specific storage capacity
[in]	snnew	current cell saturation
[in]	snold	previous cell saturation
[in]	hnew	current head
[in]	hold	previous head
[in,out]	aterm	coefficient matrix term
[in,out]	rhsterm	right-hand side term
[in,out]	rate	calculated specific storage rate

Definition at line 32 of file GwfStorageUtils.f90.

    ! -- dummy variables
    integer(I4B), intent(in) :: iconvert !< flag indicating if cell is convertible
    integer(I4B), intent(in) :: iorig_ss !< flag indicating if the original MODFLOW 6 specific storage formulation is being used
    integer(I4B), intent(in) :: iconf_ss !< flag indicating if specific storage only applies under confined conditions
    real(DP), intent(in) :: top !< top of cell
    real(DP), intent(in) :: bot !< bottom of cell
    real(DP), intent(in) :: rho1 !< current specific storage capacity
    real(DP), intent(in) :: rho1old !< previous specific storage capacity
    real(DP), intent(in) :: snnew !< current cell saturation
    real(DP), intent(in) :: snold !< previous cell saturation
    real(DP), intent(in) :: hnew !< current head
    real(DP), intent(in) :: hold !< previous head
    real(DP), intent(inout) :: aterm !< coefficient matrix term
    real(DP), intent(inout) :: rhsterm !< right-hand side term
    real(DP), intent(inout), optional :: rate !< calculated specific storage rate
    ! -- local variables
    real(DP) :: tthk
    real(DP) :: zold
    real(DP) :: znew
    !
    ! -- initialize terms
    aterm = -rho1 * snnew
    rhsterm = dzero
    !
    ! -- calculate specific storage terms
    if (iconvert /= 0) then
      if (iorig_ss == 0) then
        if (iconf_ss == 0) then
          tthk = top - bot
          zold = bot + dhalf * tthk * snold
          znew = bot + dhalf * tthk * snnew
          rhsterm = -rho1old * snold * (hold - zold) - rho1 * snnew * znew
        else
          if (snold == done) then
            rhsterm = rhsterm - rho1old * (hold - top)
          end if
          if (snnew == done) then
            rhsterm = rhsterm - rho1 * top
          else
            aterm = dzero
          end if
        end if
      else
        rhsterm = -rho1old * snold * hold
      end if
    else
      rhsterm = -rho1old * snold * hold
    end if
    !
    ! -- calculate rate
    if (present(rate)) then
      rate = aterm * hnew - rhsterm
    end if

Here is the caller graph for this function:

sycapacity()

pure real(dp) function, public gwfstorageutilsmodule::sycapacity	(	real(dp), intent(in)	area,
		real(dp), intent(in)	sy
	)

Function to calculate the specific yield capacity using the cell area and the specific yield.

Returns

sc2 specific yield capacity

Parameters

[in]	area	horizontal cell area
[in]	sy	specific yield

Definition at line 169 of file GwfStorageUtils.f90.

    ! -- dummy variables
    real(DP), intent(in) :: area !< horizontal cell area
    real(DP), intent(in) :: sy !< specific yield
    ! -- local variables
    real(DP) :: sc2
    ! -- calculate specific yield capacity
    sc2 = sy * area

Here is the caller graph for this function:

syterms()

pure subroutine, public gwfstorageutilsmodule::syterms	(	real(dp), intent(in)	top,
		real(dp), intent(in)	bot,
		real(dp), intent(in)	rho2,
		real(dp), intent(in)	rho2old,
		real(dp), intent(in)	snnew,
		real(dp), intent(in)	snold,
		real(dp), intent(inout)	aterm,
		real(dp), intent(inout)	rhsterm,
		real(dp), intent(inout), optional	rate
	)

Subroutine to calculate the specific yield storage terms for a cell using the cell geometry, current and previous specific yield storage capacity, and the current and previous cell saturation. Subroutine can optionally return the flow rate from specific yield.

Parameters

[in]	top	top of cell
[in]	bot	bottom of cell
[in]	rho2	current specific yield storage capacity
[in]	rho2old	previous specific yield storage capacity
[in]	snnew	current cell saturation
[in]	snold	previous cell saturation
[in,out]	aterm	coefficient matrix term
[in,out]	rhsterm	right-hand side term
[in,out]	rate	calculated specific yield rate

Definition at line 98 of file GwfStorageUtils.f90.

    ! -- dummy variables
    real(DP), intent(in) :: top !< top of cell
    real(DP), intent(in) :: bot !< bottom of cell
    real(DP), intent(in) :: rho2 !< current specific yield storage capacity
    real(DP), intent(in) :: rho2old !< previous specific yield storage capacity
    real(DP), intent(in) :: snnew !< current cell saturation
    real(DP), intent(in) :: snold !< previous cell saturation
    real(DP), intent(inout) :: aterm !< coefficient matrix term
    real(DP), intent(inout) :: rhsterm !< right-hand side term
    real(DP), intent(inout), optional :: rate !< calculated specific yield rate
    ! -- local variables
    real(DP) :: tthk
    !
    ! -- initialize terms
    aterm = dzero
    tthk = top - bot
    !
    ! -- calculate specific yield storage terms
    if (snnew < done) then
      if (snnew > dzero) then
        aterm = -rho2
        rhsterm = -rho2old * tthk * snold - rho2 * bot
      else
        rhsterm = tthk * (dzero - rho2old * snold)
      end if
      ! -- known flow from specific yield
    else
      rhsterm = tthk * (rho2 * snnew - rho2old * snold)
    end if
    !
    ! -- calculate rate
    if (present(rate)) then
      rate = rho2old * tthk * snold - rho2 * tthk * snnew
    end if

Here is the caller graph for this function: