olb::equilibria::FreeEnergy::type< DESCRIPTOR, MOMENTA > Struct Template Reference

#include <freeEnergyDynamics.h>

Collaboration diagram for olb::equilibria::FreeEnergy::type< DESCRIPTOR, MOMENTA >:

Public Types
using	MomentaF = typename MOMENTA::template type<DESCRIPTOR>

Public Member Functions
template<typename RHO , typename U , typename V = RHO>
auto	compute (int iPop, const RHO &rho, const U &u) any_platform
template<typename CELL , typename PARAMETERS , typename FEQ , typename V = typename CELL::value_t>
CellStatistic< V >	compute (CELL &cell, PARAMETERS &parameters, FEQ &fEq) any_platform

Detailed Description

template<typename DESCRIPTOR, typename MOMENTA>
struct olb::equilibria::FreeEnergy::type< DESCRIPTOR, MOMENTA >

Definition at line 49 of file freeEnergyDynamics.h.

Member Typedef Documentation

MomentaF

template<typename DESCRIPTOR , typename MOMENTA >

using olb::equilibria::FreeEnergy::type< DESCRIPTOR, MOMENTA >::MomentaF = typename MOMENTA::template type<DESCRIPTOR>

Definition at line 50 of file freeEnergyDynamics.h.

Member Function Documentation

compute() [1/2]

template<typename DESCRIPTOR , typename MOMENTA >

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

CellStatistic< V > olb::equilibria::FreeEnergy::type< DESCRIPTOR, MOMENTA >::compute ( CELL & cell, PARAMETERS & parameters, FEQ & fEq )

inline

Definition at line 64 of file freeEnergyDynamics.h.

                                                                                        {
      auto u = cell.template getField<descriptors::FORCE>();
      V rho = MomentaF().computeRho(cell);
      const V uSqr = util::normSqr<V,DESCRIPTOR::d>(u);
      for (int iPop=0; iPop < DESCRIPTOR::q; ++iPop) {
        fEq[iPop] = equilibrium<DESCRIPTOR>::secondOrder(iPop, rho, u, uSqr);
      }
      return {rho, uSqr};
    };

References olb::equilibrium< DESCRIPTOR >::secondOrder().

Here is the call graph for this function:

compute() [2/2]

template<typename DESCRIPTOR , typename MOMENTA >

template<typename RHO , typename U , typename V = RHO>

auto olb::equilibria::FreeEnergy::type< DESCRIPTOR, MOMENTA >::compute ( int iPop, const RHO & rho, const U & u )

inline

Definition at line 53 of file freeEnergyDynamics.h.

                                                                    {
      V eq = equilibrium<DESCRIPTOR>::secondOrder(iPop, rho, u);
      if (iPop == 0) {
        eq += (V{1} - descriptors::t<V,DESCRIPTOR>(0)) * rho;
      } else {
        eq -= descriptors::t<V,DESCRIPTOR>(iPop) * rho;
      }
      return eq;
    }

References olb::equilibrium< DESCRIPTOR >::secondOrder().

Here is the call graph for this function:

---

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

• src/dynamics/freeEnergyDynamics.h