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

#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 130 of file postProcessing.h.

Constructor & Destructor Documentation

◆ PostProcessor3D()

template<typename T , typename DESCRIPTOR >
olb::PostProcessor3D< T, DESCRIPTOR >::PostProcessor3D ( )
inline

Definition at line 132 of file postProcessing.h.

132 :
133 _priority{0} { }

◆ ~PostProcessor3D()

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

Definition at line 134 of file postProcessing.h.

134{ }

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::WallFunctionBoundaryProcessor3D< T, DESCRIPTOR >, olb::ShanChenDynOmegaForcedPostProcessor3D< T, DESCRIPTOR >, olb::SlipBoundaryProcessor3D< T, DESCRIPTOR >, olb::PartialSlipBoundaryProcessor3D< T, DESCRIPTOR >, olb::ExtendedFdPlaneBoundaryPostProcessor3D< T, DESCRIPTOR, direction, orientation >, olb::ZeroVelocityBouzidiLinearPostProcessor3D< T, DESCRIPTOR >, olb::ZeroVelocityBounceBackPostProcessor3D< T, DESCRIPTOR >, olb::VelocityBouzidiLinearPostProcessor3D< T, DESCRIPTOR >, olb::VelocityBounceBackPostProcessor3D< T, DESCRIPTOR >, olb::ConvectionBoundaryProcessor3D< T, DESCRIPTOR >, olb::ExtFieldBoundaryProcessor3D< T, DESCRIPTOR, FIELD_A, FIELD_B >, olb::ZeroDistributionBoundaryProcessor3D< T, DESCRIPTOR >, olb::GlobalPostProcessor3D< T, DESCRIPTOR >, olb::ConcentrationAdvectionDiffusionCouplingPostProcessor3D< T, DESCRIPTOR >, olb::FreeEnergyChemicalPotentialCoupling3D< T, DESCRIPTOR >, olb::FreeEnergyForceCoupling3D< T, DESCRIPTOR >, olb::FreeEnergyInletOutletCoupling3D< T, DESCRIPTOR >, olb::FreeEnergyDensityOutletCoupling3D< T, DESCRIPTOR >, olb::TotalEnthalpyPhaseChangeCouplingPostProcessor3D< T, DESCRIPTOR, DYNAMICS >, olb::PhaseFieldCouplingPostProcessor3D< T, DESCRIPTOR >, olb::SmagorinskyBoussinesqCouplingPostProcessor3D< T, DESCRIPTOR >, olb::AdvectionDiffusionParticleCouplingPostProcessor3D< T, DESCRIPTOR, ADLattice, FIELD_A, FIELD_B >, olb::PorousNavierStokesAdvectionDiffusionCouplingPostProcessor3D< T, DESCRIPTOR >, olb::MixedScaleBoussinesqCouplingPostProcessor3D< T, DESCRIPTOR >, olb::VolumeAveragedNavierStokesAdvectionDiffusionParticleCouplingPostProcessor3D< T, DESCRIPTOR, POROSITY, ADLattice, FIELD_A, FIELD_B >, olb::ShanChenForcedSingleComponentPostProcessor3D< T, DESCRIPTOR >, olb::AdsorptionCouplingPostProcessor3D< T, NSDESCRIPTOR, ADEDESCRIPTOR >, olb::PassiveSoluteCouplingPostProcessor3D< T, NSDESCRIPTOR, CADDESCRIPTOR >, olb::AdsorptionFullCouplingPostProcessor3D< T, NSDESCRIPTOR, ADEDESCRIPTOR >, olb::Eul2LagrPostProcessor3D< T, DESCRIPTOR >, olb::Eul2LagrNormDistrPostProcessor3D< T, DESCRIPTOR >, and olb::ReactionPostProcessor3D< T, DESCRIPTOR, REACTIONS >.

◆ 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::GlobalPostProcessor3D< T, DESCRIPTOR >, olb::WallFunctionBoundaryProcessor3D< T, DESCRIPTOR >, olb::ShanChenDynOmegaForcedPostProcessor3D< T, DESCRIPTOR >, olb::SlipBoundaryProcessor3D< T, DESCRIPTOR >, olb::PartialSlipBoundaryProcessor3D< T, DESCRIPTOR >, olb::ExtendedFdPlaneBoundaryPostProcessor3D< T, DESCRIPTOR, direction, orientation >, olb::ZeroVelocityBouzidiLinearPostProcessor3D< T, DESCRIPTOR >, olb::ZeroVelocityBounceBackPostProcessor3D< T, DESCRIPTOR >, olb::VelocityBouzidiLinearPostProcessor3D< T, DESCRIPTOR >, olb::VelocityBounceBackPostProcessor3D< T, DESCRIPTOR >, olb::ConvectionBoundaryProcessor3D< T, DESCRIPTOR >, olb::ExtFieldBoundaryProcessor3D< T, DESCRIPTOR, FIELD_A, FIELD_B >, olb::ZeroDistributionBoundaryProcessor3D< T, DESCRIPTOR >, olb::ConcentrationAdvectionDiffusionCouplingPostProcessor3D< T, DESCRIPTOR >, olb::FreeEnergyChemicalPotentialCoupling3D< T, DESCRIPTOR >, olb::FreeEnergyForceCoupling3D< T, DESCRIPTOR >, olb::FreeEnergyInletOutletCoupling3D< T, DESCRIPTOR >, olb::FreeEnergyDensityOutletCoupling3D< T, DESCRIPTOR >, olb::TotalEnthalpyPhaseChangeCouplingPostProcessor3D< T, DESCRIPTOR, DYNAMICS >, olb::PhaseFieldCouplingPostProcessor3D< T, DESCRIPTOR >, olb::SmagorinskyBoussinesqCouplingPostProcessor3D< T, DESCRIPTOR >, olb::AdvectionDiffusionParticleCouplingPostProcessor3D< T, DESCRIPTOR, ADLattice, FIELD_A, FIELD_B >, olb::PorousNavierStokesAdvectionDiffusionCouplingPostProcessor3D< T, DESCRIPTOR >, olb::MixedScaleBoussinesqCouplingPostProcessor3D< T, DESCRIPTOR >, olb::VolumeAveragedNavierStokesAdvectionDiffusionParticleCouplingPostProcessor3D< T, DESCRIPTOR, POROSITY, ADLattice, FIELD_A, FIELD_B >, olb::ShanChenForcedSingleComponentPostProcessor3D< T, DESCRIPTOR >, olb::AdsorptionCouplingPostProcessor3D< T, NSDESCRIPTOR, ADEDESCRIPTOR >, olb::PassiveSoluteCouplingPostProcessor3D< T, NSDESCRIPTOR, CADDESCRIPTOR >, olb::AdsorptionFullCouplingPostProcessor3D< T, NSDESCRIPTOR, ADEDESCRIPTOR >, olb::Eul2LagrPostProcessor3D< T, DESCRIPTOR >, olb::Eul2LagrNormDistrPostProcessor3D< T, DESCRIPTOR >, and olb::ReactionPostProcessor3D< T, DESCRIPTOR, REACTIONS >.

◆ 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.

193{
194 return _name;
195}
+ 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.

199{
200 return _name;
201}

◆ 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.

205{
206 return _priority;
207}

◆ 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::WallFunctionBoundaryProcessor3D< T, DESCRIPTOR >, olb::ShanChenDynOmegaForcedPostProcessor3D< T, DESCRIPTOR >, olb::SlipBoundaryProcessor3D< T, DESCRIPTOR >, olb::PartialSlipBoundaryProcessor3D< T, DESCRIPTOR >, olb::ExtendedFdPlaneBoundaryPostProcessor3D< T, DESCRIPTOR, direction, orientation >, olb::ZeroVelocityBouzidiLinearPostProcessor3D< T, DESCRIPTOR >, olb::ZeroVelocityBounceBackPostProcessor3D< T, DESCRIPTOR >, olb::VelocityBouzidiLinearPostProcessor3D< T, DESCRIPTOR >, olb::VelocityBounceBackPostProcessor3D< T, DESCRIPTOR >, olb::ConvectionBoundaryProcessor3D< T, DESCRIPTOR >, olb::ExtFieldBoundaryProcessor3D< T, DESCRIPTOR, FIELD_A, FIELD_B >, olb::ZeroDistributionBoundaryProcessor3D< T, DESCRIPTOR >, olb::ConcentrationAdvectionDiffusionCouplingPostProcessor3D< T, DESCRIPTOR >, olb::FreeEnergyChemicalPotentialCoupling3D< T, DESCRIPTOR >, olb::FreeEnergyForceCoupling3D< T, DESCRIPTOR >, olb::FreeEnergyInletOutletCoupling3D< T, DESCRIPTOR >, olb::FreeEnergyDensityOutletCoupling3D< T, DESCRIPTOR >, olb::TotalEnthalpyPhaseChangeCouplingPostProcessor3D< T, DESCRIPTOR, DYNAMICS >, olb::PhaseFieldCouplingPostProcessor3D< T, DESCRIPTOR >, olb::SmagorinskyBoussinesqCouplingPostProcessor3D< T, DESCRIPTOR >, olb::AdvectionDiffusionParticleCouplingPostProcessor3D< T, DESCRIPTOR, ADLattice, FIELD_A, FIELD_B >, olb::PorousNavierStokesAdvectionDiffusionCouplingPostProcessor3D< T, DESCRIPTOR >, olb::MixedScaleBoussinesqCouplingPostProcessor3D< T, DESCRIPTOR >, olb::VolumeAveragedNavierStokesAdvectionDiffusionParticleCouplingPostProcessor3D< T, DESCRIPTOR, POROSITY, ADLattice, FIELD_A, FIELD_B >, olb::ShanChenForcedSingleComponentPostProcessor3D< T, DESCRIPTOR >, olb::Eul2LagrPostProcessor3D< T, DESCRIPTOR >, olb::Eul2LagrNormDistrPostProcessor3D< T, DESCRIPTOR >, olb::ReactionPostProcessor3D< T, DESCRIPTOR, REACTIONS >, and olb::GlobalPostProcessor3D< 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::Eul2LagrPostProcessor3D< T, DESCRIPTOR >, olb::Eul2LagrNormDistrPostProcessor3D< T, DESCRIPTOR >, olb::ReactionPostProcessor3D< T, DESCRIPTOR, REACTIONS >, olb::WallFunctionBoundaryProcessor3D< T, DESCRIPTOR >, olb::ShanChenDynOmegaForcedPostProcessor3D< T, DESCRIPTOR >, olb::SlipBoundaryProcessor3D< T, DESCRIPTOR >, olb::PartialSlipBoundaryProcessor3D< T, DESCRIPTOR >, olb::ExtendedFdPlaneBoundaryPostProcessor3D< T, DESCRIPTOR, direction, orientation >, olb::ZeroVelocityBouzidiLinearPostProcessor3D< T, DESCRIPTOR >, olb::ZeroVelocityBounceBackPostProcessor3D< T, DESCRIPTOR >, olb::VelocityBouzidiLinearPostProcessor3D< T, DESCRIPTOR >, olb::VelocityBounceBackPostProcessor3D< T, DESCRIPTOR >, olb::ConvectionBoundaryProcessor3D< T, DESCRIPTOR >, olb::ExtFieldBoundaryProcessor3D< T, DESCRIPTOR, FIELD_A, FIELD_B >, olb::ZeroDistributionBoundaryProcessor3D< T, DESCRIPTOR >, olb::GlobalPostProcessor3D< T, DESCRIPTOR >, olb::ConcentrationAdvectionDiffusionCouplingPostProcessor3D< T, DESCRIPTOR >, olb::FreeEnergyChemicalPotentialCoupling3D< T, DESCRIPTOR >, olb::FreeEnergyForceCoupling3D< T, DESCRIPTOR >, olb::FreeEnergyInletOutletCoupling3D< T, DESCRIPTOR >, olb::FreeEnergyDensityOutletCoupling3D< T, DESCRIPTOR >, olb::TotalEnthalpyPhaseChangeCouplingPostProcessor3D< T, DESCRIPTOR, DYNAMICS >, olb::PhaseFieldCouplingPostProcessor3D< T, DESCRIPTOR >, olb::SmagorinskyBoussinesqCouplingPostProcessor3D< T, DESCRIPTOR >, olb::AdvectionDiffusionParticleCouplingPostProcessor3D< T, DESCRIPTOR, ADLattice, FIELD_A, FIELD_B >, olb::PorousNavierStokesAdvectionDiffusionCouplingPostProcessor3D< T, DESCRIPTOR >, olb::MixedScaleBoussinesqCouplingPostProcessor3D< T, DESCRIPTOR >, olb::VolumeAveragedNavierStokesAdvectionDiffusionParticleCouplingPostProcessor3D< T, DESCRIPTOR, POROSITY, ADLattice, FIELD_A, FIELD_B >, and olb::ShanChenForcedSingleComponentPostProcessor3D< 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: