isoThermalDynamics.h

Go to the documentation of this file.

/* This file is part of the Palabos library.
 *
 * Copyright (C) 2011 FlowKit Sarl
 * Avenue de Chailly 23
 * 1012 Lausanne, Switzerland
 * E-mail contact: contact@flowkit.com
 *
 * The most recent release of Palabos can be downloaded at 
 * <http://www.palabos.org/>
 *
 * The library Palabos is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * The library 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef ISO_THERMAL_DYNAMICS_H
#define ISO_THERMAL_DYNAMICS_H

#include "core/globalDefs.h"
#include "core/dynamics.h"

namespace plb {

template<typename T, template<typename U> class Descriptor>
class IsoThermalBulkDynamics : public BasicBulkDynamics<T,Descriptor> {
public:
    IsoThermalBulkDynamics(T omega_);

/* *************** Collision, Equilibrium, and Non-equilibrium ******* */

    virtual void regularize(Cell<T,Descriptor>& cell, T rhoBar, Array<T,Descriptor<T>::d> const& j,
                            T jSqr, Array<T,SymmetricTensor<T,Descriptor>::n> const& PiNeq, T thetaBar=T() ) const;

/* *************** Computation of macroscopic variables ************** */

    virtual T computeTemperature(Cell<T,Descriptor> const& cell) const;

    virtual void computeDeviatoricStress (
        Cell<T,Descriptor> const& cell, Array<T,SymmetricTensor<T,Descriptor>::n>& PiNeq ) const;

    virtual void computeHeatFlux( Cell<T,Descriptor> const& cell,
                                  Array<T,Descriptor<T>::d>& q ) const;

/* *************** Switch between population and moment representation ****** */


    virtual plint numDecomposedVariables(plint order) const;


    virtual void decompose(Cell<T,Descriptor> const& cell, std::vector<T>& rawData, plint order) const;


    virtual void recompose(Cell<T,Descriptor>& cell, std::vector<T> const& rawData, plint order) const;


    virtual void rescale(std::vector<T>& rawData, T xDxInv, T xDt, plint order) const;
    virtual void rescale(int dxScale, int dtScale) {
        Dynamics<T,Descriptor>::rescale(dxScale, dtScale);
    }
    

/* *************** Additional moments, intended for internal use ***** */

    virtual T computeEbar(Cell<T,Descriptor> const& cell) const;

private:
    virtual void decomposeOrder0(Cell<T,Descriptor> const& cell, std::vector<T>& rawData) const;
    virtual void decomposeOrder1(Cell<T,Descriptor> const& cell, std::vector<T>& rawData) const;
    virtual void recomposeOrder0(Cell<T,Descriptor>& cell, std::vector<T> const& rawData) const;
    virtual void recomposeOrder1(Cell<T,Descriptor>& cell, std::vector<T> const& rawData) const;
    virtual void rescaleOrder0(std::vector<T>& rawData, T xDxInv, T xDt) const;
    virtual void rescaleOrder1(std::vector<T>& rawData, T xDxInv, T xDt) const;
};

template<typename T, template<typename U> class Descriptor>
class BGKdynamics : public IsoThermalBulkDynamics<T,Descriptor> {
public:
/* *************** Construction / Destruction ************************ */
    BGKdynamics(T omega_);

    virtual BGKdynamics<T,Descriptor>* clone() const;

    virtual int getId() const;

/* *************** Collision and Equilibrium ************************* */

    virtual void collide(Cell<T,Descriptor>& cell,
                         BlockStatistics& statistics_);

    virtual void collide(Cell<T,Descriptor>& cell, T rhoBar,
                         Array<T,Descriptor<T>::d> const& j, T thetaBar, BlockStatistics& stat);

    virtual T computeEquilibrium(plint iPop, T rhoBar, Array<T,Descriptor<T>::d> const& j,
                                 T jSqr, T thetaBar=T()) const;
private:
    static int id;
};

template<typename T, template<typename U> class Descriptor>
class StoreRhoBarJBGKdynamics : public IsoThermalBulkDynamics<T,Descriptor> {
public:
/* *************** Construction / Destruction ************************ */
    StoreRhoBarJBGKdynamics(T omega_);

    virtual StoreRhoBarJBGKdynamics<T,Descriptor>* clone() const;

    virtual int getId() const;

/* *************** Collision and Equilibrium ************************* */

    virtual void collide(Cell<T,Descriptor>& cell,
                         BlockStatistics& statistics_);

    virtual void collide(Cell<T,Descriptor>& cell, T rhoBar,
                         Array<T,Descriptor<T>::d> const& j, T thetaBar, BlockStatistics& stat);

