olb::boundary::AdvectionDiffusionDirichlet< T, DESCRIPTOR, MixinDynamics > Struct Template Reference

#include <advectionDiffusionDirichlet2D.h>

Collaboration diagram for olb::boundary::AdvectionDiffusionDirichlet< T, DESCRIPTOR, MixinDynamics >:

Public Types
using	value_t = T
using	descriptor_t = DESCRIPTOR

Public Member Functions
CellDistance	getNeighborhoodRadius ()
std::optional< DynamicsPromise< T, DESCRIPTOR > >	getDynamics (DiscreteNormalType type, DiscreteNormal< DESCRIPTOR > n)
std::optional< PostProcessorPromise< T, DESCRIPTOR > >	getPostProcessor (DiscreteNormalType type, DiscreteNormal< DESCRIPTOR > n)
CellDistance	getNeighborhoodRadius ()
std::optional< DynamicsPromise< T, DESCRIPTOR > >	getDynamics (DiscreteNormalType type, DiscreteNormal< DESCRIPTOR > n)
std::optional< PostProcessorPromise< T, DESCRIPTOR > >	getPostProcessor (DiscreteNormalType type, DiscreteNormal< DESCRIPTOR > n)

Detailed Description

template<concepts::BaseType T, concepts::LatticeDescriptor DESCRIPTOR, typename MixinDynamics>
requires (DESCRIPTOR::d == 3)
struct olb::boundary::AdvectionDiffusionDirichlet< T, DESCRIPTOR, MixinDynamics >

Definition at line 37 of file advectionDiffusionDirichlet3D.h.

Member Typedef Documentation

descriptor_t

template<concepts::BaseType T, concepts::LatticeDescriptor DESCRIPTOR, typename MixinDynamics >

typedef DESCRIPTOR olb::boundary::AdvectionDiffusionDirichlet< T, DESCRIPTOR, MixinDynamics >::descriptor_t = DESCRIPTOR

Definition at line 39 of file advectionDiffusionDirichlet2D.h.

value_t

template<concepts::BaseType T, concepts::LatticeDescriptor DESCRIPTOR, typename MixinDynamics >

typedef T olb::boundary::AdvectionDiffusionDirichlet< T, DESCRIPTOR, MixinDynamics >::value_t = T

Definition at line 38 of file advectionDiffusionDirichlet2D.h.

Member Function Documentation

getDynamics() [1/2]

template<concepts::BaseType T, concepts::LatticeDescriptor DESCRIPTOR, typename MixinDynamics >

std::optional< DynamicsPromise< T, DESCRIPTOR > > olb::boundary::AdvectionDiffusionDirichlet< T, DESCRIPTOR, MixinDynamics >::getDynamics ( DiscreteNormalType type, DiscreteNormal< DESCRIPTOR > n )

inline

Definition at line 45 of file advectionDiffusionDirichlet2D.h.

                                                                                       {
  switch (type) {
  case DiscreteNormalType::Flat:
    return boundaryhelper::DirectionOrientationMixinDynamicsForPlainMomenta<T,DESCRIPTOR,
          AdvectionDiffusionBoundariesDynamics,MixinDynamics,momenta::EquilibriumBoundaryTuple
    >::construct(n);
 
  case DiscreteNormalType::ExternalCorner:
    return boundaryhelper::NormalMixinDynamicsForPlainMomenta<T,DESCRIPTOR,
          AdvectionDiffusionCornerDynamics2D,MixinDynamics,momenta::EquilibriumBoundaryTuple
    >::construct(n);
 
  default:
    throw std::runtime_error("No valid discrete normal found. This BC is not suited for curved walls.");
  }
}

References olb::ExternalCorner, and olb::Flat.

getDynamics() [2/2]

template<concepts::BaseType T, concepts::LatticeDescriptor DESCRIPTOR, typename MixinDynamics >

std::optional< DynamicsPromise< T, DESCRIPTOR > > olb::boundary::AdvectionDiffusionDirichlet< T, DESCRIPTOR, MixinDynamics >::getDynamics ( DiscreteNormalType type, DiscreteNormal< DESCRIPTOR > n )

inline

Definition at line 46 of file advectionDiffusionDirichlet3D.h.

                                                                                       {
  switch (type) {
  case DiscreteNormalType::Flat:
    return boundaryhelper::DirectionOrientationMixinDynamicsForPlainMomenta<T,DESCRIPTOR,
            AdvectionDiffusionBoundariesDynamics,MixinDynamics,momenta::EquilibriumBoundaryTuple
    >::construct(n);
 
  case DiscreteNormalType::ExternalCorner:
    return boundaryhelper::NormalMixinDynamicsForPlainMomenta<T,DESCRIPTOR,
          AdvectionDiffusionCornerDynamics3D,MixinDynamics,momenta::EquilibriumBoundaryTuple
    >::construct(n);
 
  case DiscreteNormalType::ExternalEdge:
    return boundaryhelper::NormalSpecialMixinDynamicsForPlainMomenta<T,DESCRIPTOR,
          AdvectionDiffusionEdgesDynamics,MixinDynamics,momenta::EquilibriumBoundaryTuple
    >::construct(n);
 
  default:
    throw std::runtime_error("No valid discrete normal found. This BC is not suited for curved walls.");
  }
}

References olb::ExternalCorner, olb::ExternalEdge, and olb::Flat.

getNeighborhoodRadius() [1/2]

template<concepts::BaseType T, concepts::LatticeDescriptor DESCRIPTOR, typename MixinDynamics >

CellDistance olb::boundary::AdvectionDiffusionDirichlet< T, DESCRIPTOR, MixinDynamics >::getNeighborhoodRadius ( )

inline

Definition at line 41 of file advectionDiffusionDirichlet2D.h.

                                     {
  return 1;
}

getNeighborhoodRadius() [2/2]

template<concepts::BaseType T, concepts::LatticeDescriptor DESCRIPTOR, typename MixinDynamics >

CellDistance olb::boundary::AdvectionDiffusionDirichlet< T, DESCRIPTOR, MixinDynamics >::getNeighborhoodRadius ( )

inline

Definition at line 42 of file advectionDiffusionDirichlet3D.h.

                                     {
  return 1;
}

getPostProcessor() [1/2]

template<concepts::BaseType T, concepts::LatticeDescriptor DESCRIPTOR, typename MixinDynamics >

std::optional< PostProcessorPromise< T, DESCRIPTOR > > olb::boundary::AdvectionDiffusionDirichlet< T, DESCRIPTOR, MixinDynamics >::getPostProcessor ( DiscreteNormalType type, DiscreteNormal< DESCRIPTOR > n )

inline

Definition at line 63 of file advectionDiffusionDirichlet2D.h.

                                                                                                 {
    return std::nullopt;
  }

getPostProcessor() [2/2]

template<concepts::BaseType T, concepts::LatticeDescriptor DESCRIPTOR, typename MixinDynamics >

std::optional< PostProcessorPromise< T, DESCRIPTOR > > olb::boundary::AdvectionDiffusionDirichlet< T, DESCRIPTOR, MixinDynamics >::getPostProcessor ( DiscreteNormalType type, DiscreteNormal< DESCRIPTOR > n )

inline

Definition at line 69 of file advectionDiffusionDirichlet3D.h.

                                                                                                 {
    return std::nullopt;
}

---

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

• src/boundary/advectionDiffusionDirichlet2D.h
• src/boundary/advectionDiffusionDirichlet3D.h