cell.h

Go to the documentation of this file.

/*  This file is part of the OpenLB library
 *
 *  Copyright (C) 2006-2007 Jonas Latt,
 *                2015-2019 Mathias J. Krause, Adrian Kummerlaender
 *  E-mail contact: info@openlb.net
 *  The most recent release of OpenLB can be downloaded at
 *  <http://www.openlb.net/>
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU General Public License
 *  as published by the Free Software Foundation; either version 2
 *  of the License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public
 *  License along with this program; if not, write to the Free
 *  Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 *  Boston, MA  02110-1301, USA.
*/
 
#ifndef CELL_H
#define CELL_H
 
#include <type_traits>
 
#include "util.h"
#include "meta.h"
#include "utilities/aliases.h"
 
#include "fieldArrayD.h"
 
namespace olb {
 
template<typename T> struct CellStatistic;
template<typename T> class LatticeStatistics;
template<typename T, typename DESCRIPTOR> struct Dynamics;
template<typename T, typename DESCRIPTOR> class BlockLattice;
template<typename T, typename DESCRIPTOR> class Cell;
 
 
template<typename T, typename DESCRIPTOR>
class ConstCell {
private:
  ConstCell<T,DESCRIPTOR>& self() const;
 
protected:
  friend Cell<T,DESCRIPTOR>;
 
  std::size_t _iCell;
  BlockLattice<T,DESCRIPTOR>& _block;
 
  Vector<T*,DESCRIPTOR::q> _populations;
 
public:
  using value_t = T;
  using descriptor_t = DESCRIPTOR;
 
  ConstCell(const BlockLattice<T,DESCRIPTOR>& block,
            std::size_t iCell);
 
  std::size_t getCellId() const;
 
 
  void setCellId(std::size_t iCell)
  {
    _iCell = iCell;
    _populations = _block.getPopulationPointers(iCell);
  }
 
  bool operator==(ConstCell<T,DESCRIPTOR>& rhs) const;
  bool operator!=(ConstCell<T,DESCRIPTOR>& rhs) const;
  bool operator< (ConstCell<T,DESCRIPTOR>& rhs) const;
  bool operator<=(ConstCell<T,DESCRIPTOR>& rhs) const;
 
  ConstCell<T,DESCRIPTOR> neighbor(Vector<int,DESCRIPTOR::d> c) const;
 
 
  T operator[](unsigned iPop) const;
 
  template <typename FIELD>
  auto getFieldPointer(FIELD field = FIELD()) const;
  template <typename FIELD>
  auto getFieldComponent(unsigned iD) const;
  template <typename FIELD>
  auto getField(FIELD field = FIELD()) const;
 
  const Dynamics<T,DESCRIPTOR>* getDynamics() const;
 
  template <typename FIELD>
  void computeField(T* data) const;
  T computeRho() const;
  void computeU(T u[descriptors::d<DESCRIPTOR>()]) const;
  void computeJ(T j[descriptors::d<DESCRIPTOR>()]) const;
  void computeStress(T pi[util::TensorVal<DESCRIPTOR >::n]) const;
  void computeRhoU(T& rho, T u[descriptors::d<DESCRIPTOR>()]) const;
  void computeFeq(T fEq[descriptors::q<DESCRIPTOR>()]) const;
  void computeFneq(T fNeq[descriptors::q<DESCRIPTOR>()]) const;
  void computeAllMomenta(
    T& rho, T u[descriptors::d<DESCRIPTOR>()],
    T pi[util::TensorVal<DESCRIPTOR >::n] ) const;
 
};
 
template<typename T, typename DESCRIPTOR>
class Cell : public ConstCell<T,DESCRIPTOR> {
public:
  Cell(BlockLattice<T,DESCRIPTOR>& block,
       std::size_t iCell):
    ConstCell<T,DESCRIPTOR>(block, iCell)
  { }
 
  Cell<T,DESCRIPTOR> neighbor(Vector<int,DESCRIPTOR::d> c);
 
 
  T& operator[](unsigned iPop);
 
  template <typename FIELD>
  auto getFieldPointer(FIELD field = FIELD());
 
  template <typename FIELD>
  void setField(const FieldD<T,DESCRIPTOR,FIELD>& field);
  template <typename FIELD>
  std::enable_if_t<(DESCRIPTOR::template size<FIELD>() == 1), void>
  setField(typename FIELD::template value_type<T> value);
 
  template <typename FIELD>
  void setFieldComponent(unsigned iD, typename FIELD::template value_type<T> value);
 
  Dynamics<T,DESCRIPTOR>* getDynamics();
 
  void revert();
 
  CellStatistic<T> collide();
 
  void defineRho(T rho);
  void defineU(const T u[descriptors::d<DESCRIPTOR>()]);
  void defineRhoU(T rho, const T u[descriptors::d<DESCRIPTOR>()]);
  void definePopulations(const T* f_);
  void iniEquilibrium(T rho, const T u[descriptors::d<DESCRIPTOR>()]);
  void iniRegularized(T rho, const T u[descriptors::d<DESCRIPTOR>()], const T pi[util::TensorVal<DESCRIPTOR >::n]);
 
};
 
}
 
#endif