MODFLOW 6  version 6.5.0.dev2
MODFLOW 6 Code Documentation
Private Member Functions | Private Attributes | List of all members
mvrmodule::mvrtype Type Reference

Derived type for MvrType. More...

Collaboration diagram for mvrmodule::mvrtype:
Collaboration graph

Private Member Functions

procedure set_values
 
procedure prepare
 
procedure echo
 
procedure advance
 
procedure update_provider
 
procedure update_receiver
 
procedure qrcalc
 
procedure writeflow
 

Private Attributes

character(len=lenmempath) mem_path_src = ''
 provider package name More...
 
character(len=lenmempath) mem_path_tgt = ''
 receiver package name More...
 
integer(i4b), pointer irchnrsrc => null()
 provider reach number More...
 
integer(i4b) irchnrsrcmapped
 mapped provider reach number (currently for lake outlet) More...
 
integer(i4b), pointer irchnrtgt => null()
 receiver reach number More...
 
integer(i4b), pointer imvrtype => null()
 mover type (1, 2, 3, 4) corresponds to mvrtypes More...
 
real(dp), pointer value => null()
 factor or rate depending on mvrtype More...
 
logical(lgp) is_provider_active = .true.
 
logical(lgp) is_receiver_active = .true.
 
real(dp) qpactual = DZERO
 rate provided to the receiver More...
 
real(dp) qavailable = DZERO
 rate available at time of providing More...
 
real(dp), pointer qtformvr_ptr => null()
 pointer to total available flow (qtformvr) More...
 
real(dp), pointer qformvr_ptr => null()
 pointer to available flow after consumed (qformvr) More...
 
real(dp), pointer qtomvr_ptr => null()
 pointer to provider flow rate (qtomvr) More...
 
real(dp), pointer qfrommvr_ptr => null()
 pointer to receiver flow rate (qfrommvr) More...
 

Detailed Description

This derived type contains information and methods for moving water between packages.

Definition at line 29 of file Mover.f90.

Member Function/Subroutine Documentation

◆ advance()

procedure mvrmodule::mvrtype::advance
private

Definition at line 49 of file Mover.f90.

◆ echo()

procedure mvrmodule::mvrtype::echo
private

Definition at line 48 of file Mover.f90.

◆ prepare()

procedure mvrmodule::mvrtype::prepare
private

Definition at line 47 of file Mover.f90.

◆ qrcalc()

procedure mvrmodule::mvrtype::qrcalc
private

Definition at line 52 of file Mover.f90.

◆ set_values()

procedure mvrmodule::mvrtype::set_values
private

Definition at line 46 of file Mover.f90.

◆ update_provider()

procedure mvrmodule::mvrtype::update_provider
private

Definition at line 50 of file Mover.f90.

◆ update_receiver()

procedure mvrmodule::mvrtype::update_receiver
private

Definition at line 51 of file Mover.f90.

◆ writeflow()

procedure mvrmodule::mvrtype::writeflow
private

Definition at line 53 of file Mover.f90.

Member Data Documentation

◆ imvrtype

integer(i4b), pointer mvrmodule::mvrtype::imvrtype => null()
private

Definition at line 35 of file Mover.f90.

35  integer(I4B), pointer :: imvrtype => null() !< mover type (1, 2, 3, 4) corresponds to mvrtypes

◆ irchnrsrc

integer(i4b), pointer mvrmodule::mvrtype::irchnrsrc => null()
private

Definition at line 32 of file Mover.f90.

32  integer(I4B), pointer :: iRchNrSrc => null() !< provider reach number

◆ irchnrsrcmapped

integer(i4b) mvrmodule::mvrtype::irchnrsrcmapped
private

Definition at line 33 of file Mover.f90.

33  integer(I4B) :: iRchNrSrcMapped !< mapped provider reach number (currently for lake outlet)

◆ irchnrtgt

integer(i4b), pointer mvrmodule::mvrtype::irchnrtgt => null()
private

Definition at line 34 of file Mover.f90.

34  integer(I4B), pointer :: iRchNrTgt => null() !< receiver reach number

◆ is_provider_active

logical(lgp) mvrmodule::mvrtype::is_provider_active = .true.
private

Definition at line 37 of file Mover.f90.

37  logical(LGP) :: is_provider_active = .true.

◆ is_receiver_active

logical(lgp) mvrmodule::mvrtype::is_receiver_active = .true.
private

Definition at line 38 of file Mover.f90.

38  logical(LGP) :: is_receiver_active = .true.

◆ mem_path_src

character(len=lenmempath) mvrmodule::mvrtype::mem_path_src = ''
private

Definition at line 30 of file Mover.f90.

30  character(len=LENMEMPATH) :: mem_path_src = '' !< provider package name

◆ mem_path_tgt

character(len=lenmempath) mvrmodule::mvrtype::mem_path_tgt = ''
private

Definition at line 31 of file Mover.f90.

31  character(len=LENMEMPATH) :: mem_path_tgt = '' !< receiver package name

◆ qavailable

real(dp) mvrmodule::mvrtype::qavailable = DZERO
private

Definition at line 40 of file Mover.f90.

40  real(DP) :: qavailable = dzero !< rate available at time of providing

◆ qformvr_ptr

real(dp), pointer mvrmodule::mvrtype::qformvr_ptr => null()
private

Definition at line 42 of file Mover.f90.

42  real(DP), pointer :: qformvr_ptr => null() !< pointer to available flow after consumed (qformvr)

◆ qfrommvr_ptr

real(dp), pointer mvrmodule::mvrtype::qfrommvr_ptr => null()
private

Definition at line 44 of file Mover.f90.

44  real(DP), pointer :: qfrommvr_ptr => null() !< pointer to receiver flow rate (qfrommvr)

◆ qpactual

real(dp) mvrmodule::mvrtype::qpactual = DZERO
private

Definition at line 39 of file Mover.f90.

39  real(DP) :: qpactual = dzero !< rate provided to the receiver

◆ qtformvr_ptr

real(dp), pointer mvrmodule::mvrtype::qtformvr_ptr => null()
private

Definition at line 41 of file Mover.f90.

41  real(DP), pointer :: qtformvr_ptr => null() !< pointer to total available flow (qtformvr)

◆ qtomvr_ptr

real(dp), pointer mvrmodule::mvrtype::qtomvr_ptr => null()
private

Definition at line 43 of file Mover.f90.

43  real(DP), pointer :: qtomvr_ptr => null() !< pointer to provider flow rate (qtomvr)

◆ value

real(dp), pointer mvrmodule::mvrtype::value => null()
private

Definition at line 36 of file Mover.f90.

36  real(DP), pointer :: value => null() !< factor or rate depending on mvrtype
The documentation for this type was generated from the following file: