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

#include <localVelocity2D.h>

Collaboration diagram for olb::boundary::LocalVelocity< 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::LocalVelocity< T, DESCRIPTOR, MixinDynamics >

Definition at line 38 of file localVelocity3D.h.

Member Typedef Documentation

descriptor_t

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

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

Definition at line 42 of file localVelocity2D.h.

value_t

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

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

Definition at line 41 of file localVelocity2D.h.

Member Function Documentation

getDynamics() [1/2]

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

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

inline

Definition at line 48 of file localVelocity2D.h.

                                                                                       {
  switch (type) {
  case DiscreteNormalType::Flat:
    return boundaryhelper::PlainMixinDynamicsForDirectionOrientationMomenta<T,DESCRIPTOR,
      CombinedRLBdynamics,MixinDynamics,momenta::RegularizedVelocityBoundaryTuple
    >::construct(n);
 
  case DiscreteNormalType::ExternalCorner:
    return meta::id<typename MixinDynamics::template exchange_momenta<momenta::FixedVelocityBoundaryTuple>>{};
 
  case DiscreteNormalType::InternalCorner:
    return boundaryhelper::PlainMixinDynamicsForNormalMomenta<T,DESCRIPTOR,
      CombinedRLBdynamics,MixinDynamics,momenta::InnerCornerVelocityTuple2D
    >::construct(n);
 
  default:
    return std::nullopt;
  }
}

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

getDynamics() [2/2]

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

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

inline

Definition at line 47 of file localVelocity3D.h.

                                                                                       {
  switch (type) {
  case DiscreteNormalType::Flat:
    if (n[0] != 0 && n[0] == -1) {
      return meta::id<CombinedRLBdynamics<T,DESCRIPTOR, MixinDynamics,
        momenta::RegularizedVelocityBoundaryTuple<0,-1>
      >>();
    }
    else if (n[0] != 0 && n[0] == 1) {
      return meta::id<CombinedRLBdynamics<T,DESCRIPTOR, MixinDynamics,
        momenta::RegularizedVelocityBoundaryTuple<0,1>
      >>();
    }
    else if (n[1] != 0 && n[1] == -1) {
      return meta::id<CombinedRLBdynamics<T,DESCRIPTOR, MixinDynamics,
        momenta::RegularizedVelocityBoundaryTuple<1,-1>
      >>();
    }
    else if (n[1] != 0 && n[1] == 1) {
      return meta::id<CombinedRLBdynamics<T,DESCRIPTOR, MixinDynamics,
        momenta::RegularizedVelocityBoundaryTuple<1,1>
      >>();
    }
    else if (n[2] != 0 && n[2] == -1) {
      return meta::id<CombinedRLBdynamics<T,DESCRIPTOR, MixinDynamics,
        momenta::RegularizedVelocityBoundaryTuple<2,-1>
      >>();
    }
    else if (n[2] != 0 && n[2] == 1) {
      return meta::id<CombinedRLBdynamics<T,DESCRIPTOR, MixinDynamics,
        momenta::RegularizedVelocityBoundaryTuple<2,1>
      >>();
    }
    return std::nullopt;
 
  case DiscreteNormalType::ExternalCorner:
    return meta::id<typename MixinDynamics::template exchange_momenta<
      momenta::FixedVelocityBoundaryTuple
    >>();
 
  case DiscreteNormalType::InternalCorner:
    return boundaryhelper::PlainMixinDynamicsForNormalMomenta<T,DESCRIPTOR,
      CombinedRLBdynamics,MixinDynamics,momenta::InnerCornerVelocityTuple3D
    >::construct(n);
 
  case DiscreteNormalType::ExternalEdge:
    return meta::id<typename MixinDynamics::template exchange_momenta<
      momenta::FixedVelocityBoundaryTuple
    >>();
 
  case DiscreteNormalType::InternalEdge:
    return boundaryhelper::PlainMixinDynamicsForNormalSpecialMomenta<T,DESCRIPTOR,
      CombinedRLBdynamics,MixinDynamics,momenta::InnerEdgeVelocityTuple3D
    >::construct(n);
 
  default:
    return std::nullopt;
  }
}

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

getNeighborhoodRadius() [1/2]

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

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

inline

Definition at line 44 of file localVelocity2D.h.

                                     {
  return 2;
}

getNeighborhoodRadius() [2/2]

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

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

inline

Definition at line 43 of file localVelocity3D.h.

                                     {
  return 2;
}

getPostProcessor() [1/2]

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

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

inline

Definition at line 69 of file localVelocity2D.h.

                                                                                                 {
  switch (type) {
  case DiscreteNormalType::ExternalCorner:
    return boundaryhelper::promisePostProcessorForNormal<T,DESCRIPTOR,OuterVelocityCornerProcessor2D>(n);
 
  default:
    return std::nullopt;
  }
}

References olb::ExternalCorner, and olb::boundaryhelper::promisePostProcessorForNormal().

Here is the call graph for this function:

getPostProcessor() [2/2]

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

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

inline

Definition at line 108 of file localVelocity3D.h.

                                                                                                 {
  switch (type) {
  case DiscreteNormalType::ExternalCorner:
    return boundaryhelper::promisePostProcessorForNormal<T,DESCRIPTOR,OuterVelocityCornerProcessor3D>(n);
  case DiscreteNormalType::ExternalEdge:
    return boundaryhelper::promisePostProcessorForNormalSpecial<T,DESCRIPTOR,OuterVelocityEdgeProcessor3D>(n);
  default:
    return std::nullopt;
  }
}

References olb::ExternalCorner, olb::ExternalEdge, olb::boundaryhelper::promisePostProcessorForNormal(), and olb::boundaryhelper::promisePostProcessorForNormalSpecial().

Here is the call graph for this function:

---

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

• src/boundary/localVelocity2D.h
• src/boundary/localVelocity3D.h