/usr/include/palabos/latticeBoltzmann/advectionDiffusionDynamicsTemplates.h is in libplb-dev 1.5~r1+repack1-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 | /* This file is part of the Palabos library.
*
* Copyright (C) 2011-2015 FlowKit Sarl
* Route d'Oron 2
* 1010 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
*/
/** \file
* Helper functions for the implementation of LB dynamics. This file is all
* about efficiency. The generic template code is specialized for commonly
* used Lattices, so that a maximum performance can be taken out of each
* case.
*/
#ifndef ADVECTION_DIFFUSION_DYNAMICS_TEMPLATES_H
#define ADVECTION_DIFFUSION_DYNAMICS_TEMPLATES_H
#include "core/globalDefs.h"
#include "core/cell.h"
#include "core/util.h"
#include "latticeBoltzmann/dynamicsTemplates.h"
#include "latticeBoltzmann/offEquilibriumTemplates.h"
#include "latticeBoltzmann/offEquilibriumAdvectionDiffusionTemplates.h"
namespace plb {
template<typename T, class Descriptor> struct advectionDiffusionDynamicsTemplatesImpl;
/// This structure forwards the calls to the appropriate helper class
template<typename T, template<typename U> class Descriptor>
struct advectionDiffusionDynamicsTemplates {
static T bgk_ma1_equilibrium(plint iPop, T rhoBar, Array<T,Descriptor<T>::d> const& jEq)
{
return advectionDiffusionDynamicsTemplatesImpl<T,typename Descriptor<T>::BaseDescriptor>
::bgk_ma1_equilibrium(iPop, rhoBar, jEq);
}
static void regularize(Cell<T,Descriptor>& cell, T rhoBar, Array<T,Descriptor<T>::d> const& jAdvDiff,
Array<T,Descriptor<T>::d> const& jEq)
{
advectionDiffusionDynamicsTemplatesImpl<T,typename Descriptor<T>::BaseDescriptor>
::regularize(cell.getRawPopulations(), rhoBar, jAdvDiff, jEq);
}
static T no_corr_bgk_collision(
Cell<T,Descriptor>& cell, T rhoBar,
Array<T,Descriptor<T>::d> const& jEq, T omega)
{
return advectionDiffusionDynamicsTemplatesImpl<T,typename Descriptor<T>::BaseDescriptor>
::no_corr_bgk_collision(cell.getRawPopulations(), rhoBar, jEq, omega);
}
static T no_corr_bgk_collision(
Cell<T,Descriptor>& cell, T rhoBar,
Array<T,Descriptor<T>::d> const& jEq, T omega, T sourceTerm)
{
return advectionDiffusionDynamicsTemplatesImpl<T,typename Descriptor<T>::BaseDescriptor>
::no_corr_bgk_collision(cell.getRawPopulations(), rhoBar, jEq, omega, sourceTerm);
}
static T no_corr_rlb_collision(Cell<T,Descriptor>& cell, T rhoBar,
Array<T,Descriptor<T>::d> const& jEq,
Array<T,Descriptor<T>::d> const& jNeq,
T omega )
{
return advectionDiffusionDynamicsTemplatesImpl<T,typename Descriptor<T>::BaseDescriptor>
::no_corr_rlb_collision(cell.getRawPopulations(), rhoBar, jEq, jNeq, omega);
}
static T no_corr_rlb_collision(Cell<T,Descriptor>& cell, T rhoBar,
Array<T,Descriptor<T>::d> const& jEq,
Array<T,Descriptor<T>::d> const& jNeq,
T omega, T sourceTerm )
{
return advectionDiffusionDynamicsTemplatesImpl<T,typename Descriptor<T>::BaseDescriptor>
::no_corr_rlb_collision(cell.getRawPopulations(), rhoBar, jEq, jNeq, omega, sourceTerm);
}
static T complete_mrt_ma2_ext_rhoBar_j_collision(Cell<T,Descriptor>& cell, T rhoBar, Array<T,Descriptor<T>::d> const& j, T omega, T omegaNonPhys)
{
return dynamicsTemplatesImpl<T,typename Descriptor<T>::BaseDescriptor>
::complete_mrt_ma2_ext_rhoBar_j_collision(cell.getRawPopulations(), rhoBar, j, omega, omegaNonPhys, Descriptor<T>::d);
}
static void complete_bgk_ma2_regularize(Cell<T,Descriptor>& cell, T rhoPhiBar, T rhoBar,
Array<T,Descriptor<T>::d> const& jEq, Array<T,Descriptor<T>::d> const& jNeq,
const Array<T,SymmetricTensor<T,Descriptor>::n> &piNeq, T omega, T omegaNonPhys, T omegaFluid, T omegaFluidNonPhys )
{
return advectionDiffusionDynamicsTemplatesImpl<T,typename Descriptor<T>::BaseDescriptor>
::complete_bgk_ma2_regularize(cell.getRawPopulations(), rhoPhiBar, rhoBar, jEq, jNeq, piNeq, omega, omegaNonPhys, omegaFluid, omegaFluidNonPhys);
}
}; // struct advectionDiffusionDynamicsTemplates
/// All helper functions are inside this structure
template<typename T, class Descriptor>
struct advectionDiffusionDynamicsTemplatesImpl
{
static T bgk_ma1_equilibrium(plint iPop, T rhoBar, Array<T,Descriptor::d> const& jEq)
{
T c_j = Descriptor::c[iPop][0]*jEq[0];
for (int iD=1; iD < Descriptor::d; ++iD) {
c_j += Descriptor::c[iPop][iD]*jEq[iD];
}
return Descriptor::t[iPop] * (rhoBar + Descriptor::invCs2 * c_j);
}
/// Regularization
static void regularize( Array<T,Descriptor::q>& f, T rhoBar,
Array<T,Descriptor::d> const& jAdvDiff,
Array<T,Descriptor::d> const& jEq )
{
// Off-equilibrium j
Array<T,Descriptor::d> jNeq;
for (int iD=0; iD<Descriptor::d; ++iD)
{
jNeq[iD] = jAdvDiff[iD] - jEq[iD];
}
// Regularize each population
for (plint iPop=0; iPop<Descriptor::q; ++iPop)
{
T fEq = bgk_ma1_equilibrium(iPop, rhoBar, jEq);
T fNeq = (T)Descriptor::c[iPop][0] * jNeq[0];
for (plint iD = 1; iD < Descriptor::d; ++iD)
{
fNeq += (T)Descriptor::c[iPop][iD] * jNeq[iD];
}
fNeq *= Descriptor::t[iPop] * Descriptor::invCs2;
f[iPop] = fEq + fNeq;
}
}
static T no_corr_bgk_collision(
Array<T,Descriptor::q>& f, T rhoBar, Array<T,Descriptor::d> const& jEq,
T omega)
{
T invRho = Descriptor::invRho(rhoBar);
const T jSqr = VectorTemplateImpl<T,Descriptor::d>::normSqr(jEq);
for (plint iPop=0; iPop < Descriptor::q; ++iPop) {
f[iPop] *= (T)1-omega;
f[iPop] += omega * advectionDiffusionDynamicsTemplatesImpl<T,Descriptor>::bgk_ma1_equilibrium (
iPop, rhoBar, jEq);
}
return jSqr*invRho*invRho;
}
static T no_corr_bgk_collision(
Array<T,Descriptor::q>& f, T rhoBar, Array<T,Descriptor::d> const& jEq,
T omega, T sourceTerm)
{
T invRho = Descriptor::invRho(rhoBar);
const T jSqr = VectorTemplateImpl<T,Descriptor::d>::normSqr(jEq);
for (plint iPop=0; iPop < Descriptor::q; ++iPop) {
f[iPop] *= (T)1-omega;
f[iPop] += omega * advectionDiffusionDynamicsTemplatesImpl<T,Descriptor>::bgk_ma1_equilibrium (
iPop, rhoBar, jEq);
f[iPop] += Descriptor::t[iPop]*sourceTerm;
}
return jSqr*invRho*invRho;
}
static T no_corr_rlb_collision (
Array<T,Descriptor::q>& f, T rhoBar, Array<T,Descriptor::d> const& jEq,
Array<T,Descriptor::d> const& jNeq,T omega )
{
T invRho = Descriptor::invRho(rhoBar);
const T jSqr = VectorTemplateImpl<T,Descriptor::d>::normSqr(jEq);
for (plint iPop=0; iPop < Descriptor::q; ++iPop)
{
f[iPop] = advectionDiffusionDynamicsTemplatesImpl<T,Descriptor>::
bgk_ma1_equilibrium(iPop, rhoBar, jEq);
T fNeq = ((T)1-omega) *
offEquilibriumAdvectionDiffusionTemplatesImpl<T,Descriptor>::fromJtoFneq(iPop, jNeq);
f[iPop] += fNeq;
}
return jSqr*invRho*invRho;
}
static T no_corr_rlb_collision (
Array<T,Descriptor::q>& f, T rhoBar, Array<T,Descriptor::d> const& jEq,
Array<T,Descriptor::d> const& jNeq, T omega, T sourceTerm )
{
T invRho = Descriptor::invRho(rhoBar);
const T jSqr = VectorTemplateImpl<T,Descriptor::d>::normSqr(jEq);
for (plint iPop=0; iPop < Descriptor::q; ++iPop)
{
f[iPop] = advectionDiffusionDynamicsTemplatesImpl<T,Descriptor>::
bgk_ma1_equilibrium(iPop, rhoBar, jEq);
T fNeq = ((T)1-omega) *
offEquilibriumAdvectionDiffusionTemplatesImpl<T,Descriptor>::fromJtoFneq(iPop, jNeq);
f[iPop] += fNeq + Descriptor::t[iPop] * sourceTerm;
}
return jSqr*invRho*invRho;
}
static void complete_bgk_ma2_regularize(Array<T,Descriptor::q>& f, T rhoPhiBar, T rhoBar,
Array<T,Descriptor::d> const& jEq, Array<T,Descriptor::d> const& jNeq,
const Array<T,SymmetricTensorImpl<T,Descriptor::d>::n> &piNeq, T omega, T omegaNonPhys, T omegaFluid, T omegaFluidNonPhys )
{
PLB_ASSERT(false);
}
}; // struct advectionDiffusionDynamicsTemplatesImpl
} // namespace plb
#include "latticeBoltzmann/advectionDiffusionDynamicsTemplates2D.h"
#include "latticeBoltzmann/advectionDiffusionDynamicsTemplates3D.h"
#endif
|