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

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

#include <freeEnergyPostProcessor3D.h>

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

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

Public Member Functions
	FreeEnergyChemicalPotentialGenerator3D (int x0_, int x1_, int y0_, int y1_, int z0_, int z1_, T alpha_, T kappa1_, T kappa2_)
	Two component free energy model.
	FreeEnergyChemicalPotentialGenerator3D (T alpha_, T kappa1_, T kappa2_)
	Two component free energy model.
	FreeEnergyChemicalPotentialGenerator3D (int x0_, int x1_, int y0_, int y1_, int z0_, int z1_, T alpha_, T kappa1_, T kappa2_, T kappa3_)
	Three component free energy model.
	FreeEnergyChemicalPotentialGenerator3D (T alpha_, T kappa1_, T kappa2_, T kappa3_)
	Three component free energy model.
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::FreeEnergyChemicalPotentialGenerator3D< T, DESCRIPTOR >

Generator class for the PostProcessors calculating the chemical potential.

Definition at line 162 of file freeEnergyPostProcessor3D.h.

Constructor & Destructor Documentation

FreeEnergyChemicalPotentialGenerator3D() [1/4]

template<typename T , typename DESCRIPTOR >

olb::FreeEnergyChemicalPotentialGenerator3D< T, DESCRIPTOR >::FreeEnergyChemicalPotentialGenerator3D	(	int	x0_,
		int	x1_,
		int	y0_,
		int	y1_,
		int	z0_,
		int	z1_,
		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 509 of file freeEnergyPostProcessor3D.hh.

  : LatticeCouplingGenerator3D<T,DESCRIPTOR>(x0_, x1_, y0_, y1_, z0_, z1_), alpha(alpha_),
    kappa1(kappa1_), kappa2(kappa2_), kappa3(0)
{ }

FreeEnergyChemicalPotentialGenerator3D() [2/4]

template<typename T , typename DESCRIPTOR >

olb::FreeEnergyChemicalPotentialGenerator3D< T, DESCRIPTOR >::FreeEnergyChemicalPotentialGenerator3D	(	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 517 of file freeEnergyPostProcessor3D.hh.

  : LatticeCouplingGenerator3D<T,DESCRIPTOR>(0, 0, 0, 0, 0, 0), alpha(alpha_),
    kappa1(kappa1_), kappa2(kappa2_), kappa3(0)
{ }

FreeEnergyChemicalPotentialGenerator3D() [3/4]

template<typename T , typename DESCRIPTOR >

olb::FreeEnergyChemicalPotentialGenerator3D< T, DESCRIPTOR >::FreeEnergyChemicalPotentialGenerator3D	(	int	x0_,
		int	x1_,
		int	y0_,
		int	y1_,
		int	z0_,
		int	z1_,
		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 524 of file freeEnergyPostProcessor3D.hh.

  : LatticeCouplingGenerator3D<T,DESCRIPTOR>(x0_, x1_, y0_, y1_, z0_, z1_), alpha(alpha_),
    kappa1(kappa1_), kappa2(kappa2_), kappa3(kappa3_)
{ }

FreeEnergyChemicalPotentialGenerator3D() [4/4]

template<typename T , typename DESCRIPTOR >

olb::FreeEnergyChemicalPotentialGenerator3D< T, DESCRIPTOR >::FreeEnergyChemicalPotentialGenerator3D	(	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 532 of file freeEnergyPostProcessor3D.hh.

  : LatticeCouplingGenerator3D<T,DESCRIPTOR>(0, 0, 0, 0, 0, 0), alpha(alpha_),
    kappa1(kappa1_), kappa2(kappa2_), kappa3(kappa3_)
{ }

Member Function Documentation

clone()

template<typename T , typename DESCRIPTOR >

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

overridevirtual

Implements olb::LatticeCouplingGenerator3D< T, DESCRIPTOR >.

Definition at line 549 of file freeEnergyPostProcessor3D.hh.

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

generate()

template<typename T , typename DESCRIPTOR >

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

overridevirtual

Implements olb::LatticeCouplingGenerator3D< T, DESCRIPTOR >.

Definition at line 539 of file freeEnergyPostProcessor3D.hh.

{
  return new FreeEnergyChemicalPotentialCoupling3D<T,DESCRIPTOR>(
           this->x0, this->x1, this->y0, this->y1, this->z0, this->z1,
           alpha, kappa1, kappa2, kappa3, partners);
}

---

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

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