00001 /*---------------------------------------------------------------------------*\ 00002 ========= | 00003 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox 00004 \\ / O peration | 00005 \\ / A nd | Copyright (C) 2008-2010 OpenCFD Ltd. 00006 \\/ M anipulation | 00007 ------------------------------------------------------------------------------- 00008 License 00009 This file is part of OpenFOAM. 00010 00011 OpenFOAM is free software: you can redistribute it and/or modify it 00012 under the terms of the GNU General Public License as published by 00013 the Free Software Foundation, either version 3 of the License, or 00014 (at your option) any later version. 00015 00016 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT 00017 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 00018 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 00019 for more details. 00020 00021 You should have received a copy of the GNU General Public License 00022 along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>. 00023 00024 Class 00025 Foam::referredMolecule 00026 00027 Description 00028 00029 SourceFiles 00030 referredMoleculeI.H 00031 referredMolecule.C 00032 00033 \*---------------------------------------------------------------------------*/ 00034 00035 #ifndef referredMolecule_H 00036 #define referredMolecule_H 00037 00038 #include <OpenFOAM/vector.H> 00039 #include <OpenFOAM/List.H> 00040 00041 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00042 00043 namespace Foam 00044 { 00045 00046 /*---------------------------------------------------------------------------*\ 00047 Class referredMolecule Declaration 00048 \*---------------------------------------------------------------------------*/ 00049 00050 class referredMolecule 00051 { 00052 // Private data 00053 00054 label id_; 00055 00056 vector position_; 00057 00058 List<vector> sitePositions_; 00059 00060 00061 public: 00062 00063 // Constructors 00064 00065 //- Construct null 00066 referredMolecule(); 00067 00068 //- Construct from components 00069 referredMolecule 00070 ( 00071 const label id, 00072 const vector& position, 00073 const List<vector>& sitePositions 00074 ); 00075 00076 00077 // Destructor 00078 00079 virtual ~referredMolecule(); 00080 00081 00082 // Member Functions 00083 00084 // Access 00085 00086 inline label id() const; 00087 00088 inline const vector& position() const; 00089 00090 inline const List<vector>& sitePositions() const; 00091 00092 00093 // Friend Operators 00094 00095 inline friend bool operator== 00096 ( 00097 const referredMolecule& a, 00098 const referredMolecule& b 00099 ); 00100 00101 inline friend bool operator!= 00102 ( 00103 const referredMolecule& a, 00104 const referredMolecule& b 00105 ); 00106 00107 00108 // IOstream Operators 00109 00110 friend Istream& operator>> 00111 ( 00112 Istream&, 00113 referredMolecule& 00114 ); 00115 00116 friend Ostream& operator<< 00117 ( 00118 Ostream&, 00119 const referredMolecule& 00120 ); 00121 }; 00122 00123 00124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00125 00126 } // End namespace Foam 00127 00128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00129 00130 #include <molecule/referredMoleculeI.H> 00131 00132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * // 00133 00134 #endif 00135 00136 // ************************ vim: set sw=4 sts=4 et: ************************ //
