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

/* This code was written with help of a Fortran code kindly provided
 * by Prof. Taehun Lee, and contains important contributions by
 * Andrea Parmigiani.
 */

#ifndef HE_LEE_PROCESSOR_3D_H
#define HE_LEE_PROCESSOR_3D_H

#include "core/globalDefs.h"
#include "atomicBlock/dataProcessorWrapper3D.h"
#include "atomicBlock/blockLattice3D.h"
#include "multiPhysics/interparticlePotential.h"

namespace plb {



template<typename T, template<typename U> class Descriptor >
class Compute_C_processor : public BoxProcessingFunctional3D
{
public:
    Compute_C_processor(T M_);
    virtual void processGenericBlocks(Box3D domain, std::vector<AtomicBlock3D*> blocks);
    virtual Compute_C_processor<T,Descriptor>* clone() const;
    virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
private:
    T M;
};


template<typename T>
class Compute_gradC_rho_mu_processor : public BoxProcessingFunctional3D
{
public:
    Compute_gradC_rho_mu_processor(T beta_, T kappa_, T rho_h_, T rho_l_);
    virtual void processGenericBlocks(Box3D domain, std::vector<AtomicBlock3D*> blocks);
    virtual Compute_gradC_rho_mu_processor<T>* clone() const;
    virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
private:
    T beta, kappa;
    T rho_h, rho_l;
};


template<typename T, template<typename U> class Descriptor >
class Compute_gradMu_laplaceMu_processor : public BoxProcessingFunctional3D
{
public:
    Compute_gradMu_laplaceMu_processor();
    virtual void processGenericBlocks(Box3D domain, std::vector<AtomicBlock3D*> blocks);
    virtual Compute_gradMu_laplaceMu_processor<T,Descriptor>* clone() const;
    virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
};


template<typename T, template<typename U> class Descriptor >
class Compute_gradMu_laplaceMu_u_p1_processor : public BoxProcessingFunctional3D
{
public:
    Compute_gradMu_laplaceMu_u_p1_processor(T rho_h_, T rho_l_, T RT_);
    virtual void processGenericBlocks(Box3D domain, std::vector<AtomicBlock3D*> blocks);
    virtual Compute_gradMu_laplaceMu_u_p1_processor<T,Descriptor>* clone() const;
    virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
private:
    T rho_h, rho_l, RT;
};


template<typename T, template<typename U> class Descriptor >
class HeLeeCollisionProcessor : public BoxProcessingFunctional3D
{
public:
    HeLeeCollisionProcessor (
            T rho_h_, T rho_l_, T tau_h_, T tau_l_, T M_, T RT_,
            bool initialize_ = false );
    virtual void processGenericBlocks(Box3D domain, std::vector<AtomicBlock3D*> blocks);
    virtual HeLeeCollisionProcessor<T,Descriptor>* clone() const;
    virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
private:
    void computeAdvectionTerms (
        ScalarField3D<T> const& C, T& adv_gradC, T& bias_adv_gradC,
        plint iX, plint iY, plint iZ, plint iPop );
private:
    T rho_h, rho_l, tau_h, tau_l, M, RT;
    bool initialize;
};

}  // namespace Palabos

#endif  // HE_LEE_LATTICES_3D_H