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

Generator class for the PostProcessors assigning the density boundary condition at the outlet. More...

#include <freeEnergyPostProcessor3D.h>

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

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

Public Member Functions
	FreeEnergyDensityOutletGenerator3D (int x0_, int x1_, int y0_, int y1_, int z0_, int z1_, T rho_)
	FreeEnergyDensityOutletGenerator3D (T rho_)
PostProcessor3D< T, DESCRIPTOR > *	generate (std::vector< BlockStructureD< 3 > * > partners) const override
LatticeCouplingGenerator3D< T, DESCRIPTOR > *	clone () const override
Public Member Functions inherited from olb::LatticeCouplingGenerator3D< T, DESCRIPTOR >
	LatticeCouplingGenerator3D ()=delete
	LatticeCouplingGenerator3D (int x0_, int x1_, int y0_, int y1_, int z0_, int z1_)
virtual	~LatticeCouplingGenerator3D ()
void	shift (LatticeR< 3 > delta, int iC_=-1)
void	shift (int deltaX, int deltaY, int deltaZ, int iC_=-1)
bool	extract (int x0_, int x1_, int y0_, int y1_, int z0_, int z1_)
bool	extract (LatticeR< 3 > lower, LatticeR< 3 > upper)
void	reset (LatticeR< 3 > lower, LatticeR< 3 > upper)
void	reset (int x0_, int x1_, int y0_, int y1_, int z0_, int z1_)

Additional Inherited Members
Protected Attributes inherited from olb::LatticeCouplingGenerator3D< T, DESCRIPTOR >
int	x0
int	x1
int	y0
int	y1
int	z0
int	z1
int	iC

Detailed Description

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

Generator class for the PostProcessors assigning the density boundary condition at the outlet.

Definition at line 217 of file freeEnergyPostProcessor3D.h.

Constructor & Destructor Documentation

FreeEnergyDensityOutletGenerator3D() [1/2]

template<typename T , typename DESCRIPTOR >

olb::FreeEnergyDensityOutletGenerator3D< T, DESCRIPTOR >::FreeEnergyDensityOutletGenerator3D	(	int	x0_,
		int	x1_,
		int	y0_,
		int	y1_,
		int	z0_,
		int	z1_,
		T	rho_ )

Parameters

[in]

rho_

- Gives the value of the constraint.

Definition at line 611 of file freeEnergyPostProcessor3D.hh.

  : LatticeCouplingGenerator3D<T,DESCRIPTOR>(x0_, x1_, y0_, y1_), rho(rho_)
{ }

FreeEnergyDensityOutletGenerator3D() [2/2]

template<typename T , typename DESCRIPTOR >

olb::FreeEnergyDensityOutletGenerator3D< T, DESCRIPTOR >::FreeEnergyDensityOutletGenerator3D

(

T

rho_

)

Parameters

[in]

rho_

- Gives the value of the constraint.

Definition at line 617 of file freeEnergyPostProcessor3D.hh.

  : LatticeCouplingGenerator3D<T,DESCRIPTOR>(0, 0, 0, 0, 0, 0), rho(rho_)
{ }

Member Function Documentation

clone()

template<typename T , typename DESCRIPTOR >

LatticeCouplingGenerator3D< T, DESCRIPTOR > * olb::FreeEnergyDensityOutletGenerator3D< T, DESCRIPTOR >::clone ( ) const

overridevirtual

Implements olb::LatticeCouplingGenerator3D< T, DESCRIPTOR >.

Definition at line 631 of file freeEnergyPostProcessor3D.hh.

{
  return new FreeEnergyDensityOutletGenerator3D<T,DESCRIPTOR>(*this);
}

generate()

template<typename T , typename DESCRIPTOR >

PostProcessor3D< T, DESCRIPTOR > * olb::FreeEnergyDensityOutletGenerator3D< T, DESCRIPTOR >::generate ( std::vector< BlockStructureD< 3 > * > partners ) const

overridevirtual

Parameters

[in]

partners_

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

Implements olb::LatticeCouplingGenerator3D< T, DESCRIPTOR >.

Definition at line 623 of file freeEnergyPostProcessor3D.hh.

{
  return new FreeEnergyDensityOutletCoupling3D<T,DESCRIPTOR>(
           this->x0,this->x1,this->y0,this->y1,this->z0,this->z1, rho, partners);
}

---

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

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