indexedParticle.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011-2017 OpenFOAM Foundation
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8 License
9  This file is part of OpenFOAM.
10 
11  OpenFOAM is free software: you can redistribute it and/or modify it
12  under the terms of the GNU General Public License as published by
13  the Free Software Foundation, either version 3 of the License, or
14  (at your option) any later version.
15 
16  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
19  for more details.
20 
21  You should have received a copy of the GNU General Public License
22  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::indexedParticle
26 
27 Description
28  Adds label index to base particle
29 
30 SourceFiles
31  indexedParticle.H
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef indexedParticle_H
36 #define indexedParticle_H
37 
38 #include "particle.H"
39 #include "IOstream.H"
40 #include "autoPtr.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class indexedParticle Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class indexedParticle
52 :
53  public particle
54 {
55  // Private data
56 
57  label index_;
58 
59 
60 public:
61 
62  // Constructors
63 
64  //- Construct from components
66  (
67  const polyMesh& mesh,
68  const barycentric& coordinates,
69  const label celli,
70  const label tetFacei,
71  const label tetPti,
72  const label index = 0
73  )
74  :
75  particle(mesh, coordinates, celli, tetFacei, tetPti),
76  index_(index)
77  {}
78 
79  //- Construct from Istream
81  (
82  const polyMesh& mesh,
83  Istream& is,
84  bool readFields = true
85  )
86  :
87  particle(mesh, is, readFields)
88  {}
89 
90  //- Construct as a copy
92  :
93  particle(p)
94  {}
95 
96  //- Construct and return a clone
97  virtual autoPtr<particle> clone() const
98  {
99  return autoPtr<particle>(new indexedParticle(*this));
100  }
101 
102 
103  // Member functions
105  label index() const
106  {
107  return index_;
108  }
110  label& index()
111  {
112  return index_;
113  }
114 };
115 
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 } // End namespace Foam
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 #endif
124 
125 // ************************************************************************* //
const polyMesh & mesh() const
Return the mesh database.
Definition: particleI.H:45
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
indexedParticle(const polyMesh &mesh, const barycentric &coordinates, const label celli, const label tetFacei, const label tetPti, const label index=0)
Construct from components.
virtual autoPtr< particle > clone() const
Construct and return a clone.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
static void readFields(CloudType &c)
Read the fields associated with the owner cloud.
Base particle class.
Definition: particle.H:81
const barycentric & coordinates() const
Return current particle coordinates.
Definition: particleI.H:51
An auto-pointer similar to the STL auto_ptr but with automatic casting to a reference to the type and...
Definition: PtrList.H:52
Mesh consisting of general polyhedral cells.
Definition: polyMesh.H:74
volScalarField & p
Adds label index to base particle.
Namespace for OpenFOAM.