    virtual T computeEquilibrium(plint iPop, T rhoBar, Array<T,Descriptor<T>::d> const& j,
                                 T jSqr, T thetaBar=T()) const;
private:
    static int id;
};

template<typename T, template<typename U> class Descriptor>
class ExternalMomentBGKdynamics : public IsoThermalBulkDynamics<T,Descriptor> {
public:
/* *************** Construction / Destruction ************************ */
    ExternalMomentBGKdynamics(T omega_);

    virtual ExternalMomentBGKdynamics<T,Descriptor>* clone() const;

    virtual int getId() const;

/* *************** Collision and Equilibrium ************************* */

    virtual void collide(Cell<T,Descriptor>& cell,
                         BlockStatistics& statistics_);

    virtual void collide(Cell<T,Descriptor>& cell, T rhoBar,
                         Array<T,Descriptor<T>::d> const& j, T thetaBar, BlockStatistics& stat);

    virtual T computeEquilibrium(plint iPop, T rhoBar, Array<T,Descriptor<T>::d> const& j,
                                 T jSqr, T thetaBar=T()) const;

/* *************** Moments ******************************************* */

    // The function computeDensity() is not overridden, and the default
    //   implementation is kept, for two reasons. First, it is equivalent to access
    //   rho from the external scalar or to recompute it from the bulk (this
    //   is not the case for the velocity, in a Shan/Chen multicomponent model).
    //   Second, the Shan/Chen data-processor needs computeDensity() to be
    //   default implemented, because it uses this function to treat walls with
    //   a virtual-density mechanism.

    virtual void computeVelocity( Cell<T,Descriptor> const& cell,
                                  Array<T,Descriptor<T>::d>& u ) const;

    virtual T computeRhoBar(Cell<T,Descriptor> const& cell) const;


    virtual void computeRhoBarJ(Cell<T,Descriptor> const& cell,
                                T& rhoBar, Array<T,Descriptor<T>::d>& j) const;

private:
    static int id;
};

template<typename T, template<typename U> class Descriptor>
class ExternalVelocityBGKdynamics : public IsoThermalBulkDynamics<T,Descriptor> {
public:
/* *************** Construction / Destruction ************************ */
    ExternalVelocityBGKdynamics(T omega_);

    virtual ExternalVelocityBGKdynamics<T,Descriptor>* clone() const;

    virtual int getId() const;

/* *************** Collision and Equilibrium ************************* */

    virtual void collide(Cell<T,Descriptor>& cell,
                         BlockStatistics& statistics_);

    virtual void collide(Cell<T,Descriptor>& cell, T rhoBar,
                         Array<T,Descriptor<T>::d> const& j, T thetaBar=T());

    virtual T computeEquilibrium(plint iPop, T rhoBar, Array<T,Descriptor<T>::d> const& j,
                                 T jSqr, T thetaBar=T()) const;

/* *************** Moments ******************************************* */

    // The function computeDensity() is not overridden, and the default
    //   implementation is kept, for two reasons. First, it is equivalent to access
    //   rho from the external scalar or to recompute it from the bulk (this
    //   is not the case for the velocity, in a Shan/Chen multicomponent model).
    //   Second, the Shan/Chen data-processor needs computeDensity() to be
    //   default implemented, because it uses this function to treat walls with
    //   a virtual-density mechanism.

    virtual void computeVelocity( Cell<T,Descriptor> const& cell,
                                  Array<T,Descriptor<T>::d>& u ) const;

    virtual T computeRhoBar(Cell<T,Descriptor> const& cell) const;


    virtual void computeRhoBarJ(Cell<T,Descriptor> const& cell,
                                T& rhoBar, Array<T,Descriptor<T>::d>& j) const;

private:
    static int id;
};


template<typename T, template<typename U> class Descriptor>
class QuasiIncBGKdynamics : public BGKdynamics<T,Descriptor> {
public:
/* *************** Construction / Destruction ************************ */
    QuasiIncBGKdynamics(T omega_);

    virtual QuasiIncBGKdynamics<T,Descriptor>* clone() const;

    virtual int getId() const;

    virtual bool velIsJ() const;

/* *************** Macroscopic variables ***************************** */

    virtual void computeVelocity( Cell<T,Descriptor> const& cell,
                                  Array<T,Descriptor<T>::d>& u ) const;

    virtual void computeRhoBarJPiNeq( Cell<T,Descriptor> const& cell,
                                      T& rhoBar, Array<T,Descriptor<T>::d>& j,
                                      Array<T,SymmetricTensor<T,Descriptor>::n>& PiNeq ) const;
private:
    static int id;
};

template<typename T, template<typename U> class Descriptor>
class IncBGKdynamics : public IsoThermalBulkDynamics<T,Descriptor> {
public:
/* *************** Construction / Destruction ************************ */
    IncBGKdynamics(T omega_);

