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 cell definition. More...
subroutine	load_rect_verts_flows (this)
	Load local polygon vertex indices and rectangular face flows. More...
integer(i4b) function	get_rect_ivert_sw (this)
	Get index of SW rectangle vertex. More...
subroutine	get_rect_dim_rot (this)
	Get rectangular cell dimensions and rotation. More...
real(dp) function	get_rect_flow (this, iq, irv)
	Return a rectangle face flow. More...
logical(lgp) 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 44 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 56 of file CellRectQuad.f90.

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

face_is_refined()

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

private

Parameters

i	face index

Definition at line 212 of file CellRectQuad.f90.

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

get_rect_dim_rot()

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

private

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

Definition at line 162 of file CellRectQuad.f90.

    ! dummy
    class(CellRectQuadType), intent(inout) :: this
    ! local
    integer(I4B) :: irv2, irv4, ipv1, ipv2, ipv4
    integer(I4B), dimension(4) :: irvnxt = (/2, 3, 4, 1/)
    real(DP) :: x1, y1, x2, y2, x4, y4, dx2, dy2, dx4, dy4
 
    ! Get rectangle vertex neighbors irv2 and irv4
    irv2 = irvnxt(this%irvOrigin)
    irv4 = irvnxt(irvnxt(irv2))
 
    ! Get model coordinates at irv1, irv2, and irv4
    ipv1 = this%irectvert(this%irvOrigin)
    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
    this%xOrigin = x1
    this%yOrigin = y1
    this%zOrigin = this%defn%bot
    dx2 = x2 - this%xOrigin
    dy2 = y2 - this%yOrigin
    dx4 = x4 - this%xOrigin
    dy4 = y4 - this%yOrigin
    this%dx = dsqrt(dx4 * dx4 + dy4 * dy4)
    this%dy = dsqrt(dx2 * dx2 + dy2 * dy2)
    this%dz = this%defn%top - this%zOrigin
 
    ! Compute sine and cosine of rotation angle (angle between "southern"
    ! rectangle side irv1-irv4 and the model x axis)
    this%sinrot = dy4 / this%dx
    this%cosrot = dx4 / this%dx

get_rect_flow()

real(dp) function cellrectquadmodule::get_rect_flow ( class(cellrectquadtype), intent(inout)  this, integer(i4b)  iq, integer(i4b)  irv  )

private

Definition at line 204 of file CellRectQuad.f90.

    class(CellRectQuadType), intent(inout) :: this
    integer(I4B) :: iq, irv
    real(DP) :: rectflow
    rectflow = this%rectflow(iq, irv)

get_rect_ivert_sw()

integer(i4b) function cellrectquadmodule::get_rect_ivert_sw ( 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 117 of file CellRectQuad.f90.

    ! dummy
    class(CellRectQuadType), intent(inout) :: this
    integer(I4B) :: irv1
    ! local
    integer(I4B) :: irv, irv2, irv4, ipv1, ipv2, ipv4
    integer(I4B), dimension(4) :: irvnxt = (/2, 3, 4, 1/)
    real(DP) :: 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

init_from()

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

private

Definition at line 64 of file CellRectQuad.f90.

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

load_rect_verts_flows()

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

private

Loads local polygon vertex indices of the four rectangle vertices and face flows of a rectangular-quad cell.

Definition at line 77 of file CellRectQuad.f90.

    ! dummy
    class(CellRectQuadType), intent(inout) :: this
    ! local
    integer(I4B) :: n, m
    logical(LGP) :: istart180
 
    n = 0
    istart180 = .false.
    do m = 1, this%defn%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) = dzero
      else
        if (n .ne. 0) then
          this%ipv4irv(2, n) = m
          this%rectflow(2, n) = this%defn%get_faceflow(m)
        else
          istart180 = .true.
        end if
      end if
    end do
    if (istart180) then
      this%ipv4irv(2, 4) = 1
      this%rectflow(2, 4) = this%defn%get_faceflow(1)
    end if
 
    ! Wrap around for convenience
    this%irectvert(5) = this%irectvert(1)