Data Types
type	swfobstype

Functions/Subroutines
subroutine, public	swf_obs_cr (obs, inobs)
	Create a new obs object. More...

subroutine	swf_obs_ar (this, ic, x, flowja)
	Allocate and read. More...

subroutine	swf_obs_df (this, iout, pkgname, filtyp, dis)
	Define. More...

subroutine	swf_obs_bd (this)
	Save obs. More...

subroutine	swf_obs_rp (this)
	Do observations need any checking? If so, add checks here. More...

subroutine	swf_obs_da (this)
	Deallocate memory. More...

subroutine	set_pointers (this, ic, x, flowja)
	Set pointers. More...

subroutine	swf_process_stage_obs_id (obsrv, dis, inunitobs, iout)
	Calculate stage observation when requested. More...

subroutine	swf_process_intercell_obs_id (obsrv, dis, inunitobs, iout)
	Process flow between two cells when requested. More...

Function/Subroutine Documentation

◆ set_pointers()

subroutine swfobsmodule::set_pointers	(	class(swfobstype), intent(inout)	this,
		type(swfictype), intent(in), pointer	ic,
		real(dp), dimension(:), intent(in), pointer, contiguous	x,
		real(dp), dimension(:), intent(in), pointer, contiguous	flowja
	)

private

Definition at line 147 of file swf-obs.f90.

     ! -- dummy
     class(SwfObsType), intent(inout) :: this
     type(SwfIcType), pointer, intent(in) :: ic
     real(DP), dimension(:), pointer, contiguous, intent(in) :: x
     real(DP), dimension(:), pointer, contiguous, intent(in) :: flowja
     !
     this%ic => ic
     this%x => x
     this%flowja => flowja

◆ swf_obs_ar()

subroutine swfobsmodule::swf_obs_ar	(	class(swfobstype), intent(inout)	this,
		type(swfictype), intent(in), pointer	ic,
		real(dp), dimension(:), intent(in), pointer, contiguous	x,
		real(dp), dimension(:), intent(in), pointer, contiguous	flowja
	)

private

Definition at line 52 of file swf-obs.f90.

     ! -- dummy
     class(SwfObsType), intent(inout) :: this
     type(SwfIcType), pointer, intent(in) :: ic
     real(DP), dimension(:), pointer, contiguous, intent(in) :: x
     real(DP), dimension(:), pointer, contiguous, intent(in) :: flowja
     !
     ! Call ar method of parent class
     call this%obs_ar()
     !
     ! set pointers
     call this%set_pointers(ic, x, flowja)

◆ swf_obs_bd()

subroutine swfobsmodule::swf_obs_bd ( class(swfobstype), intent(inout) this )

private

Definition at line 95 of file swf-obs.f90.

     ! -- dummy
     class(SwfObsType), intent(inout) :: this
     ! -- local
     integer(I4B) :: i, jaindex, nodenumber
     character(len=100) :: msg
     class(ObserveType), pointer :: obsrv => null()
     !
     call this%obs_bd_clear()
     !
     ! -- iterate through all SWF observations
     if (this%npakobs > 0) then
       do i = 1, this%npakobs
         obsrv => this%pakobs(i)%obsrv
         nodenumber = obsrv%NodeNumber
         jaindex = obsrv%JaIndex
         select case (obsrv%ObsTypeId)
         case ('STAGE')
           call this%SaveOneSimval(obsrv, this%x(nodenumber))
         case ('FLOW-JA-FACE')
           call this%SaveOneSimval(obsrv, this%flowja(jaindex))
         case default
           msg = ' Unrecognized observation type: '//trim(obsrv%ObsTypeId)
           call store_error(msg)
           call store_error_unit(this%inUnitObs)
         end select
       end do
     end if

Here is the call graph for this function:

◆ swf_obs_cr()

subroutine, public swfobsmodule::swf_obs_cr	(	type(swfobstype), intent(out), pointer	obs,
		integer(i4b), intent(in), pointer	inobs
	)

Create observation object, allocate pointers, initialize values

Definition at line 38 of file swf-obs.f90.

     ! -- dummy
     type(SwfObsType), pointer, intent(out) :: obs
     integer(I4B), pointer, intent(in) :: inobs
     !
     allocate (obs)
     call obs%allocate_scalars()
     obs%active = .false.
     obs%inputFilename = ''
     obs%inUnitObs => inobs

Here is the caller graph for this function:

◆ swf_obs_da()

subroutine swfobsmodule::swf_obs_da ( class(swfobstype), intent(inout) this )

private

Definition at line 136 of file swf-obs.f90.

     class(SwfObsType), intent(inout) :: this
     !
     nullify (this%ic)
     nullify (this%x)
     nullify (this%flowja)
     call this%ObsType%obs_da()

◆ swf_obs_df()

subroutine swfobsmodule::swf_obs_df	(	class(swfobstype), intent(inout)	this,
		integer(i4b), intent(in)	iout,
		character(len=*), intent(in)	pkgname,
		character(len=*), intent(in)	filtyp,
		class(disbasetype), pointer	dis
	)

private

