olb::ForceCoupling2D Struct Reference

#include <freeEnergyCoupling2D.h>

Collaboration diagram for olb::ForceCoupling2D:

Public Member Functions
template<typename CELLS >
void	apply (CELLS &cells) any_platform

Static Public Attributes
static constexpr OperatorScope	scope = OperatorScope::PerCell

Detailed Description

Definition at line 170 of file freeEnergyCoupling2D.h.

Member Function Documentation

apply()

template<typename CELLS >

void olb::ForceCoupling2D::apply ( CELLS & cells )

inline

Definition at line 176 of file freeEnergyCoupling2D.h.

                                        {
 
    using V = typename CELLS::template value_t<names::A>::value_t;
    using DESCRIPTOR = typename CELLS::template value_t<names::A>::descriptor_t;
 
    // Get the cell of the first lattice
    auto& cellA = cells.template get<names::A>();
 
    // Get the cell of the second lattice
    auto& cellB = cells.template get<names::B>();
 
    V u[2] { };
    V phi = cellA.computeRho();
    V rho = cellB.computeRho();
 
    /*
    * Calculatations for lattice A. The neighbours of the currently
    * looked at cell (i.e. cell 0) are ordered as following:
    *
    *    1 - 8 - 7
    *    |   |   |
    *    2 - 0 - 6
    *    |   |   |
    *    3 - 4 - 5
    *
    */
    auto cellA1 = cellA.neighbor(descriptors::c<DESCRIPTOR>(1));
    auto cellA2 = cellA.neighbor(descriptors::c<DESCRIPTOR>(2));
    auto cellA3 = cellA.neighbor(descriptors::c<DESCRIPTOR>(3));
 
    auto cellA7 = cellA.neighbor(descriptors::c<DESCRIPTOR>(7));
    auto cellA6 = cellA.neighbor(descriptors::c<DESCRIPTOR>(6));
    auto cellA5 = cellA.neighbor(descriptors::c<DESCRIPTOR>(5));
 
    // 1/12 * ( -A1 -4*A2 -A3   +A7 +4*A6 +A5)
    V gradMuPhiX = 1./12. * (
    -      cellA1.template getField<descriptors::CHEM_POTENTIAL>()
    - 4. * cellA2.template getField<descriptors::CHEM_POTENTIAL>()
    -      cellA3.template getField<descriptors::CHEM_POTENTIAL>()
    +      cellA7.template getField<descriptors::CHEM_POTENTIAL>()
    + 4. * cellA6.template getField<descriptors::CHEM_POTENTIAL>()
    +      cellA5.template getField<descriptors::CHEM_POTENTIAL>());
 
    auto cellA8 = cellA.neighbor(descriptors::c<DESCRIPTOR>(8));
    auto cellA4 = cellA.neighbor(descriptors::c<DESCRIPTOR>(4));
 
    // 1/12 * ( +A1 +4*A8 +A7    -A3 -4*A4 -A5)
    V gradMuPhiY = 1./12. * (
    +      cellA1.template getField<descriptors::CHEM_POTENTIAL>()
    + 4. * cellA8.template getField<descriptors::CHEM_POTENTIAL>()
    +      cellA7.template getField<descriptors::CHEM_POTENTIAL>()
    -      cellA3.template getField<descriptors::CHEM_POTENTIAL>()
    - 4. * cellA4.template getField<descriptors::CHEM_POTENTIAL>()
    -      cellA5.template getField<descriptors::CHEM_POTENTIAL>());
 
    /*
    * Calculatations for lattice B. The neighbours of the currently
    * looked at cell (i.e. cell 0) are ordered as following:
    *
    *    1 - 8 - 7
    *    |   |   |
    *    2 - 0 - 6
    *    |   |   |
    *    3 - 4 - 5
    */
    auto cellB1 = cellB.neighbor(descriptors::c<DESCRIPTOR>(1));
    auto cellB2 = cellB.neighbor(descriptors::c<DESCRIPTOR>(2));
    auto cellB3 = cellB.neighbor(descriptors::c<DESCRIPTOR>(3));
 
    auto cellB7 = cellB.neighbor(descriptors::c<DESCRIPTOR>(7));
    auto cellB6 = cellB.neighbor(descriptors::c<DESCRIPTOR>(6));
    auto cellB5 = cellB.neighbor(descriptors::c<DESCRIPTOR>(5));
 
    // 1/12 * ( -B1 -4*B2 -B3   +B7 +4*B6 +B5)
    V gradMuRhoX = 1./12. * (
    -      cellB1.template getField<descriptors::CHEM_POTENTIAL>()
    - 4. * cellB2.template getField<descriptors::CHEM_POTENTIAL>()
    -      cellB3.template getField<descriptors::CHEM_POTENTIAL>()
    +      cellB7.template getField<descriptors::CHEM_POTENTIAL>()
    + 4. * cellB6.template getField<descriptors::CHEM_POTENTIAL>()
    +      cellB5.template getField<descriptors::CHEM_POTENTIAL>());
 
    auto cellB8 = cellB.neighbor(descriptors::c<DESCRIPTOR>(8));
    auto cellB4 = cellB.neighbor(descriptors::c<DESCRIPTOR>(4));
 
    // 1/12 * ( +B1 +4*B8 +B7    -B3 -4*B4 -B5)
    V gradMuRhoY = 1./12. * (
    +      cellB1.template getField<descriptors::CHEM_POTENTIAL>()
    + 4. * cellB8.template getField<descriptors::CHEM_POTENTIAL>()
    +      cellB7.template getField<descriptors::CHEM_POTENTIAL>()
    -      cellB3.template getField<descriptors::CHEM_POTENTIAL>()
    - 4. * cellB4.template getField<descriptors::CHEM_POTENTIAL>()
    -      cellB5.template getField<descriptors::CHEM_POTENTIAL>());
 
 
 
    // Get the cell of the third lattice, if it is provided
    if constexpr (CELLS::map_t::keys_t::template contains<names::C>()){
      auto& cellC = cells.template get<names::C>();
      V psi = cellC.computeRho();
 
      auto cellC1 = cellC.neighbor(descriptors::c<DESCRIPTOR>(1));
      auto cellC2 = cellC.neighbor(descriptors::c<DESCRIPTOR>(2));
      auto cellC3 = cellC.neighbor(descriptors::c<DESCRIPTOR>(3));
 
      auto cellC7 = cellC.neighbor(descriptors::c<DESCRIPTOR>(7));
      auto cellC6 = cellC.neighbor(descriptors::c<DESCRIPTOR>(6));
      auto cellC5 = cellC.neighbor(descriptors::c<DESCRIPTOR>(5));
 
 
      // 1/12 * ( -C1 -4*C2 -C3   +C7 +4*C6 +C5)
      V gradMuPsiX = 1./12. * (
      -     cellC1.template getField<descriptors::CHEM_POTENTIAL>()
      - 4 * cellC2.template getField<descriptors::CHEM_POTENTIAL>()
      -     cellC3.template getField<descriptors::CHEM_POTENTIAL>()
      +     cellC7.template getField<descriptors::CHEM_POTENTIAL>()
      + 4 * cellC6.template getField<descriptors::CHEM_POTENTIAL>()
      +     cellC5.template getField<descriptors::CHEM_POTENTIAL>());
 
      auto cellC8 = cellC.neighbor(descriptors::c<DESCRIPTOR>(8));
      auto cellC4 = cellC.neighbor(descriptors::c<DESCRIPTOR>(4));
 
      // 1/12 * ( +C1 +4*C8 +C7    -C3 -4*C4 -C5)
      V gradMuPsiY = 1./12. * (
      +     cellC1.template getField<descriptors::CHEM_POTENTIAL>()
      + 4 * cellC8.template getField<descriptors::CHEM_POTENTIAL>()
      +     cellC7.template getField<descriptors::CHEM_POTENTIAL>()
      -     cellC3.template getField<descriptors::CHEM_POTENTIAL>()
      - 4 * cellC4.template getField<descriptors::CHEM_POTENTIAL>()
      -     cellC5.template getField<descriptors::CHEM_POTENTIAL>());
 
      cellB.template setField<descriptors::FORCE>({
        - rho*gradMuRhoX - phi*gradMuPhiX - psi*gradMuPsiX,
        - rho*gradMuRhoY - phi*gradMuPhiY - psi*gradMuPsiY
      });
 
      cellB.computeU(u);
      cellA.template setField<descriptors::FORCE>(u);
      cellC.template setField<descriptors::FORCE>(u);
 
    } else {
 
      cellB.template setField<descriptors::FORCE>({
        - rho*gradMuRhoX - phi*gradMuPhiX,
        - rho*gradMuRhoY - phi*gradMuPhiY
      });
 
      cellB.computeU(u);
      cellA.template setField<descriptors::FORCE>(u);
    }
 
  }

Member Data Documentation

scope

constexpr OperatorScope olb::ForceCoupling2D::scope = OperatorScope::PerCell

staticconstexpr

Definition at line 173 of file freeEnergyCoupling2D.h.

---

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

• src/dynamics/freeEnergyCoupling2D.h