swfcxsmodule Module Reference

Data Types
type	cxsoptionsfoundtype
	flags indicating which CXS options were found in the input More...
type	cxsdimensionsfoundtype
	flags indicating which CXS dimensions were found in the input More...
type	cxspackagedatafoundtype
	flags indicating which CXS packagedata were found in the input More...
type	cxscrosssectiondatafoundtype
	flags indicating which CXS crosssectiondata were found in the input More...
type	swfcxstype

Functions/Subroutines
subroutine, public	cxs_cr (pobj, name_model, input_mempath, inunit, iout, dis)
	create package More...
subroutine	allocate_scalars (this)
	@ brief Allocate scalars More...
subroutine	source_options (this)
	Copy options from IDM into package. More...
subroutine	log_options (this, found)
	Write user options to list file. More...
subroutine	source_dimensions (this)
	Copy options from IDM into package. More...
subroutine	log_dimensions (this, found)
	Write user options to list file. More...
subroutine	allocate_arrays (this)
	allocate memory for arrays More...
subroutine	source_packagedata (this)
	Copy options from IDM into package. More...
subroutine	calc_iacross (nxspoints, iacross)
	Calculate index pointer array iacross from nxspoints. More...
subroutine	check_packagedata (this)
	Check packagedata. More...
subroutine	log_packagedata (this, found)
	Write user packagedata to list file. More...
subroutine	source_crosssectiondata (this)
	Copy options from IDM into package. More...
subroutine	check_crosssectiondata (this, ifno)
	Check crosssectiondata IFNO against PACKAGEDATA section groupings. More...
subroutine	log_crosssectiondata (this, found)
	Write user packagedata to list file. More...
subroutine	write_cxs_table (this, idcxs, width, slope, rough, unitconv)
subroutine	cxs_da (this)
	deallocate memory More...
subroutine	get_cross_section_info (this, idcxs, i0, i1, npts, icalcmeth)
real(dp) function	get_area (this, idcxs, width, depth)
real(dp) function	cxs_wetted_perimeter (this, idcxs, width, depth)
real(dp) function	get_roughness (this, idcxs, width, depth, rough, slope)
real(dp) function	cxs_conveyance (this, idcxs, width, depth, rough)
	Calculate and return conveyance. More...
real(dp) function	get_hydraulic_radius (this, idcxs, width, depth, area)
real(dp) function	get_wetted_top_width (this, idcxs, width, depth)
real(dp) function	get_maximum_top_width (this, idcxs, width)

Function/Subroutine Documentation

allocate_arrays()

subroutine swfcxsmodule::allocate_arrays ( class(swfcxstype)  this )

private

Definition at line 277 of file swf-cxs.f90.

    ! -- dummy
    class(SwfCxsType) :: this
    ! -- locals
    integer(I4B) :: n
    !
    ! -- arrays allocation
    call mem_allocate(this%idcxs, this%nsections, &
                      'IDCXS', this%memoryPath)
    call mem_allocate(this%nxspoints, this%nsections, &
                      'NXSPOINTS', this%memoryPath)
    call mem_allocate(this%xfraction, this%npoints, &
                      'XFRACTION', this%memoryPath)
    call mem_allocate(this%height, this%npoints, &
                      'HEIGHT', this%memoryPath)
    call mem_allocate(this%manfraction, this%npoints, &
                      'MANFRACTION', this%memoryPath)
    call mem_allocate(this%iacross, this%nsections + 1, &
                      'IACROSS', this%memoryPath)
 
    ! -- initialization
    do n = 1, this%nsections
      this%idcxs(n) = 0
      this%nxspoints(n) = 0
    end do
    do n = 1, this%npoints
      this%xfraction(n) = dzero
      this%height(n) = dzero
      this%manfraction(n) = dzero
    end do
    do n = 1, this%nsections + 1
      this%iacross(n) = 0
    end do

allocate_scalars()

subroutine swfcxsmodule::allocate_scalars

(

class(swfcxstype)

this

)

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

Definition at line 156 of file swf-cxs.f90.

    ! -- modules
    ! -- dummy
    class(SwfCxsType) :: this
    !
    ! -- allocate scalars in NumericalPackageType
    call this%NumericalPackageType%allocate_scalars()
    !
    ! -- Allocate scalars
    call mem_allocate(this%nsections, 'NSECTIONS', this%memoryPath)
    call mem_allocate(this%npoints, 'NPOINTS', this%memoryPath)
 
    ! -- initialize
    this%nsections = 0
    this%npoints = 0

calc_iacross()

subroutine swfcxsmodule::calc_iacross	(	integer(i4b), dimension(:), intent(in)	nxspoints,
		integer(i4b), dimension(:), intent(inout)	iacross
	)

Definition at line 360 of file swf-cxs.f90.

    integer(I4B), dimension(:), intent(in) :: nxspoints
    integer(I4B), dimension(:), intent(inout) :: iacross
    integer(I4B) :: n
    iacross(1) = 1
    do n = 1, size(nxspoints)
      iacross(n + 1) = iacross(n) + nxspoints(n)
    end do

Here is the caller graph for this function:

check_crosssectiondata()

subroutine swfcxsmodule::check_crosssectiondata	(	class(swfcxstype)	this,
		integer(i4b), dimension(:), intent(in)	ifno
	)

Parameters

	this	this instance
[in]	ifno	cross section number for each point

Definition at line 496 of file swf-cxs.f90.

    ! -- dummy
    class(SwfCxsType) :: this !< this instance
    integer(I4B), dimension(:), intent(in) :: ifno !< cross section number for each point
    ! -- local
    integer(I4B) :: n
    integer(I4B) :: i
    integer(I4B) :: i0
    integer(I4B) :: i1
 
    do n = 1, this%nsections
      i0 = this%iacross(n)
      i1 = this%iacross(n + 1) - 1
      do i = i0, i1
        if (ifno(i) /= this%idcxs(n)) then
          write (errmsg, '(a, i0, a, i0, a, i0, a)') &
          'IFNO value in CROSSSECTIONDATA does not match the cross &
          &section implied by PACKAGEDATA.  Found IFNO = ', ifno(i), &
          ' at point ', i, ' but expected ', this%idcxs(n), '.'
          call store_error(errmsg)
        end if
      end do
    end do
 
    if (count_errors() > 0) then
      call store_error_filename(this%input_fname)
    end if

Here is the call graph for this function:

check_packagedata()

subroutine swfcxsmodule::check_packagedata ( class(swfcxstype)  this )

private

Parameters

this	this instance

Definition at line 372 of file swf-cxs.f90.

    ! dummy arguments
    class(SwfCxsType) :: this !< this instance
    ! local variables
    integer(I4B) :: i
 
    ! Check that all cross section IDs are in range
    do i = 1, size(this%idcxs)
      if (this%idcxs(i) <= 0 .or. this%idcxs(i) > this%nsections) then
        write (errmsg, '(a, i0, a)') &
        'IFNO values must be greater than 0 and less than NSECTIONS.  &
        &Found ', this%idcxs(i), '.'
        call store_error(errmsg)
      end if
    end do
 
    ! Check that nxspoints are greater than one
    do i = 1, size(this%nxspoints)
      if (this%nxspoints(i) <= 1) then
        write (errmsg, '(a, i0, a, i0, a)') &
        'NXSPOINTS values must be greater than 1 for each cross section.  &
        &Found ', this%nxspoints(i), ' for cross section ', this%idcxs(i), '.'
        call store_error(errmsg)
      end if
    end do
 
    ! write summary of package error messages
    if (count_errors() > 0) then
      call store_error_filename(this%input_fname)
    end if
 

Here is the call graph for this function:

cxs_conveyance()

real(dp) function swfcxsmodule::cxs_conveyance	(	class(swfcxstype)	this,
		integer(i4b), intent(in)	idcxs,
		real(dp), intent(in)	width,
		real(dp), intent(in)	depth,
		real(dp), intent(in)	rough
	)

Conveyance = area * hydraulic_radius ** (2/3) / mannings_roughness If idcxs = 0 (no cross section specified) then reach is

Parameters

[in]	idcxs	cross section id
[in]	width	width in reach
[in]	depth	stage in reach
[in]	rough	mannings value provided for the reach

Returns

calculated composite roughness

Definition at line 772 of file swf-cxs.f90.

    ! -- modules
    use swfcxsutilsmodule, only: get_conveyance
    ! -- dummy
    class(SwfCxsType) :: this
    integer(I4B), intent(in) :: idcxs !< cross section id
    real(DP), intent(in) :: width !< width in reach
    real(DP), intent(in) :: depth !< stage in reach
    real(DP), intent(in) :: rough !< mannings value provided for the reach
    ! -- return
    real(DP) :: conveyance !< calculated composite roughness
    ! -- local
    real(DP) :: a
    real(DP) :: rh
    integer(I4B) :: i0
    integer(I4B) :: i1
    integer(I4B) :: npts
    integer(I4B) :: icalcmeth
    call this%get_cross_section_info(idcxs, i0, i1, npts, icalcmeth)
    if (npts == 0) then
      a = depth * width
      rh = depth
      conveyance = a * rh**dtwothirds / rough
    else
      conveyance = get_conveyance(npts, &
                                  this%xfraction(i0:i1), &
                                  this%height(i0:i1), &
                                  this%manfraction(i0:i1), &
                                  width, rough, depth)
    end if

Here is the call graph for this function:

cxs_cr()

subroutine, public swfcxsmodule::cxs_cr	(	type(swfcxstype), pointer	pobj,
		character(len=*), intent(in)	name_model,
		character(len=*), intent(in)	input_mempath,
		integer(i4b), intent(in)	inunit,
		integer(i4b), intent(in)	iout,
		class(disbasetype), intent(inout), pointer	dis
	)

Parameters

[in,out]

dis

the pointer to the discretization

Definition at line 90 of file swf-cxs.f90.

    ! -- modules
    use memorymanagerextmodule, only: mem_set_value
    ! -- dummy
    type(SwfCxsType), pointer :: pobj
    character(len=*), intent(in) :: name_model
    character(len=*), intent(in) :: input_mempath
    integer(I4B), intent(in) :: inunit
    integer(I4B), intent(in) :: iout
    class(DisBaseType), pointer, intent(inout) :: dis !< the pointer to the discretization
    ! -- locals
    logical(LGP) :: found_fname
    ! -- formats
    character(len=*), parameter :: fmtheader = &
      "(1x, /1x, 'CXS --  CROSS SECTION PACKAGE, VERSION 1, 5/24/2023', &
       &' INPUT READ FROM MEMPATH: ', A, /)"
    !
    ! -- Create the object
    allocate (pobj)
 
    ! -- create name and memory path
    call pobj%set_names(1, name_model, 'CXS', 'CXS')
 
    ! -- Allocate scalars
    call pobj%allocate_scalars()
 
    ! -- Set variables
    pobj%input_mempath = input_mempath
    pobj%inunit = inunit
    pobj%iout = iout
    pobj%dis => dis
 
    ! -- set name of input file
    call mem_set_value(pobj%input_fname, 'INPUT_FNAME', pobj%input_mempath, &
                       found_fname)
 
    ! -- check if package is enabled
    if (inunit > 0) then
 
      ! -- Print a message identifying the package.
      write (iout, fmtheader) input_mempath
 
      ! -- source options
      call pobj%source_options()
 
      ! -- source dimensions
      call pobj%source_dimensions()
 
      ! -- allocate arrays
      call pobj%allocate_arrays()
 
      ! -- source dimensions
      call pobj%source_packagedata()
 
      ! -- source dimensions
      call pobj%source_crosssectiondata()
 
    end if

Here is the caller graph for this function:

cxs_da()

subroutine swfcxsmodule::cxs_da

(

class(swfcxstype)

this

)

Definition at line 618 of file swf-cxs.f90.

    ! -- modules
    use memorymanagermodule, only: mem_deallocate
    use memorymanagerextmodule, only: memorystore_remove
    use simvariablesmodule, only: idm_context
    ! -- dummy
    class(SwfCxsType) :: this
    !
    ! -- Deallocate input memory
    call memorystore_remove(this%name_model, 'CXS', idm_context)
    !
    ! -- Scalars
    call mem_deallocate(this%nsections)
    call mem_deallocate(this%npoints)
    !
    ! -- Deallocate arrays if the package was created
    !    from an input file
    if (this%inunit > 0) then
      call mem_deallocate(this%idcxs)
      call mem_deallocate(this%nxspoints)
      call mem_deallocate(this%xfraction)
      call mem_deallocate(this%height)
      call mem_deallocate(this%manfraction)
      call mem_deallocate(this%iacross)
    end if
    !
    ! -- deallocate parent
    call this%NumericalPackageType%da()

Here is the call graph for this function:

cxs_wetted_perimeter()

real(dp) function swfcxsmodule::cxs_wetted_perimeter	(	class(swfcxstype)	this,
		integer(i4b), intent(in)	idcxs,
		real(dp), intent(in)	width,
		real(dp), intent(in)	depth
	)

Parameters

[in]	idcxs	cross section id
[in]	width	width in reach
[in]	depth	stage in reach

Definition at line 709 of file swf-cxs.f90.

    ! -- modules
    use swfcxsutilsmodule, only: get_wetted_perimeter
    ! -- dummy
    class(SwfCxsType) :: this
    integer(I4B), intent(in) :: idcxs !< cross section id
    real(DP), intent(in) :: width !< width in reach
    real(DP), intent(in) :: depth !< stage in reach
    ! -- local
    real(DP) :: wp
    integer(I4B) :: i0
    integer(I4B) :: i1
    integer(I4B) :: npts
    integer(I4B) :: icalcmeth
    call this%get_cross_section_info(idcxs, i0, i1, npts, icalcmeth)
    if (npts == 0) then
      wp = width
    else
      wp = get_wetted_perimeter(npts, &
                                this%xfraction(i0:i1), &
                                this%height(i0:i1), &
                                width, depth)
    end if

Here is the call graph for this function:

get_area()

real(dp) function swfcxsmodule::get_area ( class(swfcxstype)  this, integer(i4b), intent(in)  idcxs, real(dp), intent(in)  width, real(dp), intent(in)  depth  )

private

Parameters

[in]	idcxs	cross section id
[in]	width	width in reach
[in]	depth	stage in reach

Definition at line 684 of file swf-cxs.f90.

    ! -- modules
    use swfcxsutilsmodule, only: get_cross_section_area
    ! -- dummy
    class(SwfCxsType) :: this
    integer(I4B), intent(in) :: idcxs !< cross section id
    real(DP), intent(in) :: width !< width in reach
    real(DP), intent(in) :: depth !< stage in reach
    ! -- local
    real(DP) :: area
    integer(I4B) :: i0
    integer(I4B) :: i1
    integer(I4B) :: npts
    integer(I4B) :: icalcmeth
    call this%get_cross_section_info(idcxs, i0, i1, npts, icalcmeth)
    if (npts == 0) then
      area = width * depth
    else
      area = get_cross_section_area(npts, &
                                    this%xfraction(i0:i1), &
                                    this%height(i0:i1), &
                                    width, depth)
    end if

Here is the call graph for this function:

get_cross_section_info()

subroutine swfcxsmodule::get_cross_section_info	(	class(swfcxstype)	this,
		integer(i4b), intent(in)	idcxs,
		integer(i4b), intent(inout)	i0,
		integer(i4b), intent(inout)	i1,
		integer(i4b), intent(inout)	npts,
		integer(i4b), intent(inout)	icalcmeth
	)

Parameters

[in]	idcxs	cross section id number
[in,out]	i0	starting cross section point number
[in,out]	i1	ending cross section point number
[in,out]	npts	number of points in cross section
[in,out]	icalcmeth	calculation method for mannings roughness

Definition at line 648 of file swf-cxs.f90.

    ! -- dummy
    class(SwfCxsType) :: this
    integer(I4B), intent(in) :: idcxs !< cross section id number
    integer(I4B), intent(inout) :: i0 !< starting cross section point number
    integer(I4B), intent(inout) :: i1 !< ending cross section point number
    integer(I4B), intent(inout) :: npts !< number of points in cross section
    integer(I4B), intent(inout) :: icalcmeth !< calculation method for mannings roughness
    ! -- local
    !
    ! -- Return npts = 0 if this package does not have input file
    if (this%inunit == 0 .or. idcxs == 0) then
      npts = 0
      i0 = 1
      i1 = 1
      icalcmeth = 0
    else
      !
      ! -- If the cross section id is 0, then it is a hydraulically wide channel,
      !    and only width and rough are needed (not xfraction, height, and manfraction)
      if (idcxs > 0) then
        i0 = this%iacross(idcxs)
        i1 = this%iacross(idcxs + 1) - 1
      else
        i0 = 1
        i1 = 1
      end if
      ! set icalcmeth based on number of cross section points
      npts = i1 - i0 + 1
      icalcmeth = 0 ! linear composite mannings resistance
      if (npts > 4) then
        icalcmeth = 0 ! sum q by cross section segments
      end if
    end if

get_hydraulic_radius()

real(dp) function swfcxsmodule::get_hydraulic_radius	(	class(swfcxstype)	this,
		integer(i4b), intent(in)	idcxs,
		real(dp), intent(in)	width,
		real(dp), intent(in)	depth,
		real(dp), intent(in), optional	area
	)

