/usr/include/palabos/boundaryCondition/boundaryCondition2D.h is in libplb-dev 1.5~r1+repack1-2build2.
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 237 238 239 240 241 242 243 244 245 | /* 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/>.
*/
/** \file A helper for initialising 2D boundaries -- header file. */
#ifndef BOUNDARY_CONDITION_2D_H
#define BOUNDARY_CONDITION_2D_H
#include "core/globalDefs.h"
#include "boundaryCondition/boundaryCondition.h"
#include "boundaryCondition/finiteDifferenceBoundaryProcessor2D.h"
#include "core/dynamics.h"
namespace plb {
template<typename T, template<typename U> class Descriptor> class BlockLattice2D;
template<typename T, template<typename U> class Descriptor> class MultiBlockLattice2D;
template<typename T, template<typename U> class Descriptor>
class OnLatticeBoundaryCondition2D {
public:
virtual ~OnLatticeBoundaryCondition2D() { }
virtual OnLatticeBoundaryCondition2D<T,Descriptor>* clone() const =0;
// PART I: Atomic-block version.
virtual void addVelocityBoundary0N( Box2D domain, BlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addVelocityBoundary0P( Box2D domain, BlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addVelocityBoundary1N( Box2D domain, BlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addVelocityBoundary1P( Box2D domain, BlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addPressureBoundary0N( Box2D domain, BlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addPressureBoundary0P( Box2D domain, BlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addPressureBoundary1N( Box2D domain, BlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addPressureBoundary1P( Box2D domain, BlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addExternalVelocityCornerNN( plint x, plint y, BlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addExternalVelocityCornerNP( plint x, plint y, BlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addExternalVelocityCornerPN( plint x, plint y, BlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addExternalVelocityCornerPP( plint x, plint y, BlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addInternalVelocityCornerNN( plint x, plint y, BlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addInternalVelocityCornerNP( plint x, plint y, BlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addInternalVelocityCornerPN( plint x, plint y, BlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addInternalVelocityCornerPP( plint x, plint y, BlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
/// Set velocity/Neumann condition on outer boundaries of the lattice (atomic-block
/// version).
void setVelocityConditionOnBlockBoundaries( BlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet );
/// Set velocity/Neumann condition on a sub-domain, on the outer boundaries of
/// the lattice (atomic-block version).
/** Attention: this function only has an effect when it is used on the outer surface
* of the atomic-block. For boundaries inside the domain, use
* the method which takes two Box2D arguments.
**/
void setVelocityConditionOnBlockBoundaries( BlockLattice2D<T,Descriptor>& lattice,
Box2D applicationDomain,
boundary::BcType bcType=boundary::dirichlet );
/// Set velocity/Neumann condition on the block boundaries, but only on places which
/// intersect with the area of applicationDomain (atomic-block version).
void setVelocityConditionOnBlockBoundaries( BlockLattice2D<T,Descriptor>& lattice,
Box2D block, Box2D applicationDomain,
boundary::BcType bcType=boundary::dirichlet );
/// Set Pressure condition on outer boundaries of the lattice (atomic-block version).
/** Attention: pressure conditions are implemented for edges only. On corners,
* this function has no effect.
**/
void setPressureConditionOnBlockBoundaries( BlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet );
/// Set Pressure condition on a sub-domain, on the outer boundaries of
/// the lattice (atomic-block version).
/** Attention: this function only has an effect when it is used on the outer surface
* of the atomic-block. For boundaries inside the domain, use
* the method which takes two Box2D arguments.
* Attention: pressure conditions are implemented for edges only. On corners,
* this function has no effect.
**/
void setPressureConditionOnBlockBoundaries( BlockLattice2D<T,Descriptor>& lattice,
Box2D applicationDomain,
boundary::BcType bcType=boundary::dirichlet );
/// Set Pressure condition on the block boundaries, but only on places which
/// intersect with the area of applicationDomain (atomic-block version).
/** Attention: pressure conditions are implemented for edges only. On corners,
* this function has no effect.
**/
void setPressureConditionOnBlockBoundaries( BlockLattice2D<T,Descriptor>& lattice,
Box2D block, Box2D applicationDomain,
boundary::BcType bcType=boundary::dirichlet );
// PART II: Multi-block version.
virtual void addVelocityBoundary0N( Box2D domain, MultiBlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addVelocityBoundary0P( Box2D domain, MultiBlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addVelocityBoundary1N( Box2D domain, MultiBlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addVelocityBoundary1P( Box2D domain, MultiBlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addPressureBoundary0N( Box2D domain, MultiBlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addPressureBoundary0P( Box2D domain, MultiBlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addPressureBoundary1N( Box2D domain, MultiBlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addPressureBoundary1P( Box2D domain, MultiBlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addExternalVelocityCornerNN( plint x, plint y, MultiBlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addExternalVelocityCornerNP( plint x, plint y, MultiBlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addExternalVelocityCornerPN( plint x, plint y, MultiBlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addExternalVelocityCornerPP( plint x, plint y, MultiBlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addInternalVelocityCornerNN( plint x, plint y, MultiBlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addInternalVelocityCornerNP( plint x, plint y, MultiBlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addInternalVelocityCornerPN( plint x, plint y, MultiBlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
virtual void addInternalVelocityCornerPP( plint x, plint y, MultiBlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet ) =0;
/// Set velocity/Neumann condition on outer boundaries of the lattice (multi-block
/// version).
void setVelocityConditionOnBlockBoundaries( MultiBlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet );
/// Set velocity/Neumann condition on a sub-domain, on the outer boundaries of
/// the lattice (multi-block version).
/** Attention: this function only has an effect when it is used on the outer surface
* of the multi-block. For boundaries inside the domain, use
* the method which takes two Box2D arguments.
**/
void setVelocityConditionOnBlockBoundaries( MultiBlockLattice2D<T,Descriptor>& lattice,
Box2D applicationDomain,
boundary::BcType bcType=boundary::dirichlet );
/// Set velocity/Neumann condition on the block boundaries, but only on places which
/// intersect with the area of applicationDomain (multi-block version).
void setVelocityConditionOnBlockBoundaries( MultiBlockLattice2D<T,Descriptor>& lattice,
Box2D block, Box2D applicationDomain,
boundary::BcType bcType=boundary::dirichlet );
/// Set Pressure condition on outer boundaries of the lattice (multi-block version).
/** Attention: pressure conditions are implemented for edges only. On corners,
* this function has no effect.
**/
void setPressureConditionOnBlockBoundaries( MultiBlockLattice2D<T,Descriptor>& lattice,
boundary::BcType bcType=boundary::dirichlet );
/// Set Pressure condition on a sub-domain, on the outer boundaries of
/// the lattice (multi-block version).
/** Attention: this function only has an effect when it is used on the outer surface
* of the multi-block. For boundaries inside the domain, use
* the method which takes two Box2D arguments.
* Attention: pressure conditions are implemented for edges only. On corners,
* this function has no effect.
**/
void setPressureConditionOnBlockBoundaries( MultiBlockLattice2D<T,Descriptor>& lattice,
Box2D applicationDomain,
boundary::BcType bcType=boundary::dirichlet );
/// Set Pressure condition on the block boundaries, but only on places which
/// intersect with the area of applicationDomain (multi-block version).
/** Attention: pressure conditions are implemented for edges only. On corners,
* this function has no effect.
**/
void setPressureConditionOnBlockBoundaries( MultiBlockLattice2D<T,Descriptor>& lattice,
Box2D block, Box2D applicationDomain,
boundary::BcType bcType=boundary::dirichlet );
};
////////// Factory functions //////////////////////////////////////////////////
/// Generate the regularized boundary condition, managed by data processors.
template<typename T, template<typename U> class Descriptor>
OnLatticeBoundaryCondition2D<T,Descriptor>* createLocalBoundaryCondition2D();
/// Generate the regularized boundary condition, managed by dynamics only.
template<typename T, template<typename U> class Descriptor>
OnLatticeBoundaryCondition2D<T,Descriptor>* createDynamicsBasedLocalBoundaryCondition2D();
/// Generate a boundary condition which imposes equilibrium, but computes density properly.
template<typename T, template<typename U> class Descriptor>
OnLatticeBoundaryCondition2D<T,Descriptor>* createEquilibriumBoundaryCondition2D();
/// Generate Skordos boundary condition.
template<typename T, template<typename U> class Descriptor>
OnLatticeBoundaryCondition2D<T,Descriptor>* createInterpBoundaryCondition2D();
} // namespace plb
#endif // BOUNDARY_CONDITION_2D_H
|