/usr/include/palabos/finiteDifference/fdFunctional3D.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 | /* 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
* Helper functions for domain initialization -- header file.
*/
#ifndef FINITE_DIFFERENCE_FUNCTIONAL_3D_H
#define FINITE_DIFFERENCE_FUNCTIONAL_3D_H
#include "core/globalDefs.h"
#include "atomicBlock/dataProcessingFunctional3D.h"
#include "atomicBlock/reductiveDataProcessingFunctional3D.h"
namespace plb {
/* *************** Central finite-difference schemes ***************** */
template<typename T>
class BoxXderivativeFunctional3D : public BoundedBoxProcessingFunctional3D_SS<T,T>
{
public:
virtual void processBulk( Box3D domain, ScalarField3D<T>& value, ScalarField3D<T>& derivative );
virtual void processPlane( int direction, int orientation, Box3D domain,
ScalarField3D<T>& value, ScalarField3D<T>& derivative );
virtual void processEdge( int plane, int normal1, int normal2, Box3D domain,
ScalarField3D<T>& value, ScalarField3D<T>& derivative);
virtual void processCorner( int normalX, int normalY, int normalZ, Box3D domain,
ScalarField3D<T>& value, ScalarField3D<T>& derivative );
virtual BoxXderivativeFunctional3D<T>* clone() const;
virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
virtual BlockDomain::DomainT appliesTo() const;
};
template<typename T>
class BoxYderivativeFunctional3D : public BoundedBoxProcessingFunctional3D_SS<T,T>
{
public:
virtual void processBulk( Box3D domain, ScalarField3D<T>& value, ScalarField3D<T>& derivative );
virtual void processPlane( int direction, int orientation, Box3D domain,
ScalarField3D<T>& value, ScalarField3D<T>& derivative );
virtual void processEdge( int plane, int normal1, int normal2, Box3D domain,
ScalarField3D<T>& value, ScalarField3D<T>& derivative);
virtual void processCorner( int normalX, int normalY, int normalZ, Box3D domain,
ScalarField3D<T>& value, ScalarField3D<T>& derivative );
virtual BoxYderivativeFunctional3D<T>* clone() const;
virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
virtual BlockDomain::DomainT appliesTo() const;
};
template<typename T>
class BoxZderivativeFunctional3D : public BoundedBoxProcessingFunctional3D_SS<T,T>
{
public:
virtual void processBulk( Box3D domain, ScalarField3D<T>& value, ScalarField3D<T>& derivative );
virtual void processPlane( int direction, int orientation, Box3D domain,
ScalarField3D<T>& value, ScalarField3D<T>& derivative );
virtual void processEdge( int plane, int normal1, int normal2, Box3D domain,
ScalarField3D<T>& value, ScalarField3D<T>& derivative);
virtual void processCorner( int normalX, int normalY, int normalZ, Box3D domain,
ScalarField3D<T>& value, ScalarField3D<T>& derivative );
virtual BoxZderivativeFunctional3D<T>* clone() const;
virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
virtual BlockDomain::DomainT appliesTo() const;
};
template<typename T>
class BoxGradientNormFunctional3D : public BoundedBoxProcessingFunctional3D_SS<T,T>
{
public:
virtual void processBulk( Box3D domain, ScalarField3D<T>& value, ScalarField3D<T>& grNorm );
virtual void processPlane( int direction, int orientation, Box3D domain,
ScalarField3D<T>& value, ScalarField3D<T>& grNorm );
virtual void processEdge( int plane, int normal1, int normal2, Box3D domain,
ScalarField3D<T>& value, ScalarField3D<T>& grNorm);
virtual void processCorner( int normalX, int normalY, int normalZ, Box3D domain,
ScalarField3D<T>& value, ScalarField3D<T>& grNorm );
virtual BoxGradientNormFunctional3D<T>* clone() const;
virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
virtual BlockDomain::DomainT appliesTo() const;
};
/* *************** SOR iterations to solve a Poisson equation ******** */
template<typename T>
class BoxPoissonIteration3D : public BoundedScalarFieldBoxProcessingFunctional3D<T>
{
public:
BoxPoissonIteration3D(T beta_);
virtual void processBulk( Box3D domain, std::vector<ScalarField3D<T>*> scalarFields);
virtual void processPlane( int direction, int orientation, Box3D domain,
std::vector<ScalarField3D<T>*> scalarFields );
virtual void processEdge( int plane, int normal1, int normal2, Box3D domain,
std::vector<ScalarField3D<T>*> scalarFields );
virtual void processCorner( int normalX, int normalY, int normalZ, Box3D domain,
std::vector<ScalarField3D<T>*> scalarFields );
virtual BoxPoissonIteration3D<T>* clone() const;
virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
virtual BlockDomain::DomainT appliesTo() const;
private:
T beta; //< Relaxation parameter
};
template<typename T>
class BoxPoissonResidueFunctional3D : public ReductiveBoxProcessingFunctional3D_SS<T,T>
{
public:
BoxPoissonResidueFunctional3D();
virtual void process(Box3D domain, ScalarField3D<T>& pressure, ScalarField3D<T>& rhs);
virtual BoxPoissonResidueFunctional3D<T>* clone() const;
virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const {
modified[0] = modif::nothing;
modified[1] = modif::nothing;
}
T getMaxResidue() const;
private:
plint maxResidueId;
};
// ========================================================================= //
// PERIODIC VERSIONS OF THE DERIVATIVES AND POISSON SCHEMES //
// ========================================================================= //
/* *************** Central finite-difference schemes ***************** */
template<typename T>
class BoxXperiodicDerivativeFunctional3D : public BoxProcessingFunctional3D_SS<T,T>
{
public:
virtual void process( Box3D domain, ScalarField3D<T>& value, ScalarField3D<T>& derivative );
virtual BoxXperiodicDerivativeFunctional3D<T>* clone() const;
virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
virtual BlockDomain::DomainT appliesTo() const;
};
template<typename T>
class BoxYperiodicDerivativeFunctional3D : public BoxProcessingFunctional3D_SS<T,T>
{
public:
virtual void process( Box3D domain, ScalarField3D<T>& value, ScalarField3D<T>& derivative );
virtual BoxYperiodicDerivativeFunctional3D<T>* clone() const;
virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
virtual BlockDomain::DomainT appliesTo() const;
};
template<typename T>
class BoxZperiodicDerivativeFunctional3D : public BoxProcessingFunctional3D_SS<T,T>
{
public:
virtual void process( Box3D domain, ScalarField3D<T>& value, ScalarField3D<T>& derivative );
virtual BoxZperiodicDerivativeFunctional3D<T>* clone() const;
virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
virtual BlockDomain::DomainT appliesTo() const;
};
template<typename T>
class BoxPeriodicGradientNormFunctional3D : public BoxProcessingFunctional3D_SS<T,T>
{
public:
virtual void process( Box3D domain, ScalarField3D<T>& value, ScalarField3D<T>& grNorm );
virtual BoxPeriodicGradientNormFunctional3D<T>* clone() const;
virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
virtual BlockDomain::DomainT appliesTo() const;
};
template<typename T>
class BoxPeriodicGradientFunctional3D : public BoxProcessingFunctional3D_ST<T,T,3>
{
public:
virtual void process( Box3D domain, ScalarField3D<T>& value, TensorField3D<T,3>& derivative );
virtual BoxPeriodicGradientFunctional3D<T>* clone() const;
virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
virtual BlockDomain::DomainT appliesTo() const;
};
/* *************** SOR iterations to solve a Poisson equation ******** */
template<typename T>
class BoxPeriodicPoissonIteration3D : public ScalarFieldBoxProcessingFunctional3D<T>
{
public:
BoxPeriodicPoissonIteration3D(T beta_);
virtual void process( Box3D domain, std::vector<ScalarField3D<T>*> scalarFields);
virtual BoxPeriodicPoissonIteration3D<T>* clone() const;
virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
private:
T beta; //< Relaxation parameter
};
} // namespace plb
#endif // FINITE_DIFFERENCE_FUNCTIONAL_3D_H
|