olb::BlockLatticePhysBoundaryForce2D< T, DESCRIPTOR > Class Template Reference

BlockLatticePhysBoundaryForce2D returns pointwise phys force acting on a boundary. More...

#include <latticePhysBoundaryForce2D.h>

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

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

Public Member Functions
	BlockLatticePhysBoundaryForce2D (BlockLattice< T, DESCRIPTOR > &blockLattice, BlockIndicatorF2D< T > &indicatorF, const UnitConverter< T, DESCRIPTOR > &converter)
bool	operator() (T output[], const int input[]) override
	has to be implemented for 'every' derived class
Public Member Functions inherited from olb::BlockLatticeF2D< T, DESCRIPTOR >
BlockLattice< T, DESCRIPTOR > &	getBlock ()
	Copy Constructor.
Public Member Functions inherited from olb::BlockF2D< T >
virtual BlockStructureD< 2 > &	getBlockStructure ()
	virtual destructor for defined behaviour
void	setBlockStructure (BlockStructureD< 2 > *blockStructure)
BlockF2D< T > &	operator- (BlockF2D< T > &rhs)
BlockF2D< T > &	operator+ (BlockF2D< T > &rhs)
BlockF2D< T > &	operator* (BlockF2D< T > &rhs)
BlockF2D< T > &	operator/ (BlockF2D< T > &rhs)
Public Member Functions inherited from olb::GenericF< T, int >
virtual	~GenericF ()=default
int	getSourceDim () const
	read only access to member variable _m
int	getTargetDim () const
	read only access to member variable _n
std::string &	getName ()
	read and write access to name
std::string const &	getName () const
	read only access to name
bool	operator() (T output[])
	wrapper that call the pure virtual operator() (T output[], const S input[]) from above
bool	operator() (T output[], int input0)
bool	operator() (T output[], int input0, int input1)
bool	operator() (T output[], int input0, int input1, int input2)
bool	operator() (T output[], int input0, int input1, int input2, int input3)

Additional Inherited Members
Public Types inherited from olb::GenericF< T, int >
using	targetType
using	sourceType
Public Attributes inherited from olb::GenericF< T, int >
std::shared_ptr< GenericF< T, int > >	_ptrCalcC
	memory management, frees resouces (calcClass)
Protected Member Functions inherited from olb::BlockLatticePhysF2D< T, DESCRIPTOR >
	BlockLatticePhysF2D (BlockLattice< T, DESCRIPTOR > &blockLattice, const UnitConverter< T, DESCRIPTOR > &converter, int targetDim)
Protected Member Functions inherited from olb::BlockLatticeF2D< T, DESCRIPTOR >
	BlockLatticeF2D (BlockLattice< T, DESCRIPTOR > &blockLattice, int targetDim)
Protected Member Functions inherited from olb::BlockF2D< T >
	BlockF2D (BlockStructureD< 2 > &blockStructure, int targetDim)
	BlockF2D (int targetDim)
Protected Member Functions inherited from olb::GenericF< T, int >
	GenericF (int targetDim, int sourceDim)
Protected Attributes inherited from olb::BlockLatticePhysF2D< T, DESCRIPTOR >
const UnitConverter< T, DESCRIPTOR > &	_converter
Protected Attributes inherited from olb::BlockLatticeF2D< T, DESCRIPTOR >
BlockLattice< T, DESCRIPTOR > &	_blockLattice
Protected Attributes inherited from olb::BlockF2D< T >
BlockStructureD< 2 > *	_blockStructure

Detailed Description

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

BlockLatticePhysBoundaryForce2D returns pointwise phys force acting on a boundary.

Definition at line 56 of file latticePhysBoundaryForce2D.h.

Constructor & Destructor Documentation

BlockLatticePhysBoundaryForce2D()

template<typename T , typename DESCRIPTOR >

olb::BlockLatticePhysBoundaryForce2D< T, DESCRIPTOR >::BlockLatticePhysBoundaryForce2D	(	BlockLattice< T, DESCRIPTOR > &	blockLattice,
		BlockIndicatorF2D< T > &	indicatorF,
		const UnitConverter< T, DESCRIPTOR > &	converter )

Definition at line 73 of file latticePhysBoundaryForce2D.hh.

  : BlockLatticePhysF2D<T,DESCRIPTOR>(blockLattice, converter, 2),
    _indicatorF(indicatorF),
    _blockGeometry(indicatorF.getBlockGeometry())
{
  this->getName() = "physBoundaryForce";
}

References olb::GenericF< T, int >::getName().

Here is the call graph for this function:

Member Function Documentation

operator()()

template<typename T , typename DESCRIPTOR >

bool olb::BlockLatticePhysBoundaryForce2D< T, DESCRIPTOR >::operator() ( T output[], const int input[] )

overridevirtual

has to be implemented for 'every' derived class

Implements olb::GenericF< T, int >.

Definition at line 85 of file latticePhysBoundaryForce2D.hh.

{
  for (int i = 0; i < this->getTargetDim(); ++i) {
    output[i] = T();
  }
 
  if (_indicatorF(input)) {
    for (int iPop = 1; iPop < DESCRIPTOR::q; ++iPop) {
      // Get direction
      // Get next cell located in the current direction
      // Check if the next cell is a fluid node
      if (_blockGeometry.get({input[0] + descriptors::c<DESCRIPTOR >(iPop,0), input[1] + descriptors::c<DESCRIPTOR >(iPop,1)}) == 1) {
        // Get f_q of next fluid cell where l = opposite(q)
        T f = this->_blockLattice.get(input[0] + descriptors::c<DESCRIPTOR >(iPop,0), input[1] + descriptors::c<DESCRIPTOR >(iPop,1))[iPop];
        // Get f_l of the boundary cell
        // Add f_q and f_opp
        f += this->_blockLattice.get(input[0], input[1])[descriptors::opposite<DESCRIPTOR >(iPop)];
        // Update force
        for (int i = 0; i < this->getTargetDim(); ++i) {
          output[i] -= descriptors::c<DESCRIPTOR >(iPop,i) * f;
        }
      }
    }
    for (int i = 0; i < this->getTargetDim(); ++i) {
      output[i] = this->_converter.getPhysForce(output[i]);
    }
  }
  return true;
}

References olb::descriptors::c(), and olb::descriptors::opposite().

Here is the call graph for this function:

---

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

• src/functors/lattice/latticePhysBoundaryForce2D.h
• src/functors/lattice/latticePhysBoundaryForce2D.hh