flash.pyFlash4.Grid.BlockList

class BlockList(self: flash.pyFlash4.Grid.BlockList, blockType: int, refinementLevel: int = 0, region_bndBox: int = 0, includePartialBlocks: bool = 0)

Bases: pybind11_object

Maintains a list of a single block-type that are owned by the current process. Use __call__() to return a Block.

Methods

Attributes

nBlocks

Total number of blocks held in the list

__call__(self: flash.pyFlash4.Grid.BlockList, lb: int, gridDataStruct: int = 2) → flash.pyFlash4.Grid.Block

Returns a Block data structure for the lb-th block on the list

Parameters:

• lb (int) – index on the list of blocks to retrieve a Block

• gridDataStruct (int) – request this data structure from Block.

Returns:

Block data for the requested block

Return type:

Block

- The options are defined in constantsH 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

property nBlocks

Total number of blocks held in the list