smagorinskyDynamics.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/>.
*/

/* Orestis Malaspinas designed some of the classes and concepts contained
 * in this file. */

#ifndef SMAGORINSKY_DYNAMICS_H
#define SMAGORINSKY_DYNAMICS_H

#include "core/globalDefs.h"
#include "core/hierarchicSerializer.h"
#include "basicDynamics/isoThermalDynamics.h"
#include "basicDynamics/externalForceDynamics.h"
#include "complexDynamics/variableOmegaDynamics.h"

namespace plb {

template<typename T, template<typename U> class Descriptor>
class SmagorinskyDynamics : public OmegaFromPiDynamics<T,Descriptor> {
public:
    SmagorinskyDynamics(Dynamics<T,Descriptor>* baseDynamics_, T omega0_, T cSmago_,
                        bool automaticPrepareCollision=true);
    SmagorinskyDynamics(HierarchicUnserializer& unserializer);
    SmagorinskyDynamics<T,Descriptor>* clone() const;
    virtual int getId() const;
    virtual void serialize(HierarchicSerializer& serializer) const;
    virtual void unserialize(HierarchicUnserializer& unserializer);
    virtual T getOmegaFromPiAndRhoBar(Array<T,SymmetricTensor<T,Descriptor>::n> const& PiNeq, T rhoBar) const;
    virtual void setOmega(T omega_);
    virtual T getOmega() const;
private:
    T omega0;    //< "Laminar" relaxation parameter, used when the strain-rate is zero.
    T cSmago;    //< Smagorinsky constant.
    T preFactor; //< A factor depending on the Smagorinky constant, used to compute the effective viscosity.
    static int id;
};

template<typename T, template<typename U> class Descriptor>
class SmagorinskyBGKdynamics : public IsoThermalBulkDynamics<T,Descriptor> {
public:
/* *************** Construction / Destruction ************************ */
    SmagorinskyBGKdynamics(T omega0_, T cSmago_);
    SmagorinskyBGKdynamics(HierarchicUnserializer& unserializer);
    virtual SmagorinskyBGKdynamics<T,Descriptor>* clone() const;
    virtual int getId() const;
    virtual void serialize(HierarchicSerializer& serializer) const;
    virtual void unserialize(HierarchicUnserializer& unserializer);
    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;
    virtual void setOmega(T omega_);
    virtual T getOmega() const;
private:
    T omega0;    //< "Laminar" relaxation parameter, used when the strain-rate is zero.
    T cSmago;    //< Smagorinsky constant.
    T preFactor; //< A factor depending on the Smagorinky constant, used to compute the effective viscosity.
    static int id;
};

template<typename T, template<typename U> class Descriptor>
class GuoExternalForceSmagorinskyBGKdynamics : public IsoThermalBulkDynamics<T,Descriptor> {
public:
/* *************** Construction / Destruction ************************ */
    GuoExternalForceSmagorinskyBGKdynamics(T omega0_, T cSmago_);
    GuoExternalForceSmagorinskyBGKdynamics(HierarchicUnserializer& unserializer);
    virtual GuoExternalForceSmagorinskyBGKdynamics<T,Descriptor>* clone() const;
    virtual int getId() const;
    virtual void serialize(HierarchicSerializer& serializer) const;
    virtual void unserialize(HierarchicUnserializer& unserializer);
    virtual void collide(Cell<T,Descriptor>& cell,
                         BlockStatistics& statistics_);
    virtual void computeVelocity (Cell<T,Descriptor> const& cell,
                                  Array<T,Descriptor<T>::d>& u ) const;
    virtual T computeEquilibrium(plint iPop, T rhoBar, Array<T,Descriptor<T>::d> const& j,
                                 T jSqr, T thetaBar=T()) const;
    virtual void setOmega(T omega_);
    virtual T getOmega() const;
private:
    T omega0;    //< "Laminar" relaxation parameter, used when the strain-rate is zero.
    T cSmago;    //< Smagorinsky constant.
    static int id;
};

template<typename T, template<typename U> class Descriptor>
class IncGuoExternalForceSmagorinskyBGKdynamics : public IsoThermalBulkDynamics<T,Descriptor> {
public:
/* *************** Construction / Destruction ************************ */
    IncGuoExternalForceSmagorinskyBGKdynamics(T omega0_, T cSmago_);
    IncGuoExternalForceSmagorinskyBGKdynamics(HierarchicUnserializer& unserializer);
    virtual IncGuoExternalForceSmagorinskyBGKdynamics<T,Descriptor>* clone() const;
    virtual int getId() const;
    virtual void serialize(HierarchicSerializer& serializer) const;
    virtual void unserialize(HierarchicUnserializer& unserializer);
    virtual void collide(Cell<T,Descriptor>& cell,
                         BlockStatistics& statistics_);
    virtual void computeVelocity (Cell<T,Descriptor> const& cell,
                                  Array<T,Descriptor<T>::d>& u ) const;
    virtual T computeEquilibrium(plint iPop, T rhoBar, Array<T,Descriptor<T>::d> const& j,
                                 T jSqr, T thetaBar=T()) const;
    virtual void setOmega(T omega_);
    virtual T getOmega() const;
    virtual bool velIsJ() const;
private:
    T omega0;    //< "Laminar" relaxation parameter, used when the strain-rate is zero.
    T cSmago;    //< Smagorinsky constant.
    static int id;
};

template<typename T, template<typename U> class Descriptor>
class SmagorinskyRegularizedDynamics : public IsoThermalBulkDynamics<T,Descriptor> {
public:
    SmagorinskyRegularizedDynamics(T omega0_, T cSmago_);

    virtual SmagorinskyRegularizedDynamics<T,Descriptor>* clone() const;
    virtual int getId() const;
    virtual void serialize(HierarchicSerializer& serializer) const;
    virtual void unserialize(HierarchicUnserializer& unserializer);
    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;
    virtual void setOmega(T omega_);
    virtual T getOmega() const;
private:
    T omega0;    //< "Laminar" relaxation parameter, used when the strain-rate is zero.
    T cSmago;    //< Smagorinsky constant.
    T preFactor; //< A factor depending on the Smagorinky constant, used to compute the effective viscosity.
    static int id;
};

} // namespace plb

#endif  // SMAGORINSKY_DYNAMICS_H