MultiBlockLevelGeom Class Reference

#include <MultiBlockLevelGeom.H>

List of all members.


Detailed Description

The class MultiBlockLevelGeom stores topological and geometric information.

MultiBlockLevelGeom stores topological and geometric information about a particular layout with a particular MultiBlockCoordSys.

Implementations of specific multiblock coordinate systems will be provided by derived classes.

Public Member Functions

 MultiBlockLevelGeom ()
 default constructor
 ~MultiBlockLevelGeom ()
 destructor
 MultiBlockLevelGeom (const MultiBlockCoordSys *a_coordSysPtr, const DisjointBoxLayout &a_grids, int a_ghosts, Interval a_fixedDims=Interval(), Vector< int > a_fixedPt=Vector< int >())
 full constructor
void undefine ()
void define (const MultiBlockCoordSys *a_coordSysPtr, const DisjointBoxLayout &a_grids, const int a_solUpdateGhosts, const int a_spaceOrder, Interval a_fixedDims=Interval(), Vector< int > a_fixedPt=Vector< int >())
 define knowing only ghosts required for the solution update procedure. DEPRECATED.
void define (const MultiBlockCoordSys *a_coordSysPtr, const DisjointBoxLayout &a_grids, int a_ghosts, Interval a_fixedDims=Interval(), Vector< int > a_fixedPt=Vector< int >())
 define with explicit specification of number of multiblock ghosts
int ghosts () const
 accessor
const DisjointBoxLayoutgrids () const
 accessor
const DisjointBoxLayoutgridsFull () const
 accessor
MultiBlockCoordSyscoordSysPtr () const
 accessor
const LayoutData< int > & block () const
 accessor
const LayoutData< IVSFAB
< IntVect > * > & 
validIndices () const
 accessor
const LayoutData< IVSFAB< int > * > & validBlock () const
 accessor
const LayoutData< IVSFAB
< RealVect > * > & 
validMappedCenter () const
 accessor
const IntervalfixedDims () const
const Vector< int > & fixedDimsVect () const
const Vector< int > & interpDimsVect () const
const Vector< int > & fixedPt () const
const BoxLayoutgridsFixedOff () const
bool allGridsHaveFixedPt () const
MultiBlockUtilmbUtil () const
void extraBlockGhosts (LayoutData< IntVectSet > &a_ghostCells, int a_ghostLayer) const
 return indices of destination ghost cells for a particular width
bool isDefined () const

Protected Attributes

bool m_isDefined
MultiBlockCoordSysm_coordSysPtr
 coordinate system (given in constructor)
DisjointBoxLayout m_gridsFull
 original underlying grids
DisjointBoxLayout m_grids
 underlying grids (given in constructor) varying in m_interpDimsVect but set to m_fixedPt in m_fixedDimsVect
BoxLayout m_gridsFixedOff
 displacement of original underlying grids from m_grids: 0 in m_interpDimsVect but varying in m_fixedDimsVect
bool m_allGridsHaveFixedPt
 whether all original underlying grids contain m_fixedPt in m_fixedDimsVect
int m_ghosts
 width of ghost layer around m_grids, from which data will be taken (given in constructor)
Interval m_fixedDims
 dimensions that are fixed. Default is empty.
Vector< int > m_fixedDimsVect
 dimensions that are fixed. Default is empty.
Vector< int > m_fixedPt
 coordinates in dimensions of m_fixedDims. Default is empty.
Vector< int > m_interpDimsVect
 dimensions that will be interpolated, which is all dimensions that are not in m_fixedDims. Default is 0:SpaceDim-1.
Vector< Tuple< BlockBoundary,
2 *SpaceDim > > 
m_boundaries
 all block boundaries; from m_coordSysPtr
LayoutData< int > m_block
 block containing each box of m_grids
LayoutData< IntVectSetm_ghostCells
 extra-block ghost cells from which data will be taken. Lives on m_grids.
LayoutData< IVSFAB< IntVect > * > m_validIndices
 coordinate indices within the valid block of the cell in which the center of each extra-block ghost cell falls. Lives on m_ghostCells, has 1 component.
LayoutData< IVSFAB< int > * > m_validBlock
 index of the valid block in which the center of each extra-block ghost cell falls. Lives on m_ghostCells, has 1 component.
LayoutData< IVSFAB< RealVect > * > m_validMappedCenter
 mapped coordinates, in valid block's index space, of center of each extra-block ghost cell. Lives on m_ghostCells, has 1 component.
MultiBlockUtilm_mbUtil


Constructor & Destructor Documentation

MultiBlockLevelGeom::MultiBlockLevelGeom (  )  [inline]

default constructor

References m_isDefined.

MultiBlockLevelGeom::~MultiBlockLevelGeom (  ) 

destructor

MultiBlockLevelGeom::MultiBlockLevelGeom ( const MultiBlockCoordSys a_coordSysPtr,
const DisjointBoxLayout a_grids,
int  a_ghosts,
Interval  a_fixedDims = Interval(),
Vector< int >  a_fixedPt = Vector< int >() 
)

full constructor


Member Function Documentation

void MultiBlockLevelGeom::undefine (  ) 

