swfcdbmodule Module Reference

This module contains the CDB package methods. More...

Data Types
type	swfcdbtype

Functions/Subroutines
subroutine, public	cdb_create (packobj, id, ibcnum, inunit, iout, namemodel, pakname, mempath, dis, cxs, lengthconv, timeconv)
	@ brief Create a new package object More...
subroutine	cdb_allocate_scalars (this)
	@ brief Allocate scalars More...
subroutine	cdb_allocate_arrays (this, nodelist, auxvar)
	@ brief Allocate arrays More...
subroutine	cdb_da (this)
	@ brief Deallocate package memory More...
subroutine	cdb_options (this)
	@ brief Source additional options for package More...
subroutine	log_cdb_options (this, found)
	@ brief Log SWF specific package options More...
subroutine	cdb_cf (this)
	@ brief Formulate the package hcof and rhs terms. More...
real(dp) function	qcalc (this, i, depth)
	Calculate critical depth boundary flow. More...
subroutine	cdb_fc (this, rhs, ia, idxglo, matrix_sln)
	@ brief Copy hcof and rhs terms into solution. More...
subroutine	define_listlabel (this)
	@ brief Define the list label for the package More...
logical function	cdb_obs_supported (this)
	Determine if observations are supported. More...
subroutine	cdb_df_obs (this)
	Define the observation types available in the package. More...
subroutine	cdb_bd_obs (this)
	Save observations for the package. More...
subroutine	cdb_rp_ts (this)
	Assign time series links for the package. More...
real(dp) function	cdb_bound_value (this, col, row)
	@ brief Return a bound value More...

Variables
character(len=lenftype)	ftype = 'CDB'
	package ftype More...
character(len=16)	text = ' CDB'
	package flow text string More...

Detailed Description

This module can be used to represent outflow from streams using a critical depth boundary.

Function/Subroutine Documentation

cdb_allocate_arrays()

subroutine swfcdbmodule::cdb_allocate_arrays	(	class(swfcdbtype)	this,
		integer(i4b), dimension(:), optional, pointer, contiguous	nodelist,
		real(dp), dimension(:, :), optional, pointer, contiguous	auxvar
	)

Allocate and initialize arrays for the SWF package

Definition at line 146 of file swf-cdb.f90.

    ! -- modules
    use memorymanagermodule, only: mem_allocate, mem_setptr, mem_checkin
    ! -- dummy
    class(SwfCdbType) :: this
    integer(I4B), dimension(:), pointer, contiguous, optional :: nodelist
    real(DP), dimension(:, :), pointer, contiguous, optional :: auxvar
    ! -- local
    !
    ! -- call BndExtType allocate scalars
    call this%BndExtType%allocate_arrays(nodelist, auxvar)
    !
    ! -- set array input context pointer
    call mem_setptr(this%idcxs, 'IDCXS', this%input_mempath)
    call mem_setptr(this%width, 'WIDTH', this%input_mempath)
    !
    ! -- checkin array input context pointer
    call mem_checkin(this%idcxs, 'IDCXS', this%memoryPath, &
                     'IDCXS', this%input_mempath)
    call mem_checkin(this%width, 'WIDTH', this%memoryPath, &
                     'WIDTH', this%input_mempath)

cdb_allocate_scalars()

subroutine swfcdbmodule::cdb_allocate_scalars ( class(swfcdbtype)  this )

private

Allocate and initialize scalars for the CDB package. The base model allocate scalars method is also called.

Parameters

this	SwfcdbType object

Definition at line 125 of file swf-cdb.f90.

    ! -- modules
    use memorymanagermodule, only: mem_allocate
    ! -- dummy variables
    class(SwfCdbType) :: this !< SwfcdbType object
    !
    ! -- call base type allocate scalars
    call this%BndExtType%allocate_scalars()
    !
    ! -- allocate the object and assign values to object variables
    call mem_allocate(this%gravconv, 'GRAVCONV', this%memoryPath)
    !
    ! -- Set values
    this%gravconv = dzero

cdb_bd_obs()

subroutine swfcdbmodule::cdb_bd_obs ( class(swfcdbtype)  this )

private

Method to save simulated values for the CDB package.

Parameters

this	SwfCdbType object

Definition at line 434 of file swf-cdb.f90.

    ! -- dummy variables
    class(SwfCdbType) :: this !< SwfCdbType  object
    ! -- local variables
    integer(I4B) :: i
    integer(I4B) :: n
    integer(I4B) :: jj
    real(DP) :: v
    type(ObserveType), pointer :: obsrv => null()
    !
    ! -- clear the observations
    call this%obs%obs_bd_clear()
    !
    ! -- Save simulated values for all of package's observations.
    do i = 1, this%obs%npakobs
      obsrv => this%obs%pakobs(i)%obsrv
      if (obsrv%BndFound) then
        do n = 1, obsrv%indxbnds_count
          v = dnodata
          jj = obsrv%indxbnds(n)
          select case (obsrv%ObsTypeId)
          case ('TO-MVR')
            if (this%imover == 1) then
              v = this%pakmvrobj%get_qtomvr(jj)
              if (v > dzero) then
                v = -v
              end if
            end if
          case ('CDB')
            v = this%simvals(jj)
          case default
            errmsg = 'Unrecognized observation type: '//trim(obsrv%ObsTypeId)
            call store_error(errmsg)
          end select
          call this%obs%SaveOneSimval(obsrv, v)
        end do
      else
        call this%obs%SaveOneSimval(obsrv, dnodata)
      end if
    end do

Here is the call graph for this function:

cdb_bound_value()

real(dp) function swfcdbmodule::cdb_bound_value ( class(swfcdbtype), intent(inout)  this, integer(i4b), intent(in)  col, integer(i4b), intent(in)  row  )

private

Return a bound value associated with an ncolbnd index and row.

Definition at line 509 of file swf-cdb.f90.

    ! -- modules
    use constantsmodule, only: dzero
    ! -- dummy variables
    class(SwfCdbType), intent(inout) :: this
    integer(I4B), intent(in) :: col
    integer(I4B), intent(in) :: row
    ! -- result
    real(DP) :: bndval
    !
    select case (col)
    case (1)
      bndval = this%idcxs(row)
    case (2)
      bndval = this%width(row)
    case default
      errmsg = 'Programming error. CDB bound value requested column '&
               &'outside range of ncolbnd (1).'
      call store_error(errmsg)
      call store_error_filename(this%input_fname)
    end select

Here is the call graph for this function:

cdb_cf()

subroutine swfcdbmodule::cdb_cf

(

class(swfcdbtype)

this

)

Formulate the hcof and rhs terms for the CDB package that will be added to the coefficient matrix and right-hand side vector.

Parameters

this	SwfCdbType object

Definition at line 247 of file swf-cdb.f90.

    ! modules
    use mathutilmodule, only: get_perturbation
    ! -- dummy variables
    class(SwfCdbType) :: this !< SwfCdbType  object
    ! -- local variables
    integer(I4B) :: i, node
    real(DP) :: q
    real(DP) :: qeps
    real(DP) :: depth
    real(DP) :: derv
    real(DP) :: eps
    !
    ! -- Return if no inflows
    if (this%nbound == 0) return
    !
    ! -- Calculate hcof and rhs for each cdb entry
    do i = 1, this%nbound
 
      node = this%nodelist(i)
      if (this%ibound(node) <= 0) then
        this%hcof(i) = dzero
        this%rhs(i) = dzero
        cycle
      end if
 
      ! -- calculate terms and add to hcof and rhs
      depth = this%xnew(node) - this%dis%bot(node)
 
      ! -- calculate unperturbed q
      q = this%qcalc(i, depth)
 
      ! -- calculate perturbed q
      eps = get_perturbation(depth)
      qeps = this%qcalc(i, depth + eps)
 
      ! -- calculate derivative
      derv = (qeps - q) / eps
 
      ! -- add terms to hcof and rhs
      this%hcof(i) = derv
      this%rhs(i) = -q + derv * this%xnew(node)
 
    end do

Here is the call graph for this function:

cdb_create()

subroutine, public swfcdbmodule::cdb_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,
		class(disbasetype), intent(inout), pointer	dis,
		type(swfcxstype), intent(in), pointer	cxs,
		real(dp), intent(in)	lengthconv,
		real(dp), intent(in)	timeconv
	)

