Doxygen Generated Documentation From Interface Source Code
Gravity_accelOneRow.F90 File Reference

Go to the source code of this file.


subroutine Gravity_accelOneRow_blkid (pos, sweepDir, blockID, numCells, grav, potentialIndex, extraAccelVars)
subroutine Gravity_accelOneRow (pos, sweepDir, tileDesc, lo, hi, grav, Uin, potentialIndex, extraAccelVars)

Function/Subroutine Documentation

◆ Gravity_accelOneRow()

subroutine Gravity_accelOneRow ( integer, dimension(2)  pos,
integer  sweepDir,
type(Grid_tile_t)  tileDesc,
integer  lo,
integer  hi,
real, dimension(lo:hi)  grav,
real  Uin,
integer  potentialIndex,
integer  extraAccelVars 

Definition at line 71 of file Gravity_accelOneRow.F90.

◆ Gravity_accelOneRow_blkid()

subroutine Gravity_accelOneRow_blkid ( integer, dimension(2)  pos,
integer  sweepDir,
integer  blockID,
integer  numCells,
real, dimension(numCells)  grav,
integer  potentialIndex,
integer  extraAccelVars 

This routine computes the gravitational acceleration for a row of cells in a specified direction in a given block.

pos : Row indices transverse to the sweep direction sweepDir : The sweep direction: allowed values are SWEEP_X, SWEEP_Y, and SWEEP_Z. These values are defined in constants.h. blockID : The local identifier of the block to work on numCells : Number of cells to update in grav() grav() : Array to receive result potentialIndex : Variable # to take as potential if present ( this argument is applicable only in self-gravity formulated as Poisson's equation) extraAccelVars - if specified, Variables from which extra accelerations are taken. Used to identify the UNK variables that contain sink-on-gas accelerations when sink particles are used.


The following applies to Gravity implementations which solve the Poisson problem for self-gravity: If certain variables declared by the sink particles inplementation are declared, it is assumed that sink particles are in use. The sets of variables to make this determination are o those given by extraAccelVars extraAccelVars if present; o {SGXO_VAR, SGYO_VAR, SGZO_VAR} if potentialIndex is GPOL_VAR; o {SGAX_VAR, SGAY_VAR, SGAZ_VAR} otherwise. If it is assumed that sink particles are in use, then the acceleration returned in the grav array will have the appropriate sink particle acceleration component added to the acceleration computed by differencing the potential variable given by potentialIndex.

Definition at line 54 of file Gravity_accelOneRow.F90.