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

Interface of 2D post-processing steps. More...

#include <postProcessing.h>

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

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

Public Member Functions
	PostProcessor2D ()
virtual	~PostProcessor2D ()
virtual void	process (BlockLattice< T, DESCRIPTOR > &blockLattice)=0
	Execute post-processing step.
virtual void	processSubDomain (BlockLattice< T, DESCRIPTOR > &blockLattice, int x0_, int x1_, int y0_, int y1_)=0
	Execute post-processing step on a sublattice.
virtual int	extent () const =0
	Extent of application area (0 for purely local operations)
virtual int	extent (int direction) const =0
	Extent of application area along a direction (0 or 1)
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

Protected Attributes
int	_priority

Detailed Description

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

Interface of 2D post-processing steps.

Definition at line 43 of file aliases.h.

Constructor & Destructor Documentation

PostProcessor2D()

template<typename T , typename DESCRIPTOR >

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

inline

Definition at line 45 of file postProcessing.h.

                   :
    _priority{0} { }

~PostProcessor2D()

template<typename T , typename DESCRIPTOR >

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

inlinevirtual

Definition at line 47 of file postProcessing.h.

{ }

Member Function Documentation

extent() [1/2]

template<typename T , typename DESCRIPTOR >

virtual int olb::PostProcessor2D< T, DESCRIPTOR >::extent ( ) const

pure virtual

Extent of application area (0 for purely local operations)

Implemented in olb::AntiBounceBackPostProcessor2D< T, DESCRIPTOR >, olb::batteryCouplingPostProcessor2D< T, DESCRIPTOR >, olb::BoundaryStreamPostProcessor2D< T, DESCRIPTOR >, olb::ConcentrationAdvectionDiffusionCouplingPostProcessor2D< T, DESCRIPTOR >, olb::ExtendedStraightFdBoundaryPostProcessor2D< T, DESCRIPTOR, direction, orientation >, olb::FreeEnergyChemicalPotentialCoupling2D< T, DESCRIPTOR >, olb::FreeEnergyDensityOutletCoupling2D< T, DESCRIPTOR >, olb::FreeEnergyForceCoupling2D< T, DESCRIPTOR >, olb::FreeEnergyInletOutletCoupling2D< T, DESCRIPTOR >, olb::GlobalPostProcessor2D< T, DESCRIPTOR >, olb::MixedScaleBoussinesqCouplingPostProcessor2D< T, DESCRIPTOR >, olb::PhaseFieldCouplingPostProcessor2D< T, DESCRIPTOR >, olb::ReactionPostProcessor2D< T, DESCRIPTOR, REACTIONS >, olb::ShanChenDynOmegaForcedPostProcessor2D< T, DESCRIPTOR >, olb::ShanChenForcedSingleComponentPostProcessor2D< T, DESCRIPTOR >, olb::SlipBoundaryProcessor2D< T, DESCRIPTOR >, olb::SmagorinskyBoussinesqCouplingPostProcessor2D< T, DESCRIPTOR >, olb::VelocityBounceBackPostProcessor2D< T, DESCRIPTOR >, olb::VelocityBouzidiLinearPostProcessor2D< T, DESCRIPTOR >, olb::ZeroVelocityBounceBackPostProcessor2D< T, DESCRIPTOR >, and olb::ZeroVelocityBouzidiLinearPostProcessor2D< T, DESCRIPTOR >.

extent() [2/2]

template<typename T , typename DESCRIPTOR >

virtual int olb::PostProcessor2D< T, DESCRIPTOR >::extent ( int direction ) const

pure virtual

Extent of application area along a direction (0 or 1)

Implemented in olb::AntiBounceBackPostProcessor2D< T, DESCRIPTOR >, olb::batteryCouplingPostProcessor2D< T, DESCRIPTOR >, olb::BoundaryStreamPostProcessor2D< T, DESCRIPTOR >, olb::ConcentrationAdvectionDiffusionCouplingPostProcessor2D< T, DESCRIPTOR >, olb::ExtendedStraightFdBoundaryPostProcessor2D< T, DESCRIPTOR, direction, orientation >, olb::FreeEnergyChemicalPotentialCoupling2D< T, DESCRIPTOR >, olb::FreeEnergyDensityOutletCoupling2D< T, DESCRIPTOR >, olb::FreeEnergyForceCoupling2D< T, DESCRIPTOR >, olb::FreeEnergyInletOutletCoupling2D< T, DESCRIPTOR >, olb::GlobalPostProcessor2D< T, DESCRIPTOR >, olb::MixedScaleBoussinesqCouplingPostProcessor2D< T, DESCRIPTOR >, olb::PhaseFieldCouplingPostProcessor2D< T, DESCRIPTOR >, olb::ReactionPostProcessor2D< T, DESCRIPTOR, REACTIONS >, olb::ShanChenDynOmegaForcedPostProcessor2D< T, DESCRIPTOR >, olb::ShanChenForcedSingleComponentPostProcessor2D< T, DESCRIPTOR >, olb::SlipBoundaryProcessor2D< T, DESCRIPTOR >, olb::SmagorinskyBoussinesqCouplingPostProcessor2D< T, DESCRIPTOR >, olb::VelocityBounceBackPostProcessor2D< T, DESCRIPTOR >, olb::VelocityBouzidiLinearPostProcessor2D< T, DESCRIPTOR >, olb::ZeroVelocityBounceBackPostProcessor2D< T, DESCRIPTOR >, and olb::ZeroVelocityBouzidiLinearPostProcessor2D< T, DESCRIPTOR >.

