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

#include <postProcessing.h>

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

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

Public Member Functions
	PostProcessor3D ()
virtual	~PostProcessor3D ()
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_, int z0_, int z1_)=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::PostProcessor3D< T, DESCRIPTOR >

Definition at line 44 of file aliases.h.

Constructor & Destructor Documentation

PostProcessor3D()

template<typename T , typename DESCRIPTOR >

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

inline

Definition at line 132 of file postProcessing.h.

                   :
    _priority{0} { }

~PostProcessor3D()

template<typename T , typename DESCRIPTOR >

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

inlinevirtual

Definition at line 134 of file postProcessing.h.

{ }

Member Function Documentation

extent() [1/2]

template<typename T , typename DESCRIPTOR >

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

pure virtual

Extent of application area (0 for purely local operations)

Implemented in olb::ConcentrationAdvectionDiffusionCouplingPostProcessor3D< T, DESCRIPTOR >, olb::ConvectionBoundaryProcessor3D< T, DESCRIPTOR >, olb::ExtendedFdPlaneBoundaryPostProcessor3D< T, DESCRIPTOR, direction, orientation >, olb::FreeEnergyChemicalPotentialCoupling3D< T, DESCRIPTOR >, olb::FreeEnergyDensityOutletCoupling3D< T, DESCRIPTOR >, olb::FreeEnergyForceCoupling3D< T, DESCRIPTOR >, olb::FreeEnergyInletOutletCoupling3D< T, DESCRIPTOR >, olb::GlobalPostProcessor3D< T, DESCRIPTOR >, olb::MixedScaleBoussinesqCouplingPostProcessor3D< T, DESCRIPTOR >, olb::PartialSlipBoundaryProcessor3D< T, DESCRIPTOR >, olb::PhaseFieldCouplingPostProcessor3D< T, DESCRIPTOR >, olb::PorousNavierStokesAdvectionDiffusionCouplingPostProcessor3D< T, DESCRIPTOR >, olb::ReactionPostProcessor3D< T, DESCRIPTOR, REACTIONS >, olb::ShanChenDynOmegaForcedPostProcessor3D< T, DESCRIPTOR >, olb::ShanChenForcedSingleComponentPostProcessor3D< T, DESCRIPTOR >, olb::SlipBoundaryProcessor3D< T, DESCRIPTOR >, olb::SmagorinskyBoussinesqCouplingPostProcessor3D< T, DESCRIPTOR >, olb::VelocityBounceBackPostProcessor3D< T, DESCRIPTOR >, olb::VelocityBouzidiLinearPostProcessor3D< T, DESCRIPTOR >, olb::VolumeAveragedNavierStokesAdvectionDiffusionParticleCouplingPostProcessor3D< T, DESCRIPTOR, POROSITY, ADLattice, FIELD_A, FIELD_B >, olb::WallFunctionBoundaryProcessor3D< T, DESCRIPTOR >, olb::ZeroDistributionBoundaryProcessor3D< T, DESCRIPTOR >, olb::ZeroVelocityBounceBackPostProcessor3D< T, DESCRIPTOR >, and olb::ZeroVelocityBouzidiLinearPostProcessor3D< T, DESCRIPTOR >.

extent() [2/2]

template<typename T , typename DESCRIPTOR >

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

pure virtual

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

Implemented in olb::ConcentrationAdvectionDiffusionCouplingPostProcessor3D< T, DESCRIPTOR >, olb::ConvectionBoundaryProcessor3D< T, DESCRIPTOR >, olb::ExtendedFdPlaneBoundaryPostProcessor3D< T, DESCRIPTOR, direction, orientation >, olb::FreeEnergyChemicalPotentialCoupling3D< T, DESCRIPTOR >, olb::FreeEnergyDensityOutletCoupling3D< T, DESCRIPTOR >, olb::FreeEnergyForceCoupling3D< T, DESCRIPTOR >, olb::FreeEnergyInletOutletCoupling3D< T, DESCRIPTOR >, olb::GlobalPostProcessor3D< T, DESCRIPTOR >, olb::MixedScaleBoussinesqCouplingPostProcessor3D< T, DESCRIPTOR >, olb::PartialSlipBoundaryProcessor3D< T, DESCRIPTOR >, olb::PhaseFieldCouplingPostProcessor3D< T, DESCRIPTOR >, olb::PorousNavierStokesAdvectionDiffusionCouplingPostProcessor3D< T, DESCRIPTOR >, olb::ReactionPostProcessor3D< T, DESCRIPTOR, REACTIONS >, olb::ShanChenDynOmegaForcedPostProcessor3D< T, DESCRIPTOR >, olb::ShanChenForcedSingleComponentPostProcessor3D< T, DESCRIPTOR >, olb::SlipBoundaryProcessor3D< T, DESCRIPTOR >, olb::SmagorinskyBoussinesqCouplingPostProcessor3D< T, DESCRIPTOR >, olb::VelocityBounceBackPostProcessor3D< T, DESCRIPTOR >, olb::VelocityBouzidiLinearPostProcessor3D< T, DESCRIPTOR >, olb::VolumeAveragedNavierStokesAdvectionDiffusionParticleCouplingPostProcessor3D< T, DESCRIPTOR, POROSITY, ADLattice, FIELD_A, FIELD_B >, olb::WallFunctionBoundaryProcessor3D< T, DESCRIPTOR >, olb::ZeroDistributionBoundaryProcessor3D< T, DESCRIPTOR >, olb::ZeroVelocityBounceBackPostProcessor3D< T, DESCRIPTOR >, and olb::ZeroVelocityBouzidiLinearPostProcessor3D< T, DESCRIPTOR >.

getName() [1/2]

template<typename T , typename DESCRIPTOR >

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

(

)

read and write access to name

Definition at line 192 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::PostProcessor3D< T, DESCRIPTOR >::getName

(

)

const

read only access to name

Definition at line 198 of file postProcessing.hh.

{
  return _name;
}

getPriority()

template<typename T , typename DESCRIPTOR >

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

(

)

const

read only access to priority

Definition at line 204 of file postProcessing.hh.

{
  return _priority;
}

process()

template<typename T , typename DESCRIPTOR >

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

pure virtual

Execute post-processing step.

Implemented in olb::ConcentrationAdvectionDiffusionCouplingPostProcessor3D< T, DESCRIPTOR >, olb::ConvectionBoundaryProcessor3D< T, DESCRIPTOR >, olb::ExtendedFdPlaneBoundaryPostProcessor3D< T, DESCRIPTOR, direction, orientation >, olb::FreeEnergyChemicalPotentialCoupling3D< T, DESCRIPTOR >, olb::FreeEnergyDensityOutletCoupling3D< T, DESCRIPTOR >, olb::FreeEnergyForceCoupling3D< T, DESCRIPTOR >, olb::FreeEnergyInletOutletCoupling3D< T, DESCRIPTOR >, olb::GlobalPostProcessor3D< T, DESCRIPTOR >, olb::MixedScaleBoussinesqCouplingPostProcessor3D< T, DESCRIPTOR >, olb::PartialSlipBoundaryProcessor3D< T, DESCRIPTOR >, olb::PhaseFieldCouplingPostProcessor3D< T, DESCRIPTOR >, olb::PorousNavierStokesAdvectionDiffusionCouplingPostProcessor3D< T, DESCRIPTOR >, olb::ReactionPostProcessor3D< T, DESCRIPTOR, REACTIONS >, olb::ShanChenDynOmegaForcedPostProcessor3D< T, DESCRIPTOR >, olb::ShanChenForcedSingleComponentPostProcessor3D< T, DESCRIPTOR >, olb::SlipBoundaryProcessor3D< T, DESCRIPTOR >, olb::SmagorinskyBoussinesqCouplingPostProcessor3D< T, DESCRIPTOR >, olb::VelocityBounceBackPostProcessor3D< T, DESCRIPTOR >, olb::VelocityBouzidiLinearPostProcessor3D< T, DESCRIPTOR >, olb::VolumeAveragedNavierStokesAdvectionDiffusionParticleCouplingPostProcessor3D< T, DESCRIPTOR, POROSITY, ADLattice, FIELD_A, FIELD_B >, olb::WallFunctionBoundaryProcessor3D< T, DESCRIPTOR >, olb::ZeroDistributionBoundaryProcessor3D< T, DESCRIPTOR >, olb::ZeroVelocityBounceBackPostProcessor3D< T, DESCRIPTOR >, and olb::ZeroVelocityBouzidiLinearPostProcessor3D< T, DESCRIPTOR >.

processSubDomain()

template<typename T , typename DESCRIPTOR >

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

pure virtual

Execute post-processing step on a sublattice.

Implemented in olb::ConcentrationAdvectionDiffusionCouplingPostProcessor3D< T, DESCRIPTOR >, olb::ConvectionBoundaryProcessor3D< T, DESCRIPTOR >, olb::ExtendedFdPlaneBoundaryPostProcessor3D< T, DESCRIPTOR, direction, orientation >, olb::FreeEnergyChemicalPotentialCoupling3D< T, DESCRIPTOR >, olb::FreeEnergyDensityOutletCoupling3D< T, DESCRIPTOR >, olb::FreeEnergyForceCoupling3D< T, DESCRIPTOR >, olb::FreeEnergyInletOutletCoupling3D< T, DESCRIPTOR >, olb::GlobalPostProcessor3D< T, DESCRIPTOR >, olb::MixedScaleBoussinesqCouplingPostProcessor3D< T, DESCRIPTOR >, olb::PartialSlipBoundaryProcessor3D< T, DESCRIPTOR >, olb::PhaseFieldCouplingPostProcessor3D< T, DESCRIPTOR >, olb::PorousNavierStokesAdvectionDiffusionCouplingPostProcessor3D< T, DESCRIPTOR >, olb::ReactionPostProcessor3D< T, DESCRIPTOR, REACTIONS >, olb::ShanChenDynOmegaForcedPostProcessor3D< T, DESCRIPTOR >, olb::ShanChenForcedSingleComponentPostProcessor3D< T, DESCRIPTOR >, olb::SlipBoundaryProcessor3D< T, DESCRIPTOR >, olb::SmagorinskyBoussinesqCouplingPostProcessor3D< T, DESCRIPTOR >, olb::VelocityBounceBackPostProcessor3D< T, DESCRIPTOR >, olb::VelocityBouzidiLinearPostProcessor3D< T, DESCRIPTOR >, olb::VolumeAveragedNavierStokesAdvectionDiffusionParticleCouplingPostProcessor3D< T, DESCRIPTOR, POROSITY, ADLattice, FIELD_A, FIELD_B >, olb::WallFunctionBoundaryProcessor3D< T, DESCRIPTOR >, olb::ZeroDistributionBoundaryProcessor3D< T, DESCRIPTOR >, olb::ZeroVelocityBounceBackPostProcessor3D< T, DESCRIPTOR >, and olb::ZeroVelocityBouzidiLinearPostProcessor3D< T, DESCRIPTOR >.

Member Data Documentation

_priority

template<typename T , typename DESCRIPTOR >

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

protected

Definition at line 152 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