# Parameter definitions for thorn PolarGrid2D
# $Header$

shares: driver

USES BOOLEAN periodic
USES BOOLEAN periodic_x
USES BOOLEAN periodic_y

private:

KEYWORD theta_extent "How much of the grid is covered in the theta direction"
{
  "full"   ::  "The whole grid        - 0 -- 2*pi"
  "upper"  ::  "Upper half plane      - 0 -- pi"
  "lower"  ::  "Lower half plane      - pi -- 2*pi"
  "right"  ::  "Right hand half plane - -pi/2 -- pi/2"
  "left"   ::  "Left  hand half plane -  pi/2 -- 3*pi/2"
  "first"  ::  "First  quadrant       - 0      -- pi/2"
  "second" ::  "Second quadrant       - pi/2   -- pi"
  "third"  ::  "Third  quadrant       - pi     -- 3*pi/2"
  "fourth" ::  "Fourth quadrant       - 3*pi/2 -- 2*pi"
  "wedge"  ::  "Wedge defined by thetamin and thetamax"
} "full"

KEYWORD r_extent "How to calculate r"
{
  "byrange"    :: "Use rmin and rmax to calculate dr"
  "byspacing"  :: "Go from (rmin-r_offset*dr) to nr*delta r" 
} "byrange"
  
INT r_offset "Number of grid points to left of rmin to start grid in rmin to nr*dr mode"
{
  : :: "Any integer"
} 0

BOOLEAN avoid_rmin "Avoid rmin by offseting grid by half a gp to left"
{
} "no"

REAL dr "Coarse grid spacing in r-direction"
{
  0:* :: "Positive"
} 0.3

REAL rmin "Coordinate minimum in r-direction"
{
  0:* :: "Any positive value"
} 0.0

REAL rmax "Coordinate maximum in r-direction"
{
  : :: "Anything"
} 1.0

REAL thetamin "Coordinate minimum in theta-direction"
{
  : :: "Anything"
} 0.0

REAL thetamax "Coordinate maximum in theta-direction"
{
  : :: "Anything"
} 1.0