FLASH4 complete API

Generated from /data/asci2/site/flashcode/secure/release_4p8/source/Grid/Grid_getDomainBoundBox.F90 with ROBODoc v4.99.8 on Mon May 06 09:27:22 2024

TABLE OF CONTENTS

[Functions] source/Grid/Grid_getDomainBoundBox

[top][index]

NAME

  Grid_getDomainBoundBox

SYNOPSIS

  Grid_getDomainBoundBox(real(OUT) :: boundBox(2, MDIM))

DESCRIPTION

  Gets the physical domain bounding box of the entire domain.
  For each dimension the left (lower or forward) 
  physical coordinate of the domain edge and the right (upper or back) 
  physical coordinate of the domain edge is returned.  See arguments
  below for more detail.

ARGUMENTS

  boundBox - returned array holding the boundBox coordinates in
             each dimension

            for readability, in constants.h we define IAXIS = 1, JAXIS = 2, KAXIS = 3

            boundBox(1,IAXIS) = left edge coordinate of domain in x direction
            boundBox(2,IAXIS) = right edge coordinate of domain in x direction
            boundBox(1,JAXIS) = top edge coordinate of domain in y direction
            boundBox(2,JAXIS) = bottom edge coordinate of domain in y direction
            boundBox(1,KAXIS) = front edge coordinate of domain in z direction
            boundBox(2,KAXIS) = back edge coordinate of domain in z direction

EXAMPLE

   In 2 dimensions, if physical coordinates are ...
    
     ________________(0.5 1.0)
    |                |
    |                |
    |                |
    |                |
    |                |
    |                |
    |                |
    |_______________ |
  (-0.5, 0.0)



     boundBox(1, IAXIS) = -0.5
     boundBox(2, IAXIS) = 0.5
     boundBox(1, JAXIS) = 0.0
     boundBox(2, JAXIS) = 1.0