FLASH4.6.1 API

Generated from /asc/asci2/site/flashcode/secure/release_4p6/source/Grid/Grid_getBlkPtr.F90 with ROBODoc v4.99.8 on Fri Sep 20 16:16:02 2019

TABLE OF CONTENTS


[Functions] source/Grid/Grid_getBlkPtr

[top][index]

NAME

  Grid_getBlkPtr

SYNOPSIS

  Grid_getBlkPtr(integer(IN)            :: blockID,
                 real(pointer)(:,:,:,:) :: dataPtr,
                 integer(IN),optional   :: gridDataStruct)

DESCRIPTION

  Gets a pointer to a single block of simulation data from the
  specified Grid data structure. The block includes guard cells.
  If the optional argument "gridDataStructure" is not specified,
  it returns a block from cell centered data structure.

ARGUMENTS

  blockID : the local blockid

  dataPtr : Pointer to the data block

  gridDataStruct : optional integer value specifying data structure. 
                   The options are defined in constants.h and they are :
                   CENTER cell centered variables (default)
                   FACEX  face centered variable on faces along IAXIS
                   FACEY  face centered variable on faces along JAXIS
                   FACEZ  face centered variable on faces along IAXIS
                   SCRATCH scratch space that can fit cell and face centered variables
                   SCRATCH_CTR scratch space for cell centered variables
                   SCRATCH_FACEX scratch space facex variables
                   SCRATCH_FACEY scratch space facey variables
                   SCRATCH_FACEZ scratch space facez variables

NOTES

  Grid_getBlkPtr is an accessor function that passes a pointer
  as an argument and requires an explicit interface for most compilers.

  Don't forget to call Grid_releaseBlkPtr when you are finished with it!