FreeFOAM The Cross-Platform CFD Toolkit
referredMolecule.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) 2008-2010 OpenCFD Ltd.
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::referredMolecule
26 
27 Description
28 
29 SourceFiles
30  referredMoleculeI.H
31  referredMolecule.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef referredMolecule_H
36 #define referredMolecule_H
37 
38 #include <OpenFOAM/vector.H>
39 #include <OpenFOAM/List.H>
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 /*---------------------------------------------------------------------------*\
47  Class referredMolecule Declaration
48 \*---------------------------------------------------------------------------*/
49 
51 {
52  // Private data
53 
54  label id_;
55 
56  vector position_;
57 
58  List<vector> sitePositions_;
59 
60 
61 public:
62 
63  // Constructors
64 
65  //- Construct null
67 
68  //- Construct from components
70  (
71  const label id,
72  const vector& position,
74  );
75 
76 
77  // Destructor
78 
79  virtual ~referredMolecule();
80 
81 
82  // Member Functions
83 
84  // Access
85 
86  inline label id() const;
87 
88  inline const vector& position() const;
89 
90  inline const List<vector>& sitePositions() const;
91 
92 
93  // Friend Operators
94 
95  inline friend bool operator==
96  (
97  const referredMolecule& a,
98  const referredMolecule& b
99  );
100 
101  inline friend bool operator!=
102  (
103  const referredMolecule& a,
104  const referredMolecule& b
105  );
106 
107 
108  // IOstream Operators
109 
110  friend Istream& operator>>
111  (
112  Istream&,
114  );
115 
116  friend Ostream& operator<<
117  (
118  Ostream&,
119  const referredMolecule&
120  );
121 };
122 
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 } // End namespace Foam
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
131 
132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
133 
134 #endif
135 
136 // ************************ vim: set sw=4 sts=4 et: ************************ //