advectionDiffusionLattices.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 ADVECTION_DIFFUSION_LATTICES_H
#define ADVECTION_DIFFUSION_LATTICES_H

#include "core/globalDefs.h"
#include "latticeBoltzmann/externalFields.h"
#include "latticeBoltzmann/roundOffPolicy.h"
#include <vector>

namespace plb {


namespace descriptors 
{
//===========================================================================//
//=================== AdvectionDiffusion Lattice Descriptors=================//
//===========================================================================//
    
    template <typename T> struct D2Q5Constants
    {
        enum { d = 2, q = 5 };      
        static const T invD;          
        static const int vicinity;    
        static const int c[q][d];     
        static const int cNormSqr[q]; 
        static const T t[q];          
        static const T cs2;           
        static const T invCs2;        
    };

    template <typename T> struct D2Q5DescriptorBase
        : public D2Q5Constants<T>, public DefaultRoundOffPolicy<T>
    {
        typedef D2Q5DescriptorBase<T> BaseDescriptor;
        enum { numPop=D2Q5Constants<T>::q };
    };
    
    template <typename T> struct AdvectionDiffusionD2Q5Descriptor
        : public D2Q5DescriptorBase<T>, public Velocity2dDescriptorBase
    {
        static const char name[];
    };
    
    template <typename T> struct D3Q7Constants {
        enum { d = 3, q = 7 };     
        static const T invD;          
        static const int vicinity;    
        static const int c[q][d];     
        static const int cNormSqr[q]; 
        static const T t[q];          
        static const T cs2;           
        static const T invCs2;        
    };

    template <typename T> struct D3Q7DescriptorBase
        : public D3Q7Constants<T>, public DefaultRoundOffPolicy<T>
    {
        typedef D3Q7DescriptorBase<T> BaseDescriptor;
        enum { numPop=D3Q7Constants<T>::q };
    };

    template <typename T> struct AdvectionDiffusionD3Q7Descriptor 
    : public D3Q7DescriptorBase<T>, public Velocity3dBase
    {
        static const char name[];
    };

    template <typename T> struct AdvectionDiffusionWithSourceD3Q7Descriptor 
    : public D3Q7DescriptorBase<T>, public VelocityAndScalar3dBase
    {
        static const char name[];
    };

}  // namespace descriptors

}  // namespace plb

#endif