Derived type for MvrType.
More...
|
| procedure | set_values (this, mname1, pname1, id1, mname2, pname2, id2, imvrtype, value) |
| | @ brief Set values from input data
|
| procedure | prepare (this, inunit, pckmempaths, pakmovers) |
| | @ brief Prepare object
|
| procedure | echo (this, iout) |
| | @ brief Echo data to list file
|
| procedure | advance (this) |
| | @ brief Advance
|
| procedure | update_provider (this) |
| | @ brief Formulate coefficients
|
| procedure | update_receiver (this) |
| | @ brief Formulate coefficients
|
| procedure | qrcalc (this, qa, qta) |
| | @ brief Flow to receiver
|
| procedure | writeflow (this, iout) |
| | @ brief Write flow
|
|
| character(len=lenmempath) | mem_path_src = '' |
| | provider package name
|
| character(len=lenmempath) | mem_path_tgt = '' |
| | receiver package name
|
| integer(i4b), pointer | irchnrsrc => null() |
| | provider reach number
|
| integer(i4b) | irchnrsrcmapped |
| | mapped provider reach number (currently for lake outlet)
|
| integer(i4b), pointer | irchnrtgt => null() |
| | receiver reach number
|
| integer(i4b), pointer | imvrtype => null() |
| | mover type (1, 2, 3, 4) corresponds to mvrtypes
|
| real(dp), pointer | value => null() |
| | factor or rate depending on mvrtype
|
| logical(lgp) | is_provider_active = .true. |
| logical(lgp) | is_receiver_active = .true. |
| real(dp) | qpactual = DZERO |
| | rate provided to the receiver
|
| real(dp) | qavailable = DZERO |
| | rate available at time of providing
|
| real(dp), pointer | qtformvr_ptr => null() |
| | pointer to total available flow (qtformvr)
|
| real(dp), pointer | qformvr_ptr => null() |
| | pointer to available flow after consumed (qformvr)
|
| real(dp), pointer | qtomvr_ptr => null() |
| | pointer to provider flow rate (qtomvr)
|
| real(dp), pointer | qfrommvr_ptr => null() |
| | pointer to receiver flow rate (qfrommvr)
|
This derived type contains information and methods for moving water between packages.
Definition at line 29 of file Mover.f90.
◆ advance()
| procedure mvrmodule::mvrtype::advance |
( |
class(mvrtype) | this | ) |
|
Advance mover object. Does nothing now.
Definition at line 49 of file Mover.f90.
◆ echo()
| procedure mvrmodule::mvrtype::echo |
( |
class(mvrtype) | this, |
|
|
integer(i4b), intent(in) | iout ) |
Write mover values to output file.
- Parameters
-
| this | MvrType |
| [in] | iout | unit number for output file |
Definition at line 48 of file Mover.f90.
◆ prepare()
| procedure mvrmodule::mvrtype::prepare |
( |
class(mvrtype) | this, |
|
|
integer(i4b), intent(in) | inunit, |
|
|
character(len=lenmempath), dimension(:), pointer, contiguous | pckmempaths, |
|
|
type(packagemovertype), dimension(:), pointer, contiguous | pakmovers ) |
Set values and pointers for mover object. pckMemPaths is an array of strings which are the memory paths for those packages. They are composed of model names and package names. The mover entries must be in pckMemPaths, or this routine will terminate with an error.
- Parameters
-
| this | MvrType object |
| [in] | inunit | input file unit number |
| pckmempaths | array of strings |
| pakmovers | Array of package mover objects |
Definition at line 47 of file Mover.f90.
◆ qrcalc()
| procedure mvrmodule::mvrtype::qrcalc |
( |
class(mvrtype) | this, |
|
|
real(dp), intent(in) | qa, |
|
|
real(dp), intent(in) | qta ) |
Calculate the rate of water provided to receiver.
- Parameters
-
| this | MvrType |
| [in] | qa | actual flow |
| [in] | qta | total available flow |
Definition at line 52 of file Mover.f90.
◆ set_values()
| procedure mvrmodule::mvrtype::set_values |
( |
class(mvrtype) | this, |
|
|
character(len=*), intent(in) | mname1, |
|
|
character(len=*), intent(in) | pname1, |
|
|
integer(i4b), intent(in), target | id1, |
|
|
character(len=*), intent(in) | mname2, |
|
|
character(len=*), intent(in) | pname2, |
|
|
integer(i4b), intent(in), target | id2, |
|
|
integer(i4b), intent(in), target | imvrtype, |
|
|
real(dp), intent(in), target | value ) |
Set values and pointers for mover object.
Definition at line 46 of file Mover.f90.
◆ update_provider()
| procedure mvrmodule::mvrtype::update_provider |
( |
class(mvrtype) | this | ) |
|
Make mover calculations for provider.
- Parameters
-
Definition at line 50 of file Mover.f90.
◆ update_receiver()
| procedure mvrmodule::mvrtype::update_receiver |
( |
class(mvrtype) | this | ) |
|
Make mover calculations for receiver.
- Parameters
-
Definition at line 51 of file Mover.f90.
◆ writeflow()
| procedure mvrmodule::mvrtype::writeflow |
( |
class(mvrtype) | this, |
|
|
integer(i4b), intent(in) | iout ) |
Write a line of output for this mover object.
- Parameters
-
| this | MvrType |
| [in] | iout | output file unit number |
Definition at line 53 of file Mover.f90.
◆ imvrtype
| integer(i4b), pointer mvrmodule::mvrtype::imvrtype => null() |
◆ irchnrsrc
| integer(i4b), pointer mvrmodule::mvrtype::irchnrsrc => null() |
◆ irchnrsrcmapped
| integer(i4b) mvrmodule::mvrtype::irchnrsrcmapped |
Definition at line 33 of file Mover.f90.
33 integer(I4B) :: iRchNrSrcMapped
◆ irchnrtgt
| integer(i4b), pointer mvrmodule::mvrtype::irchnrtgt => null() |
◆ is_provider_active
| logical(lgp) mvrmodule::mvrtype::is_provider_active = .true. |
◆ is_receiver_active
| logical(lgp) mvrmodule::mvrtype::is_receiver_active = .true. |
◆ mem_path_src
| character(len=lenmempath) mvrmodule::mvrtype::mem_path_src = '' |
◆ mem_path_tgt
| character(len=lenmempath) mvrmodule::mvrtype::mem_path_tgt = '' |
◆ qavailable
| real(dp) mvrmodule::mvrtype::qavailable = DZERO |
◆ qformvr_ptr
| real(dp), pointer mvrmodule::mvrtype::qformvr_ptr => null() |
◆ qfrommvr_ptr
| real(dp), pointer mvrmodule::mvrtype::qfrommvr_ptr => null() |
◆ qpactual
| real(dp) mvrmodule::mvrtype::qpactual = DZERO |
◆ qtformvr_ptr
| real(dp), pointer mvrmodule::mvrtype::qtformvr_ptr => null() |
◆ qtomvr_ptr
| real(dp), pointer mvrmodule::mvrtype::qtomvr_ptr => null() |
◆ value
| real(dp), pointer mvrmodule::mvrtype::value => null() |
The documentation for this type was generated from the following file:
- /home/runner/work/modflow6/modflow6/src/Model/ModelUtilities/Mover.f90
1.18.0