MODFLOW 6  version 6.5.0.dev2
MODFLOW 6 Code Documentation
xt3dmodule::xt3dtype Type Reference
Collaboration diagram for xt3dmodule::xt3dtype:
Collaboration graph

Public Member Functions

procedure xt3d_df
 
procedure xt3d_ac
 
procedure xt3d_mc
 
procedure xt3d_ar
 
procedure xt3d_fc
 
procedure xt3d_fcpc
 
procedure xt3d_fhfb
 
procedure xt3d_flowjahfb
 
procedure xt3d_fn
 
procedure xt3d_flowja
 
procedure xt3d_da
 

Public Attributes

character(len=lenmempath) memorypath
 location in memory manager for storing package variables More...
 
integer(i4b), pointer inunit => null()
 unit number from where xt3d was read More...
 
integer(i4b), pointer iout => null()
 unit number for output More...
 
integer(i4b), pointer inewton => null()
 Newton flag. More...
 
integer(i4b), dimension(:), pointer, contiguous ibound => null()
 pointer to model ibound More...
 
integer(i4b), dimension(:), pointer, contiguous iax => null()
 ia array for extended neighbors used by xt3d More...
 
integer(i4b), dimension(:), pointer, contiguous jax => null()
 ja array for extended neighbors used by xt3d More...
 
integer(i4b), dimension(:), pointer, contiguous idxglox => null()
 mapping array for extended neighbors used by xt3d More...
 
integer(i4b), dimension(:), pointer, contiguous ia_xt3d => null()
 ia array for local extended xt3d connections (no diagonal) More...
 
integer(i4b), dimension(:), pointer, contiguous ja_xt3d => null()
 ja array for local extended xt3d connections (no diagonal) More...
 
integer(i4b), pointer numextnbrs => null()
 dimension of jax array More...
 
integer(i4b), pointer ixt3d => null()
 xt3d flag (0 is off, 1 is lhs, 2 is rhs) More...
 
logical, pointer nozee => null()
 nozee flag More...
 
real(dp), pointer vcthresh => null()
 attenuation function threshold More...
 
real(dp), dimension(:, :), pointer, contiguous rmatck => null()
 rotation matrix for the conductivity tensor More...
 
real(dp), dimension(:), pointer, contiguous qsat => null()
 saturated flow saved for Newton More...
 
integer(i4b), pointer nbrmax => null()
 maximum number of neighbors for any cell More...
 
real(dp), dimension(:), pointer, contiguous amatpc => null()
 saved contributions to amat from permanently confined connections, direct neighbors More...
 
real(dp), dimension(:), pointer, contiguous amatpcx => null()
 saved contributions to amat from permanently confined connections, extended neighbors More...
 
integer(i4b), dimension(:), pointer, contiguous iallpc => null()
 indicates for each node whether all connections processed by xt3d are permanently confined (0 no, 1 yes) More...
 
logical, pointer lamatsaved => null()
 indicates whether amat has been saved for permanently confined connections More...
 
class(disbasetype), pointer dis => null()
 discretization object More...
 
real(dp), dimension(:), pointer, contiguous k11 => null()
 horizontal hydraulic conductivity More...
 
real(dp), dimension(:), pointer, contiguous k22 => null()
 minor axis of horizontal hydraulic conductivity ellipse More...
 
real(dp), dimension(:), pointer, contiguous k33 => null()
 vertical hydraulic conductivity More...
 
integer(i4b), pointer ik22 => null()
 flag indicates K22 was read More...
 
integer(i4b), pointer ik33 => null()
 flag indicates K33 was read More...
 
real(dp), dimension(:), pointer, contiguous sat => null()
 saturation (0. to 1.) for each cell More...
 
integer(i4b), dimension(:), pointer, contiguous icelltype => null()
 cell type (confined or unconfined) More...
 
integer(i4b), pointer iangle1 => null()
 flag to indicate angle1 was read More...
 
integer(i4b), pointer iangle2 => null()
 flag to indicate angle2 was read More...
 
integer(i4b), pointer iangle3 => null()
 flag to indicate angle3 was read More...
 
