olb::ForwardCouplingModel< T, Particle > Class Template Reference

Abstact base class for all the forward-coupling models Its raison d'etre consists of not being templetized in Lattice. More...

#include <forwardCouplingModels3D.h>

Inheritance diagram for olb::ForwardCouplingModel< T, Particle >:

Collaboration diagram for olb::ForwardCouplingModel< T, Particle >:

Public Member Functions
virtual bool	operator() (Particle< T > *p, int globic)=0
	Class operator to apply the coupling, for overload.

Protected Member Functions
	ForwardCouplingModel (SuperGeometry< T, 3 > &sGeometry, std::shared_ptr< DragModel< T, Particle > > dragModel)
	Constructor.

Protected Attributes
SuperGeometry< T, 3 > &	_sGeometry
std::shared_ptr< DragModel< T, Particle > >	_dragModel

Detailed Description

template<typename T, template< typename V > class Particle>
class olb::ForwardCouplingModel< T, Particle >

Abstact base class for all the forward-coupling models Its raison d'etre consists of not being templetized in Lattice.

Definition at line 41 of file forwardCouplingModels3D.h.

Constructor & Destructor Documentation

ForwardCouplingModel()

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

olb::ForwardCouplingModel< T, Particle >::ForwardCouplingModel ( SuperGeometry< T, 3 > & sGeometry, std::shared_ptr< DragModel< T, Particle > > dragModel )

protected

Constructor.

Definition at line 37 of file forwardCouplingModels3D.hh.

  : _sGeometry(sGeometry),
    _dragModel(dragModel)
{}

Member Function Documentation

operator()()

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

virtual bool olb::ForwardCouplingModel< T, Particle >::operator() ( Particle< T > * p, int globic )

pure virtual

Class operator to apply the coupling, for overload.

Implemented in olb::LocalBaseForwardCouplingModel< T, Lattice, Particle >, olb::NonLocalBaseForwardCouplingModel< T, Lattice, Particle >, and olb::vanWachemForwardCouplingModel< T, Lattice, Particle >.

Member Data Documentation

_dragModel

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

std::shared_ptr<DragModel<T, Particle> > olb::ForwardCouplingModel< T, Particle >::_dragModel

protected

Definition at line 49 of file forwardCouplingModels3D.h.

_sGeometry

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

SuperGeometry<T,3>& olb::ForwardCouplingModel< T, Particle >::_sGeometry

protected

Definition at line 48 of file forwardCouplingModels3D.h.

---

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

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