advectionDiffusionDynamics.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
e* 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/>.
*/

/* Main author: Orestis Malaspinas
 */

#ifndef ADVECTION_DIFFUSION_DYNAMICS_H
#define ADVECTION_DIFFUSION_DYNAMICS_H

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

namespace plb {
    
template<typename T, template<typename U> class Descriptor>
class AdvectionDiffusionDynamics : public BasicBulkDynamics<T,Descriptor> {
public:
    AdvectionDiffusionDynamics(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;

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

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

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

    virtual plint numDecomposedVariables(plint order) const { return 0; }

    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 { }
    
};


template<typename T, template<typename U> class Descriptor>
class AdvectionDiffusionRLBdynamics : public AdvectionDiffusionDynamics <T,Descriptor> {
public:
    AdvectionDiffusionRLBdynamics(T omega_);
    virtual AdvectionDiffusionRLBdynamics<T,Descriptor>* clone() const;
    virtual int getId() const;
    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 AdvectionDiffusionWithSourceRLBdynamics : public AdvectionDiffusionDynamics <T,Descriptor> {
public:
    AdvectionDiffusionWithSourceRLBdynamics(T omega_);
    virtual AdvectionDiffusionWithSourceRLBdynamics<T,Descriptor>* clone() const;
    virtual int getId() const;
    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 SmagorinskyAdvectionDiffusionRLBdynamics : public AdvectionDiffusionDynamics <T,Descriptor> {
public:
    SmagorinskyAdvectionDiffusionRLBdynamics(T omega_, T cSmago_);
    virtual SmagorinskyAdvectionDiffusionRLBdynamics<T,Descriptor>* clone() const;
    virtual int getId() const;
    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:
    T cSmago;
    static int id;
};


template<typename T, template<typename U> class Descriptor>
class AdvectionDiffusionBGKdynamics : public AdvectionDiffusionDynamics <T,Descriptor> {
public:
    AdvectionDiffusionBGKdynamics(T omega_);
    virtual AdvectionDiffusionBGKdynamics<T,Descriptor>* clone() const;
    virtual int getId() const;
    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;

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

    virtual plint numDecomposedVariables(plint order) const { return 0; }

    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 { }
private:
    static int id;
};

} // namespace plb

#endif  // ADVECTION_DIFFUSION_DYNAMICS_H