src/lagrangian/basic/InteractionLists/referredWallFace/referredWallFace.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2011 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::referredWallFace
  26
  27 Description
  28     Storage for referred wall faces.  Stores patch index, face and
  29     associated points
  30
  31 SourceFiles
  32     referredWallFaceI.H
  33     referredWallFace.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef referredWallFace_H
  38 #define referredWallFace_H
  39
  40 #include "face.H"
  41 #include "pointField.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 // Forward declaration of classes
  49 class Istream;
  50 class Ostream;
  51
  52 // Forward declaration of friend functions and operators
  53 class referredWallFace;
  54 Istream& operator>>(Istream&, referredWallFace&);
  55 Ostream& operator<<(Ostream&, const referredWallFace&);
  56
  57
  58 /*---------------------------------------------------------------------------*\
  59                         Class referredWallFace Declaration
  60 \*---------------------------------------------------------------------------*/
  61
  62 class referredWallFace
  63 :
  64     public face
  65 {
  66     // Private data
  67
  68         //- Points of face
  69         pointField pts_;
  70
  71         //- Index of originating patch
  72         label patchI_;
  73
  74
  75 public:
  76
  77     // Constructors
  78
  79         //- Construct null
  80         referredWallFace();
  81
  82         //- Construct from components
  83         referredWallFace
  84         (
  85             const face& f,
  86             const pointField& pts,
  87             label patchI
  88         );
  89
  90         //- Construct as copy
  91         referredWallFace(const referredWallFace&);
  92
  93
  94     //- Destructor
  95     ~referredWallFace();
  96
  97
  98     // Member Functions
  99
 100         // Access
 101
 102             //- Return access to the stored points
 103             inline const pointField& points() const;
 104
 105             //- Return non-const access to the stored points
 106             inline pointField& points();
 107
 108             //- Return access to the patch index
 109             inline label patchIndex() const;
 110
 111             //- Return non-const access to the patch index
 112             inline label& patchIndex();
 113
 114
 115     // Member Operators
 116
 117         bool operator==(const referredWallFace&) const;
 118         bool operator!=(const referredWallFace&) const;
 119
 120     // IOstream Operators
 121
 122         friend Istream& operator>>(Istream&, referredWallFace&);
 123         friend Ostream& operator<<(Ostream&, const referredWallFace&);
 124 };
 125
 126
 127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 128
 129 } // End namespace Foam
 130
 131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 132
 133 #include "referredWallFaceI.H"
 134
 135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 136
 137 #endif
 138
 139 // ************************************************************************* //