    virtual IncBGKdynamics<T,Descriptor>* clone() const;

    virtual int getId() const;

    virtual bool velIsJ() const;

/* *************** Collision and Equilibrium ************************* */

    virtual void computeVelocity( Cell<T,Descriptor> const& cell,
                                  Array<T,Descriptor<T>::d>& u ) const;

    virtual void computeRhoBarJPiNeq( Cell<T,Descriptor> const& cell,
                                      T& rhoBar, Array<T,Descriptor<T>::d>& j,
                                      Array<T,SymmetricTensor<T,Descriptor>::n>& PiNeq ) const;

    virtual void collide(Cell<T,Descriptor>& cell,
                         BlockStatistics& statistics_);

    virtual void collide(Cell<T,Descriptor>& cell, T rhoBar,
                         Array<T,Descriptor<T>::d> const& j, T thetaBar, BlockStatistics& stat);

    virtual T computeEquilibrium(plint iPop, T rhoBar, Array<T,Descriptor<T>::d> const& j,
                                 T jSqr, T thetaBar=T()) const;
private:
    static int id;
};

template<typename T, template<typename U> class Descriptor>
class ConstRhoBGKdynamics : public IsoThermalBulkDynamics<T,Descriptor> {
public:
/* *************** Construction / Destruction ************************ */
    ConstRhoBGKdynamics(T omega_);

    virtual ConstRhoBGKdynamics<T,Descriptor>* clone() const;

    virtual int getId() const;

/* *************** Collision and Equilibrium ************************* */

    virtual void collide(Cell<T,Descriptor>& cell,
                         BlockStatistics& statistics_);

    virtual T computeEquilibrium(plint iPop, T rhoBar, Array<T,Descriptor<T>::d> const& j,
                                 T jSqr, T thetaBar=T()) const;
private:
    static int id;
};


template<typename T, template<typename U> class Descriptor>
class RLBdynamics : public BulkCompositeDynamics<T,Descriptor> {
public:
/* *************** Construction / Destruction ************************ */
    RLBdynamics(Dynamics<T,Descriptor>* baseDynamics, bool automaticPrepareCollision=true);

    virtual RLBdynamics<T,Descriptor>* clone() const;

    virtual int getId() const;

/* *************** Completion algorithm and base dynamics ************ */

    virtual void completePopulations(Cell<T,Descriptor>& cell) const;
private:
    static int id;
};


template<typename T, template<typename U> class Descriptor>
class RegularizedBGKdynamics : public IsoThermalBulkDynamics<T,Descriptor> {
public:
/* *************** Construction / Destruction ************************ */
    RegularizedBGKdynamics(T omega_);

    virtual RegularizedBGKdynamics<T,Descriptor>* clone() const;

    virtual int getId() const;

/* *************** Collision and Equilibrium ************************* */

    virtual void collide(Cell<T,Descriptor>& cell,
                         BlockStatistics& statistics_);

    virtual void collide(Cell<T,Descriptor>& cell, T rhoBar,
                         Array<T,Descriptor<T>::d> const& j, T thetaBar, BlockStatistics& stat);

    virtual T computeEquilibrium(plint iPop, T rhoBar, Array<T,Descriptor<T>::d> const& j,
                                 T jSqr, T thetaBar=T()) const;
private:
    static int id;
};

template<typename T, template<typename U> class Descriptor>
class IncRegularizedBGKdynamics : public IsoThermalBulkDynamics<T,Descriptor> {
public:
/* *************** Construction / Destruction ************************ */
    IncRegularizedBGKdynamics(T omega_);

    virtual IncRegularizedBGKdynamics<T,Descriptor>* clone() const;

    virtual int getId() const;

/* *************** Collision and Equilibrium ************************* */

    virtual void computeVelocity( Cell<T,Descriptor> const& cell,
                                  Array<T,Descriptor<T>::d>& u ) const;

    virtual void computeRhoBarJPiNeq( Cell<T,Descriptor> const& cell,
                                      T& rhoBar, Array<T,Descriptor<T>::d>& j,
                                      Array<T,SymmetricTensor<T,Descriptor>::n>& PiNeq ) const;

    virtual void collide(Cell<T,Descriptor>& cell,
                         BlockStatistics& statistics_);

    virtual void collide(Cell<T,Descriptor>& cell, T rhoBar,
                         Array<T,Descriptor<T>::d> const& j, T thetaBar, BlockStatistics& stat);

    virtual T computeEquilibrium(plint iPop, T rhoBar, Array<T,Descriptor<T>::d> const& j,
                                 T jSqr, T thetaBar=T()) const;

