olb::forcing::AllenCahn::combined_collision< DESCRIPTOR, MOMENTA, EQUILIBRIUM, COLLISION > Struct Template Reference

#include <forcing.h>

Collaboration diagram for olb::forcing::AllenCahn::combined_collision< DESCRIPTOR, MOMENTA, EQUILIBRIUM, COLLISION >:

Public Types
using	MomentaF = typename MOMENTA::template type<DESCRIPTOR>
using	CollisionO = typename COLLISION::template type<DESCRIPTOR,MOMENTA,EQUILIBRIUM>

Public Member Functions
template<typename CELL , typename PARAMETERS , typename V = typename CELL::value_t>
CellStatistic< V >	apply (CELL &cell, PARAMETERS &parameters) any_platform

Detailed Description

template<typename DESCRIPTOR, typename MOMENTA, typename EQUILIBRIUM, typename COLLISION>
struct olb::forcing::AllenCahn::combined_collision< DESCRIPTOR, MOMENTA, EQUILIBRIUM, COLLISION >

Definition at line 276 of file forcing.h.

Member Typedef Documentation

CollisionO

template<typename DESCRIPTOR , typename MOMENTA , typename EQUILIBRIUM , typename COLLISION >

using olb::forcing::AllenCahn::combined_collision< DESCRIPTOR, MOMENTA, EQUILIBRIUM, COLLISION >::CollisionO = typename COLLISION::template type<DESCRIPTOR,MOMENTA,EQUILIBRIUM>

Definition at line 278 of file forcing.h.

MomentaF

template<typename DESCRIPTOR , typename MOMENTA , typename EQUILIBRIUM , typename COLLISION >

using olb::forcing::AllenCahn::combined_collision< DESCRIPTOR, MOMENTA, EQUILIBRIUM, COLLISION >::MomentaF = typename MOMENTA::template type<DESCRIPTOR>

Definition at line 277 of file forcing.h.

Member Function Documentation

apply()

template<typename DESCRIPTOR , typename MOMENTA , typename EQUILIBRIUM , typename COLLISION >

template<typename CELL , typename PARAMETERS , typename V = typename CELL::value_t>

CellStatistic< V > olb::forcing::AllenCahn::combined_collision< DESCRIPTOR, MOMENTA, EQUILIBRIUM, COLLISION >::apply ( CELL & cell, PARAMETERS & parameters )

inline

Definition at line 284 of file forcing.h.

                                                                            {
      V phi = MomentaF().computeRho(cell);
      CollisionO().apply(cell, parameters);
      const V omega = parameters.template get<descriptors::OMEGA>();
      const auto force = cell.template getField<descriptors::FORCE>();
      const auto u = cell.template getField<descriptors::VELOCITY>();
      const auto source = cell.template getField<descriptors::SOURCE>();
      lbm<DESCRIPTOR>::addAllenCahnForce(cell, omega, force);
      lbm<DESCRIPTOR>::addAllenCahnSource(cell, omega, source);
      return {phi, util::normSqr<V,DESCRIPTOR::d>(u)};
    };

References olb::lbm< DESCRIPTOR >::addAllenCahnForce(), olb::lbm< DESCRIPTOR >::addAllenCahnSource(), and olb::util::normSqr().

Here is the call graph for this function:

---

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

• src/dynamics/forcing.h