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

Class for a generic non-local back-coupling model (but this is NOT VIRTUAL!), viz., momentum coupling from particle to fluid, for model more complicated that CubicDeltaBackCouplingModel. More...

#include <backCouplingModels.h>

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

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

Public Member Functions
	NonLocalBaseBackCouplingModel (UnitConverter< T, Lattice > &converter, SuperLattice< T, Lattice > &sLattice, SuperGeometry< T, 3 > &sGeometry, std::shared_ptr< SmoothingFunctional< T, Lattice > > smoothingFunctional, int overlap)
	Constructor.
virtual bool	operator() (Particle< T > *p, int globic, int material, int subCycles=1) override
	Class operator to apply the coupling.
Public Member Functions inherited from olb::BaseNonLocalBackCouplingModel< T, Lattice, Particle >
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.

Protected Attributes
std::shared_ptr< SmoothingFunctional< T, Lattice > >	_smoothingFunctional
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

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.

Detailed Description

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

Class for a generic non-local back-coupling model (but this is NOT VIRTUAL!), viz., momentum coupling from particle to fluid, for model more complicated that CubicDeltaBackCouplingModel.

It reproduces the characteristics (viz., smoothing) of an input forward coupling model. Input parameters in attice units.

Definition at line 148 of file backCouplingModels.h.

Constructor & Destructor Documentation

NonLocalBaseBackCouplingModel()

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

olb::NonLocalBaseBackCouplingModel< T, Lattice, Particle >::NonLocalBaseBackCouplingModel	(	UnitConverter< T, Lattice > &	converter,
		SuperLattice< T, Lattice > &	sLattice,
		SuperGeometry< T, 3 > &	sGeometry,
		std::shared_ptr< SmoothingFunctional< T, Lattice > >	smoothingFunctional,
		int	overlap )

Constructor.

Definition at line 230 of file backCouplingModels.hh.

  : BaseNonLocalBackCouplingModel<T,Lattice,Particle>(converter, sLattice, sGeometry, overlap),
    _smoothingFunctional(smoothingFunctional)
{}

Member Function Documentation

operator()()

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

bool olb::NonLocalBaseBackCouplingModel< T, Lattice, Particle >::operator() ( Particle< T > * p, int globic, int material, int subCycles = 1 )

overridevirtual

Class operator to apply the coupling.

Implements olb::BackCouplingModel< T, Particle >.

Definition at line 241 of file backCouplingModels.hh.

{
  int locIC = this->_sLattice.getLoadBalancer().loc(globic);
 
  // reading the force from the value stored inside the particle
  std::vector<T> physForceP = p->getStoreForce(); // physical force acting on the particle
  T latticeForceP[3] = { physForceP[0] / this->_converter.getConversionFactorForce(),
                         physForceP[1] / this->_converter.getConversionFactorForce(),
                         physForceP[2] / this->_converter.getConversionFactorForce()
                       }; // dimensionless force acting on the particle
 
  // Updating force through voxels within kernel smoothing length from the bubble's position
  for (auto&& i : this->_smoothingFunctional->getData()) {
 
    // Updating iterated voxel
    if ( this->_sGeometry.getBlockGeometry(locIC).getMaterial(i.latticePos[0], i.latticePos[1], i.latticePos[2]) == material ) {
 
      // Weighted force acting on the iterated voxel
      FieldD<T,Lattice,descriptors::FORCE> F{
        -latticeForceP[0] * i.weight / (T)(subCycles),
        -latticeForceP[1] * i.weight / (T)(subCycles),
        -latticeForceP[2] * i.weight / (T)(subCycles)
      }; // dimensionless smoothed force
 
      this->_sLattice.getBlock(locIC).get(
        i.latticePos[0], i.latticePos[1], i.latticePos[2]
      ).template getFieldPointer<descriptors::FORCE>() += F;
    }
  }
  return true;
}

References olb::Vector< T, D >::getBlock().

Here is the call graph for this function:

Member Data Documentation

_smoothingFunctional

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

std::shared_ptr<SmoothingFunctional<T, Lattice> > olb::NonLocalBaseBackCouplingModel< T, Lattice, Particle >::_smoothingFunctional

protected

Definition at line 159 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