shanChenProcessor3D.h

00001 /* This file is part of the Palabos library.
00002  *
00003  * Copyright (C) 2011 FlowKit Sarl
00004  * Avenue de Chailly 23
00005  * 1012 Lausanne, Switzerland
00006  * E-mail contact: contact@flowkit.com
00007  *
00008  * The most recent release of Palabos can be downloaded at 
00009  * <http://www.palabos.org/>
00010  *
00011  * The library Palabos is free software: you can redistribute it and/or
00012  * modify it under the terms of the GNU Affero General Public License as
00013  * published by the Free Software Foundation, either version 3 of the
00014  * License, or (at your option) any later version.
00015  *
00016  * The library is distributed in the hope that it will be useful,
00017  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00018  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00019  * GNU Affero General Public License for more details.
00020  *
00021  * You should have received a copy of the GNU Affero General Public License
00022  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
00023 */
00024 
00025 /* The original version of this file was written by Orestis Malaspinas
00026  * and Andrea Parmigiani.
00027  */
00028 
00029 #ifndef SHAN_CHEN_PROCESSOR_3D_H
00030 #define SHAN_CHEN_PROCESSOR_3D_H
00031 
00032 #include "core/globalDefs.h"
00033 #include "atomicBlock/dataProcessorWrapper3D.h"
00034 #include "atomicBlock/blockLattice3D.h"
00035 #include "multiPhysics/interparticlePotential.h"
00036 
00037 namespace plb {
00038 
00040 template<typename T, template<typename U> class Descriptor>
00041 class ShanChenMultiComponentProcessor3D :
00042     public LatticeBoxProcessingFunctional3D<T,Descriptor>
00043 {
00044 public:
00047     ShanChenMultiComponentProcessor3D(T G_);
00051     ShanChenMultiComponentProcessor3D(T G_, std::vector<T> const& imposedOmega_);
00052     virtual void process(Box3D domain, std::vector<BlockLattice3D<T,Descriptor>*> lattices );
00053     virtual ShanChenMultiComponentProcessor3D<T,Descriptor>* clone() const;
00054     virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
00055 private:
00056     T G;
00057     std::vector<T> imposedOmega;
00058 };
00059 
00061 template<typename T, template<typename U> class Descriptor>
00062 class ShanChenSingleComponentProcessor3D : public BoxProcessingFunctional3D_L<T,Descriptor> {
00063 public:
00064     ShanChenSingleComponentProcessor3D(T G_, interparticlePotential::PsiFunction<T>* Psi_);
00065     ~ShanChenSingleComponentProcessor3D();
00066     ShanChenSingleComponentProcessor3D(ShanChenSingleComponentProcessor3D<T,Descriptor> const& rhs);
00067     ShanChenSingleComponentProcessor3D& operator=(ShanChenSingleComponentProcessor3D<T,Descriptor> const& rhs);
00068     virtual void process(Box3D domain, BlockLattice3D<T,Descriptor>& lattice );
00069     virtual ShanChenSingleComponentProcessor3D<T,Descriptor>* clone() const;
00070     virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
00071 private:
00072     T G;
00073     interparticlePotential::PsiFunction<T>* Psi;
00074 };
00075 
00076 }
00077 
00078 #endif  // SHAN_CHEN_LATTICES_3D_H