src/OpenFOAM/meshes/polyMesh/mapPolyMesh/objectMap/objectMap.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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 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::objectMap
  27
  28 Description
  29     An objectMap is a pair of labels defining the mapping of an object from
  30     another object, e.g. a cell mapped from a point.
  31
  32 SourceFiles
  33     objectMapI.H
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef objectMap_H
  38 #define objectMap_H
  39
  40 #include "labelList.H"
  41
  42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  43
  44 namespace Foam
  45 {
  46
  47 // Forward declaration of friend functions and operators
  48
  49 class objectMap;
  50 inline bool operator==(const objectMap& a, const objectMap& b);
  51 inline bool operator!=(const objectMap& a, const objectMap& b);
  52 inline Ostream& operator<<(Ostream&, const objectMap&);
  53
  54
  55 /*---------------------------------------------------------------------------*\
  56                            Class objectMap Declaration
  57 \*---------------------------------------------------------------------------*/
  58
  59 class objectMap
  60 {
  61     // Private data
  62
  63         //- Object index
  64         label index_;
  65
  66         //- Master object index
  67         labelList masterObjects_;
  68
  69
  70 public:
  71
  72     // Constructors
  73
  74         //- Null constructor for lists
  75         inline objectMap();
  76
  77         //- Construct from components
  78         inline objectMap(const label index, const labelList& master);
  79
  80         //- Construct from Istream
  81         inline objectMap(Istream&);
  82
  83
  84     // Member Functions
  85
  86         //- Return object index
  87         inline label& index();
  88         inline label index() const;
  89
  90         //- Return master object index
  91         inline labelList& masterObjects();
  92         inline const labelList& masterObjects() const;
  93
  94
  95     // Friend Operators
  96
  97         friend bool operator==(const objectMap& a, const objectMap& b);
  98         friend bool operator!=(const objectMap& a, const objectMap& b);
  99
 100
 101     // IOstream Operators
 102
 103         friend Ostream& operator<<(Ostream&, const objectMap&);
 104 };
 105
 106
 107 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 108
 109 } // End namespace Foam
 110
 111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 112
 113 #include "objectMapI.H"
 114
 115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 116
 117 #endif
 118
 119 // ************************************************************************* //