real(dp), dimension(:), pointer, contiguous angle1 => null()
 k ellipse rotation in xy plane around z axis (yaw) More...
 
real(dp), dimension(:), pointer, contiguous angle2 => null()
 k ellipse rotation up from xy plane around y axis (pitch) More...
 
real(dp), dimension(:), pointer, contiguous angle3 => null()
 k tensor rotation around x axis (roll) More...
 
logical, pointer ldispersion => null()
 flag to indicate dispersion More...
 

Private Member Functions

procedure, private allocate_scalars
 
procedure, private allocate_arrays
 
procedure, private xt3d_load
 
procedure, private xt3d_load_inbr
 
procedure, private xt3d_indices
 
procedure, private xt3d_areas
 
procedure, private xt3d_amat_nbrs
 
procedure, private xt3d_amatpc_nbrs
 
procedure, private xt3d_amat_nbrnbrs
 
procedure, private xt3d_amatpcx_nbrnbrs
 
procedure, private xt3d_iallpc
 
procedure, private xt3d_get_iinm
 
procedure, private xt3d_get_iinmx
 
procedure, private xt3d_rhs
 
procedure, private xt3d_fillrmatck
 
procedure, private xt3d_qnbrs
 

Detailed Description

Definition at line 13 of file Xt3dInterface.f90.

Member Function/Subroutine Documentation

◆ allocate_arrays()

procedure, private xt3dmodule::xt3dtype::allocate_arrays
private

Definition at line 67 of file Xt3dInterface.f90.

◆ allocate_scalars()

procedure, private xt3dmodule::xt3dtype::allocate_scalars
private

Definition at line 66 of file Xt3dInterface.f90.

◆ xt3d_ac()

procedure xt3dmodule::xt3dtype::xt3d_ac

Definition at line 56 of file Xt3dInterface.f90.

◆ xt3d_amat_nbrnbrs()

procedure, private xt3dmodule::xt3dtype::xt3d_amat_nbrnbrs
private

Definition at line 74 of file Xt3dInterface.f90.

◆ xt3d_amat_nbrs()

procedure, private xt3dmodule::xt3dtype::xt3d_amat_nbrs
private

Definition at line 72 of file Xt3dInterface.f90.

◆ xt3d_amatpc_nbrs()

procedure, private xt3dmodule::xt3dtype::xt3d_amatpc_nbrs
private

Definition at line 73 of file Xt3dInterface.f90.

◆ xt3d_amatpcx_nbrnbrs()

procedure, private xt3dmodule::xt3dtype::xt3d_amatpcx_nbrnbrs
private

Definition at line 75 of file Xt3dInterface.f90.

◆ xt3d_ar()

procedure xt3dmodule::xt3dtype::xt3d_ar

Definition at line 58 of file Xt3dInterface.f90.

◆ xt3d_areas()

procedure, private xt3dmodule::xt3dtype::xt3d_areas
private

Definition at line 71 of file Xt3dInterface.f90.

◆ xt3d_da()

procedure xt3dmodule::xt3dtype::xt3d_da

Definition at line 65 of file Xt3dInterface.f90.

◆ xt3d_df()

procedure xt3dmodule::xt3dtype::xt3d_df

Definition at line 55 of file Xt3dInterface.f90.

◆ xt3d_fc()

procedure xt3dmodule::xt3dtype::xt3d_fc

Definition at line 59 of file Xt3dInterface.f90.

◆ xt3d_fcpc()

procedure xt3dmodule::xt3dtype::xt3d_fcpc

Definition at line 60 of file Xt3dInterface.f90.

◆ xt3d_fhfb()

procedure xt3dmodule::xt3dtype::xt3d_fhfb

Definition at line 61 of file Xt3dInterface.f90.

◆ xt3d_fillrmatck()

procedure, private xt3dmodule::xt3dtype::xt3d_fillrmatck
private

Definition at line 80 of file Xt3dInterface.f90.

◆ xt3d_flowja()

procedure xt3dmodule::xt3dtype::xt3d_flowja

