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

Abstact class for all the non-local back-coupling models. More...

#include <backCouplingModels.h>

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

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

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

Additional Inherited Members
Protected Member Functions inherited from olb::BaseBackCouplingModel< T, Lattice, Particle >
	BaseBackCouplingModel (UnitConverter< T, Lattice > &converter, SuperLattice< T, Lattice > &sLattice, SuperGeometry< T, 3 > &sGeometry, int overlap)
	Constructor.
Protected Attributes inherited from olb::BaseBackCouplingModel< T, Lattice, Particle >
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::BaseNonLocalBackCouplingModel< T, Lattice, Particle >

Abstact class for all the non-local back-coupling models.

Input parameters in attice units.

Definition at line 94 of file backCouplingModels.h.

Constructor & Destructor Documentation

BaseNonLocalBackCouplingModel()

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

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

Constructor.

Definition at line 87 of file backCouplingModels.hh.

  : BaseBackCouplingModel<T,Lattice,Particle>(converter, sLattice, sGeometry, overlap),
    _commForce(sLattice)
{
  _commForce.template requestField<olb::descriptors::FORCE>();
  _commForce.requestOverlap(overlap);
  _commForce.exchangeRequests();
}

Member Function Documentation

communicate()

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

void olb::BaseNonLocalBackCouplingModel< T, Lattice, Particle >::communicate ( )

overridevirtual

Communicates POPULATION and FORCE fields if the model is non-local.

Implements olb::BackCouplingModel< T, Particle >.

Definition at line 101 of file backCouplingModels.hh.

{
  this->_commPopulation.communicate();
  _commForce.communicate();
}

---

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

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