    bool velIsJ() const;
private:
    static int id;
};

template<typename T, template<typename U> class Descriptor>
class ExternalMomentRegularizedBGKdynamics : public IsoThermalBulkDynamics<T,Descriptor> {
public:
/* *************** Construction / Destruction ************************ */
    ExternalMomentRegularizedBGKdynamics(T omega_);

    virtual ExternalMomentRegularizedBGKdynamics<T,Descriptor>* clone() const;

    virtual int getId() const;

/* *************** Collision and Equilibrium ************************* */

    virtual void collide(Cell<T,Descriptor>& cell,
                         BlockStatistics& statistics_);

    virtual void collide(Cell<T,Descriptor>& cell, T rhoBar,
                         Array<T,Descriptor<T>::d> const& j, T thetaBar, BlockStatistics& stat);

    virtual T computeEquilibrium(plint iPop, T rhoBar, Array<T,Descriptor<T>::d> const& j,
                                 T jSqr, T thetaBar=T()) const;

/* *************** Moments ******************************************* */

    // The function computeDensity() is not overridden, and the default
    //   implementation is kept, for two reasons. First, it is equivalent to access
    //   rho from the external scalar or to recompute it from the bulk (this
    //   is not the case for the velocity, in a Shan/Chen multicomponent model).
    //   Second, the Shan/Chen data-processor needs computeDensity() to be
    //   default implemented, because it uses this function to treat walls with
    //   a virtual-density mechanism.

    virtual void computeVelocity( Cell<T,Descriptor> const& cell,
                                  Array<T,Descriptor<T>::d>& u ) const;

    virtual T computeRhoBar(Cell<T,Descriptor> const& cell) const;


    virtual void computeRhoBarJ(Cell<T,Descriptor> const& cell,
                                T& rhoBar, Array<T,Descriptor<T>::d>& j) const;

private:
    static int id;
};

template<typename T, template<typename U> class Descriptor>
class ChopardDynamics : public IsoThermalBulkDynamics<T,Descriptor> {
public:
/* *************** Construction / Destruction ************************ */
    ChopardDynamics(T vs2_, T omega_);

    virtual ChopardDynamics<T,Descriptor>* clone() const;

    virtual int getId() const;

    virtual void serialize(HierarchicSerializer& serializer) const;

    virtual void unserialize(HierarchicUnserializer& unserializer);

/* *************** Collision and Equilibrium ************************* */

    virtual void collide(Cell<T,Descriptor>& cell,
                         BlockStatistics& statistics_);

    virtual void collide(Cell<T,Descriptor>& cell, T rhoBar,
                         Array<T,Descriptor<T>::d> const& j, T thetaBar, BlockStatistics& stat);

    virtual T computeEquilibrium(plint iPop, T rhoBar, Array<T,Descriptor<T>::d> const& j,
                                 T jSqr, T thetaBar=T()) const;
    
/* *************** Configurable parameters *************************** */

    virtual void setParameter(plint whichParameter, T value);
    virtual T getParameter(plint whichParameter) const;
    void setVs2(T vs2_);
    T    getVs2() const;

private:
/* *************** Static implementation methods********************** */

    static T chopardBgkCollision (
        Cell<T,Descriptor>& cell, T rhoBar, Array<T,Descriptor<T>::d> const& j, T vs2, T omega);
    static T chopardEquilibrium (
        plint iPop, T rhoBar, T invRho, Array<T,Descriptor<T>::d> const& j, T jSqr, T vs2);
private:
    T vs2;    
private:
    static int id;
};

template<typename T, template<typename U> class Descriptor>
class PrecondBGKdynamics : public IsoThermalBulkDynamics<T,Descriptor> {
public:
/* *************** Construction / Destruction ************************ */
    PrecondBGKdynamics(T omega_, T invGamma_);

    virtual PrecondBGKdynamics<T,Descriptor>* clone() const;

    virtual int getId() const;

    virtual void serialize(HierarchicSerializer& serializer) const;

    virtual void unserialize(HierarchicUnserializer& unserializer);

/* *************** Collision and Equilibrium ************************* */

    virtual void collide(Cell<T,Descriptor>& cell,
                         BlockStatistics& statistics_);

    virtual void collide(Cell<T,Descriptor>& cell, T rhoBar,
                         Array<T,Descriptor<T>::d> const& j, T thetaBar, BlockStatistics& stat);

    virtual T computeEquilibrium(plint iPop, T rhoBar, Array<T,Descriptor<T>::d> const& j,
                                 T jSqr, T thetaBar=T()) const;
private:
    static int id;
    T invGamma;
};

}  // namespace plb

#endif  // ISO_THERMAL_DYNAMICS_H