Definition at line 64 of file Xt3dInterface.f90.

◆ xt3d_flowjahfb()

procedure xt3dmodule::xt3dtype::xt3d_flowjahfb

Definition at line 62 of file Xt3dInterface.f90.

◆ xt3d_fn()

procedure xt3dmodule::xt3dtype::xt3d_fn

Definition at line 63 of file Xt3dInterface.f90.

◆ xt3d_get_iinm()

procedure, private xt3dmodule::xt3dtype::xt3d_get_iinm
private

Definition at line 77 of file Xt3dInterface.f90.

◆ xt3d_get_iinmx()

procedure, private xt3dmodule::xt3dtype::xt3d_get_iinmx
private

Definition at line 78 of file Xt3dInterface.f90.

◆ xt3d_iallpc()

procedure, private xt3dmodule::xt3dtype::xt3d_iallpc
private

Definition at line 76 of file Xt3dInterface.f90.

◆ xt3d_indices()

procedure, private xt3dmodule::xt3dtype::xt3d_indices
private

Definition at line 70 of file Xt3dInterface.f90.

◆ xt3d_load()

procedure, private xt3dmodule::xt3dtype::xt3d_load
private

Definition at line 68 of file Xt3dInterface.f90.

◆ xt3d_load_inbr()

procedure, private xt3dmodule::xt3dtype::xt3d_load_inbr
private

Definition at line 69 of file Xt3dInterface.f90.

◆ xt3d_mc()

procedure xt3dmodule::xt3dtype::xt3d_mc

Definition at line 57 of file Xt3dInterface.f90.

◆ xt3d_qnbrs()

procedure, private xt3dmodule::xt3dtype::xt3d_qnbrs
private

Definition at line 81 of file Xt3dInterface.f90.

◆ xt3d_rhs()

procedure, private xt3dmodule::xt3dtype::xt3d_rhs
private

Definition at line 79 of file Xt3dInterface.f90.

Member Data Documentation

◆ amatpc

real(dp), dimension(:), pointer, contiguous xt3dmodule::xt3dtype::amatpc => null()

Definition at line 32 of file Xt3dInterface.f90.

32  real(DP), dimension(:), pointer, contiguous :: amatpc => null() !< saved contributions to amat from permanently confined connections, direct neighbors

◆ amatpcx

real(dp), dimension(:), pointer, contiguous xt3dmodule::xt3dtype::amatpcx => null()

Definition at line 33 of file Xt3dInterface.f90.

33  real(DP), dimension(:), pointer, contiguous :: amatpcx => null() !< saved contributions to amat from permanently confined connections, extended neighbors

◆ angle1

real(dp), dimension(:), pointer, contiguous xt3dmodule::xt3dtype::angle1 => null()

Definition at line 48 of file Xt3dInterface.f90.

48  real(DP), dimension(:), pointer, contiguous :: angle1 => null() !< k ellipse rotation in xy plane around z axis (yaw)

◆ angle2

real(dp), dimension(:), pointer, contiguous xt3dmodule::xt3dtype::angle2 => null()

Definition at line 49 of file Xt3dInterface.f90.

49  real(DP), dimension(:), pointer, contiguous :: angle2 => null() !< k ellipse rotation up from xy plane around y axis (pitch)

◆ angle3

real(dp), dimension(:), pointer, contiguous xt3dmodule::xt3dtype::angle3 => null()

Definition at line 50 of file Xt3dInterface.f90.

50  real(DP), dimension(:), pointer, contiguous :: angle3 => null() !< k tensor rotation around x axis (roll)

◆ dis

class(disbasetype), pointer xt3dmodule::xt3dtype::dis => null()

Definition at line 36 of file Xt3dInterface.f90.

36  class(DisBaseType), pointer :: dis => null() !< discretization object

◆ ia_xt3d

integer(i4b), dimension(:), pointer, contiguous xt3dmodule::xt3dtype::ia_xt3d => null()

Definition at line 23 of file Xt3dInterface.f90.

