FLASH4.5 API

Generated from /asc/asci2/site/flashcode/secure/release_4p5/source/physics/Gravity/Gravity_accelAtCoords.F90 with ROBODoc v4.99.8 on Tue Mar 05 16:16:17 2019

TABLE OF CONTENTS


[Functions] source/physics/Gravity/Gravity_accelAtCoords

[top][index]

NAME

  Gravity_accelAtCoords 

SYNOPSIS

  Gravity_accelAtCoords(integer(IN) :: numPoints,
                      real(IN)      :: iCoords(:),
                      real(IN)      :: jCoords(:),
                      real(IN)      :: kCoords(:),
                      integer(IN)   :: accelDir,
                      real(OUT)     :: accel(numPoints),
                      integer(IN)   :: blockID,
                      integer(IN),optional :: potentialIndex)

DESCRIPTION

  This routine computes the gravitational acceleration in a
  specified direction for a vector of points given by their
  coordinates.

ARGUMENTS

  iCoords,jCoords,kCoords: coordinates of the points where the
                           gravitational accelation is requested.
                           Each of these arrays should either be
                           of lenght numPoints (or more), in which
                           case its nth value is used for the nth
                           point; or else of dimension 1, in which
                           case the value is used for all points.
  accelDir :    The acceleration direction:  allowed values are 
              IAXIS, JAXIS and IAXIS. These values are defined
              in constants.h.
  numPoints :  Number of cells to update in accel()
  accel     :   Array to receive results
  blockID  :  The local identifier of the block to work on,
                not applicable in pointmass gravity.
  potentialIndex :  optional, not applicable in pointmass gravity