MODFLOW 6  version 6.6.0.dev0
USGS Modular Hydrologic Model
tsp-oc.f90
Go to the documentation of this file.
1 module tspocmodule
2 
3  use basedismodule, only: disbasetype
4  use kindmodule, only: dp, i4b
8 
9  implicit none
10  private
11  public tspoctype, oc_cr
12 
13  !> @ brief Output control
14  !!
15  !! Concrete implementation of OutputControlType for a
16  !! Transport Model
17  !<
18  type, extends(outputcontroltype) :: tspoctype
19  contains
20  procedure :: oc_ar
21  end type tspoctype
22 
23 contains
24 
25  !> @ brief Create TspOcType
26  !!
27  !! Create by allocating a new TspOcType object and initializing
28  !! member variables.
29  !<
30  subroutine oc_cr(ocobj, name_model, inunit, iout)
31  ! -- dummy
32  type(tspoctype), pointer :: ocobj !< TspOcType object
33  character(len=*), intent(in) :: name_model !< name of the model
34  integer(I4B), intent(in) :: inunit !< unit number for input
35  integer(I4B), intent(in) :: iout !< unit number for output
36  !
37  ! -- Create the object
38  allocate (ocobj)
39  !
40  ! -- Allocate variables
41  call ocobj%allocate_scalars(name_model)
42  !
43  ! -- Save unit numbers
44  ocobj%inunit = inunit
45  ocobj%iout = iout
46  !
47  ! -- Initialize block parser
48  call ocobj%parser%Initialize(inunit, iout)
49  end subroutine oc_cr
50 
51  !> @ brief Allocate and read TspOcType
52  !!
53  !! Setup dependent variable (e.g., concentration or temperature)
54  !! and budget as output control variables.
55  !!
56  !<
57  subroutine oc_ar(this, depvar, dis, dnodata, dvname)
58  ! -- dummy
59  class(tspoctype) :: this !< TspOcType object
60  real(DP), dimension(:), pointer, contiguous, intent(in) :: depvar !< model concentration
61  character(len=*), intent(in) :: dvname !< name of dependent variable solved by generalized transport model (concentration, temperature)
62  class(disbasetype), pointer, intent(in) :: dis !< model discretization package
63  real(DP), intent(in) :: dnodata !< no data value
64  ! -- local
65  integer(I4B) :: i, nocdobj, inodata
66  type(outputcontroldatatype), pointer :: ocdobjptr
67  real(DP), dimension(:), pointer, contiguous :: nullvec => null()
68  !
69  ! -- Initialize variables
70  inodata = 0
71  nocdobj = 2
72  allocate (this%ocds(nocdobj))
73  do i = 1, nocdobj
74  call ocd_cr(ocdobjptr)
75  select case (i)
76  case (1)
77  call ocdobjptr%init_dbl('BUDGET', nullvec, dis, 'PRINT LAST ', &
78  'COLUMNS 10 WIDTH 11 DIGITS 4 GENERAL ', &
79  this%iout, dnodata)
80  case (2)
81  call ocdobjptr%init_dbl(trim(dvname), depvar, dis, 'PRINT LAST ', &
82  'COLUMNS 10 WIDTH 11 DIGITS 4 GENERAL ', &
83  this%iout, dnodata)
84  end select
85  this%ocds(i) = ocdobjptr
86  deallocate (ocdobjptr)
87  end do
88  !
89  ! -- Read options or set defaults if this package not on
90  if (this%inunit > 0) then
91  call this%read_options()
92  end if
93  end subroutine oc_ar
94 
95 end module tspocmodule
This module contains simulation constants.
Definition: Constants.f90:9
integer(i4b), parameter lenmodelname
maximum length of the model name
Definition: Constants.f90:22
This module defines variable data types.
Definition: kind.f90:8
Output control data module.
subroutine, public ocd_cr(ocdobj)
@ brief Create a new output control data type.
Model output control.
subroutine, public oc_cr(ocobj, name_model, inunit, iout)
@ brief Create TspOcType
Definition: tsp-oc.f90:31
subroutine oc_ar(this, depvar, dis, dnodata, dvname)
@ brief Allocate and read TspOcType
Definition: tsp-oc.f90:58
@ brief Controls model output. Overridden for each model type.
@ brief Output control
Definition: tsp-oc.f90:18