23  integer(I4B), dimension(:), pointer, contiguous :: ia_xt3d => null() !< ia array for local extended xt3d connections (no diagonal)

◆ iallpc

integer(i4b), dimension(:), pointer, contiguous xt3dmodule::xt3dtype::iallpc => null()

Definition at line 34 of file Xt3dInterface.f90.

34  integer(I4B), dimension(:), pointer, contiguous :: iallpc => null() !< indicates for each node whether all connections processed by xt3d are permanently confined (0 no, 1 yes)

◆ iangle1

integer(i4b), pointer xt3dmodule::xt3dtype::iangle1 => null()

Definition at line 45 of file Xt3dInterface.f90.

45  integer(I4B), pointer :: iangle1 => null() !< flag to indicate angle1 was read

◆ iangle2

integer(i4b), pointer xt3dmodule::xt3dtype::iangle2 => null()

Definition at line 46 of file Xt3dInterface.f90.

46  integer(I4B), pointer :: iangle2 => null() !< flag to indicate angle2 was read

◆ iangle3

integer(i4b), pointer xt3dmodule::xt3dtype::iangle3 => null()

Definition at line 47 of file Xt3dInterface.f90.

47  integer(I4B), pointer :: iangle3 => null() !< flag to indicate angle3 was read

◆ iax

integer(i4b), dimension(:), pointer, contiguous xt3dmodule::xt3dtype::iax => null()

Definition at line 20 of file Xt3dInterface.f90.

20  integer(I4B), dimension(:), pointer, contiguous :: iax => null() !< ia array for extended neighbors used by xt3d

◆ ibound

integer(i4b), dimension(:), pointer, contiguous xt3dmodule::xt3dtype::ibound => null()

Definition at line 19 of file Xt3dInterface.f90.

19  integer(I4B), dimension(:), pointer, contiguous :: ibound => null() !< pointer to model ibound

◆ icelltype

integer(i4b), dimension(:), pointer, contiguous xt3dmodule::xt3dtype::icelltype => null()

Definition at line 44 of file Xt3dInterface.f90.

44  integer(I4B), dimension(:), pointer, contiguous :: icelltype => null() !< cell type (confined or unconfined)

◆ idxglox

integer(i4b), dimension(:), pointer, contiguous xt3dmodule::xt3dtype::idxglox => null()

Definition at line 22 of file Xt3dInterface.f90.

22  integer(I4B), dimension(:), pointer, contiguous :: idxglox => null() !< mapping array for extended neighbors used by xt3d

◆ ik22

integer(i4b), pointer xt3dmodule::xt3dtype::ik22 => null()

Definition at line 41 of file Xt3dInterface.f90.

41  integer(I4B), pointer :: ik22 => null() !< flag indicates K22 was read

◆ ik33

integer(i4b), pointer xt3dmodule::xt3dtype::ik33 => null()

Definition at line 42 of file Xt3dInterface.f90.

42  integer(I4B), pointer :: ik33 => null() !< flag indicates K33 was read

◆ inewton

integer(i4b), pointer xt3dmodule::xt3dtype::inewton => null()

Definition at line 18 of file Xt3dInterface.f90.

18  integer(I4B), pointer :: inewton => null() !< Newton flag

◆ inunit

integer(i4b), pointer xt3dmodule::xt3dtype::inunit => null()

Definition at line 16 of file Xt3dInterface.f90.

16  integer(I4B), pointer :: inunit => null() !< unit number from where xt3d was read

◆ iout

integer(i4b), pointer xt3dmodule::xt3dtype::iout => null()

Definition at line 17 of file Xt3dInterface.f90.

17  integer(I4B), pointer :: iout => null() !< unit number for output

◆ ixt3d

integer(i4b), pointer xt3dmodule::xt3dtype::ixt3d => null()

Definition at line 26 of file Xt3dInterface.f90.

26  integer(I4B), pointer :: ixt3d => null() !< xt3d flag (0 is off, 1 is lhs, 2 is rhs)

◆ ja_xt3d

integer(i4b), dimension(:), pointer, contiguous xt3dmodule::xt3dtype::ja_xt3d => null()