Parameters

[in]	idcxs	cross section id
[in]	width	width in reach
[in]	depth	stage in reach
[in]	area	area of the reach

Returns

calculated hydraulic radius

Definition at line 805 of file swf-cxs.f90.

    ! -- modules
    use swfcxsutilsmodule, only: get_hydraulic_radius_xf
    ! -- dummy
    class(SwfCxsType) :: this
    integer(I4B), intent(in) :: idcxs !< cross section id
    real(DP), intent(in) :: width !< width in reach
    real(DP), intent(in) :: depth !< stage in reach
    real(DP), intent(in), optional :: area !< area of the reach
    ! -- local
    real(DP) :: r !< calculated hydraulic radius
    real(DP) :: a
    integer(I4B) :: i0
    integer(I4B) :: i1
    integer(I4B) :: npts
    integer(I4B) :: icalcmeth
    call this%get_cross_section_info(idcxs, i0, i1, npts, icalcmeth)
    if (present(area)) then
      a = area
    else
      a = this%get_area(idcxs, width, depth)
    end if
    if (npts == 0) then
      r = a / width
    else
      r = get_hydraulic_radius_xf(npts, &
                                  this%xfraction(i0:i1), &
                                  this%height(i0:i1), &
                                  width, depth)
    end if

Here is the call graph for this function:

get_maximum_top_width()

real(dp) function swfcxsmodule::get_maximum_top_width	(	class(swfcxstype)	this,
		integer(i4b), intent(in)	idcxs,
		real(dp), intent(in)	width
	)

Parameters

[in]	idcxs	cross section id
[in]	width	width in reach

Returns

calculated hydraulic radius

Definition at line 860 of file swf-cxs.f90.

    ! modules
    use swfcxsutilsmodule, only: get_saturated_topwidth
    ! dummy
    class(SwfCxsType) :: this
    integer(I4B), intent(in) :: idcxs !< cross section id
    real(DP), intent(in) :: width !< width in reach
    ! local
    real(DP) :: r !< calculated hydraulic radius
    integer(I4B) :: i0
    integer(I4B) :: i1
    integer(I4B) :: npts
    integer(I4B) :: icalcmeth
    call this%get_cross_section_info(idcxs, i0, i1, npts, icalcmeth)
    if (npts == 0) then
      r = width
    else
      r = get_saturated_topwidth(npts, this%xfraction(i0:i1), width)
    end if

Here is the call graph for this function:

get_roughness()

real(dp) function swfcxsmodule::get_roughness	(	class(swfcxstype)	this,
		integer(i4b), intent(in)	idcxs,
		real(dp), intent(in)	width,
		real(dp), intent(in)	depth,
		real(dp), intent(in)	rough,
		real(dp), intent(in)	slope
	)

Parameters

[in]	idcxs	cross section id
[in]	width	width in reach
[in]	depth	stage in reach
[in]	rough	mannings value provided for the reach
[in]	slope	slope value provided for the reach

Returns

calculated composite roughness

Definition at line 734 of file swf-cxs.f90.

    ! -- modules
    use swfcxsutilsmodule, only: calc_composite_roughness
    ! -- dummy
    class(SwfCxsType) :: this
    integer(I4B), intent(in) :: idcxs !< cross section id
    real(DP), intent(in) :: width !< width in reach
    real(DP), intent(in) :: depth !< stage in reach
    real(DP), intent(in) :: rough !< mannings value provided for the reach
    real(DP), intent(in) :: slope !< slope value provided for the reach
    ! -- local
    real(DP) :: roughc !< calculated composite roughness
    integer(I4B) :: i0
    integer(I4B) :: i1
    integer(I4B) :: npts
    integer(I4B) :: icalcmeth
    call this%get_cross_section_info(idcxs, i0, i1, npts, icalcmeth)
    if (npts == 0) then
      roughc = rough
    else
      roughc = calc_composite_roughness(npts, &
                                        depth, &
                                        width, &
                                        rough, &
                                        slope, &
                                        this%xfraction(i0:i1), &
                                        this%height(i0:i1), &
                                        this%manfraction(i0:i1), &
                                        icalcmeth)
    end if

Here is the call graph for this function:

get_wetted_top_width()

real(dp) function swfcxsmodule::get_wetted_top_width	(	class(swfcxstype)	this,
		integer(i4b), intent(in)	idcxs,
		real(dp), intent(in)	width,
		real(dp), intent(in)	depth
	)

