This file is indexed.

/usr/include/palabos/particles/visualParticleFunctional3D.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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
/* 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/>.
*/

#ifndef VISUAL_PARTICLE_FUNCTIONAL_3D_H
#define VISUAL_PARTICLE_FUNCTIONAL_3D_H

#include "core/globalDefs.h"
#include "atomicBlock/dataProcessingFunctional3D.h"
#include "atomicBlock/atomicContainerBlock3D.h"
#include "offLattice/triangularSurfaceMesh.h"
#include "offLattice/triangleBoundary3D.h"

namespace plb {

template<typename T, template<typename U> class Descriptor, class ParticleT>
class CreateParticleFromVertex3D : public BoxProcessingFunctional3D
{
public:
    CreateParticleFromVertex3D(TriangularSurfaceMesh<T> const& mesh_);
    /// Arguments: [0] Particle-field.
    virtual void processGenericBlocks(Box3D domain, std::vector<AtomicBlock3D*> fields);
    virtual CreateParticleFromVertex3D<T,Descriptor,ParticleT>* clone() const;
    virtual BlockDomain::DomainT appliesTo() const;
    virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
private:
    TriangularSurfaceMesh<T> const& mesh;
};

template<typename T, template<typename U> class Descriptor>
class CreateParticleFromVertexNoTagging3D : public BoxProcessingFunctional3D
{
public:
    CreateParticleFromVertexNoTagging3D( TriangularSurfaceMesh<T> const& mesh_,
                                         Particle3D<T,Descriptor>* particleTemplate_ );
    ~CreateParticleFromVertexNoTagging3D();
    CreateParticleFromVertexNoTagging3D(CreateParticleFromVertexNoTagging3D<T,Descriptor> const& rhs);
    CreateParticleFromVertexNoTagging3D<T,Descriptor>& operator=(CreateParticleFromVertexNoTagging3D<T,Descriptor> const& rhs);
    void swap(CreateParticleFromVertexNoTagging3D<T,Descriptor>& rhs);
    /// Arguments: [0] Particle-field.
    virtual void processGenericBlocks(Box3D domain, std::vector<AtomicBlock3D*> fields);
    virtual CreateParticleFromVertexNoTagging3D<T,Descriptor>* clone() const;
    virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
private:
    TriangularSurfaceMesh<T> const* mesh;
    Particle3D<T,Descriptor>* particleTemplate;
};

template<typename T, template<typename U> class Descriptor>
class CloneParticles3D : public BoxProcessingFunctional3D
{
public:
    CloneParticles3D (
            Particle3D<T,Descriptor>* particleTemplate_ );
    CloneParticles3D(CloneParticles3D<T,Descriptor> const& rhs);
    ~CloneParticles3D();
    CloneParticles3D<T,Descriptor>& operator= (
            CloneParticles3D<T,Descriptor> const& rhs );
    void swap(CloneParticles3D<T,Descriptor>& rhs);
    /// Arguments: [0] original particles; [1] cloned particles.
    virtual void processGenericBlocks(Box3D domain, std::vector<AtomicBlock3D*> fields);
    virtual CloneParticles3D<T,Descriptor>* clone() const;
    virtual BlockDomain::DomainT appliesTo() const;
    virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
private:
    Particle3D<T,Descriptor>* particleTemplate;
};

template<typename T, template<typename U> class Descriptor, class ParticleT>
class CopyVertexToParticle3D : public BoxProcessingFunctional3D
{
public:
    CopyVertexToParticle3D(TriangularSurfaceMesh<T> const& mesh_);
    /// Arguments: [0] Particle-field.
    virtual void processGenericBlocks(Box3D domain, std::vector<AtomicBlock3D*> fields);
    virtual CopyVertexToParticle3D<T,Descriptor,ParticleT>* clone() const;
    virtual BlockDomain::DomainT appliesTo() const;
    virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
private:
    TriangularSurfaceMesh<T> const& mesh;
};

template<typename T, template<typename U> class Descriptor>
class CopyParticleToVertex3D : public BoxProcessingFunctional3D
{
public:
    CopyParticleToVertex3D(TriangularSurfaceMesh<T>& mesh_);
    /// Arguments: [0] Particle-field.
    virtual void processGenericBlocks(Box3D domain, std::vector<AtomicBlock3D*> fields);
    virtual CopyParticleToVertex3D<T,Descriptor>* clone() const;
    virtual BlockDomain::DomainT appliesTo() const;
    virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
private:
    TriangularSurfaceMesh<T>& mesh;
};

template< typename T, template<typename U> class Descriptor >
class ComputeParticleForce3D : public BoxProcessingFunctional3D
{
public:
    ComputeParticleForce3D( TriangleBoundary3D<T> const& triangleBoundary_,
                            int flowType_, bool incompressibleModel_ );
    /// Arguments: [0] Particle-field; [1] Scalar-field.
    virtual void processGenericBlocks(Box3D domain, std::vector<AtomicBlock3D*> fields);
    virtual ComputeParticleForce3D<T,Descriptor>* clone() const;
    virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
private:
    TriangleBoundary3D<T> const& triangleBoundary;
    int flowType;
    bool incompressibleModel;
};

template< typename T, template<typename U> class Descriptor >
class ScalarFieldToParticle3D : public BoxProcessingFunctional3D
{
public:
    ScalarFieldToParticle3D(plint whichScalar_=-1);
    /// Arguments: [0] Particle-field; [1] Scalar-Field
    virtual void processGenericBlocks(Box3D domain, std::vector<AtomicBlock3D*> fields);
    virtual ScalarFieldToParticle3D<T,Descriptor>* clone() const;
    virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
private:
    plint whichScalar;
};

template<typename T, template<typename U> class Descriptor>
class GetParticleVelocity3D : public BoxProcessingFunctional3D
{
public:
    /// Arguments: [0] Orignal field (point-particles), [1] Cloned field (visual particles).
    virtual void processGenericBlocks(Box3D domain, std::vector<AtomicBlock3D*> fields);
    virtual GetParticleVelocity3D<T,Descriptor>* clone() const;
    virtual BlockDomain::DomainT appliesTo() const;
    virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
};

template<typename T, template<typename U> class Descriptor>
class CreateParticleMap3D : public BoxProcessingFunctional3D
{
public:
    /// Arguments: [0] particle field; [1] x-matrix of map; [2] y-matrix of map; [3] z-matrix of map.
    virtual void processGenericBlocks(Box3D domain, std::vector<AtomicBlock3D*> fields);
    virtual CreateParticleMap3D<T,Descriptor>* clone() const;
    virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
};

/// Create particles at weighted random positions for visualization purposes.
template<typename T, template<typename U> class Descriptor>
class VisualScalarFieldParticles3D : public BoxProcessingFunctional3D
{
public:
    VisualScalarFieldParticles3D (
            T mostUnlikely_, T mostLikely_, plint numShotsPerCell_, T probability_,
            plint ny_, plint nz_, Particle3D<T,Descriptor>* particleTemplate_ );
    ~VisualScalarFieldParticles3D();
    VisualScalarFieldParticles3D(VisualScalarFieldParticles3D<T,Descriptor> const& rhs);
    VisualScalarFieldParticles3D<T,Descriptor>& operator=(VisualScalarFieldParticles3D<T,Descriptor> const& rhs);
    void swap(VisualScalarFieldParticles3D<T,Descriptor>& rhs);
    /// Arguments: [0] Particle-field.
    virtual void processGenericBlocks(Box3D domain, std::vector<AtomicBlock3D*> fields);
    virtual VisualScalarFieldParticles3D<T,Descriptor>* clone() const;
    virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
private:
    T mostUnlikely, mostLikely;
    plint numShotsPerCell;
    T probability;
    plint ny, nz;
    Particle3D<T,Descriptor>* particleTemplate;
};

/// Take a particle field of PlaneMappingParticle3D particles, and reset the initial velocity member of
/// each particle to be its current velocity.
template<typename T, template<typename U> class Descriptor>
class ResetInitialVelocityOfPlaneMappingParticles3D : public BoxProcessingFunctional3D
{
public:
    /// Arguments: [0] Particle-field of PlaneMappingParticle3D particles.
    virtual void processGenericBlocks(Box3D domain, std::vector<AtomicBlock3D*> fields);
    virtual ResetInitialVelocityOfPlaneMappingParticles3D<T,Descriptor>* clone() const;
    virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
};

/// Take a particle field of PlaneMappingParticle3D particles, and assign a time scaling to each one of them.
template<typename T, template<typename U> class Descriptor>
class AssignTimeScalingToPlaneMappingParticles3D : public BoxProcessingFunctional3D
{
public:
    AssignTimeScalingToPlaneMappingParticles3D(T timeScaling_);
    /// Arguments: [0] Particle-field of PlaneMappingParticle3D particles.
    virtual void processGenericBlocks(Box3D domain, std::vector<AtomicBlock3D*> fields);
    virtual AssignTimeScalingToPlaneMappingParticles3D<T,Descriptor>* clone() const;
    virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
private:
    T timeScaling;
};

/// Compute statistics for PlaneMappingParticles3D
template<typename T, template<typename U> class Descriptor>
class PlaneMappingParticleStatistics3D : public PlainReductiveBoxProcessingFunctional3D
{
public:
    PlaneMappingParticleStatistics3D(T cutOffValue_, int wallFlag_, int fluidFlag_);
    /// Arguments: [0] Particle-field [1] Flag-matrix
    virtual void processGenericBlocks(Box3D domain, std::vector<AtomicBlock3D*> fields);
    virtual PlaneMappingParticleStatistics3D<T,Descriptor>* clone() const;
    plint getNumParticles() const; // Total number of particles.
    plint getNumTerminalParticles() const; // Number of particles that reached the terminal plane.
    plint getNumWallParticles() const; // Number of particles inside walls (if any).
    plint getNumSlowParticles() const; // Number of particles with very small velocities.
    plint getNumSlowNearWallParticles() const; // Number of particles with very small velocities which are in the viscinity of walls.
    virtual void getTypeOfModification(std::vector<modif::ModifT>& modified) const;
private:
    T cutOffValue; // When the speed of the particle drops below sqrt(cutOffValue), then this particle is a "slow" particle.
    int wallFlag; // Value that represents the wall nodes in the flag matrix.
    int fluidFlag; // Value that represents the fluid nodes in the flag matrix.
    plint numParticlesId;
    plint numTerminalParticlesId;
    plint numWallParticlesId;
    plint numSlowParticlesId;
    plint numSlowNearWallParticlesId;
};

template<typename T, template<typename U> class Descriptor>
void computePlaneMappingParticleStatistics3D(
        MultiParticleField3D<DenseParticleField3D<T,Descriptor> >& particles,
        MultiScalarField3D<int>& flagMatrix, T cutOffValue, int wallFlag, int fluidFlag, Box3D domain,
        plint& numParticles, plint& numTerminalParticles, plint& numWallParticles,
        plint& numSlowParticles, plint& numSlowNearWallParticles);


}  // namespace plb

#endif  // VISUAL_PARTICLE_FUNCTIONAL_3D_H