FLASH4 complete API

Generated from /data/asci2/site/flashcode/secure/release_4p7/source/physics/Gravity/Gravity_accelListOfBlocks.F90 with ROBODoc v4.99.8 on Thu May 02 08:04:32 2024

TABLE OF CONTENTS

[Functions] source/physics/Gravity/Gravity_accelListOfBlocks

[top][index]

NAME

  Gravity_accelListOfBlocks

SYNOPSIS

  Gravity_accelListOfBlocks(integer(IN) :: blockCount,
                         integer(:)(IN) :: blockList,
                         integer(:)(IN) :: component,
                         integer(IN)    :: accelIndex,
                         integer(IN),optional    :: potentialIndex)

DESCRIPTION

  Compute components of the zone-averaged gravitational
  acceleration on all mesh blocks.  Either a single component
  of the acceleration or all three can be computed.

ARGUMENTS

   blockCount   : The number of blocks in the list
   blockList(:) : The list of blocks on which to calculate acceleration.
   component    : The directional component of the acceleration to compute.
                  Permitted values are IAXIS, JAXIS, KAXIS, and ALLDIR.
                  These constants are defined in constants.h.
   accelIndex   : grid variable to store the acceleration, e.g., GRAC
   potentialIndex :   Variable to take as potential if present.  If not
                      present, GPOT is assumed by default.

NOTES

   This routine can be used as a wrapper to Gravity_accelOneRow.  Each implementation
   of the Gravity unit has a version of Gravity_accelOneRow, but this wrapper remains
   constant.