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

#include <postProcessing.h>

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

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

Public Member Functions
	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_)
virtual PostProcessor3D< T, DESCRIPTOR > *	generate (std::vector< BlockStructureD< 3 > * > partners) const =0
virtual LatticeCouplingGenerator3D< T, DESCRIPTOR > *	clone () const =0

Protected Attributes
int	x0
int	x1
int	y0
int	y1
int	z0
int	z1
int	iC

Detailed Description

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

Definition at line 177 of file postProcessing.h.

Constructor & Destructor Documentation

LatticeCouplingGenerator3D() [1/2]

template<typename T , typename DESCRIPTOR >

olb::LatticeCouplingGenerator3D< T, DESCRIPTOR >::LatticeCouplingGenerator3D ( )

delete

LatticeCouplingGenerator3D() [2/2]

template<typename T , typename DESCRIPTOR >

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

Definition at line 297 of file postProcessing.hh.

  : x0(x0_), x1(x1_), y0(y0_), y1(y1_), z0(z0_), z1(z1_), iC(-1)
{ }

~LatticeCouplingGenerator3D()

template<typename T , typename DESCRIPTOR >

virtual olb::LatticeCouplingGenerator3D< T, DESCRIPTOR >::~LatticeCouplingGenerator3D ( )

inlinevirtual

Definition at line 182 of file postProcessing.h.

{ }

Member Function Documentation

clone()

template<typename T , typename DESCRIPTOR >

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

pure virtual

Implemented in olb::ShanChenDynOmegaForcedGenerator3D< T, DESCRIPTOR >, olb::ConcentrationAdvectionDiffusionCouplingGenerator3D< T, DESCRIPTOR >, olb::FreeEnergyChemicalPotentialGenerator3D< T, DESCRIPTOR >, olb::FreeEnergyForceGenerator3D< T, DESCRIPTOR >, olb::FreeEnergyInletOutletGenerator3D< T, DESCRIPTOR >, olb::FreeEnergyDensityOutletGenerator3D< T, DESCRIPTOR >, olb::TotalEnthalpyPhaseChangeCouplingGenerator3D< T, DESCRIPTOR, DYNAMICS >, olb::PhaseFieldCouplingGenerator3D< T, DESCRIPTOR >, olb::SmagorinskyBoussinesqCouplingGenerator3D< T, DESCRIPTOR >, olb::AdvectionDiffusionParticleCouplingGenerator3D< T, DESCRIPTOR, ADLattice, FIELD_A, FIELD_B >, olb::PorousNavierStokesAdvectionDiffusionCouplingGenerator3D< T, DESCRIPTOR >, olb::MixedScaleBoussinesqCouplingGenerator3D< T, DESCRIPTOR >, olb::VolumeAveragedNavierStokesAdvectionDiffusionParticleCouplingGenerator3D< T, DESCRIPTOR, POROSITY, ADLattice, FIELD_A, FIELD_B >, olb::ShanChenForcedSingleComponentGenerator3D< T, DESCRIPTOR >, olb::AdsorptionCouplingPostProcessorGenerator3D< T, NSDESCRIPTOR, ADEDESCRIPTOR >, olb::PassiveSoluteCouplingPostProcessorGenerator3D< T, NSDESCRIPTOR, CADDESCRIPTOR >, olb::AdsorptionFullCouplingPostProcessorGenerator3D< T, NSDESCRIPTOR, ADEDESCRIPTOR >, and olb::ReactionGenerator3D< T, DESCRIPTOR, REACTIONS >.

extract() [1/2]

template<typename T , typename DESCRIPTOR >

bool olb::LatticeCouplingGenerator3D< T, DESCRIPTOR >::extract	(	int	x0_,
		int	x1_,
		int	y0_,
		int	y1_,
		int	z0_,
		int	z1_ )

Definition at line 328 of file postProcessing.hh.

{
  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 ) ) {
    x0 = newX0;
    x1 = newX1;
    y0 = newY0;
    y1 = newY1;
    z0 = newZ0;
    z1 = newZ1;
    return true;
  }
  else {
    return false;
  }
}

References olb::util::intersect().

Here is the call graph for this function:

extract() [2/2]

template<typename T , typename DESCRIPTOR >

bool olb::LatticeCouplingGenerator3D< T, DESCRIPTOR >::extract	(	LatticeR< 3 >	lower,
		LatticeR< 3 >	upper )

Definition at line 350 of file postProcessing.hh.

{
  return extract(lower[0], upper[0], lower[1], upper[1], lower[2], upper[2]);
}

generate()

template<typename T , typename DESCRIPTOR >

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

pure virtual

Implemented in olb::ShanChenDynOmegaForcedGenerator3D< T, DESCRIPTOR >, olb::AdsorptionCouplingPostProcessorGenerator3D< T, NSDESCRIPTOR, ADEDESCRIPTOR >, olb::AdsorptionFullCouplingPostProcessorGenerator3D< T, NSDESCRIPTOR, ADEDESCRIPTOR >, olb::ConcentrationAdvectionDiffusionCouplingGenerator3D< T, DESCRIPTOR >, olb::FreeEnergyChemicalPotentialGenerator3D< T, DESCRIPTOR >, olb::FreeEnergyForceGenerator3D< T, DESCRIPTOR >, olb::FreeEnergyInletOutletGenerator3D< T, DESCRIPTOR >, olb::FreeEnergyDensityOutletGenerator3D< T, DESCRIPTOR >, olb::TotalEnthalpyPhaseChangeCouplingGenerator3D< T, DESCRIPTOR, DYNAMICS >, olb::PhaseFieldCouplingGenerator3D< T, DESCRIPTOR >, olb::SmagorinskyBoussinesqCouplingGenerator3D< T, DESCRIPTOR >, olb::AdvectionDiffusionParticleCouplingGenerator3D< T, DESCRIPTOR, ADLattice, FIELD_A, FIELD_B >, olb::PorousNavierStokesAdvectionDiffusionCouplingGenerator3D< T, DESCRIPTOR >, olb::MixedScaleBoussinesqCouplingGenerator3D< T, DESCRIPTOR >, olb::VolumeAveragedNavierStokesAdvectionDiffusionParticleCouplingGenerator3D< T, DESCRIPTOR, POROSITY, ADLattice, FIELD_A, FIELD_B >, olb::ShanChenForcedSingleComponentGenerator3D< T, DESCRIPTOR >, olb::PassiveSoluteCouplingPostProcessorGenerator3D< T, NSDESCRIPTOR, CADDESCRIPTOR >, and olb::ReactionGenerator3D< T, DESCRIPTOR, REACTIONS >.

reset() [1/2]

template<typename T , typename DESCRIPTOR >

void olb::LatticeCouplingGenerator3D< T, DESCRIPTOR >::reset	(	int	x0_,
		int	x1_,
		int	y0_,
		int	y1_,
		int	z0_,
		int	z1_ )

Definition at line 367 of file postProcessing.hh.

{
  x0 = x0_;
  x1 = x1_;
  y0 = y0_;
  y1 = y1_;
  z0 = z0_;
  z1 = z1_;
}

reset() [2/2]

template<typename T , typename DESCRIPTOR >

void olb::LatticeCouplingGenerator3D< T, DESCRIPTOR >::reset	(	LatticeR< 3 >	lower,
		LatticeR< 3 >	upper )

Definition at line 356 of file postProcessing.hh.

{
  x0 = lower[0];
  x1 = upper[0];
  y0 = lower[1];
  y1 = upper[1];
  z0 = lower[2];
  z1 = upper[2];
}

shift() [1/2]

template<typename T , typename DESCRIPTOR >

void olb::LatticeCouplingGenerator3D< T, DESCRIPTOR >::shift	(	int	deltaX,
		int	deltaY,
		int	deltaZ,
		int	iC_ = -1 )

Definition at line 315 of file postProcessing.hh.

{
  x0 += deltaX;
  x1 += deltaX;
  y0 += deltaY;
  y1 += deltaY;
  z0 += deltaZ;
  z1 += deltaZ;
  iC = iC_;
}

shift() [2/2]

template<typename T , typename DESCRIPTOR >

void olb::LatticeCouplingGenerator3D< T, DESCRIPTOR >::shift	(	LatticeR< 3 >	delta,
		int	iC_ = -1 )

Definition at line 303 of file postProcessing.hh.

{
  x0 += delta[0];
  x1 += delta[0];
  y0 += delta[1];
  y1 += delta[1];
  z0 += delta[2];
  z1 += delta[2];
  iC = iC_;
}

Member Data Documentation

iC

template<typename T , typename DESCRIPTOR >

int olb::LatticeCouplingGenerator3D< T, DESCRIPTOR >::iC

protected

Definition at line 192 of file postProcessing.h.

x0

template<typename T , typename DESCRIPTOR >

int olb::LatticeCouplingGenerator3D< T, DESCRIPTOR >::x0

protected

Definition at line 192 of file postProcessing.h.

x1

template<typename T , typename DESCRIPTOR >

int olb::LatticeCouplingGenerator3D< T, DESCRIPTOR >::x1

protected

Definition at line 192 of file postProcessing.h.

y0

template<typename T , typename DESCRIPTOR >

int olb::LatticeCouplingGenerator3D< T, DESCRIPTOR >::y0

protected

Definition at line 192 of file postProcessing.h.

y1

template<typename T , typename DESCRIPTOR >

int olb::LatticeCouplingGenerator3D< T, DESCRIPTOR >::y1

protected

Definition at line 192 of file postProcessing.h.

z0

template<typename T , typename DESCRIPTOR >

int olb::LatticeCouplingGenerator3D< T, DESCRIPTOR >::z0

protected

Definition at line 192 of file postProcessing.h.

z1

template<typename T , typename DESCRIPTOR >

int olb::LatticeCouplingGenerator3D< T, DESCRIPTOR >::z1

protected

Definition at line 192 of file postProcessing.h.

---

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

• src/core/postProcessing.h
• src/core/postProcessing.hh