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

/* Main author: Orestis Malaspinas
 */

#ifndef EXTERNAL_FORCE_DYNAMICS_H
#define EXTERNAL_FORCE_DYNAMICS_H

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

namespace plb {

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

/* *************** Velocity computation ************************* */

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


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

    virtual NaiveExternalForceBGKdynamics<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 GuoExternalForceBGKdynamics : public ExternalForceDynamics<T,Descriptor> {
public:
/* *************** Construction / Destruction ************************ */
    GuoExternalForceBGKdynamics(T omega_);

    virtual GuoExternalForceBGKdynamics<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 ShanChenExternalForceBGKdynamics : public ExternalForceDynamics<T,Descriptor> {
public:
/* *************** Construction / Destruction ************************ */
    ShanChenExternalForceBGKdynamics(T omega_);

    virtual ShanChenExternalForceBGKdynamics<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 HeExternalForceBGKdynamics : public ExternalForceDynamics<T,Descriptor> {
public:
/* *************** Construction / Destruction ************************ */
    HeExternalForceBGKdynamics(T omega_);

    virtual HeExternalForceBGKdynamics<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 IncGuoExternalForceBGKdynamics : public ExternalForceDynamics<T,Descriptor> {
public:
    /* *************** Construction / Destruction ************************ */
    IncGuoExternalForceBGKdynamics(T omega_);
    
    virtual IncGuoExternalForceBGKdynamics<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;
                                 
    virtual bool velIsJ() const;
private:
    static int id;
};

}  // namespace plb

#endif  // EXTERNAL_FORCE_DYNAMICS_H