cellrectquadmodule Module Reference

Data Types
type	cellrectquadtype

Functions/Subroutines
subroutine, public	create_cell_rect_quad (cell)
	Create a new rectangular-quad cell. More...
subroutine	destroy_cell_rect_quad (this)
	Destroy the rectangular-quad cell. More...
subroutine	init_from (this, defn)
	Initialize a rectangular-quad cell from another cell. More...
subroutine	load_irectvert (this)
	Load local polygon vertex indices. More...
integer function	get_irectvertsw (this)
	Get index of SW rectangle vertex. More...
subroutine	get_rectdimensionsrotation (this, irv1, xOrigin, yOrigin, zOrigin, dx, dy, dz, sinrot, cosrot)
	Get rectangular cell dimensions and rotation. More...
double precision function	get_rectflow (this, iq, irv)
	Return a rectangle face flow. More...
logical function	face_is_refined (this, i)
	Return whether a rectangle face is refined. More...

Function/Subroutine Documentation

create_cell_rect_quad()

subroutine, public cellrectquadmodule::create_cell_rect_quad

(

type(cellrectquadtype), pointer

cell

)

Definition at line 43 of file CellRectQuad.f90.

    type(CellRectQuadType), pointer :: cell
    allocate (cell)
    call create_defn(cell%defn)
    allocate (cell%irectvert(5))
    allocate (cell%ipv4irv(2, 4))
    allocate (cell%rectflow(2, 4))
    allocate (cell%type)
    cell%type = 'rectquad'

Here is the call graph for this function:

Here is the caller graph for this function:

destroy_cell_rect_quad()

subroutine cellrectquadmodule::destroy_cell_rect_quad ( class(cellrectquadtype), intent(inout)  this )

private

Definition at line 55 of file CellRectQuad.f90.

    class(CellRectQuadType), intent(inout) :: this
    deallocate (this%defn)
    deallocate (this%irectvert)
    deallocate (this%type)

face_is_refined()

logical function cellrectquadmodule::face_is_refined ( class(cellrectquadtype), intent(inout)  this, integer  i  )

private

Parameters

i	face index

Definition at line 207 of file CellRectQuad.f90.

    ! -- dummy
    class(CellRectQuadType), intent(inout) :: this
    integer :: i !< face index
    logical :: is_refined
 
    if (this%ipv4irv(2, i) .ne. 0) then
      is_refined = .true.
    else
      is_refined = .false.
    end if

get_irectvertsw()

integer function cellrectquadmodule::get_irectvertsw ( class(cellrectquadtype), intent(inout)  this )

private

Return the index (1, 2, 3, or 4) of the southwest rectangle vertex of a rectangular-quad cell

Definition at line 109 of file CellRectQuad.f90.

    ! -- dummy
    class(CellRectQuadType), intent(inout) :: this
    integer :: irv1
    ! -- local
    integer :: irv, irv2, irv4, ipv1, ipv2, ipv4
    integer, dimension(4) :: irvnxt = (/2, 3, 4, 1/) ! kluge???
    double precision :: x1, y1, x2, y2, x4, y4
 
    ! -- Find the "southwest" rectangle vertex by finding the vertex formed
    ! -- either by (1) a rectangle edge over which x decreases (going
    ! -- clockwise) followed by an edge over which x does not increase, or by
    ! -- (2) a rectangle edge over which y does not decrease (again going
    ! -- clockwise) followed by a rectangle edge over which y increases. In
    ! -- the end, ipv1 is the index (1, 2, 3, or 4) of the southwest
    ! -- rectangle vertex.
    do irv = 1, 4
      irv4 = irv
      irv1 = irvnxt(irv4)
      ipv4 = this%irectvert(irv4)
      ipv1 = this%irectvert(irv1)
      x4 = this%defn%polyvert(1, ipv4)
      y4 = this%defn%polyvert(2, ipv4)
      x1 = this%defn%polyvert(1, ipv1)
      y1 = this%defn%polyvert(2, ipv1)
      if (x1 .lt. x4) then
        irv2 = irvnxt(irv1)
        ipv2 = this%irectvert(irv2)
        x2 = this%defn%polyvert(1, ipv2)
        if (x2 .le. x1) return
      else if (y1 .ge. y4) then
        irv2 = irvnxt(irv1)
        ipv2 = this%irectvert(irv2)
        y2 = this%defn%polyvert(2, ipv2)
        if (y2 .gt. y1) return
      end if
    end do

get_rectdimensionsrotation()

subroutine cellrectquadmodule::get_rectdimensionsrotation ( class(cellrectquadtype), intent(inout)  this, integer  irv1, double precision  xOrigin, double precision  yOrigin, double precision  zOrigin, double precision  dx, double precision  dy, double precision  dz, double precision  sinrot, double precision  cosrot  )

private

Compute rectangular dimensions and rotation of the cell using the specified rectangle vertex as the origin

Definition at line 154 of file CellRectQuad.f90.

    ! -- dummy
    class(CellRectQuadType), intent(inout) :: this
    integer :: irv1
    double precision :: xOrigin, yOrigin, zOrigin, dx, dy, dz, sinrot, cosrot
    ! -- local
    integer :: irv2, irv4, ipv1, ipv2, ipv4
    integer, dimension(4) :: irvnxt = (/2, 3, 4, 1/) ! kluge???
    double precision :: x1, y1, x2, y2, x4, y4, dx2, dy2, dx4, dy4
 
    ! -- Get rectangle vertex neighbors irv2 and irv4
    irv2 = irvnxt(irv1)
    irv4 = irvnxt(irvnxt(irv2)) ! kluge
 
    ! -- Get model coordinates at irv1, irv2, and irv4
    ipv1 = this%irectvert(irv1)
    x1 = this%defn%polyvert(1, ipv1)
    y1 = this%defn%polyvert(2, ipv1)
    ipv2 = this%irectvert(irv2)
    x2 = this%defn%polyvert(1, ipv2)
    y2 = this%defn%polyvert(2, ipv2)
    ipv4 = this%irectvert(irv4)
    x4 = this%defn%polyvert(1, ipv4)
    y4 = this%defn%polyvert(2, ipv4)
 
    ! -- Compute rectangle dimensions
    xorigin = x1
    yorigin = y1
    zorigin = this%defn%bot
    dx2 = x2 - xorigin
    dy2 = y2 - yorigin
    dx4 = x4 - xorigin
    dy4 = y4 - yorigin
    dx = dsqrt(dx4 * dx4 + dy4 * dy4)
    dy = dsqrt(dx2 * dx2 + dy2 * dy2)
    dz = this%defn%top - zorigin ! kluge note: need to account for partial saturation
 
    ! -- Compute sine and cosine of rotation angle (angle between "southern"
    ! -- rectangle side irv1-irv4 and the model x axis)
    sinrot = dy4 / dx
    cosrot = dx4 / dx

get_rectflow()

double precision function cellrectquadmodule::get_rectflow ( class(cellrectquadtype), intent(inout)  this, integer  iq, integer  irv  )

private

Definition at line 199 of file CellRectQuad.f90.

    class(CellRectQuadType), intent(inout) :: this
    integer :: iq, irv
    double precision :: rectflow
    rectflow = this%rectflow(iq, irv)

init_from()

subroutine cellrectquadmodule::init_from ( class(cellrectquadtype), intent(inout)  this, type(celldefntype), pointer  defn  )

private

Definition at line 63 of file CellRectQuad.f90.

    class(CellRectQuadType), intent(inout) :: this
    type(CellDefnType), pointer :: defn
    this%defn => defn
    call this%load_irectvert()

load_irectvert()

subroutine cellrectquadmodule::load_irectvert ( class(cellrectquadtype), intent(inout)  this )

private

Loads local polygon vertex indices of the four rectangle vertices of a rectangular-quad cell. Todo: rename?

Definition at line 75 of file CellRectQuad.f90.

    ! -- dummy
    class(CellRectQuadType), intent(inout) :: this
    ! -- local
    integer :: npolyverts, n, m
 
    npolyverts = this%defn%get_npolyverts()
 
    n = 0
    do m = 1, npolyverts
      if (.not. this%defn%get_ispv180(m)) then
        n = n + 1
        this%irectvert(n) = m
        this%ipv4irv(1, n) = m
        this%rectflow(1, n) = this%defn%get_faceflow(m)
        this%ipv4irv(2, n) = 0
        this%rectflow(2, n) = 0d0
      else
        if (n .ne. 0) then
          this%ipv4irv(2, n) = m
          this%rectflow(2, n) = this%defn%get_faceflow(m)
        end if
      end if
    end do
 
    ! Wrap around for convenience
    this%irectvert(5) = this%irectvert(1)