entropicDynamics.h

Go to the documentation of this file.

/*  This file is part of the OpenLB library
 *
 *  Copyright (C) 2006, 2007, 2017 Orestis Malaspinas, Jonas Latt, Mathias J. Krause
 *  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 ENTROPIC_LB_DYNAMICS_H
#define ENTROPIC_LB_DYNAMICS_H
 
#include "dynamics/dynamics.h"
 
namespace olb {
 
 
template<typename T, typename DESCRIPTOR, typename MOMENTA=momenta::BulkTuple>
class EntropicEqDynamics : public legacy::BasicDynamics<T,DESCRIPTOR,MOMENTA> {
public:
  template<typename M>
  using exchange_momenta = EntropicEqDynamics<T,DESCRIPTOR,M>;
 
  EntropicEqDynamics(T omega_);
  T computeEquilibrium(int iPop, T rho, const T u[DESCRIPTOR::d], T uSqr) const override;
  CellStatistic<T> collide(Cell<T,DESCRIPTOR>& cell) override;
  T getOmega() const;
  void setOmega(T omega_);
private:
  T omega;  
};
 
template<typename T, typename DESCRIPTOR, typename MOMENTA=momenta::BulkTuple>
class ForcedEntropicEqDynamics : public legacy::BasicDynamics<T,DESCRIPTOR,MOMENTA> {
public:
  template<typename M>
  using exchange_momenta = ForcedEntropicEqDynamics<T,DESCRIPTOR,M>;
 
  ForcedEntropicEqDynamics(T omega_);
  virtual T computeEquilibrium(int iPop, T rho, const T u[DESCRIPTOR::d], T uSqr) const;
  virtual CellStatistic<T> collide(Cell<T,DESCRIPTOR>& cell);
  virtual T getOmega() const;
  virtual void setOmega(T omega_);
private:
  T omega;  
};
 
 
template<typename T, typename DESCRIPTOR, typename MOMENTA=momenta::BulkTuple>
class EntropicDynamics : public legacy::BasicDynamics<T,DESCRIPTOR,MOMENTA> {
public:
  template<typename M>
  using exchange_momenta = EntropicDynamics<T,DESCRIPTOR,M>;
 
  EntropicDynamics(T omega_);
  T computeEquilibrium(int iPop, T rho, const T u[DESCRIPTOR::d], T uSqr) const override;
  CellStatistic<T> collide(Cell<T,DESCRIPTOR>& cell) override;
  T getOmega() const;
  void setOmega(T omega_);
private:
  T computeEntropy(const T f[]);
  T computeEntropyGrowth(const T f[], const T fNeq[], const T &alpha);
  T computeEntropyGrowthDerivative(const T f[], const T fNeq[], const T &alpha);
  bool getAlpha(T &alpha, const T f[], const T fNeq[]);
 
  T omega;  
};
 
template<typename T, typename DESCRIPTOR, typename MOMENTA=momenta::BulkTuple>
class ForcedEntropicDynamics : public legacy::BasicDynamics<T,DESCRIPTOR,MOMENTA> {
public:
  template<typename M>
  using exchange_momenta = ForcedEntropicDynamics<T,DESCRIPTOR,M>;
 
  ForcedEntropicDynamics(T omega_);
  virtual T computeEquilibrium(int iPop, T rho, const T u[DESCRIPTOR::d], T uSqr) const;
  virtual CellStatistic<T> collide(Cell<T,DESCRIPTOR>& cell);
  virtual T getOmega() const;
  virtual void setOmega(T omega_);
private:
  T computeEntropy(const T f[]);
  T computeEntropyGrowth(const T f[], const T fNeq[], const T &alpha);
  T computeEntropyGrowthDerivative(const T f[], const T fNeq[], const T &alpha);
  bool getAlpha(T &alpha, const T f[], const T fNeq[]);
 
  T omega;  
};
}
 
#endif