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

#ifndef NEAREST_NEIGHBOR_LATTICES_3D_H
#define NEAREST_NEIGHBOR_LATTICES_3D_H

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

namespace plb {


namespace descriptors {

    template <typename T> struct D3Q13Constants
    {
        enum { d = 3, q = 13 };       
        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;        
        static const T lambda_e;      
        static const T lambda_h;      
    };

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

    template <typename T> struct D3Q15Constants
    {
        enum { d = 3, q = 15 };       
        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 D3Q15DescriptorBase
        : public D3Q15Constants<T>, public DefaultRoundOffPolicy<T>
    {
        typedef D3Q15DescriptorBase<T> BaseDescriptor;
        enum { numPop=D3Q15Constants<T>::q };
    };

    template <typename T> struct D3Q19Constants
    {
        enum { d = 3, q = 19 };       
        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 D3Q19DescriptorBase
        : public D3Q19Constants<T>, public DefaultRoundOffPolicy<T>
    {
        typedef D3Q19DescriptorBase<T> BaseDescriptor;
        enum { numPop=D3Q19Constants<T>::q };
    };

    template <typename T> struct D3Q27Constants
    {
        enum { d = 3, q = 27 };       
        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 D3Q27DescriptorBase
        : public D3Q27Constants<T>, public DefaultRoundOffPolicy<T>
    {
        typedef D3Q27DescriptorBase<T> BaseDescriptor;
        enum { numPop=D3Q27Constants<T>::q };
    };

    template <typename T> struct D3Q13Descriptor
        : public D3Q13DescriptorBase<T>, public NoExternalFieldBase
    {
        static const char name[];
    };

    template <typename T> struct ForcedD3Q13Descriptor
        : public D3Q13DescriptorBase<T>, public Force3dDescriptorBase
    {
        static const char name[];
    };

    template <typename T> struct D3Q15Descriptor
        : public D3Q15DescriptorBase<T>, public NoExternalFieldBase
    {
        static const char name[];
    };

    template <typename T> struct ForcedD3Q15Descriptor
        : public D3Q15DescriptorBase<T>, public Force3dDescriptorBase
    {
        static const char name[];
    };

    template <typename T> struct RhoBarJD3Q15Descriptor
        : public D3Q15DescriptorBase<T>, public RhoBarJdescriptorBase3D
    {
        static const char name[];
    };

    template <typename T> struct ForcedRhoBarJD3Q15Descriptor
        : public D3Q15DescriptorBase<T>, public ForcedRhoBarJdescriptorBase3D
    {
        static const char name[];
    };

    template <typename T> struct D3Q19Descriptor
        : public D3Q19DescriptorBase<T>, public NoExternalFieldBase
    {
        static const char name[];
    };

    template <typename T> struct ForcedD3Q19Descriptor
        : public D3Q19DescriptorBase<T>, public Force3dDescriptorBase
    {
        static const char name[];
    };

    template <typename T> struct RhoBarJD3Q19Descriptor
        : public D3Q19DescriptorBase<T>, public RhoBarJdescriptorBase3D
    {
        static const char name[];
    };
    
    template <typename T> struct ForcedRhoBarJD3Q19Descriptor
        : public D3Q19DescriptorBase<T>, public ForcedRhoBarJdescriptorBase3D
    {
        static const char name[];
    };
    
    template <typename T> struct VelocityD3Q19Descriptor
    : public D3Q19DescriptorBase<T>, public Velocity3dBase
    {
        static const char name[];
    };

    template <typename T> struct D3Q27Descriptor
        : public D3Q27DescriptorBase<T>, public NoExternalFieldBase
    {
        static const char name[];
    };

    template <typename T> struct ForcedD3Q27Descriptor
        : public D3Q27DescriptorBase<T>, public Force3dDescriptorBase
    {
        static const char name[];
    };

    template <typename T> struct RhoBarJD3Q27Descriptor
        : public D3Q27DescriptorBase<T>, public RhoBarJdescriptorBase3D
    {
        static const char name[];
    };

    template <typename T> struct ForcedRhoBarJD3Q27Descriptor
        : public D3Q27DescriptorBase<T>, public ForcedRhoBarJdescriptorBase3D
    {
        static const char name[];
    };

}  // namespace descriptors

}  // namespace plb

#endif  // NEAREST_NEIGHBOR_LATTICES_3D_H