src/lagrangian/molecularDynamics/molecule/interactionLists/referredMolecule/referredMolecule.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   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 the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     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, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::referredMolecule
  27
  28 Description
  29
  30 SourceFiles
  31     referredMoleculeI.H
  32     referredMolecule.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef referredMolecule_H
  37 #define referredMolecule_H
  38
  39 #include "vector.H"
  40 #include "List.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 /*---------------------------------------------------------------------------*\
  48                       Class referredMolecule Declaration
  49 \*---------------------------------------------------------------------------*/
  50
  51 class referredMolecule
  52 {
  53     // Private data
  54
  55         label id_;
  56
  57         vector position_;
  58
  59         List<vector> sitePositions_;
  60
  61
  62 public:
  63
  64     // Constructors
  65
  66         //- Construct null
  67         referredMolecule();
  68
  69         //- Construct from components
  70         referredMolecule
  71         (
  72             const label id,
  73             const vector& position,
  74             const List<vector>& sitePositions
  75         );
  76
  77
  78     // Destructor
  79
  80         virtual ~referredMolecule();
  81
  82
  83     // Member Functions
  84
  85         // Access
  86
  87             inline label id() const;
  88
  89             inline const vector& position() const;
  90
  91             inline const List<vector>& sitePositions() const;
  92
  93
  94     // Friend Operators
  95
  96         inline friend bool operator==
  97         (
  98             const referredMolecule& a,
  99             const referredMolecule& b
 100         );
 101
 102         inline friend bool operator!=
 103         (
 104             const referredMolecule& a,
 105             const referredMolecule& b
 106         );
 107
 108
 109     // IOstream Operators
 110
 111         friend Istream& operator>>
 112         (
 113             Istream&,
 114             referredMolecule&
 115         );
 116
 117         friend Ostream& operator<<
 118         (
 119             Ostream&,
 120             const referredMolecule&
 121         );
 122 };
 123
 124
 125 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 126
 127 } // End namespace Foam
 128
 129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 130
 131 #include "referredMoleculeI.H"
 132
 133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 134
 135 #endif
 136
 137 // ************************************************************************* //