void MultiBlockLevelGeom::define ( const MultiBlockCoordSys a_coordSysPtr,
const DisjointBoxLayout a_grids,
const int  a_solUpdateGhosts,
const int  a_spaceOrder,
Interval  a_fixedDims = Interval(),
Vector< int >  a_fixedPt = Vector< int >() 
)

define knowing only ghosts required for the solution update procedure. DEPRECATED.

void MultiBlockLevelGeom::define ( const MultiBlockCoordSys a_coordSysPtr,
const DisjointBoxLayout a_grids,
int  a_ghosts,
Interval  a_fixedDims = Interval(),
Vector< int >  a_fixedPt = Vector< int >() 
)

define with explicit specification of number of multiblock ghosts

int MultiBlockLevelGeom::ghosts (  )  const [inline]

accessor

References m_ghosts.

const DisjointBoxLayout& MultiBlockLevelGeom::grids (  )  const [inline]

accessor

References m_grids.

const DisjointBoxLayout& MultiBlockLevelGeom::gridsFull (  )  const [inline]

accessor

References m_gridsFull.

MultiBlockCoordSys* MultiBlockLevelGeom::coordSysPtr (  )  const [inline]

accessor

References m_coordSysPtr.

const LayoutData<int>& MultiBlockLevelGeom::block (  )  const [inline]

accessor

References m_block.

const LayoutData< IVSFAB<IntVect>* >& MultiBlockLevelGeom::validIndices (  )  const [inline]

accessor

References m_validIndices.

const LayoutData< IVSFAB<int>* >& MultiBlockLevelGeom::validBlock (  )  const [inline]

accessor

References m_validBlock.

const LayoutData< IVSFAB<RealVect>* >& MultiBlockLevelGeom::validMappedCenter (  )  const [inline]

accessor

References m_validMappedCenter.

const Interval& MultiBlockLevelGeom::fixedDims (  )  const [inline]

References m_fixedDims.

const Vector<int>& MultiBlockLevelGeom::fixedDimsVect (  )  const [inline]

References m_fixedDimsVect.

const Vector<int>& MultiBlockLevelGeom::interpDimsVect (  )  const [inline]

References m_interpDimsVect.

const Vector<int>& MultiBlockLevelGeom::fixedPt (  )  const [inline]

References m_fixedPt.

const BoxLayout& MultiBlockLevelGeom::gridsFixedOff (  )  const [inline]

References m_gridsFixedOff.

bool MultiBlockLevelGeom::allGridsHaveFixedPt (  )  const [inline]

References m_allGridsHaveFixedPt.

MultiBlockUtil* MultiBlockLevelGeom::mbUtil (  )  const [inline]

References m_mbUtil.

void MultiBlockLevelGeom::extraBlockGhosts ( LayoutData< IntVectSet > &  a_ghostCells,
int  a_ghostLayer 
) const

return indices of destination ghost cells for a particular width

In a_ghostCells, return ghost cells of m_grids out to a_ghostLayer, which is width of destination ghost cell layer. This function requires m_grids, m_coordSysPtr, m_block, and m_boundaries, but NOT anything else like m_validIndices, m_validBlock, m_validMappedCenter.

bool MultiBlockLevelGeom::isDefined (  )  const [inline]

References m_isDefined.


Member Data Documentation

is this object defined? covers m_coordSysPtr, m_grids, m_ghosts, m_boundaries, m_block, m_ghostCells, m_validIndices, m_validBlock, m_validMappedCenter

Referenced by isDefined(), and MultiBlockLevelGeom().

coordinate system (given in constructor)

Referenced by coordSysPtr().

original underlying grids

Referenced by gridsFull().

underlying grids (given in constructor) varying in m_interpDimsVect but set to m_fixedPt in m_fixedDimsVect

Referenced by grids().

displacement of original underlying grids from m_grids: 0 in m_interpDimsVect but varying in m_fixedDimsVect

Referenced by gridsFixedOff().

whether all original underlying grids contain m_fixedPt in m_fixedDimsVect

Referenced by allGridsHaveFixedPt().

width of ghost layer around m_grids, from which data will be taken (given in constructor)

Referenced by ghosts().

dimensions that are fixed. Default is empty.

Referenced by fixedDims().

dimensions that are fixed. Default is empty.

Referenced by fixedDimsVect().

coordinates in dimensions of m_fixedDims. Default is empty.

Referenced by fixedPt().

dimensions that will be interpolated, which is all dimensions that are not in m_fixedDims. Default is 0:SpaceDim-1.

Referenced by interpDimsVect().

all block boundaries; from m_coordSysPtr

block containing each box of m_grids

Referenced by block().

extra-block ghost cells from which data will be taken. Lives on m_grids.

coordinate indices within the valid block of the cell in which the center of each extra-block ghost cell falls. Lives on m_ghostCells, has 1 component.

Referenced by validIndices().

index of the valid block in which the center of each extra-block ghost cell falls. Lives on m_ghostCells, has 1 component.

Referenced by validBlock().

mapped coordinates, in valid block's index space, of center of each extra-block ghost cell. Lives on m_ghostCells, has 1 component.

Referenced by validMappedCenter().

Referenced by mbUtil().


The documentation for this class was generated from the following file:

Generated on Wed Nov 22 03:27:38 2017 for Chombo + EB + MF by  doxygen 1.5.5