Create a new CDB Package object

Parameters

	packobj	pointer to default package type
[in]	id	package id
[in]	ibcnum	boundary condition number
[in]	inunit	unit number of CDB package input file
[in]	iout	unit number of model listing file
[in]	namemodel	model name
[in]	pakname	package name
[in]	mempath	input mempath
[in,out]	dis	the pointer to the discretization
[in]	cxs	the pointer to the cxs package
[in]	lengthconv	conversion factor from model length to meters
[in]	timeconv	conversion factor from model time units to seconds

Definition at line 69 of file swf-cdb.f90.

    ! -- dummy variables
    class(BndType), pointer :: packobj !< pointer to default package type
    integer(I4B), intent(in) :: id !< package id
    integer(I4B), intent(in) :: ibcnum !< boundary condition number
    integer(I4B), intent(in) :: inunit !< unit number of CDB package input file
    integer(I4B), intent(in) :: iout !< unit number of model listing file
    character(len=*), intent(in) :: namemodel !< model name
    character(len=*), intent(in) :: pakname !< package name
    character(len=*), intent(in) :: mempath !< input mempath
    class(DisBaseType), pointer, intent(inout) :: dis !< the pointer to the discretization
    type(SwfCxsType), pointer, intent(in) :: cxs !< the pointer to the cxs package
    real(DP), intent(in) :: lengthconv !< conversion factor from model length to meters
    real(DP), intent(in) :: timeconv !< conversion factor from model time units to seconds
    ! -- local variables
    type(SwfCdbType), pointer :: cdbobj
    !
    ! -- allocate the object and assign values to object variables
    allocate (cdbobj)
    packobj => cdbobj
    !
    ! -- create name and memory path
    call packobj%set_names(ibcnum, namemodel, pakname, ftype, mempath)
    packobj%text = text
    !
    ! -- allocate scalars
    call cdbobj%allocate_scalars()
    !
    ! -- initialize package
    call packobj%pack_initialize()
 
    packobj%inunit = inunit
    packobj%iout = iout
    packobj%id = id
    packobj%ibcnum = ibcnum
    packobj%ncolbnd = 1
    packobj%iscloc = 1
    packobj%ictMemPath = create_mem_path(namemodel, 'DFW')
 
    ! -- store pointer to dis
    cdbobj%dis => dis
 
    ! -- store pointer to cxs
    cdbobj%cxs => cxs
    !
    ! -- store unit conversion
    cdbobj%gravconv = dgravity * lengthconv * timeconv**2

Here is the call graph for this function:

Here is the caller graph for this function:

cdb_da()

subroutine swfcdbmodule::cdb_da

(

class(swfcdbtype)

this

)

Deallocate SWF package scalars and arrays.

Parameters

this	SwfcdbType object

Definition at line 174 of file swf-cdb.f90.

    ! -- modules
    use memorymanagermodule, only: mem_deallocate
    ! -- dummy variables
    class(SwfCdbType) :: this !< SwfcdbType object
    !
    ! -- Deallocate parent package
    call this%BndExtType%bnd_da()
    !
    ! -- arrays
    call mem_deallocate(this%idcxs, 'IDCXS', this%memoryPath)
    call mem_deallocate(this%width, 'WIDTH', this%memoryPath)
    !
    ! -- scalars
    call mem_deallocate(this%gravconv)

cdb_df_obs()

subroutine swfcdbmodule::cdb_df_obs ( class(swfcdbtype)  this )

private

Method to define the observation types available in the CDB package.

Parameters

this	SwfCdbType object

Definition at line 413 of file swf-cdb.f90.

    ! -- dummy variables
    class(SwfCdbType) :: this !< SwfCdbType  object
    ! -- local variables
    integer(I4B) :: indx
    !
    ! -- initialize observations
    call this%obs%StoreObsType('cdb', .true., indx)
    this%obs%obsData(indx)%ProcessIdPtr => defaultobsidprocessor
    !
    ! -- Store obs type and assign procedure pointer
    !    for to-mvr observation type.
    call this%obs%StoreObsType('to-mvr', .true., indx)
    this%obs%obsData(indx)%ProcessIdPtr => defaultobsidprocessor

