olb::BlockStructure2D Class Reference

#include <blockStructure2D.h>

Inheritance diagram for olb::BlockStructure2D:

Collaboration diagram for olb::BlockStructure2D:

Public Member Functions
	BlockStructure2D (int nx, int ny)
	BlockStructure2D (int nx, int ny, int overlap)
	BlockStructure2D ()
int	getNx () const
	Read only access to block width.
int	getNy () const
	Read only access to block height.
std::size_t	getNcells () const
	Get number of cells.
std::size_t	getCellId (int iX, int iY) const
	Get 1D cell ID.
std::ptrdiff_t	getNeighborDistance (int iX, int iY) const
	Get 1D neighbor distance.
std::ptrdiff_t	getNeighborDistance (Vector< int, 2 > c) const
	Get 1D neighbor distance.
bool	isInside (int iX, int iY) const
	Return whether location is valid.

Protected Attributes
int	_nx
	Block width.
int	_ny
	Block height.

Detailed Description

Definition at line 47 of file blockStructure2D.h.

Constructor & Destructor Documentation

BlockStructure2D() [1/3]

olb::BlockStructure2D::BlockStructure2D ( int nx, int ny )

inline

Definition at line 54 of file blockStructure2D.h.

: _nx(nx), _ny(ny) {};

BlockStructure2D() [2/3]

olb::BlockStructure2D::BlockStructure2D ( int nx, int ny, int overlap )

inline

Definition at line 55 of file blockStructure2D.h.

                                               :
    _nx(nx+2*overlap), _ny(ny+2*overlap) { };

BlockStructure2D() [3/3]

olb::BlockStructure2D::BlockStructure2D ( )

inline

Definition at line 57 of file blockStructure2D.h.

: BlockStructure2D(1,1) {};

Member Function Documentation

getCellId()

std::size_t olb::BlockStructure2D::getCellId ( int iX, int iY ) const

inline

Get 1D cell ID.

Definition at line 79 of file blockStructure2D.h.

  {
 
 
    if(!(iX >= 0 && iX < this->_nx && iY >= 0 && iY < this->_ny)){
      throw std::runtime_error{"Bad access at: " + std::to_string(iX) + " " + std::to_string(iY) + " " + std::to_string(foo_x) + " " + std::to_string(foo_y) + " "+ std::to_string(_nx) + " " + std::to_string(_ny)};
 
    }
 
    foo_x = iX;
    foo_y = iY;
 
    OLB_PRECONDITION(iX >= 0 && iX < this->_nx);
    OLB_PRECONDITION(iY >= 0 && iY < this->_ny);
    return iX*_ny + iY;
  }

References _nx, _ny, and OLB_PRECONDITION.

getNcells()

std::size_t olb::BlockStructure2D::getNcells ( ) const

inline

Get number of cells.

Definition at line 69 of file blockStructure2D.h.

  {
    // The conversions to std::size_t ensure 64-bit compatibility. Note that
    // Nx and Ny are of type int, which might be 32-bit types, even on
    // 64-bit platforms. Therefore, Nx*Ny may lead to a type overflow.
    return static_cast<std::size_t>(getNx())
           * static_cast<std::size_t>(getNy());
  }

References getNx(), and getNy().

Here is the call graph for this function:

getNeighborDistance() [1/2]

std::ptrdiff_t olb::BlockStructure2D::getNeighborDistance ( int iX, int iY ) const

inline

Get 1D neighbor distance.

Definition at line 96 of file blockStructure2D.h.

  {
    return iX*_ny + iY;
  }

References _ny.

Here is the caller graph for this function:

getNeighborDistance() [2/2]

std::ptrdiff_t olb::BlockStructure2D::getNeighborDistance ( Vector< int, 2 > c ) const

inline

Get 1D neighbor distance.

Definition at line 101 of file blockStructure2D.h.

  {
    return getNeighborDistance(c[0], c[1]);
  }

References getNeighborDistance().

Here is the call graph for this function:

getNx()

int olb::BlockStructure2D::getNx ( ) const

inline

Read only access to block width.

Definition at line 59 of file blockStructure2D.h.

  {
    return _nx;
  };

References _nx.

Here is the caller graph for this function:

getNy()

int olb::BlockStructure2D::getNy ( ) const

inline

Read only access to block height.

Definition at line 64 of file blockStructure2D.h.

  {
    return _ny;
  };

References _ny.

Here is the caller graph for this function:

isInside()

bool olb::BlockStructure2D::isInside ( int iX, int iY ) const

inline

Return whether location is valid.

Definition at line 106 of file blockStructure2D.h.

  {
    return 0 <= iX && iX < getNx() &&
           0 <= iY && iY < getNy();
  };

References getNx(), and getNy().

Here is the call graph for this function:

Member Data Documentation

_nx

int olb::BlockStructure2D::_nx

protected

Block width.

Definition at line 50 of file blockStructure2D.h.

_ny

int olb::BlockStructure2D::_ny

protected

Block height.

Definition at line 52 of file blockStructure2D.h.

---

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

• src/core/blockStructure2D.h