rectangulargeometrymodule Module Reference

Data Types
type	rectangulargeometrytype

Functions/Subroutines
real(dp) function	area_sat (this)
	Return saturated area. More...
real(dp) function	perimeter_sat (this)
	Return saturated perimeter. More...
real(dp) function	area_wet (this, depth)
	Return wetted area. More...
real(dp) function	perimeter_wet (this, depth)
	Return wetted perimeter. More...
subroutine	set_attribute (this, line)
	Set a parameter for this rectangular object. More...
subroutine	print_attributes (this, iout)
	Print the attributes for this object. More...

Function/Subroutine Documentation

area_sat()

real(dp) function rectangulargeometrymodule::area_sat ( class(rectangulargeometrytype)  this )

private

Definition at line 27 of file RectangularGeometry.f90.

    ! -- modules
    use constantsmodule, only: dtwo, dpi
    ! -- return
    real(DP) :: area_sat
    ! -- dummy
    class(RectangularGeometryType) :: this
    !
    ! -- Calculate area
    area_sat = this%height * this%width
    !
    ! -- Return
    return

area_wet()

real(dp) function rectangulargeometrymodule::area_wet	(	class(rectangulargeometrytype)	this,
		real(dp), intent(in)	depth
	)

Definition at line 61 of file RectangularGeometry.f90.

    ! -- modules
    use constantsmodule, only: dtwo, dpi, dzero
    ! -- return
    real(DP) :: area_wet
    ! -- dummy
    class(RectangularGeometryType) :: this
    real(DP), intent(in) :: depth
    !
    ! -- Calculate area
    if (depth <= dzero) then
      area_wet = dzero
    elseif (depth <= this%height) then
      area_wet = depth * this%width
    else
      area_wet = this%width * this%height
    end if
    !
    ! -- Return
    return

perimeter_sat()

real(dp) function rectangulargeometrymodule::perimeter_sat

(

class(rectangulargeometrytype)

this

)

Definition at line 44 of file RectangularGeometry.f90.

    ! -- modules
    use constantsmodule, only: dtwo, dpi
    ! -- return
    real(DP) :: perimeter_sat
    ! -- dummy
    class(RectangularGeometryType) :: this
    !
    ! -- Calculate area
    perimeter_sat = dtwo * (this%height + this%width)
    !
    ! -- Return
    return

perimeter_wet()

real(dp) function rectangulargeometrymodule::perimeter_wet	(	class(rectangulargeometrytype)	this,
		real(dp), intent(in)	depth
	)

Definition at line 85 of file RectangularGeometry.f90.

    ! -- modules
    use constantsmodule, only: dtwo, dpi
    ! -- return
    real(DP) :: perimeter_wet
    ! -- dummy
    class(RectangularGeometryType) :: this
    real(DP), intent(in) :: depth
    !
    ! -- Calculate area
    if (depth <= dzero) then
      perimeter_wet = dzero
    elseif (depth <= this%height) then
      perimeter_wet = dtwo * (depth + this%width)
    else
      perimeter_wet = dtwo * (this%height + this%width)
    end if
    !
    ! -- Return
    return

print_attributes()

subroutine rectangulargeometrymodule::print_attributes	(	class(rectangulargeometrytype)	this,
		integer(i4b), intent(in)	iout
	)

Definition at line 151 of file RectangularGeometry.f90.

    ! -- dummy
    class(RectangularGeometryType) :: this
    ! -- local
    integer(I4B), intent(in) :: iout
    ! -- formats
    character(len=*), parameter :: fmtnm = "(4x,a,a)"
    character(len=*), parameter :: fmttd = "(4x,a,1(1PG15.6))"
    !
    ! -- call parent to print parent attributes
    call this%BaseGeometryType%print_attributes(iout)
    !
    ! -- Print specifics of this geometry type
    write (iout, fmttd) 'HEIGHT = ', this%height
    write (iout, fmttd) 'WIDTH = ', this%width
    write (iout, fmttd) 'SATURATED AREA = ', this%area_sat()
    write (iout, fmttd) 'SATURATED WETTED PERIMETER = ', this%perimeter_sat()
    !
    ! -- Return
    return

set_attribute()

subroutine rectangulargeometrymodule::set_attribute	(	class(rectangulargeometrytype)	this,
		character(len=*), intent(inout)	line
	)

Definition at line 109 of file RectangularGeometry.f90.

    ! -- module
    use inputoutputmodule, only: urword
    use constantsmodule, only: linelength
    use simmodule, only: store_error, count_errors
    ! -- dummy
    class(RectangularGeometryType) :: this
    character(len=LINELENGTH) :: errmsg
    character(len=*), intent(inout) :: line
    ! -- local
    integer(I4B) :: lloc, istart, istop, ival
    real(DP) :: rval
    !
    ! -- should change this and set id if uninitialized or store it
    lloc = 1
    call urword(line, lloc, istart, istop, 2, ival, rval, 0, 0)
    this%id = ival
    !
    ! -- Parse the attribute
    call urword(line, lloc, istart, istop, 1, ival, rval, 0, 0)
    select case (line(istart:istop))
    case ('NAME')
      call urword(line, lloc, istart, istop, 1, ival, rval, 0, 0)
      this%name = line(istart:istop)
    case ('HEIGHT')
      call urword(line, lloc, istart, istop, 3, ival, rval, 0, 0)
      this%height = rval
    case ('WIDTH')
      call urword(line, lloc, istart, istop, 3, ival, rval, 0, 0)
      this%width = rval
    case default
      write (errmsg, '(a,a)') &
        'Unknown rectangular geometry attribute: ', line(istart:istop)
      call store_error(errmsg, terminate=.true.)
    end select
    !
    ! -- Return
    return

Here is the call graph for this function: