Highest-level interface to read-only Cell data. More...

#include <cell.h>

Inheritance diagram for olb::ConstCell< T, DESCRIPTOR >:

Collaboration diagram for olb::ConstCell< T, DESCRIPTOR >:

Public Types
using	value_t = T

using	descriptor_t = DESCRIPTOR

Public Member Functions
	ConstCell (const BlockLattice< T, DESCRIPTOR > &block, std::size_t iCell)

std::size_t	getCellId () const
	Return memory ID of the currently represented cell.

void	setCellId (std::size_t iCell)
	Jump to arbitrary cell memory ID.

bool	operator== (ConstCell< T, DESCRIPTOR > &rhs) const

bool	operator!= (ConstCell< T, DESCRIPTOR > &rhs) const

bool	operator< (ConstCell< T, DESCRIPTOR > &rhs) const

bool	operator<= (ConstCell< T, DESCRIPTOR > &rhs) const

ConstCell< T, DESCRIPTOR >	neighbor (Vector< int, DESCRIPTOR::d > c) const

T	operator[] (unsigned iPop) const
	Read-only access to distribution functions.

template<typename FIELD >
auto	getFieldPointer (FIELD field=FIELD()) const
	Return read-only field accessor.

template<typename FIELD >
auto	getFieldComponent (unsigned iD) const
	Return copy of field component.

template<typename FIELD >
auto	getField (FIELD field=FIELD()) const
	Return copy of descriptor-declared FIELD as a vector.

const Dynamics< T, DESCRIPTOR > *	getDynamics () const
	Get a pointer to the dynamics.

template<typename FIELD >
void	computeField (T *data) const
	Copy FIELD content to given memory location.

T	computeRho () const
	Compute particle density on the cell.

void	computeU (T u[descriptors::d< DESCRIPTOR >()]) const
	Compute fluid velocity on the cell.

void	computeJ (T j[descriptors::d< DESCRIPTOR >()]) const
	Compute fluid momentum (j = rho * u) on the cell.

void	computeStress (T pi[util::TensorVal< DESCRIPTOR >::n]) const
	Compute components of the stress tensor on the cell.

void	computeRhoU (T &rho, T u[descriptors::d< DESCRIPTOR >()]) const
	Compute fluid velocity and particle density on the cell.

void	computeFeq (T fEq[descriptors::q< DESCRIPTOR >()]) const
	Compute equilibrium part of cell distribution.

void	computeFneq (T fNeq[descriptors::q< DESCRIPTOR >()]) const
	Compute non-equilibrium part of cell distribution.

void	computeAllMomenta (T &rho, T u[descriptors::d< DESCRIPTOR >()], T pi[util::TensorVal< DESCRIPTOR >::n]) const
	Compute all momenta on the celll, up to second order.

Protected Attributes
friend	Cell< T, DESCRIPTOR >

std::size_t	_iCell
	Memory ID of currently represented cell.

BlockLattice< T, DESCRIPTOR > &	_block
	Underlying BlockLattice.

Vector< T *, DESCRIPTOR::q >	_populations
	Pointers to population values of current cell.

Detailed Description

template<typename T, typename DESCRIPTOR>
class olb::ConstCell< T, DESCRIPTOR >

Highest-level interface to read-only Cell data.

Only use where access to the specific ConcreteBlockLattice resp. Dynamics information is not (yet) possible.

Definition at line 53 of file cell.h.

Member Typedef Documentation

◆ descriptor_t

template<typename T , typename DESCRIPTOR >

using olb::ConstCell< T, DESCRIPTOR >::descriptor_t = DESCRIPTOR

Definition at line 78 of file cell.h.

◆ value_t

template<typename T , typename DESCRIPTOR >

using olb::ConstCell< T, DESCRIPTOR >::value_t = T

Definition at line 77 of file cell.h.

Constructor & Destructor Documentation

◆ ConstCell()

template<typename T , typename DESCRIPTOR >

olb::ConstCell< T, DESCRIPTOR >::ConstCell	(	const BlockLattice< T, DESCRIPTOR > &	block,
		std::size_t	iCell )

Definition at line 43 of file cell.hh.

                                                   :
  _iCell(iCell),
  _block(const_cast<BlockLattice<T,DESCRIPTOR>&>(block)),
  _populations{_block.getPopulationPointers(iCell)}
{ }

Member Function Documentation

◆ computeAllMomenta()

template<typename T , typename DESCRIPTOR >

void olb::ConstCell< T, DESCRIPTOR >::computeAllMomenta	(	T &	rho,
		T	u[descriptors::d< DESCRIPTOR >()],
		T	pi[util::TensorVal< DESCRIPTOR >::n] ) const

Compute all momenta on the celll, up to second order.

Definition at line 259 of file cell.hh.

{
  getDynamics()->computeAllMomenta(self(), rho, u, pi);
}

Here is the caller graph for this function:

◆ computeFeq()

template<typename T , typename DESCRIPTOR >

void olb::ConstCell< T, DESCRIPTOR >::computeFeq ( T fEq[descriptors::q< DESCRIPTOR >()] ) const

Compute equilibrium part of cell distribution.

Definition at line 238 of file cell.hh.

{
  T rho{};
  Vector<T,descriptors::d<DESCRIPTOR>()> u;
  computeRhoU(rho, u.data());
  const T uSqr = norm_squared(u);
  for (int iPop=0; iPop < descriptors::q<DESCRIPTOR>(); ++iPop) {
    fEq[iPop] = lbm<DESCRIPTOR>::equilibrium(iPop, rho, u, uSqr);
  }
}

References olb::norm_squared().

Here is the call graph for this function:

◆ computeField()

template<typename T , typename DESCRIPTOR >

template<typename FIELD >

void olb::ConstCell< T, DESCRIPTOR >::computeField ( T * data ) const

Copy FIELD content to given memory location.

Definition at line 181 of file cell.hh.

{
  auto field = getFieldPointer<FIELD>();
  for (long unsigned int i=0; i < DESCRIPTOR::template size<FIELD>(); ++i) {
    data[i] = field[i];
  }
}

◆ computeFneq()

template<typename T , typename DESCRIPTOR >

void olb::ConstCell< T, DESCRIPTOR >::computeFneq ( T fNeq[descriptors::q< DESCRIPTOR >()] ) const

Compute non-equilibrium part of cell distribution.

Definition at line 250 of file cell.hh.

{
  T rho{};
  T u[descriptors::d<DESCRIPTOR>()] { };
  computeRhoU(rho, u);
  lbm<DESCRIPTOR>::computeFneq(self(), fNeq, rho, u);
}

References olb::lbm< DESCRIPTOR >::computeFneq().

Here is the call graph for this function:

◆ computeJ()

template<typename T , typename DESCRIPTOR >

void olb::ConstCell< T, DESCRIPTOR >::computeJ ( T j[descriptors::d< DESCRIPTOR >()] ) const

Compute fluid momentum (j = rho * u) on the cell.

Definition at line 218 of file cell.hh.

{
  getDynamics()->computeJ(self(), j);
}

◆ computeRho()

template<typename T , typename DESCRIPTOR >

T olb::ConstCell< T, DESCRIPTOR >::computeRho ( ) const

Compute particle density on the cell.

Definition at line 206 of file cell.hh.

{
  return getDynamics()->computeRho(self());
}

Here is the caller graph for this function:

◆ computeRhoU()

template<typename T , typename DESCRIPTOR >

void olb::ConstCell< T, DESCRIPTOR >::computeRhoU	(	T &	rho,
		T	u[descriptors::d< DESCRIPTOR >()] ) const

Compute fluid velocity and particle density on the cell.

Definition at line 232 of file cell.hh.

{
  getDynamics()->computeRhoU(self(), rho, u);
}

Here is the caller graph for this function:

◆ computeStress()

template<typename T , typename DESCRIPTOR >

void olb::ConstCell< T, DESCRIPTOR >::computeStress ( T pi[util::TensorVal< DESCRIPTOR >::n] ) const

Compute components of the stress tensor on the cell.

Definition at line 224 of file cell.hh.

{
  T rho, u[descriptors::d<DESCRIPTOR>()];
  getDynamics()->computeRhoU(self(), rho, u);
  getDynamics()->computeStress(self(), rho, u, pi);
}

◆ computeU()

template<typename T , typename DESCRIPTOR >

void olb::ConstCell< T, DESCRIPTOR >::computeU ( T u[descriptors::d< DESCRIPTOR >()] ) const

Compute fluid velocity on the cell.

Definition at line 212 of file cell.hh.

{
  getDynamics()->computeU(self(), u);
}

Here is the caller graph for this function:

◆ getCellId()

template<typename T , typename DESCRIPTOR >

std::size_t olb::ConstCell< T, DESCRIPTOR >::getCellId ( ) const

Return memory ID of the currently represented cell.

Definition at line 51 of file cell.hh.

{
  return _iCell;
}

Here is the caller graph for this function:

◆ getDynamics()

template<typename T , typename DESCRIPTOR >

const Dynamics< T, DESCRIPTOR > * olb::ConstCell< T, DESCRIPTOR >::getDynamics ( ) const

Get a pointer to the dynamics.

Definition at line 168 of file cell.hh.

{
  return _block.getDynamics(_iCell);
}

◆ getField()

template<typename T , typename DESCRIPTOR >

template<typename FIELD >

auto olb::ConstCell< T, DESCRIPTOR >::getField ( FIELD field = FIELD() ) const

Return copy of descriptor-declared FIELD as a vector.

Definition at line 139 of file cell.hh.

{
  return _block.template getField<FIELD>().get(_iCell);
}

◆ getFieldComponent()

template<typename T , typename DESCRIPTOR >

template<typename FIELD >

auto olb::ConstCell< T, DESCRIPTOR >::getFieldComponent ( unsigned iD ) const

Return copy of field component.

Definition at line 82 of file cell.hh.

{
  static_assert(descriptors::is_data_field<FIELD>::value,
                "FIELD must be structured data field");
  return _block.template getField<FIELD>()[iD][_iCell];
}

◆ getFieldPointer()

template<typename T , typename DESCRIPTOR >

template<typename FIELD >

auto olb::ConstCell< T, DESCRIPTOR >::getFieldPointer ( FIELD field = FIELD() ) const

Return read-only field accessor.

Definition at line 64 of file cell.hh.

{
  static_assert(descriptors::is_data_field<FIELD>::value,
                "FIELD must be structured data field");
  return _block.template getField<FIELD>().getPointer(_iCell);
}

◆ neighbor()

template<typename T , typename DESCRIPTOR >

ConstCell< T, DESCRIPTOR > olb::ConstCell< T, DESCRIPTOR >::neighbor ( Vector< int, DESCRIPTOR::d > c ) const

Definition at line 90 of file cell.hh.

{
  return ConstCell<T,DESCRIPTOR>(_block, _iCell + _block.getNeighborDistance(c));
}

◆ operator!=()

template<typename T , typename DESCRIPTOR >

bool olb::ConstCell< T, DESCRIPTOR >::operator!= ( ConstCell< T, DESCRIPTOR > & rhs ) const

Definition at line 120 of file cell.hh.

{
  return getCellId() != rhs.getCellId();
}

◆ operator<()

template<typename T , typename DESCRIPTOR >

bool olb::ConstCell< T, DESCRIPTOR >::operator< ( ConstCell< T, DESCRIPTOR > & rhs ) const

Definition at line 126 of file cell.hh.

{
  return getCellId() < rhs.getCellId();
}

◆ operator<=()

template<typename T , typename DESCRIPTOR >

bool olb::ConstCell< T, DESCRIPTOR >::operator<= ( ConstCell< T, DESCRIPTOR > & rhs ) const

Definition at line 132 of file cell.hh.

{
  return getCellId() <= rhs.getCellId();
}

◆ operator==()

template<typename T , typename DESCRIPTOR >

bool olb::ConstCell< T, DESCRIPTOR >::operator== ( ConstCell< T, DESCRIPTOR > & rhs ) const

Definition at line 114 of file cell.hh.

{
  return getCellId() == rhs.getCellId();
}

◆ operator[]()

template<typename T , typename DESCRIPTOR >

T olb::ConstCell< T, DESCRIPTOR >::operator[] ( unsigned iPop ) const

Read-only access to distribution functions.

Parameters

iPop	index of the accessed distribution function

Definition at line 102 of file cell.hh.

{
  return *_populations[iPop];
}

◆ setCellId()

template<typename T , typename DESCRIPTOR >

void olb::ConstCell< T, DESCRIPTOR >::setCellId ( std::size_t iCell )

inline

Jump to arbitrary cell memory ID.

Caller is responsible that this is valid.

Definition at line 90 of file cell.h.

  {
    _iCell = iCell;
    _populations = _block.getPopulationPointers(iCell);
  }

References olb::ConstCell< T, DESCRIPTOR >::_block, olb::ConstCell< T, DESCRIPTOR >::_iCell, and olb::ConstCell< T, DESCRIPTOR >::_populations.

Member Data Documentation

◆ _block

template<typename T , typename DESCRIPTOR >

BlockLattice<T,DESCRIPTOR>& olb::ConstCell< T, DESCRIPTOR >::_block

protected

Underlying BlockLattice.

Definition at line 63 of file cell.h.

◆ _iCell

template<typename T , typename DESCRIPTOR >

std::size_t olb::ConstCell< T, DESCRIPTOR >::_iCell

protected

Memory ID of currently represented cell.

Definition at line 61 of file cell.h.

◆ _populations

template<typename T , typename DESCRIPTOR >

Vector<T*,DESCRIPTOR::q> olb::ConstCell< T, DESCRIPTOR >::_populations

protected

Pointers to population values of current cell.

Workaround to increase performance of post-processors, post-processing functors until they are ported to work on concrete lattices again (as is already the case for dynamics)

Validity of neighborhood accesses via these pointers not guaranteed (e.g. consider CPU_SIMD vs. CPU_SISD)

Definition at line 74 of file cell.h.

◆ Cell< T, DESCRIPTOR >

template<typename T , typename DESCRIPTOR >

friend olb::ConstCell< T, DESCRIPTOR >::Cell< T, DESCRIPTOR >

protected

Definition at line 58 of file cell.h.

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

src/core/cell.h
src/core/cell.hh

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ descriptor_t

◆ value_t

Constructor & Destructor Documentation

◆ ConstCell()

Member Function Documentation

◆ computeAllMomenta()

◆ computeFeq()

◆ computeField()

◆ computeFneq()

◆ computeJ()

◆ computeRho()

◆ computeRhoU()

◆ computeStress()

◆ computeU()

◆ getCellId()

◆ getDynamics()

◆ getField()

◆ getFieldComponent()

◆ getFieldPointer()

◆ neighbor()

◆ operator!=()

◆ operator<()

◆ operator<=()

◆ operator==()

◆ operator[]()

◆ setCellId()

Member Data Documentation

◆ _block

◆ _iCell

◆ _populations

◆ Cell< T, DESCRIPTOR >