OpenLB 1.7
Loading...
Searching...
No Matches
Public Member Functions | List of all members
olb::FreeEnergyChemicalPotentialGenerator2D< T, DESCRIPTOR > Class Template Reference

Generator class for the PostProcessors calculating the chemical potential. More...

#include <freeEnergyPostProcessor2D.h>

+ Inheritance diagram for olb::FreeEnergyChemicalPotentialGenerator2D< T, DESCRIPTOR >:
+ Collaboration diagram for olb::FreeEnergyChemicalPotentialGenerator2D< T, DESCRIPTOR >:

Public Member Functions

 FreeEnergyChemicalPotentialGenerator2D (int x0_, int x1_, int y0_, int y1_, T alpha_, T kappa1_, T kappa2_)
 Two component free energy model.
 
 FreeEnergyChemicalPotentialGenerator2D (T alpha_, T kappa1_, T kappa2_)
 Two component free energy model.
 
 FreeEnergyChemicalPotentialGenerator2D (int x0_, int x1_, int y0_, int y1_, T alpha_, T kappa1_, T kappa2_, T kappa3_)
 Three component free energy model.
 
 FreeEnergyChemicalPotentialGenerator2D (T alpha_, T kappa1_, T kappa2_, T kappa3_)
 Three component free energy model.
 
PostProcessor2D< T, DESCRIPTOR > * generate (std::vector< BlockStructureD< 2 > * > partners) const override
 
LatticeCouplingGenerator2D< T, DESCRIPTOR > * clone () const override
 
- Public Member Functions inherited from olb::LatticeCouplingGenerator2D< T, DESCRIPTOR >
 LatticeCouplingGenerator2D (int x0_, int x1_, int y0_, int y1_)
 
virtual ~LatticeCouplingGenerator2D ()
 
void shift (LatticeR< 2 > delta)
 
void shift (int deltaX, int deltaY)
 
bool extract (int x0_, int x1_, int y0_, int y1_)
 
bool extract (LatticeR< 2 > lower, LatticeR< 2 > upper)
 
void reset (int x0_, int x1_, int y0_, int y1_)
 
void reset (LatticeR< 2 > lower, LatticeR< 2 > upper)
 

Additional Inherited Members

- Protected Attributes inherited from olb::LatticeCouplingGenerator2D< T, DESCRIPTOR >
int x0
 
int x1
 
int y0
 
int y1
 

Detailed Description

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

Generator class for the PostProcessors calculating the chemical potential.

Definition at line 170 of file freeEnergyPostProcessor2D.h.

Constructor & Destructor Documentation

◆ FreeEnergyChemicalPotentialGenerator2D() [1/4]

template<typename T , typename DESCRIPTOR >
olb::FreeEnergyChemicalPotentialGenerator2D< T, DESCRIPTOR >::FreeEnergyChemicalPotentialGenerator2D ( int x0_,
int x1_,
int y0_,
int y1_,
T alpha_,
T kappa1_,
T kappa2_ )

Two component free energy model.

Parameters
[in]alpha_- Parameter related to the interface width. [lattice units]
[in]kappa1_- Parameter related to the surface tension (need to be >0). [lattice units]
[in]kappa2_- Parameter related to the surface tension (need to be >0). [lattice units]

Definition at line 402 of file freeEnergyPostProcessor2D.hh.

404 : LatticeCouplingGenerator2D<T,DESCRIPTOR>(x0_, x1_, y0_, y1_), alpha(alpha_),
405 kappa1(kappa1_), kappa2(kappa2_), kappa3(0)
406{ }

◆ FreeEnergyChemicalPotentialGenerator2D() [2/4]

template<typename T , typename DESCRIPTOR >
olb::FreeEnergyChemicalPotentialGenerator2D< T, DESCRIPTOR >::FreeEnergyChemicalPotentialGenerator2D ( T alpha_,
T kappa1_,
T kappa2_ )

Two component free energy model.

Parameters
[in]alpha_- Parameter related to the interface width. [lattice units]
[in]kappa1_- Parameter related to the surface tension (need to be >0). [lattice units]
[in]kappa2_- Parameter related to the surface tension (need to be >0). [lattice units]

Definition at line 409 of file freeEnergyPostProcessor2D.hh.

411 : LatticeCouplingGenerator2D<T,DESCRIPTOR>(0, 0, 0, 0), alpha(alpha_),
412 kappa1(kappa1_), kappa2(kappa2_), kappa3(0)
413{ }

◆ FreeEnergyChemicalPotentialGenerator2D() [3/4]

template<typename T , typename DESCRIPTOR >
olb::FreeEnergyChemicalPotentialGenerator2D< T, DESCRIPTOR >::FreeEnergyChemicalPotentialGenerator2D ( int x0_,
int x1_,
int y0_,
int y1_,
T alpha_,
T kappa1_,
T kappa2_,
T kappa3_ )

Three component free energy model.

Parameters
[in]alpha_- Parameter related to the interface width. [lattice units]
[in]kappa1_- Parameter related to the surface tension (need to be >0). [lattice units]
[in]kappa2_- Parameter related to the surface tension (need to be >0). [lattice units]
[in]kappa3_- Parameter related to the surface tension (need to be >0). [lattice units]

Definition at line 416 of file freeEnergyPostProcessor2D.hh.

418 : LatticeCouplingGenerator2D<T,DESCRIPTOR>(x0_, x1_, y0_, y1_), alpha(alpha_),
419 kappa1(kappa1_), kappa2(kappa2_), kappa3(kappa3_)
420{ }

◆ FreeEnergyChemicalPotentialGenerator2D() [4/4]

template<typename T , typename DESCRIPTOR >
olb::FreeEnergyChemicalPotentialGenerator2D< T, DESCRIPTOR >::FreeEnergyChemicalPotentialGenerator2D ( T alpha_,
T kappa1_,
T kappa2_,
T kappa3_ )

Three component free energy model.

Parameters
[in]alpha_- Parameter related to the interface width. [lattice units]
[in]kappa1_- Parameter related to the surface tension (need to be >0). [lattice units]
[in]kappa2_- Parameter related to the surface tension (need to be >0). [lattice units]
[in]kappa3_- Parameter related to the surface tension (need to be >0). [lattice units]

Definition at line 423 of file freeEnergyPostProcessor2D.hh.

425 : LatticeCouplingGenerator2D<T,DESCRIPTOR>(0, 0, 0, 0), alpha(alpha_),
426 kappa1(kappa1_), kappa2(kappa2_), kappa3(kappa3_)
427{ }

Member Function Documentation

◆ clone()

template<typename T , typename DESCRIPTOR >
LatticeCouplingGenerator2D< T, DESCRIPTOR > * olb::FreeEnergyChemicalPotentialGenerator2D< T, DESCRIPTOR >::clone ( ) const
overridevirtual

Implements olb::LatticeCouplingGenerator2D< T, DESCRIPTOR >.

Definition at line 439 of file freeEnergyPostProcessor2D.hh.

440{
441 return new FreeEnergyChemicalPotentialGenerator2D<T,DESCRIPTOR>(*this);
442}

◆ generate()

template<typename T , typename DESCRIPTOR >
PostProcessor2D< T, DESCRIPTOR > * olb::FreeEnergyChemicalPotentialGenerator2D< T, DESCRIPTOR >::generate ( std::vector< BlockStructureD< 2 > * > partners) const
overridevirtual
Parameters
[in]partners_- Contains one partner lattice for two fluid components, or two lattices for three components.

Implements olb::LatticeCouplingGenerator2D< T, DESCRIPTOR >.

Definition at line 430 of file freeEnergyPostProcessor2D.hh.

432{
433 return new FreeEnergyChemicalPotentialCoupling2D<T,DESCRIPTOR>(
434 this->x0,this->x1,this->y0,this->y1, alpha, kappa1, kappa2, kappa3, partners);
435}

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