methodmodelmodule Module Reference

Data Types
type	methodmodeltype

Functions/Subroutines
subroutine	assess (this, particle, cell_defn, tmax)
	Check particle reporting/termination status. More...
integer(i4b) function	get_level (this)
	Get the model method's level. More...
subroutine	cap_cell_wt_flow (this, defn)
	Prevent non-boundary upwards flow at the water table. More...
subroutine	load_cell_no_exit_face (this, defn)
	Set flag indicating if the cell has any faces with outflow. Assumes cell properties and flows are already loaded. More...
subroutine	load_cell_saturation_status (this, defn)
	Set the saturation status of a cell. See the status enumeration in CellDefnModule. More...

Function/Subroutine Documentation

assess()

subroutine methodmodelmodule::assess ( class(methodmodeltype), intent(inout)  this, type(particletype), intent(inout), pointer  particle, type(celldefntype), intent(inout), pointer  cell_defn, real(dp), intent(in)  tmax  )

private

Definition at line 29 of file MethodModel.f90.

    ! dummy
    class(MethodModelType), intent(inout) :: this
    type(ParticleType), pointer, intent(inout) :: particle
    type(CellDefnType), pointer, intent(inout) :: cell_defn
    real(DP), intent(in) :: tmax
    ! noop

cap_cell_wt_flow()

subroutine methodmodelmodule::cap_cell_wt_flow ( class(methodmodeltype), intent(inout)  this, type(celldefntype), intent(inout), pointer  defn  )

private

Unless the top face is an assigned boundary with outflow, cells which contain a water table should not have upward flow through the top (i.e., the water table). Prevent it by capping the top face flow at zero in these conditions.

Assumes cell properties and flows are already loaded.

Definition at line 54 of file MethodModel.f90.

    class(MethodModelType), intent(inout) :: this
    type(CellDefnType), pointer, intent(inout) :: defn
    ! local
    integer(I4B) :: itopface
 
    ! If the cell contains a water table that is not an
    ! assigned boundary face with upflow, cap flow at 0.
    itopface = this%fmi%max_faces ! fmi's lateral face indices are not closed
    if (this%fmi%is_boundary_face(defn%icell, itopface)) return
    if (defn%isatstat == saturation_watertable) then
      itopface = defn%npolyverts + 3 ! cell defn's lateral face indices are closed
      defn%faceflow(itopface) = max(dzero, defn%faceflow(itopface))
    end if
 

get_level()

integer(i4b) function methodmodelmodule::get_level ( class(methodmodeltype), intent(in)  this )

private

Definition at line 39 of file MethodModel.f90.

    class(MethodModelType), intent(in) :: this
    integer(I4B) :: level
    level = level_model

load_cell_no_exit_face()

subroutine methodmodelmodule::load_cell_no_exit_face ( class(methodmodeltype), intent(inout)  this, type(celldefntype), intent(inout), pointer  defn  )

private

Definition at line 73 of file MethodModel.f90.

    ! dummy
    class(MethodModelType), intent(inout) :: this
    type(CellDefnType), pointer, intent(inout) :: defn
    ! local
    integer(I4B) :: m, nfaces
 
    defn%inoexitface = 1
    nfaces = defn%npolyverts + 3
    do m = 1, nfaces
      if (defn%faceflow(m) < dzero) defn%inoexitface = 0
    end do
 

load_cell_saturation_status()

subroutine methodmodelmodule::load_cell_saturation_status ( class(methodmodeltype), intent(inout)  this, type(celldefntype), intent(inout), pointer  defn  )

private

Definition at line 90 of file MethodModel.f90.

    ! dummy
    class(MethodModelType), intent(inout) :: this
    type(CellDefnType), pointer, intent(inout) :: defn
    ! local
    integer(I4B) :: ic, ictopnbr, itopface, idiag, ipos
 
    ic = defn%icell
    defn%isatstat = saturation_saturated
 
    ! dry?
    if (this%fmi%ibdgwfsat0(ic) == 0) then
      defn%isatstat = saturation_dry
      return
    end if
 
    ! partially saturated?
    if (this%fmi%gwfsat(ic) < done) then
      defn%isatstat = saturation_watertable
      return
    end if
 
    ! no top neighbor?
    itopface = defn%npolyverts + 3 ! cell defn's lateral face indices are closed
    if (defn%facenbr(itopface) == 0) then
      defn%isatstat = saturation_saturated
      return
    end if
 
    ! dry top neighbor?
    idiag = this%fmi%dis%con%ia(ic)
    ipos = idiag + defn%facenbr(itopface)
    ictopnbr = this%fmi%dis%con%ja(ipos)
    if (this%fmi%ibdgwfsat0(ictopnbr) == 0) then
      defn%isatstat = saturation_watertable
      return
    end if