MODFLOW 6  version 6.5.0.dev2
MODFLOW 6 Code Documentation
timeserieslinkmodule Module Reference

Data Types

type  timeserieslinktype
 

Functions/Subroutines

subroutine, public constructtimeserieslink (newTsLink, timeSeries, pkgName, auxOrBnd, bndElem, iRow, jCol, iprpak, text)
 Construct time series link. More...
 
type(timeserieslinktype) function, pointer, private castastimeserieslinktype (obj)
 Cast an unlimited polymorphic object as TimeSeriesLinkType. More...
 
type(timeserieslinktype) function, pointer, public gettimeserieslinkfromlist (list, indx)
 Get time series link from a list. More...
 
subroutine, public addtimeserieslinktolist (list, tslink)
 Add time series link to a list. More...
 

Function/Subroutine Documentation

◆ addtimeserieslinktolist()

subroutine, public timeserieslinkmodule::addtimeserieslinktolist ( type(listtype), intent(inout)  list,
type(timeserieslinktype), intent(inout), pointer  tslink 
)

Definition at line 124 of file TimeSeriesLink.f90.

125  implicit none
126  ! -- dummy
127  type(ListType), intent(inout) :: list
128  type(TimeSeriesLinkType), pointer, intent(inout) :: tslink
129  ! -- local
130  class(*), pointer :: obj
131  !
132  obj => tslink
133  call list%Add(obj)
134  !
135  ! -- Return
136  return
Here is the caller graph for this function:

◆ castastimeserieslinktype()

type(timeserieslinktype) function, pointer, private timeserieslinkmodule::castastimeserieslinktype ( class(*), intent(inout), pointer  obj)
private

Definition at line 81 of file TimeSeriesLink.f90.

82  implicit none
83  ! -- dummy
84  class(*), pointer, intent(inout) :: obj
85  ! -- return
86  type(TimeSeriesLinkType), pointer :: res
87  !
88  res => null()
89  if (.not. associated(obj)) return
90  !
91  select type (obj)
92  type is (timeserieslinktype)
93  res => obj
94  class default
95  continue
96  end select
97  !
98  ! -- Return
99  return
Here is the caller graph for this function:

◆ constructtimeserieslink()

subroutine, public timeserieslinkmodule::constructtimeserieslink ( type(timeserieslinktype), intent(out), pointer  newTsLink,
type(timeseriestype), intent(in), pointer  timeSeries,
character(len=*), intent(in)  pkgName,
character(len=3), intent(in)  auxOrBnd,
real(dp), intent(in), pointer  bndElem,
integer(i4b), intent(in)  iRow,
integer(i4b), intent(in)  jCol,
integer(i4b), intent(in)  iprpak,
character(len=*), optional  text 
)

Definition at line 42 of file TimeSeriesLink.f90.

45  implicit none
46  ! -- dummy
47  type(TimeSeriesLinkType), pointer, intent(out) :: newTsLink
48  type(TimeSeriesType), pointer, intent(in) :: timeSeries
49  integer(I4B), intent(in) :: iRow, jCol
50  character(len=*), intent(in) :: pkgName
51  character(len=3), intent(in) :: auxOrBnd
52  real(DP), pointer, intent(in) :: bndElem
53  integer(I4B), intent(in) :: iprpak
54  character(len=*), optional :: text
55  ! -- local
56  character(len=LENPACKAGENAME) :: pkgNameTemp
57  !
58  allocate (newtslink)
59  !
60  ! Store package name as all caps
61  pkgnametemp = pkgname
62  call upcase(pkgnametemp)
63  newtslink%PackageName = pkgnametemp
64  newtslink%AuxOrBnd = auxorbnd
65  newtslink%timeSeries => timeseries
66  newtslink%iRow = irow
67  newtslink%jCol = jcol
68  newtslink%BndElement => bndelem
69  newtslink%Iprpak = iprpak
70  !
71  if (present(text)) then
72  newtslink%Text = text
73  end if
74  !
75  ! -- Return
76  return
Here is the call graph for this function:
Here is the caller graph for this function:

◆ gettimeserieslinkfromlist()

type(timeserieslinktype) function, pointer, public timeserieslinkmodule::gettimeserieslinkfromlist ( type(listtype), intent(inout)  list,
integer(i4b), intent(in)  indx 
)

Definition at line 104 of file TimeSeriesLink.f90.

105  implicit none
106  ! -- dummy
107  type(ListType), intent(inout) :: list
108  integer(I4B), intent(in) :: indx
109  ! -- return
110  type(TimeSeriesLinkType), pointer :: tsLink
111  ! -- local
112  class(*), pointer :: obj
113  !
114  tslink => null()
115  obj => list%GetItem(indx)
116  tslink => castastimeserieslinktype(obj)
117  !
118  ! -- Return
119  return
Here is the call graph for this function:
Here is the caller graph for this function: