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

#include <phaseFieldWall2D.h>

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

Definition at line 63 of file phaseFieldWall3D.h.

Member Typedef Documentation

descriptor_t

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

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

Definition at line 174 of file phaseFieldWall2D.h.

value_t

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

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

Definition at line 173 of file phaseFieldWall2D.h.

Member Function Documentation

getDynamics() [1/2]

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

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

inline

Definition at line 180 of file phaseFieldWall2D.h.

                                                                                       {
  return meta::id<MixinDynamics>();
}

getDynamics() [2/2]

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

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

inline

Definition at line 72 of file phaseFieldWall3D.h.

                                                                                       {
  return meta::id<MixinDynamics>();
}

getNeighborhoodRadius() [1/2]

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

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

inline

Definition at line 176 of file phaseFieldWall2D.h.

                                     {
  return 1;
}

getNeighborhoodRadius() [2/2]

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

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

inline

Definition at line 68 of file phaseFieldWall3D.h.

                                     {
  return 1;
}

getPostProcessor() [1/2]

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

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

inline

Definition at line 185 of file phaseFieldWall2D.h.

                                                                                                 {
  return boundaryhelper::promisePostProcessorForNormal<T,DESCRIPTOR,FreeEnergyWallOrderParameterProcessor2D>(n);
}

References 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::FreeEnergyWallOrderParameter< T, DESCRIPTOR, MixinDynamics >::getPostProcessor ( DiscreteNormalType type, DiscreteNormal< DESCRIPTOR > n )

inline

Definition at line 77 of file phaseFieldWall3D.h.

                                                                                                 {
  return boundaryhelper::promisePostProcessorForNormal<T,DESCRIPTOR,FreeEnergyWallOrderParameterProcessor3D>(n);
}

References olb::boundaryhelper::promisePostProcessorForNormal().

Here is the call graph for this function:

---

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

• src/boundary/phaseFieldWall2D.h
• src/boundary/phaseFieldWall3D.h