getName() [1/2]

template<typename T , typename DESCRIPTOR >

std::string & olb::PostProcessor2D< T, DESCRIPTOR >::getName

(

)

read and write access to name

Definition at line 33 of file postProcessing.hh.

{
  return _name;
}

Here is the caller graph for this function:

getName() [2/2]

template<typename T , typename DESCRIPTOR >

std::string const & olb::PostProcessor2D< T, DESCRIPTOR >::getName

(

)

const

read only access to name

Definition at line 39 of file postProcessing.hh.

{
  return _name;
}

getPriority()

template<typename T , typename DESCRIPTOR >

int olb::PostProcessor2D< T, DESCRIPTOR >::getPriority

(

)

const

read only access to priority

Definition at line 45 of file postProcessing.hh.

{
  return _priority;
}

process()

template<typename T , typename DESCRIPTOR >

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

pure virtual

Execute post-processing step.

Implemented in olb::AntiBounceBackPostProcessor2D< T, DESCRIPTOR >, olb::batteryCouplingPostProcessor2D< T, DESCRIPTOR >, olb::BoundaryStreamPostProcessor2D< T, DESCRIPTOR >, olb::ConcentrationAdvectionDiffusionCouplingPostProcessor2D< T, DESCRIPTOR >, olb::ExtendedStraightFdBoundaryPostProcessor2D< T, DESCRIPTOR, direction, orientation >, olb::FreeEnergyChemicalPotentialCoupling2D< T, DESCRIPTOR >, olb::FreeEnergyDensityOutletCoupling2D< T, DESCRIPTOR >, olb::FreeEnergyForceCoupling2D< T, DESCRIPTOR >, olb::FreeEnergyInletOutletCoupling2D< T, DESCRIPTOR >, olb::GlobalPostProcessor2D< T, DESCRIPTOR >, olb::MixedScaleBoussinesqCouplingPostProcessor2D< T, DESCRIPTOR >, olb::PhaseFieldCouplingPostProcessor2D< T, DESCRIPTOR >, olb::ReactionPostProcessor2D< T, DESCRIPTOR, REACTIONS >, olb::ShanChenDynOmegaForcedPostProcessor2D< T, DESCRIPTOR >, olb::ShanChenForcedSingleComponentPostProcessor2D< T, DESCRIPTOR >, olb::SlipBoundaryProcessor2D< T, DESCRIPTOR >, olb::SmagorinskyBoussinesqCouplingPostProcessor2D< T, DESCRIPTOR >, olb::VelocityBounceBackPostProcessor2D< T, DESCRIPTOR >, olb::VelocityBouzidiLinearPostProcessor2D< T, DESCRIPTOR >, olb::ZeroVelocityBounceBackPostProcessor2D< T, DESCRIPTOR >, and olb::ZeroVelocityBouzidiLinearPostProcessor2D< T, DESCRIPTOR >.

processSubDomain()

template<typename T , typename DESCRIPTOR >

virtual void olb::PostProcessor2D< T, DESCRIPTOR >::processSubDomain ( BlockLattice< T, DESCRIPTOR > & blockLattice, int x0_, int x1_, int y0_, int y1_ )

pure virtual

Execute post-processing step on a sublattice.

Implemented in olb::AntiBounceBackPostProcessor2D< T, DESCRIPTOR >, olb::batteryCouplingPostProcessor2D< T, DESCRIPTOR >, olb::BoundaryStreamPostProcessor2D< T, DESCRIPTOR >, olb::ConcentrationAdvectionDiffusionCouplingPostProcessor2D< T, DESCRIPTOR >, olb::ExtendedStraightFdBoundaryPostProcessor2D< T, DESCRIPTOR, direction, orientation >, olb::FreeEnergyChemicalPotentialCoupling2D< T, DESCRIPTOR >, olb::FreeEnergyDensityOutletCoupling2D< T, DESCRIPTOR >, olb::FreeEnergyForceCoupling2D< T, DESCRIPTOR >, olb::FreeEnergyInletOutletCoupling2D< T, DESCRIPTOR >, olb::GlobalPostProcessor2D< T, DESCRIPTOR >, olb::MixedScaleBoussinesqCouplingPostProcessor2D< T, DESCRIPTOR >, olb::PhaseFieldCouplingPostProcessor2D< T, DESCRIPTOR >, olb::ReactionPostProcessor2D< T, DESCRIPTOR, REACTIONS >, olb::ShanChenDynOmegaForcedPostProcessor2D< T, DESCRIPTOR >, olb::ShanChenForcedSingleComponentPostProcessor2D< T, DESCRIPTOR >, olb::SlipBoundaryProcessor2D< T, DESCRIPTOR >, olb::SmagorinskyBoussinesqCouplingPostProcessor2D< T, DESCRIPTOR >, olb::VelocityBounceBackPostProcessor2D< T, DESCRIPTOR >, olb::VelocityBouzidiLinearPostProcessor2D< T, DESCRIPTOR >, olb::ZeroVelocityBounceBackPostProcessor2D< T, DESCRIPTOR >, and olb::ZeroVelocityBouzidiLinearPostProcessor2D< T, DESCRIPTOR >.

Member Data Documentation

_priority

template<typename T , typename DESCRIPTOR >

int olb::PostProcessor2D< T, DESCRIPTOR >::_priority

protected

Definition at line 64 of file postProcessing.h.

---

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

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