olb::FreeEnergyForceCoupling3D< T, DESCRIPTOR > Class Template Reference

PostProcessor calculating the interfacial force in the free energy model. More...

#include <freeEnergyPostProcessor3D.h>

Inheritance diagram for olb::FreeEnergyForceCoupling3D< T, DESCRIPTOR >:

Collaboration diagram for olb::FreeEnergyForceCoupling3D< T, DESCRIPTOR >:

Public Member Functions
	FreeEnergyForceCoupling3D (int x0_, int x1_, int y0_, int y1_, int z0_, int z1_, std::vector< BlockStructureD< 3 > * > partners_)
	FreeEnergyForceCoupling3D (std::vector< BlockStructureD< 3 > * > partners_)
int	extent () const override
	Extent of application area (0 for purely local operations)
int	extent (int whichDirection) const override
	Extent of application area along a direction (0 or 1)
void	process (BlockLattice< T, DESCRIPTOR > &blockLattice) override
	Execute post-processing step.
void	processSubDomain (BlockLattice< T, DESCRIPTOR > &blockLattice, int x0_, int x1_, int y0_, int y1_, int z0_, int z1_) override
	Execute post-processing step on a sublattice.
Public Member Functions inherited from olb::PostProcessor3D< T, DESCRIPTOR >
	PostProcessor3D ()
virtual	~PostProcessor3D ()
std::string &	getName ()
	read and write access to name
std::string const &	getName () const
	read only access to name
int	getPriority () const
	read only access to priority

Additional Inherited Members
Protected Attributes inherited from olb::PostProcessor3D< T, DESCRIPTOR >
int	_priority

Detailed Description

template<typename T, typename DESCRIPTOR>
class olb::FreeEnergyForceCoupling3D< T, DESCRIPTOR >

PostProcessor calculating the interfacial force in the free energy model.

On the fist lattice the force is stored for the Guo forcing scheme. On the other lattices a velocity, calculated from that force, is stored which is used in the equilibrium distribution function.

Definition at line 81 of file freeEnergyPostProcessor3D.h.

Constructor & Destructor Documentation

FreeEnergyForceCoupling3D() [1/2]

template<typename T , typename DESCRIPTOR >

olb::FreeEnergyForceCoupling3D< T, DESCRIPTOR >::FreeEnergyForceCoupling3D	(	int	x0_,
		int	x1_,
		int	y0_,
		int	y1_,
		int	z0_,
		int	z1_,
		std::vector< BlockStructureD< 3 > * >	partners_ )

Definition at line 218 of file freeEnergyPostProcessor3D.hh.

  :  x0(x0_), x1(x1_), y0(y0_), y1(y1_), z0(z0_), z1(z1_), partners(partners_)
{
  this->getName() = "FreeEnergyForceCoupling3D";
}

References olb::PostProcessor3D< T, DESCRIPTOR >::getName().

Here is the call graph for this function:

FreeEnergyForceCoupling3D() [2/2]

template<typename T , typename DESCRIPTOR >

olb::FreeEnergyForceCoupling3D< T, DESCRIPTOR >::FreeEnergyForceCoupling3D

(

std::vector< BlockStructureD< 3 > * >

partners_

)

Definition at line 227 of file freeEnergyPostProcessor3D.hh.

  :  x0(0), x1(0), y0(0), y1(0), z0(0), z1(0), partners(partners_)
{
  this->getName() = "FreeEnergyForceCoupling3D";
}

References olb::PostProcessor3D< T, DESCRIPTOR >::getName().

Here is the call graph for this function:

Member Function Documentation

extent() [1/2]

template<typename T , typename DESCRIPTOR >

int olb::FreeEnergyForceCoupling3D< T, DESCRIPTOR >::extent ( ) const

inlineoverridevirtual

Extent of application area (0 for purely local operations)

Implements olb::PostProcessor3D< T, DESCRIPTOR >.

Definition at line 86 of file freeEnergyPostProcessor3D.h.

  {
    return 1;
  }

extent() [2/2]

template<typename T , typename DESCRIPTOR >

