MODFLOW 6
version 6.7.0.dev0
USGS Modular Hydrologic Model
|
This module contains the WEL package methods. More...
Data Types | |
type | weltype |
Functions/Subroutines | |
subroutine, public | wel_create (packobj, id, ibcnum, inunit, iout, namemodel, pakname, mempath) |
@ brief Create a new package object More... | |
subroutine | wel_da (this) |
@ brief Deallocate package memory More... | |
subroutine | wel_allocate_scalars (this) |
@ brief Allocate scalars More... | |
subroutine | wel_allocate_arrays (this, nodelist, auxvar) |
@ brief Allocate arrays More... | |
subroutine | wel_options (this) |
@ brief Source additional options for package More... | |
subroutine | log_wel_options (this, found) |
@ brief Log WEL specific package options More... | |
subroutine | wel_rp (this) |
@ brief WEL read and prepare More... | |
subroutine | wel_cf (this) |
@ brief Formulate the package hcof and rhs terms. More... | |
subroutine | wel_fc (this, rhs, ia, idxglo, matrix_sln) |
@ brief Copy hcof and rhs terms into solution. More... | |
subroutine | wel_fn (this, rhs, ia, idxglo, matrix_sln) |
@ brief Add Newton-Raphson terms for package into solution. More... | |
subroutine | wel_afr_csv_init (this, fname) |
Initialize the auto flow reduce csv output file. More... | |
subroutine | wel_afr_csv_write (this) |
Write out auto flow reductions only when & where they occur. More... | |
subroutine | define_listlabel (this) |
@ brief Define the list label for the package More... | |
logical function | wel_obs_supported (this) |
Determine if observations are supported. More... | |
subroutine | wel_df_obs (this) |
Define the observation types available in the package. More... | |
subroutine | wel_bd_obs (this) |
Save observations for the package. More... | |
real(dp) function | q_mult (this, row) |
real(dp) function | wel_bound_value (this, col, row) |
@ brief Return a bound value More... | |
Variables | |
character(len=lenftype) | ftype = 'WEL' |
package ftype More... | |
character(len=16) | text = ' WEL' |
package flow text string More... | |
This module contains the overridden methods for the standard WEL package. Several methods need to be overridden because of the AUTO_FLOW_REDUCE option. Overridden methods include:
subroutine welmodule::define_listlabel | ( | class(weltype), intent(inout) | this | ) |
Method defined the list label for the WEL package. The list label is the heading that is written to iout when PRINT_INPUT option is used.
[in,out] | this | WelType object |
Definition at line 480 of file gwf-wel.f90.
subroutine welmodule::log_wel_options | ( | class(weltype), intent(inout) | this, |
type(gwfwelparamfoundtype), intent(in) | found | ||
) |
[in,out] | this | BndExtType object |
Definition at line 234 of file gwf-wel.f90.
|
private |
|
private |
[in,out] | this | WelType object |
Definition at line 427 of file gwf-wel.f90.
|
private |
[in,out] | this | WelType object |
Definition at line 447 of file gwf-wel.f90.
subroutine welmodule::wel_allocate_arrays | ( | class(weltype) | this, |
integer(i4b), dimension(:), optional, pointer, contiguous | nodelist, | ||
real(dp), dimension(:, :), optional, pointer, contiguous | auxvar | ||
) |
Allocate and initialize arrays for the WEL package
Definition at line 160 of file gwf-wel.f90.
subroutine welmodule::wel_allocate_scalars | ( | class(weltype) | this | ) |
Allocate and initialize scalars for the WEL package. The base model allocate scalars method is also called.
this | WelType object |
Definition at line 135 of file gwf-wel.f90.
|
private |
Method to save simulated values for the WEL package.
this | WelType object |
Definition at line 551 of file gwf-wel.f90.
real(dp) function welmodule::wel_bound_value | ( | class(weltype), intent(inout) | this, |
integer(i4b), intent(in) | col, | ||
integer(i4b), intent(in) | row | ||
) |
Return a bound value associated with an ncolbnd index and row.
[in,out] | this | BndExtType object |
Definition at line 624 of file gwf-wel.f90.
subroutine welmodule::wel_cf | ( | class(weltype) | this | ) |
Formulate the hcof and rhs terms for the WEL package that will be added to the coefficient matrix and right-hand side vector.
this | WelType object |
Definition at line 296 of file gwf-wel.f90.
subroutine, public welmodule::wel_create | ( | class(bndtype), pointer | packobj, |
integer(i4b), intent(in) | id, | ||
integer(i4b), intent(in) | ibcnum, | ||
integer(i4b), intent(in) | inunit, | ||
integer(i4b), intent(in) | iout, | ||
character(len=*), intent(in) | namemodel, | ||
character(len=*), intent(in) | pakname, | ||
character(len=*), intent(in) | mempath | ||
) |
Create a new WEL Package object
packobj | pointer to default package type | |
[in] | id | package id |
[in] | ibcnum | boundary condition number |
[in] | inunit | unit number of WEL package input file |
[in] | iout | unit number of model listing file |
[in] | namemodel | model name |
[in] | pakname | package name |
[in] | mempath | input mempath |
Definition at line 73 of file gwf-wel.f90.
|
private |
Deallocate WEL package scalars and arrays.
this | WelType object |
Definition at line 113 of file gwf-wel.f90.
|
private |
Method to define the observation types available in the WEL package.
this | WelType object |
Definition at line 525 of file gwf-wel.f90.
|
private |
Add the hcof and rhs terms for the WEL package to the coefficient matrix and right-hand side vector.
this | WelType object | |
[in,out] | rhs | right-hand side vector for model |
[in] | ia | solution CRS row pointers |
[in] | idxglo | mapping vector for model (local) to solution (global) |
matrix_sln | solution coefficient matrix |
Definition at line 340 of file gwf-wel.f90.
|
private |
Calculate and add the Newton-Raphson terms for the WEL package to the coefficient matrix and right-hand side vector.
this | WelType object | |
[in,out] | rhs | right-hand side vector for model |
[in] | ia | solution CRS row pointers |
[in] | idxglo | mapping vector for model (local) to solution (global) |
matrix_sln | solution coefficient matrix |
Definition at line 378 of file gwf-wel.f90.
|
private |
Function to determine if observations are supported by the WEL package. Observations are supported by the WEL package.
this | WelType object |
Definition at line 512 of file gwf-wel.f90.
subroutine welmodule::wel_options | ( | class(weltype), intent(inout) | this | ) |
Source additional options for WEL package.
[in,out] | this | WelType object |
Definition at line 185 of file gwf-wel.f90.
subroutine welmodule::wel_rp | ( | class(weltype), intent(inout) | this | ) |
Definition at line 273 of file gwf-wel.f90.
|
private |
Definition at line 36 of file gwf-wel.f90.
|
private |
Definition at line 37 of file gwf-wel.f90.