Here is the call graph for this function:

cdb_fc()

subroutine swfcdbmodule::cdb_fc ( class(swfcdbtype)  this, real(dp), dimension(:), intent(inout)  rhs, integer(i4b), dimension(:), intent(in)  ia, integer(i4b), dimension(:), intent(in)  idxglo, class(matrixbasetype), pointer  matrix_sln  )

private

Add the hcof and rhs terms for the CDB package to the coefficient matrix and right-hand side vector.

Parameters

	this	SwfCdbType 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 330 of file swf-cdb.f90.

    ! -- dummy variables
    class(SwfCdbType) :: this !< SwfCdbType  object
    real(DP), dimension(:), intent(inout) :: rhs !< right-hand side vector for model
    integer(I4B), dimension(:), intent(in) :: ia !< solution CRS row pointers
    integer(I4B), dimension(:), intent(in) :: idxglo !< mapping vector for model (local) to solution (global)
    class(MatrixBaseType), pointer :: matrix_sln !< solution coefficient matrix
    ! -- local variables
    integer(I4B) :: i
    integer(I4B) :: n
    integer(I4B) :: ipos
    !
    ! -- pakmvrobj fc
    if (this%imover == 1) then
      call this%pakmvrobj%fc()
    end if
    !
    ! -- Copy package rhs and hcof into solution rhs and amat
    do i = 1, this%nbound
      n = this%nodelist(i)
      rhs(n) = rhs(n) + this%rhs(i)
      ipos = ia(n)
      call matrix_sln%add_value_pos(idxglo(ipos), this%hcof(i))
      !
      ! -- If mover is active and this cdb item is discharging,
      !    store available water (as positive value).
      if (this%imover == 1 .and. this%rhs(i) > dzero) then
        call this%pakmvrobj%accumulate_qformvr(i, this%rhs(i))
      end if
    end do

cdb_obs_supported()

logical function swfcdbmodule::cdb_obs_supported ( class(swfcdbtype)  this )

private

Function to determine if observations are supported by the CDB package. Observations are supported by the CDB package.

Returns

cdb_obs_supported boolean indicating if observations are supported

Parameters

this	SwfCdbType object

Definition at line 400 of file swf-cdb.f90.

    ! -- dummy variables
    class(SwfCdbType) :: this !< SwfCdbType  object
    !
    ! -- set boolean
    cdb_obs_supported = .true.

cdb_options()

subroutine swfcdbmodule::cdb_options

(

class(swfcdbtype), intent(inout)

this

)

Source additional options for SWF package.

Parameters

[in,out]

this

SwfCdbType object

Definition at line 196 of file swf-cdb.f90.

    ! -- modules
    use inputoutputmodule, only: urword
    use memorymanagerextmodule, only: mem_set_value
    use swfcdbinputmodule, only: swfcdbparamfoundtype
    ! -- dummy variables
    class(SwfCdbType), intent(inout) :: this !< SwfCdbType object
    ! -- local variables
    type(SwfCdbParamFoundType) :: found
    ! -- formats
    !
    ! -- source base BndExtType options
    call this%BndExtType%source_options()
    !
    ! -- source options from input context
    ! none
    !
    ! -- log SWF specific options
    call this%log_cdb_options(found)

Here is the call graph for this function:

cdb_rp_ts()

subroutine swfcdbmodule::cdb_rp_ts ( class(swfcdbtype), intent(inout)  this )

private

Assign the time series links for the CDB package. Only the Q variable can be defined with time series.

Parameters

[in,out]

this

SwfCdbType object

Definition at line 484 of file swf-cdb.f90.

    ! -- dummy variables
    class(SwfCdbType), intent(inout) :: this !< SwfCdbType  object
    ! -- local variables
    integer(I4B) :: i, nlinks
    type(TimeSeriesLinkType), pointer :: tslink => null()
    !
    ! -- set up the time series links
    nlinks = this%TsManager%boundtslinks%Count()
    do i = 1, nlinks
      tslink => gettimeserieslinkfromlist(this%TsManager%boundtslinks, i)
      if (associated(tslink)) then
        if (tslink%JCol == 1) then
          tslink%Text = 'Q'
        end if
      end if
    end do

