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

Back-coupling is performed only on the cell containing the particle. More...

#include <backCouplingModels.h>

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

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

Public Member Functions
	LocalBackCouplingModel (UnitConverter< T, Lattice > &converter, SuperLattice< T, Lattice > &sLattice, SuperGeometry< T, 3 > &sGeometry, 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::BaseLocalBackCouplingModel< T, Lattice, Particle >
virtual void	communicate () override
	Communicates POPULATION and FORCE fields if the model is non-local.
	BaseLocalBackCouplingModel (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.

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::LocalBackCouplingModel< T, Lattice, Particle >

Back-coupling is performed only on the cell containing the particle.

Input parameters in attice units.

Definition at line 111 of file backCouplingModels.h.

Constructor & Destructor Documentation

LocalBackCouplingModel()

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

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

Constructor.

Definition at line 111 of file backCouplingModels.hh.

  : BaseLocalBackCouplingModel<T,Lattice,Particle>(converter, sLattice, sGeometry, overlap)
{}

Member Function Documentation

operator()()

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

bool olb::LocalBackCouplingModel< 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 120 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
 
  T physPosP[3] = { (p->getPos()[0]),
                    (p->getPos()[1]),
                    (p->getPos()[2])
                  }; // particle's physical position
 
  // particle's dimensionless position, rounded at neighbouring voxel
  int latticeRoundedPosP[3] = {0, 0, 0};
  this->_sLattice.getCuboidGeometry().get(globic).getLatticeR( latticeRoundedPosP, physPosP );
 
  if (this->_sGeometry.getBlockGeometry(locIC).getMaterial( latticeRoundedPosP[0], latticeRoundedPosP[1], latticeRoundedPosP[2] ) == material) {
    FieldD<T,Lattice,descriptors::FORCE> F{
      -latticeForceP[0] / (T)(subCycles),
      -latticeForceP[1] / (T)(subCycles),
      -latticeForceP[2] / (T)(subCycles)
    };  // dimensionless smoothed force
 
    this->_sLattice.getBlock(locIC).get(
      latticeRoundedPosP[0],
      latticeRoundedPosP[1],
      latticeRoundedPosP[2]
    ).template getFieldPointer<descriptors::FORCE>() += F;
  }
 
  return true;
}

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

Here is the call graph for this function:

---

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

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