int olb::FreeEnergyForceCoupling3D< T, DESCRIPTOR >::extent ( int direction ) const

inlineoverridevirtual

Extent of application area along a direction (0 or 1)

Implements olb::PostProcessor3D< T, DESCRIPTOR >.

Definition at line 90 of file freeEnergyPostProcessor3D.h.

  {
    return 1;
  }

process()

template<typename T , typename DESCRIPTOR >

void olb::FreeEnergyForceCoupling3D< T, DESCRIPTOR >::process ( BlockLattice< T, DESCRIPTOR > & blockLattice )

overridevirtual

Execute post-processing step.

Implements olb::PostProcessor3D< T, DESCRIPTOR >.

Definition at line 375 of file freeEnergyPostProcessor3D.hh.

{
  processSubDomain(blockLattice, x0, x1, y0, y1, z0, z1);
}

processSubDomain()

template<typename T , typename DESCRIPTOR >

void olb::FreeEnergyForceCoupling3D< T, DESCRIPTOR >::processSubDomain ( BlockLattice< T, DESCRIPTOR > & blockLattice, int x0_, int x1_, int y0_, int y1_, int z0_, int z1_ )

overridevirtual

Execute post-processing step on a sublattice.

Implements olb::PostProcessor3D< T, DESCRIPTOR >.

Definition at line 235 of file freeEnergyPostProcessor3D.hh.