Parameters

[in]	idcxs	cross section id
[in]	width	width in reach
[in]	depth	stage in reach

Returns

calculated hydraulic radius

Definition at line 837 of file swf-cxs.f90.

    ! modules
    use swfcxsutilsmodule, only: get_wetted_topwidth
    ! dummy
    class(SwfCxsType) :: this
    integer(I4B), intent(in) :: idcxs !< cross section id
    real(DP), intent(in) :: width !< width in reach
    real(DP), intent(in) :: depth !< stage in reach
    ! local
    real(DP) :: r !< calculated hydraulic radius
    integer(I4B) :: i0
    integer(I4B) :: i1
    integer(I4B) :: npts
    integer(I4B) :: icalcmeth
    call this%get_cross_section_info(idcxs, i0, i1, npts, icalcmeth)
    if (npts == 0) then
      r = width
    else
      r = get_wetted_topwidth(npts, this%xfraction(i0:i1), &
                              this%height(i0:i1), width, depth)
    end if

Here is the call graph for this function:

log_crosssectiondata()

subroutine swfcxsmodule::log_crosssectiondata ( class(swfcxstype)  this, type(cxscrosssectiondatafoundtype), intent(in)  found  )

private

Definition at line 527 of file swf-cxs.f90.

    class(SwfCxsType) :: this
    type(CxsCrosssectiondataFoundType), intent(in) :: found
 
    write (this%iout, '(1x,a)') 'Setting CXS Cross Section Data'
 
    if (found%ifno) then
      write (this%iout, '(4x,a)') 'IFNO set from input file.'
    end if
 
    if (found%xfraction) then
      write (this%iout, '(4x,a)') 'XFRACTION set from input file.'
    end if
 
    if (found%height) then
      write (this%iout, '(4x,a)') 'HEIGHT set from input file.'
    end if
 
    if (found%manfraction) then
      write (this%iout, '(4x,a)') 'MANFRACTION set from input file.'
    end if
 
    write (this%iout, '(1x,a,/)') 'End Setting CXS Cross Section Data'
 

log_dimensions()

subroutine swfcxsmodule::log_dimensions	(	class(swfcxstype)	this,
		type(cxsdimensionsfoundtype), intent(in)	found
	)

Definition at line 257 of file swf-cxs.f90.

    class(SwfCxsType) :: this
    type(CxsDimensionsFoundType), intent(in) :: found
 
    write (this%iout, '(1x,a)') 'Setting CXS Dimensions'
 
    if (found%nsections) then
      write (this%iout, '(4x,a)') 'NSECTIONS set from input file.'
    end if
 
    if (found%npoints) then
      write (this%iout, '(4x,a)') 'NPOINTS set from input file.'
    end if
 
    write (this%iout, '(1x,a,/)') 'End Setting CXS Dimensions'
 

log_options()

subroutine swfcxsmodule::log_options	(	class(swfcxstype)	this,
		type(cxsoptionsfoundtype), intent(in)	found
	)

Definition at line 201 of file swf-cxs.f90.

    class(SwfCxsType) :: this
    type(CxsOptionsFoundType), intent(in) :: found
 
    write (this%iout, '(1x,a)') 'Setting CXS Options'
 
    if (found%iprpak) then
      write (this%iout, '(4x,a)') 'Package information will be printed.'
    end if
 
    write (this%iout, '(1x,a,/)') 'End Setting CXS Options'
 

log_packagedata()

subroutine swfcxsmodule::log_packagedata ( class(swfcxstype)  this, type(cxspackagedatafoundtype), intent(in)  found  )

private

Definition at line 407 of file swf-cxs.f90.

    class(SwfCxsType) :: this
    type(CxsPackagedataFoundType), intent(in) :: found
 
    write (this%iout, '(1x,a)') 'Setting CXS Package Data'
 
    if (found%idcxs) then
      write (this%iout, '(4x,a)') 'IFNO set from input file.'
    end if
 
    if (found%nxspoints) then
      write (this%iout, '(4x,a)') 'NXSPOINTS set from input file.'
    end if
 
    write (this%iout, '(1x,a,/)') 'End Setting CXS Package Data'
 

source_crosssectiondata()

subroutine swfcxsmodule::source_crosssectiondata ( class(swfcxstype)  this )

private

Definition at line 427 of file swf-cxs.f90.

    ! -- modules
    use kindmodule, only: lgp
    use memorymanagerextmodule, only: mem_set_value
    use simvariablesmodule, only: idm_context
    ! -- dummy
    class(SwfCxsType) :: this
    ! -- locals
    character(len=LENMEMPATH) :: idmMemoryPath
    type(CxsCrosssectiondataFoundType) :: found
    integer(I4B), dimension(:), pointer, contiguous :: ifno => null()
    !
    ! -- set memory path
    idmmemorypath = create_mem_path(this%name_model, 'CXS', idm_context)
    !
    ! -- update defaults with idm sourced values
    allocate (ifno(this%npoints))
    call mem_set_value(ifno, 'IFNO', idmmemorypath, &
                       found%ifno)
    call mem_set_value(this%xfraction, 'XFRACTION', idmmemorypath, &
                       found%xfraction)
    call mem_set_value(this%height, 'HEIGHT', idmmemorypath, &
                       found%height)
    call mem_set_value(this%manfraction, 'MANFRACTION', idmmemorypath, &
                       found%manfraction)
    !
    ! -- ensure ifno was found
    if (.not. found%ifno) then
      write (errmsg, '(a)') &
        'Error in CROSSSECTIONDATA block: IFNO not found.'
      call store_error(errmsg)
    end if
    !
    ! -- ensure xfraction was found
    if (.not. found%xfraction) then
      write (errmsg, '(a)') &
        'Error in CROSSSECTIONDATA block: xfraction not found.'
      call store_error(errmsg)
    end if
    !
    ! -- ensure height was found
    if (.not. found%height) then
      write (errmsg, '(a)') &
        'Error in CROSSSECTIONDATA block: HEIGHT not found.'
      call store_error(errmsg)
    end if
    !
    ! -- ensure manfraction was found
    if (.not. found%manfraction) then
      write (errmsg, '(a)') &
        'Error in CROSSSECTIONDATA block: MANFRACTION not found.'
      call store_error(errmsg)
    end if
    !
    ! -- check that ifno is consistent with the section groupings
    !    implied by PACKAGEDATA's NXSPOINTS
    if (found%ifno) then
      call this%check_crosssectiondata(ifno)
    end if
    deallocate (ifno)
    !
    ! -- log values to list file
    if (this%iout > 0) then
      call this%log_crosssectiondata(found)
    end if

Here is the call graph for this function:

source_dimensions()

subroutine swfcxsmodule::source_dimensions ( class(swfcxstype)  this )

private

Definition at line 217 of file swf-cxs.f90.

    ! -- modules
    use kindmodule, only: lgp
    use memorymanagerextmodule, only: mem_set_value
    use simvariablesmodule, only: idm_context
    ! -- dummy
    class(SwfCxsType) :: this
    ! -- locals
    character(len=LENMEMPATH) :: idmMemoryPath
    type(CxsDimensionsFoundType) :: found
    !
    ! -- set memory path
    idmmemorypath = create_mem_path(this%name_model, 'CXS', idm_context)
    !
    ! -- update defaults with idm sourced values
    call mem_set_value(this%nsections, 'NSECTIONS', idmmemorypath, &
                       found%nsections)
    call mem_set_value(this%npoints, 'NPOINTS', idmmemorypath, &
                       found%npoints)
    !
    ! -- ensure nsections was found
    if (.not. found%nsections) then
      write (errmsg, '(a)') 'Error in DIMENSIONS block: NSECTIONS not found.'
      call store_error(errmsg)
    end if
    !
    ! -- ensure npoints was found
    if (.not. found%npoints) then
      write (errmsg, '(a)') 'Error in DIMENSIONS block: NPOINTS not found.'
      call store_error(errmsg)
    end if
    !
    ! -- log values to list file
    if (this%iout > 0) then
      call this%log_dimensions(found)
    end if

Here is the call graph for this function:

source_options()

subroutine swfcxsmodule::source_options ( class(swfcxstype)  this )

private

Definition at line 175 of file swf-cxs.f90.

    ! -- modules
    use kindmodule, only: lgp
    use memorymanagerextmodule, only: mem_set_value
    use simvariablesmodule, only: idm_context
    ! -- dummy
    class(SwfCxsType) :: this
    ! -- locals
    character(len=LENMEMPATH) :: idmMemoryPath
    type(CxsOptionsFoundType) :: found
    !
    ! -- set memory path
    idmmemorypath = create_mem_path(this%name_model, 'CXS', idm_context)
    !
    ! -- update defaults with idm sourced values
    call mem_set_value(this%iprpak, 'PRINT_INPUT', idmmemorypath, &
                       found%iprpak)
    !
    ! -- log values to list file
    if (this%iout > 0) then
      call this%log_options(found)
    end if

