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

PostProcessor for assigning the velocity at inlet and outlets to lattice two and three. More...

#include <freeEnergyPostProcessor3D.h>

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

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

Public Member Functions
	FreeEnergyInletOutletCoupling3D (int x0_, int x1_, int y0_, int y1_, int z0_, int z1_, std::vector< BlockStructureD< 3 > * > partners_)
	FreeEnergyInletOutletCoupling3D (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::FreeEnergyInletOutletCoupling3D< T, DESCRIPTOR >

PostProcessor for assigning the velocity at inlet and outlets to lattice two and three.

This should be assigned to the second lattice after FreeEnergyForcePostProcessor. The first lattice should be the first partner lattice.

Definition at line 106 of file freeEnergyPostProcessor3D.h.

Constructor & Destructor Documentation

FreeEnergyInletOutletCoupling3D() [1/2]

template<typename T , typename DESCRIPTOR >

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

Parameters

[in]

partners_

- Contains one partner lattice for two fluid components, or two lattices for three components.

Definition at line 385 of file freeEnergyPostProcessor3D.hh.

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

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

Here is the call graph for this function:

FreeEnergyInletOutletCoupling3D() [2/2]

template<typename T , typename DESCRIPTOR >

olb::FreeEnergyInletOutletCoupling3D< T, DESCRIPTOR >::FreeEnergyInletOutletCoupling3D

(

std::vector< BlockStructureD< 3 > * >

partners_

)

Parameters

[in]

partners_

- Contains one partner lattice for two fluid components, or two lattices for three components.

Definition at line 394 of file freeEnergyPostProcessor3D.hh.

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

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::FreeEnergyInletOutletCoupling3D< T, DESCRIPTOR >::extent ( ) const

inlineoverridevirtual

Extent of application area (0 for purely local operations)

Implements olb::PostProcessor3D< T, DESCRIPTOR >.

Definition at line 113 of file freeEnergyPostProcessor3D.h.

  {
    return 0;
  }

extent() [2/2]

template<typename T , typename DESCRIPTOR >

int olb::FreeEnergyInletOutletCoupling3D< 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 117 of file freeEnergyPostProcessor3D.h.

  {
    return 0;
  }

process()

template<typename T , typename DESCRIPTOR >

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

overridevirtual

Execute post-processing step.

Implements olb::PostProcessor3D< T, DESCRIPTOR >.

Definition at line 434 of file freeEnergyPostProcessor3D.hh.

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

processSubDomain()

template<typename T , typename DESCRIPTOR >

void olb::FreeEnergyInletOutletCoupling3D< 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 402 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 u[DESCRIPTOR::d];
          partnerLattice1->get(iX,iY,iZ).computeU(u);
          blockLattice.get(iX,iY,iZ).defineU(u);
          if (partners.size() > 1) {
            partnerLattice2->get(iX,iY,iZ).defineU(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