src/dynamicMesh/dynamicTopoFvMesh/eMesh/eBoundaryMesh/eBoundaryMesh.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     eBoundaryMesh
  26
  27 SourceFiles
  28     eBoundaryMesh.C
  29
  30 \*---------------------------------------------------------------------------*/
  31
  32 #ifndef eBoundaryMesh_H
  33 #define eBoundaryMesh_H
  34
  35 #include "ePatchList.H"
  36 #include "wordList.H"
  37 #include "pointField.H"
  38 #include "regIOobject.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 class eMesh;
  48
  49 /*---------------------------------------------------------------------------*\
  50                       Class eBoundaryMesh Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class eBoundaryMesh
  54 :
  55     public ePatchList,
  56     public regIOobject
  57 {
  58     // private data
  59
  60         //- Reference to mesh
  61         const eMesh& mesh_;
  62
  63         //- Disallow construct as copy
  64         eBoundaryMesh(const eBoundaryMesh&);
  65
  66         //- Disallow assignment
  67         void operator=(const eBoundaryMesh&);
  68
  69 public:
  70
  71     //- Runtime type information
  72     TypeName("eBoundaryMesh");
  73
  74
  75     // Constructors
  76
  77         //- Construct from dictionary
  78         eBoundaryMesh
  79         (
  80             const IOobject& io,
  81             const eMesh& mesh
  82         );
  83
  84         //- Construct given size
  85         eBoundaryMesh
  86         (
  87             const IOobject& io,
  88             const eMesh& mesh,
  89             const label size
  90         );
  91
  92
  93     // Destructor - default
  94
  95
  96     // Member functions
  97
  98         // Access
  99
 100             //- Return the mesh reference
 101             const eMesh& mesh() const;
 102
 103             //- Return a list of patch types
 104             wordList types() const;
 105
 106             //- Return a list of patch names
 107             wordList names() const;
 108
 109             //- Return a list of patch sizes
 110             labelList patchSizes() const;
 111
 112             //- Return a list of patch starts
 113             labelList patchStarts() const;
 114
 115             //- Return patch index for a given edge label
 116             label whichPatch(const label edgeIndex) const;
 117
 118             //- Find patch index given a name
 119             label findPatchID(const word& patchName) const;
 120
 121             //- writeData member function required by regIOobject
 122             bool writeData(Ostream&) const;
 123
 124         // Input / Output
 125
 126             //- Read from input stream
 127             void readFromInputStream();
 128
 129     // Ostream operator
 130
 131         friend Ostream& operator<<(Ostream&, const eBoundaryMesh&);
 132 };
 133
 134
 135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 136
 137 } // End namespace Foam
 138
 139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 140
 141 #endif
 142
 143 // ************************************************************************* //