Here is the call graph for this function:

define_listlabel()

subroutine swfcdbmodule::define_listlabel ( class(swfcdbtype), intent(inout)  this )

private

Method defined the list label for the CDB package. The list label is the heading that is written to iout when PRINT_INPUT option is used.

Parameters

[in,out]

this

SwfCdbType object

Definition at line 368 of file swf-cdb.f90.

    ! -- dummy variables
    class(SwfCdbType), intent(inout) :: this !< SwfCdbType  object
    !
    ! -- create the header list label
    this%listlabel = trim(this%filtyp)//' NO.'
    if (this%dis%ndim == 3) then
      write (this%listlabel, '(a, a7)') trim(this%listlabel), 'LAYER'
      write (this%listlabel, '(a, a7)') trim(this%listlabel), 'ROW'
      write (this%listlabel, '(a, a7)') trim(this%listlabel), 'COL'
    elseif (this%dis%ndim == 2) then
      write (this%listlabel, '(a, a7)') trim(this%listlabel), 'LAYER'
      write (this%listlabel, '(a, a7)') trim(this%listlabel), 'CELL2D'
    else
      write (this%listlabel, '(a, a7)') trim(this%listlabel), 'NODE'
    end if
    write (this%listlabel, '(a, a16)') trim(this%listlabel), 'FLOW RATE'
    if (this%inamedbound == 1) then
      write (this%listlabel, '(a, a16)') trim(this%listlabel), 'BOUNDARY NAME'
    end if

log_cdb_options()

subroutine swfcdbmodule::log_cdb_options	(	class(swfcdbtype), intent(inout)	this,
		type(swfcdbparamfoundtype), intent(in)	found
	)

Definition at line 219 of file swf-cdb.f90.

    ! -- modules
    use swfcdbinputmodule, only: swfcdbparamfoundtype
    ! -- dummy variables
    class(SwfCdbType), intent(inout) :: this
    type(SwfCdbParamFoundType), intent(in) :: found
    ! -- local variables
    ! -- format
    !
    ! -- log found options
    write (this%iout, '(/1x,a)') 'PROCESSING '//trim(adjustl(this%text)) &
      //' OPTIONS'
    !
    ! if (found%mover) then
    !   write (this%iout, '(4x,A)') 'MOVER OPTION ENABLED'
    ! end if
    !
    ! -- close logging block
    write (this%iout, '(1x,a)') &
      'END OF '//trim(adjustl(this%text))//' OPTIONS'

qcalc()

real(dp) function swfcdbmodule::qcalc	(	class(swfcdbtype)	this,
		integer(i4b), intent(in)	i,
		real(dp), intent(in)	depth
	)

Parameters

[in]	i	boundary number
[in]	depth	simulated depth (stage - elevation) in reach n for this iteration

Definition at line 295 of file swf-cdb.f90.

    ! modules
    ! dummy
    class(SwfCdbType) :: this
    integer(I4B), intent(in) :: i !< boundary number
    real(DP), intent(in) :: depth !< simulated depth (stage - elevation) in reach n for this iteration
    ! return
    real(DP) :: q
    ! local
    integer(I4B) :: idcxs
    real(DP) :: width
    real(DP) :: a
    real(DP) :: r
 
    idcxs = this%idcxs(i)
    width = this%width(i)
    a = this%cxs%get_area(idcxs, width, depth)
    r = this%cxs%get_hydraulic_radius(idcxs, width, depth, area=a)
 
    q = this%gravconv * a**dtwo * r
    if (q > dprec) then
      q = q**dhalf
    else
      q = dzero
    end if
    q = -q
 

Variable Documentation

ftype

character(len=lenftype) swfcdbmodule::ftype = 'CDB'

private

Definition at line 30 of file swf-cdb.f90.

  character(len=LENFTYPE) :: ftype = 'CDB' !< package ftype

text

character(len=16) swfcdbmodule::text = ' CDB'

private

Definition at line 31 of file swf-cdb.f90.

  character(len=16) :: text = '             CDB' !< package flow text string