Here is the call graph for this function:

source_packagedata()

subroutine swfcxsmodule::source_packagedata ( class(swfcxstype)  this )

private

Definition at line 314 of file swf-cxs.f90.

    ! modules
    use kindmodule, only: lgp
    use memorymanagerextmodule, only: mem_set_value
    use simvariablesmodule, only: idm_context
    ! dummy
    class(SwfCxsType) :: this
    ! locals
    character(len=LENMEMPATH) :: idmMemoryPath
    type(CxsPackagedataFoundType) :: found
 
    ! set memory path
    idmmemorypath = create_mem_path(this%name_model, 'CXS', idm_context)
 
    ! update defaults with idm sourced values
    call mem_set_value(this%idcxs, 'IFNO_PKGDATA', idmmemorypath, &
                       found%idcxs)
    call mem_set_value(this%nxspoints, 'NXSPOINTS', idmmemorypath, &
                       found%nxspoints)
 
    ! ensure idcxs was found
    if (.not. found%idcxs) then
      write (errmsg, '(a)') 'Error in PACKAGEDATA block: IFNO not found.'
      call store_error(errmsg)
    end if
 
    ! ensure nxspoints was found
    if (.not. found%nxspoints) then
      write (errmsg, '(a)') 'Error in PACKAGEDATA block: NXSPOINTS not found.'
      call store_error(errmsg)
    end if
 
    ! log values to list file
    if (this%iout > 0) then
      call this%log_packagedata(found)
    end if
 
    ! Check to make sure package data is valid
    call this%check_packagedata()
 
    ! Calculate the iacross index array using nxspoints
    call calc_iacross(this%nxspoints, this%iacross)

Here is the call graph for this function:

write_cxs_table()

subroutine swfcxsmodule::write_cxs_table ( class(swfcxstype)  this, integer(i4b), intent(in)  idcxs, real(dp), intent(in)  width, real(dp), intent(in)  slope, real(dp), intent(in)  rough, real(dp), intent(in)  unitconv  )

private

Definition at line 553 of file swf-cxs.f90.

    ! -- module
    use sortmodule, only: qsort, unique_values
    ! -- dummy
    class(SwfCxsType) :: this
    integer(I4B), intent(in) :: idcxs
    real(DP), intent(in) :: width
    real(DP), intent(in) :: slope
    real(DP), intent(in) :: rough
    real(DP), intent(in) :: unitconv
    ! -- local
    integer(I4B) :: ipt
    real(DP) :: d
    real(DP) :: a
    real(DP) :: rh
    real(DP) :: wp
    real(DP) :: r
    real(DP) :: c
    real(DP) :: q
    integer(I4B) :: i0
    integer(I4B) :: i1
    integer(I4B) :: npts
    integer(I4B) :: icalcmeth
    real(DP), dimension(:), allocatable :: depths
    real(DP), dimension(:), allocatable :: depths_unique
    integer(I4B), dimension(:), allocatable :: indx
 
    call this%get_cross_section_info(idcxs, i0, i1, npts, icalcmeth)
 
    if (npts > 0) then
 
      write (this%iout, *) 'Processing information for cross section ', idcxs
      write (this%iout, *) 'Depth Area WettedP HydRad Rough Conveyance Q'
 
      allocate (depths(npts))
      allocate (indx(size(depths)))
 
      depths(:) = this%height(:)
      call qsort(indx, depths)
      call unique_values(depths, depths_unique)
 
      do ipt = 1, size(depths_unique)
        d = depths_unique(ipt)
        a = this%get_area(idcxs, width, d)
        wp = this%get_wetted_perimeter(idcxs, width, d)
        rh = this%get_hydraulic_radius(idcxs, width, d, a)
        r = this%get_roughness(idcxs, width, d, rough, slope)
        c = this%get_conveyance(idcxs, width, d, rough)
        if (slope > dzero) then
          q = unitconv * c * sqrt(slope)
        else
          q = dzero
        end if
        write (this%iout, *) d, a, wp, rh, r, c, q
      end do
 
      deallocate (depths)
      deallocate (depths_unique)
      write (this%iout, *) 'Done processing information for cross section ', idcxs
 
    end if