Definition at line 24 of file Xt3dInterface.f90.

24  integer(I4B), dimension(:), pointer, contiguous :: ja_xt3d => null() !< ja array for local extended xt3d connections (no diagonal)

◆ jax

integer(i4b), dimension(:), pointer, contiguous xt3dmodule::xt3dtype::jax => null()

Definition at line 21 of file Xt3dInterface.f90.

21  integer(I4B), dimension(:), pointer, contiguous :: jax => null() !< ja array for extended neighbors used by xt3d

◆ k11

real(dp), dimension(:), pointer, contiguous xt3dmodule::xt3dtype::k11 => null()

Definition at line 38 of file Xt3dInterface.f90.

38  real(DP), dimension(:), pointer, contiguous :: k11 => null() !< horizontal hydraulic conductivity

◆ k22

real(dp), dimension(:), pointer, contiguous xt3dmodule::xt3dtype::k22 => null()

Definition at line 39 of file Xt3dInterface.f90.

39  real(DP), dimension(:), pointer, contiguous :: k22 => null() !< minor axis of horizontal hydraulic conductivity ellipse

◆ k33

real(dp), dimension(:), pointer, contiguous xt3dmodule::xt3dtype::k33 => null()

Definition at line 40 of file Xt3dInterface.f90.

40  real(DP), dimension(:), pointer, contiguous :: k33 => null() !< vertical hydraulic conductivity

◆ lamatsaved

logical, pointer xt3dmodule::xt3dtype::lamatsaved => null()

Definition at line 35 of file Xt3dInterface.f90.

35  logical, pointer :: lamatsaved => null() !< indicates whether amat has been saved for permanently confined connections

◆ ldispersion

logical, pointer xt3dmodule::xt3dtype::ldispersion => null()

Definition at line 51 of file Xt3dInterface.f90.

51  logical, pointer :: ldispersion => null() !< flag to indicate dispersion

◆ memorypath

character(len=lenmempath) xt3dmodule::xt3dtype::memorypath

Definition at line 15 of file Xt3dInterface.f90.

15  character(len=LENMEMPATH) :: memoryPath !< location in memory manager for storing package variables

◆ nbrmax

integer(i4b), pointer xt3dmodule::xt3dtype::nbrmax => null()

Definition at line 31 of file Xt3dInterface.f90.

31  integer(I4B), pointer :: nbrmax => null() !< maximum number of neighbors for any cell

◆ nozee

logical, pointer xt3dmodule::xt3dtype::nozee => null()

Definition at line 27 of file Xt3dInterface.f90.

27  logical, pointer :: nozee => null() !< nozee flag

◆ numextnbrs

integer(i4b), pointer xt3dmodule::xt3dtype::numextnbrs => null()

Definition at line 25 of file Xt3dInterface.f90.

25  integer(I4B), pointer :: numextnbrs => null() !< dimension of jax array

◆ qsat

real(dp), dimension(:), pointer, contiguous xt3dmodule::xt3dtype::qsat => null()

Definition at line 30 of file Xt3dInterface.f90.

30  real(DP), dimension(:), pointer, contiguous :: qsat => null() !< saturated flow saved for Newton

◆ rmatck

real(dp), dimension(:, :), pointer, contiguous xt3dmodule::xt3dtype::rmatck => null()

Definition at line 29 of file Xt3dInterface.f90.

29  real(DP), dimension(:, :), pointer, contiguous :: rmatck => null() !< rotation matrix for the conductivity tensor

◆ sat

real(dp), dimension(:), pointer, contiguous xt3dmodule::xt3dtype::sat => null()

Definition at line 43 of file Xt3dInterface.f90.

43  real(DP), dimension(:), pointer, contiguous :: sat => null() !< saturation (0. to 1.) for each cell

◆ vcthresh

real(dp), pointer xt3dmodule::xt3dtype::vcthresh => null()

Definition at line 28 of file Xt3dInterface.f90.

28  real(DP), pointer :: vcthresh => null() !< attenuation function threshold

The documentation for this type was generated from the following file: