refineCell.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 2011-2015 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::refineCell
26 
27 Description
28  Container with cells to refine. Refinement given as single direction.
29 
30 SourceFiles
31  refineCell.C
32 
33 \*---------------------------------------------------------------------------*/
34 
35 #ifndef refineCell_H
36 #define refineCell_H
37 
38 #include "label.H"
39 #include "vector.H"
40 
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 
43 namespace Foam
44 {
45 
46 class Istream;
47 class Ostream;
48 
49 /*---------------------------------------------------------------------------*\
50  Class refineCell Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 class refineCell
54 {
55  // Private data
56 
57  //- Cell label
58  label cellNo_;
59 
60  //- Preferred refinement direction (always normalized).
61  vector direction_;
62 
63 public:
64 
65  // Constructors
66 
67  //- Null
68  refineCell();
69 
70  //- From components. Vector will be normalized upon construction.
71  refineCell(const label, const vector&);
72 
73  //- From Istream. Vector will be normalized upon construction.
74  refineCell(Istream& is);
75 
76 
77  // Member Functions
78 
79  label cellNo() const
80  {
81  return cellNo_;
82  }
83 
84  const vector& direction() const
85  {
86  return direction_;
87  }
88 
89 
90  // Friend Operators
91 
92  inline friend bool operator==
93  (
94  const refineCell& rc1,
95  const refineCell& rc2
96  )
97  {
98  return (rc1.cellNo() == rc2.cellNo());
99  }
100 
101  inline friend bool operator!=
102  (
103  const refineCell& rc1,
104  const refineCell& rc2
105  )
106  {
107  return !(rc1 == rc2);
108  }
109 
110 
111  // IOstream Operators
112 
113  friend Ostream& operator<<(Ostream&, const refineCell&);
114 };
115 
116 
117 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
118 
119 } // End namespace Foam
120 
121 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
122 
123 #endif
124 
125 // ************************************************************************* //
126 
refineCell()
Null.
Definition: refineCell.C:31
Container with cells to refine. Refinement given as single direction.
Definition: refineCell.H:52
label cellNo() const
Definition: refineCell.H:78
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
Namespace for OpenFOAM.
const vector & direction() const
Definition: refineCell.H:83
An Ostream is an abstract base class for all output systems (streams, files, token lists...
Definition: Ostream.H:53
friend Ostream & operator<<(Ostream &, const refineCell &)