Definition at line 68 of file swf-obs.f90.

     ! -- dummy
     class(SwfObsType), intent(inout) :: this
     integer(I4B), intent(in) :: iout
     character(len=*), intent(in) :: pkgname
     character(len=*), intent(in) :: filtyp
     class(DisBaseType), pointer :: dis
     ! -- local
     integer(I4B) :: indx
     !
     ! Call overridden method of parent class
     call this%ObsType%obs_df(iout, pkgname, filtyp, dis)
     !
     ! -- StoreObsType arguments are: (ObserveType, cumulative, indx);
     !    indx is returned.
     !
     ! -- Store obs type and assign procedure pointer for head observation type
     call this%StoreObsType('stage', .false., indx)
     this%obsData(indx)%ProcessIdPtr => swf_process_stage_obs_id
     !
     ! -- Store obs type and assign procedure pointer for flow-ja-face observation type
     call this%StoreObsType('flow-ja-face', .true., indx)
     this%obsData(indx)%ProcessIdPtr => swf_process_intercell_obs_id

Here is the call graph for this function:

◆ swf_obs_rp()

subroutine swfobsmodule::swf_obs_rp ( class(swfobstype), intent(inout) this )

private

Definition at line 127 of file swf-obs.f90.

     class(SwfObsType), intent(inout) :: this
     !
     ! Do SWF observations need any checking? If so, add checks here
     return

◆ swf_process_intercell_obs_id()

subroutine swfobsmodule::swf_process_intercell_obs_id	(	type(observetype), intent(inout)	obsrv,
		class(disbasetype), intent(in)	dis,
		integer(i4b), intent(in)	inunitobs,
		integer(i4b), intent(in)	iout
	)

private

Definition at line 194 of file swf-obs.f90.

     ! -- dummy
     type(ObserveType), intent(inout) :: obsrv
     class(DisBaseType), intent(in) :: dis
     integer(I4B), intent(in) :: inunitobs
     integer(I4B), intent(in) :: iout
     ! -- local
     integer(I4B) :: nn1, nn2
     integer(I4B) :: icol, istart, istop, jaidx
     character(len=LINELENGTH) :: ermsg, string
     ! formats
 70  format('Error: No connection exists between cells identified in text: ', a)
     !
     ! -- Initialize variables
     string = obsrv%IDstring
     icol = 1
     !
     ! Get node number, with option for ID string to be either node
     ! number or lay, row, column (when dis is structured).
     nn1 = dis%noder_from_string(icol, istart, istop, inunitobs, &
                                 iout, string, .false.)
     !
     if (nn1 > 0) then
       obsrv%NodeNumber = nn1
     else
       ermsg = 'Error reading data from ID string: '//string(istart:istop)
       call store_error(ermsg)
     end if
     !
     ! Get node number, with option for ID string to be either node
     ! number or lay, row, column (when dis is structured).
     nn2 = dis%noder_from_string(icol, istart, istop, inunitobs, &
                                 iout, string, .false.)
     if (nn2 > 0) then
       obsrv%NodeNumber2 = nn2
     else
       ermsg = 'Error reading data from ID string: '//string(istart:istop)
       call store_error(ermsg)
     end if
     !
     ! -- store JA index
     jaidx = dis%con%getjaindex(nn1, nn2)
     if (jaidx == 0) then
       write (ermsg, 70) trim(string)
       call store_error(ermsg)
     end if
     obsrv%JaIndex = jaidx
     !
     if (count_errors() > 0) then
       call store_error_unit(inunitobs)
     end if

Here is the call graph for this function:

Here is the caller graph for this function:

◆ swf_process_stage_obs_id()

subroutine swfobsmodule::swf_process_stage_obs_id	(	type(observetype), intent(inout)	obsrv,
		class(disbasetype), intent(in)	dis,
		integer(i4b), intent(in)	inunitobs,
		integer(i4b), intent(in)	iout
	)

private

Definition at line 163 of file swf-obs.f90.

     ! -- dummy
     type(ObserveType), intent(inout) :: obsrv
     class(DisBaseType), intent(in) :: dis
     integer(I4B), intent(in) :: inunitobs
     integer(I4B), intent(in) :: iout
     ! -- local
     integer(I4B) :: nn1
     integer(I4B) :: icol, istart, istop
     character(len=LINELENGTH) :: ermsg, string
     !
     ! -- Initialize variables
     string = obsrv%IDstring
     icol = 1
     !
     ! Get node number, with option for ID string to be either node
     ! number or lay, row, column (when dis is structured).
     nn1 = dis%noder_from_string(icol, istart, istop, inunitobs, &
                                 iout, string, .false.)
     !
     if (nn1 > 0) then
       obsrv%NodeNumber = nn1
     else
       ermsg = 'Error reading data from ID string'
       call store_error(ermsg)
       call store_error_unit(inunitobs)
     end if

Here is the call graph for this function:

Here is the caller graph for this function:

Data Types

Functions/Subroutines

Function/Subroutine Documentation

◆ set_pointers()

◆ swf_obs_ar()

◆ swf_obs_bd()

◆ swf_obs_cr()

◆ swf_obs_da()

◆ swf_obs_df()

◆ swf_obs_rp()

◆ swf_process_intercell_obs_id()

◆ swf_process_stage_obs_id()