olb::BaseBackCouplingModel< T, Lattice, Particle > Class Template Reference

Abstact class for all the back-coupling models, viz., momentum coupling from particle to fluid. More...

#include <backCouplingModels.h>

Inheritance diagram for olb::BaseBackCouplingModel< T, Lattice, Particle >:

Collaboration diagram for olb::BaseBackCouplingModel< T, Lattice, Particle >:

Public Member Functions
virtual void	resetExternalField (int material) override
	Resets external field.
Public Member Functions inherited from olb::BackCouplingModel< T, Particle >
virtual void	communicate ()=0
	Communicates POPULATION and FORCE fields if the model is non-local.
virtual bool	operator() (Particle< T > *p, int globic, int material, int subCycles=1)=0
	Class operator to apply the coupling, for overload.

Protected Member Functions
	BaseBackCouplingModel (UnitConverter< T, Lattice > &converter, SuperLattice< T, Lattice > &sLattice, SuperGeometry< T, 3 > &sGeometry, int overlap)
	Constructor.

Protected Attributes
UnitConverter< T, Lattice > &	_converter
SuperGeometry< T, 3 > &	_sGeometry
SuperLattice< T, Lattice > &	_sLattice
SuperCommunicator< T, SuperLattice< T, Lattice > >	_commPopulation

Detailed Description

template<typename T, typename Lattice, template< typename V > class Particle>
class olb::BaseBackCouplingModel< T, Lattice, Particle >

Abstact class for all the back-coupling models, viz., momentum coupling from particle to fluid.

Input parameters in attice units.

Definition at line 55 of file backCouplingModels.h.

Constructor & Destructor Documentation

BaseBackCouplingModel()

template<typename T , typename Lattice , template< typename V > class Particle>

olb::BaseBackCouplingModel< T, Lattice, Particle >::BaseBackCouplingModel ( UnitConverter< T, Lattice > & converter, SuperLattice< T, Lattice > & sLattice, SuperGeometry< T, 3 > & sGeometry, int overlap )

protected

Constructor.

Definition at line 37 of file backCouplingModels.hh.

  : _converter(converter),
    _sGeometry(sGeometry),
    _sLattice(sLattice),
    _commPopulation(_sLattice)
{
  _commPopulation.template requestField<olb::descriptors::POPULATION>();
  _commPopulation.requestOverlap(overlap);
  _commPopulation.exchangeRequests();
 
  _zeroAnalytical = std::make_shared<AnalyticalConst3D<T, T> > (T());
  _zeroField = std::make_shared<AnalyticalComposed3D<T, T> > (*_zeroAnalytical, *_zeroAnalytical, *_zeroAnalytical);
}

References olb::BaseBackCouplingModel< T, Lattice, Particle >::_commPopulation.

Member Function Documentation

resetExternalField()

template<typename T , typename Lattice , template< typename V > class Particle>

void olb::BaseBackCouplingModel< T, Lattice, Particle >::resetExternalField ( int material )

overridevirtual

Resets external field.

Implements olb::BackCouplingModel< T, Particle >.

Definition at line 56 of file backCouplingModels.hh.

{
  // resets external field
  this->_sLattice.template defineField<descriptors::FORCE>(this->_sGeometry, material, *_zeroField);
 
  // NECESSARY to communicate values before using them in operator()
  _commPopulation.communicate();
}

Member Data Documentation

_commPopulation

template<typename T , typename Lattice , template< typename V > class Particle>

SuperCommunicator<T, SuperLattice<T, Lattice> > olb::BaseBackCouplingModel< T, Lattice, Particle >::_commPopulation

protected

Definition at line 68 of file backCouplingModels.h.

_converter

template<typename T , typename Lattice , template< typename V > class Particle>

UnitConverter<T, Lattice>& olb::BaseBackCouplingModel< T, Lattice, Particle >::_converter

protected

Definition at line 65 of file backCouplingModels.h.

_sGeometry

template<typename T , typename Lattice , template< typename V > class Particle>

SuperGeometry<T,3>& olb::BaseBackCouplingModel< T, Lattice, Particle >::_sGeometry

protected

Definition at line 66 of file backCouplingModels.h.

_sLattice

template<typename T , typename Lattice , template< typename V > class Particle>

SuperLattice<T, Lattice>& olb::BaseBackCouplingModel< T, Lattice, Particle >::_sLattice

protected

Definition at line 67 of file backCouplingModels.h.

---

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

• src/particles/subgrid3DLegacyFramework/twoWayCouplings/backCouplingModels.h
• src/particles/subgrid3DLegacyFramework/twoWayCouplings/backCouplingModels.hh