{
  // If partners.size() == 1: two fluid components
  // If partners.size() == 2: three fluid components
  BlockLattice<T,DESCRIPTOR> *partnerLattice1 = static_cast<BlockLattice<T,DESCRIPTOR> *>(partners[0]);
  BlockLattice<T,DESCRIPTOR> *partnerLattice2 = 0;
  if (partners.size() > 1) {
    partnerLattice2 = static_cast<BlockLattice<T,DESCRIPTOR> *>(partners[1]);
  }
 
  int newX0, newX1, newY0, newY1, newZ0, newZ1;
  if ( util::intersect ( x0, x1, y0, y1, z0, z1,
                         x0_, x1_, y0_, y1_, z0_, z1_,
                         newX0, newX1, newY0, newY1, newZ0, newZ1 ) ) {
 
    for (int iX=newX0; iX<=newX1; ++iX) {
      for (int iY=newY0; iY<=newY1; ++iY) {
        for (int iZ=newZ0; iZ<=newZ1; ++iZ) {
          T phi = blockLattice.get(iX,iY,iZ).computeRho();
          T rho = partnerLattice1->get(iX,iY,iZ).computeRho();
 
          T gradMuPhiX = 1./12. * ( -blockLattice.get(iX-1,iY,iZ-1).template getField<descriptors::CHEM_POTENTIAL>()
                                    -  blockLattice.get(iX-1,iY,iZ+1).template getField<descriptors::CHEM_POTENTIAL>()
                                    -  blockLattice.get(iX-1,iY-1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    - 2.* blockLattice.get(iX-1,iY,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    -  blockLattice.get(iX-1,iY+1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  blockLattice.get(iX+1,iY-1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    + 2.* blockLattice.get(iX+1,iY,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  blockLattice.get(iX+1,iY+1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  blockLattice.get(iX+1,iY,iZ-1).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  blockLattice.get(iX+1,iY,iZ+1).template getField<descriptors::CHEM_POTENTIAL>() );
          T gradMuPhiY = 1./12. * ( -blockLattice.get(iX-1,iY-1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    -  blockLattice.get(iX+1,iY-1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    -  blockLattice.get(iX,iY-1,iZ-1).template getField<descriptors::CHEM_POTENTIAL>()
                                    - 2.* blockLattice.get(iX,iY-1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    -  blockLattice.get(iX,iY-1,iZ+1).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  blockLattice.get(iX,iY+1,iZ-1).template getField<descriptors::CHEM_POTENTIAL>()
                                    + 2.* blockLattice.get(iX,iY+1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  blockLattice.get(iX,iY+1,iZ+1).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  blockLattice.get(iX-1,iY+1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  blockLattice.get(iX+1,iY+1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>() );
          T gradMuPhiZ = 1./12. * ( -blockLattice.get(iX,iY-1,iZ-1).template getField<descriptors::CHEM_POTENTIAL>()
                                    -  blockLattice.get(iX,iY+1,iZ-1).template getField<descriptors::CHEM_POTENTIAL>()
                                    -  blockLattice.get(iX-1,iY,iZ-1).template getField<descriptors::CHEM_POTENTIAL>()
                                    - 2.* blockLattice.get(iX,iY,iZ-1).template getField<descriptors::CHEM_POTENTIAL>()
                                    -  blockLattice.get(iX+1,iY,iZ-1).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  blockLattice.get(iX-1,iY,iZ+1).template getField<descriptors::CHEM_POTENTIAL>()
                                    + 2.* blockLattice.get(iX,iY,iZ+1).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  blockLattice.get(iX+1,iY,iZ+1).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  blockLattice.get(iX,iY-1,iZ+1).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  blockLattice.get(iX,iY+1,iZ+1).template getField<descriptors::CHEM_POTENTIAL>() );
 
          T gradMuRhoX = 1./12. * ( -partnerLattice1->get(iX-1,iY,iZ-1).template getField<descriptors::CHEM_POTENTIAL>()
                                    -  partnerLattice1->get(iX-1,iY,iZ+1).template getField<descriptors::CHEM_POTENTIAL>()
                                    -  partnerLattice1->get(iX-1,iY-1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    - 2.* partnerLattice1->get(iX-1,iY,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    -  partnerLattice1->get(iX-1,iY+1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  partnerLattice1->get(iX+1,iY-1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    + 2.* partnerLattice1->get(iX+1,iY,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  partnerLattice1->get(iX+1,iY+1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  partnerLattice1->get(iX+1,iY,iZ-1).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  partnerLattice1->get(iX+1,iY,iZ+1).template getField<descriptors::CHEM_POTENTIAL>() );
          T gradMuRhoY = 1./12. * ( -partnerLattice1->get(iX-1,iY-1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    -  partnerLattice1->get(iX+1,iY-1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    -  partnerLattice1->get(iX,iY-1,iZ-1).template getField<descriptors::CHEM_POTENTIAL>()
                                    - 2.* partnerLattice1->get(iX,iY-1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    -  partnerLattice1->get(iX,iY-1,iZ+1).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  partnerLattice1->get(iX,iY+1,iZ-1).template getField<descriptors::CHEM_POTENTIAL>()
                                    + 2.* partnerLattice1->get(iX,iY+1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  partnerLattice1->get(iX,iY+1,iZ+1).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  partnerLattice1->get(iX-1,iY+1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  partnerLattice1->get(iX+1,iY+1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>() );
          T gradMuRhoZ = 1./12. * ( -partnerLattice1->get(iX,iY-1,iZ-1).template getField<descriptors::CHEM_POTENTIAL>()
                                    -  partnerLattice1->get(iX,iY+1,iZ-1).template getField<descriptors::CHEM_POTENTIAL>()
                                    -  partnerLattice1->get(iX-1,iY,iZ-1).template getField<descriptors::CHEM_POTENTIAL>()
                                    - 2.* partnerLattice1->get(iX,iY,iZ-1).template getField<descriptors::CHEM_POTENTIAL>()
                                    -  partnerLattice1->get(iX+1,iY,iZ-1).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  partnerLattice1->get(iX-1,iY,iZ+1).template getField<descriptors::CHEM_POTENTIAL>()
                                    + 2.* partnerLattice1->get(iX,iY,iZ+1).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  partnerLattice1->get(iX+1,iY,iZ+1).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  partnerLattice1->get(iX,iY-1,iZ+1).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  partnerLattice1->get(iX,iY+1,iZ+1).template getField<descriptors::CHEM_POTENTIAL>() );
 
          T psi = 0.;
          T gradMuPsiX = 0.;
          T gradMuPsiY = 0.;
          T gradMuPsiZ = 0.;
          if (partners.size() > 1) {
            psi = partnerLattice2->get(iX,iY,iZ).computeRho();
            gradMuPsiX = 1./12. * ( -partnerLattice2->get(iX-1,iY,iZ-1).template getField<descriptors::CHEM_POTENTIAL>()
                                    -  partnerLattice2->get(iX-1,iY,iZ+1).template getField<descriptors::CHEM_POTENTIAL>()
                                    -  partnerLattice2->get(iX-1,iY-1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    - 2.* partnerLattice2->get(iX-1,iY,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    -  partnerLattice2->get(iX-1,iY+1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  partnerLattice2->get(iX+1,iY-1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    + 2.* partnerLattice2->get(iX+1,iY,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  partnerLattice2->get(iX+1,iY+1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  partnerLattice2->get(iX+1,iY,iZ-1).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  partnerLattice2->get(iX+1,iY,iZ+1).template getField<descriptors::CHEM_POTENTIAL>() );
            gradMuPsiY = 1./12. * ( -partnerLattice2->get(iX-1,iY-1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    -  partnerLattice2->get(iX+1,iY-1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    -  partnerLattice2->get(iX,iY-1,iZ-1).template getField<descriptors::CHEM_POTENTIAL>()
                                    - 2.* partnerLattice2->get(iX,iY-1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    -  partnerLattice2->get(iX,iY-1,iZ+1).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  partnerLattice2->get(iX,iY+1,iZ-1).template getField<descriptors::CHEM_POTENTIAL>()
                                    + 2.* partnerLattice2->get(iX,iY+1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  partnerLattice2->get(iX,iY+1,iZ+1).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  partnerLattice2->get(iX-1,iY+1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  partnerLattice2->get(iX+1,iY+1,iZ  ).template getField<descriptors::CHEM_POTENTIAL>() );
            gradMuPsiZ = 1./12. * ( -partnerLattice2->get(iX,iY-1,iZ-1).template getField<descriptors::CHEM_POTENTIAL>()
                                    -  partnerLattice2->get(iX,iY+1,iZ-1).template getField<descriptors::CHEM_POTENTIAL>()
                                    -  partnerLattice2->get(iX-1,iY,iZ-1).template getField<descriptors::CHEM_POTENTIAL>()
                                    - 2.* partnerLattice2->get(iX,iY,iZ-1).template getField<descriptors::CHEM_POTENTIAL>()
                                    -  partnerLattice2->get(iX+1,iY,iZ-1).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  partnerLattice2->get(iX-1,iY,iZ+1).template getField<descriptors::CHEM_POTENTIAL>()
                                    + 2.* partnerLattice2->get(iX,iY,iZ+1).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  partnerLattice2->get(iX+1,iY,iZ+1).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  partnerLattice2->get(iX,iY-1,iZ+1).template getField<descriptors::CHEM_POTENTIAL>()
                                    +  partnerLattice2->get(iX,iY+1,iZ+1).template getField<descriptors::CHEM_POTENTIAL>() );
          }
 
          T forceX = -rho*gradMuRhoX - phi*gradMuPhiX - psi*gradMuPsiX;
          T forceY = -rho*gradMuRhoY - phi*gradMuPhiY - psi*gradMuPsiY;
          T forceZ = -rho*gradMuRhoZ - phi*gradMuPhiZ - psi*gradMuPsiZ;
          partnerLattice1->get(iX,iY,iZ).template setField<descriptors::FORCE>({forceX, forceY, forceZ});
          T u[3];
          partnerLattice1->get(iX,iY,iZ).computeU(u);
          blockLattice.get(iX,iY,iZ).template setField<descriptors::FORCE>(u);
          if (partners.size() > 1) {
            partnerLattice2->get(iX,iY,iZ).template setField<descriptors::FORCE>(u);
          }
        }
      }
    }
  }
}

References olb::BlockLattice< T, DESCRIPTOR >::get(), and olb::util::intersect().

Here is the call graph for this function:

---

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

• src/dynamics/freeEnergyPostProcessor3D.h
• src/dynamics/freeEnergyPostProcessor3D.hh