Barycentric2D.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2017 OpenFOAM Foundation
9  Copyright (C) 2019-2020 OpenCFD Ltd.
10 -------------------------------------------------------------------------------
11 License
12  This file is part of OpenFOAM.
13 
14  OpenFOAM is free software: you can redistribute it and/or modify it
15  under the terms of the GNU General Public License as published by
16  the Free Software Foundation, either version 3 of the License, or
17  (at your option) any later version.
18 
19  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22  for more details.
23 
24  You should have received a copy of the GNU General Public License
25  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
26 
27 Class
28  Foam::Barycentric2D
29 
30 Description
31  Templated 2D Barycentric derived from VectorSpace.
32  Has 3 components, one of which is redundant.
33 
34 SourceFiles
35  Barycentric2DI.H
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef Barycentric2D_H
40 #define Barycentric2D_H
41 
42 #include "contiguous.H"
43 #include "VectorSpace.H"
44 
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
46 
47 namespace Foam
48 {
49 
50 /*---------------------------------------------------------------------------*\
51  Class Barycentric2D Declaration
52 \*---------------------------------------------------------------------------*/
53 
54 template<class Cmpt>
55 class Barycentric2D
56 :
57  public VectorSpace<Barycentric2D<Cmpt>, Cmpt, 3>
58 {
59 public:
60 
61  // Typedefs
62 
63  //- Equivalent type of labels used for valid component indexing
65 
66 
67  // Member Constants
68 
69  //- Rank of Barycentric2D is 1
70  static constexpr direction rank = 1;
71 
72 
73  //- Component labeling enumeration
74  enum components { A, B, C };
75 
76 
77  // Generated Methods: copy construct/assignment
78 
79  //- Default construct
80  Barycentric2D() = default;
81 
82 
83  // Constructors
84 
85  //- Construct initialized to zero
86  inline Barycentric2D(const Foam::zero);
87 
88  //- Construct from components
89  inline Barycentric2D
90  (
91  const Cmpt& va,
92  const Cmpt& vb,
93  const Cmpt& vc
94  );
95 
96 
97  // Member Functions
98 
99  // Access
100 
101  inline const Cmpt& a() const;
102  inline const Cmpt& b() const;
103  inline const Cmpt& c() const;
104 
105 
106  // Edit
107 
108  inline Cmpt& a();
109  inline Cmpt& b();
110  inline Cmpt& c();
111 
112 
113  // Tests
114 
115  //- True if any coordinates are negative
116  inline bool outside() const;
117 };
118 
119 
120 // * * * * * * * * * * * * * * * * * Traits * * * * * * * * * * * * * * * * //
121 
122 //- Data are contiguous if component type is contiguous
123 template<class Cmpt>
124 struct is_contiguous<Barycentric2D<Cmpt>> : is_contiguous<Cmpt> {};
125 
126 //- Data are contiguous label if component type is label
127 template<class Cmpt>
128 struct is_contiguous_label<Barycentric2D<Cmpt>> : is_contiguous_label<Cmpt> {};
129 
130 //- Data are contiguous scalar if component type is scalar
131 template<class Cmpt>
133 
134 
135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
136 
137 } // End namespace Foam
138 
139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
140 
141 #include "Barycentric2DI.H"
142 
143 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
144 
145 #endif
146 
147 // ************************************************************************* //
Foam::Barycentric2D::rank
static constexpr direction rank
Rank of Barycentric2D is 1.
Definition: Barycentric2D.H:69
VectorSpace.H
Foam::Barycentric2D::b
const Cmpt & b() const
Definition: Barycentric2DI.H:62
Foam::Barycentric2D
Templated 2D Barycentric derived from VectorSpace. Has 3 components, one of which is redundant.
Definition: Barycentric2D.H:54
Barycentric2DI.H
Foam::is_contiguous_label
A template class to specify if a data type is composed solely of Foam::label elements.
Definition: contiguous.H:83
Foam::Barycentric2D::c
const Cmpt & c() const
Definition: Barycentric2DI.H:69
Foam::Barycentric2D::B
Definition: Barycentric2D.H:73
Foam::VectorSpace
Templated vector space.
Definition: VectorSpace.H:56
Foam::Barycentric2D::Barycentric2D
Barycentric2D()=default
Default construct.
Foam::Barycentric2D::outside
bool outside() const
True if any coordinates are negative.
Definition: Barycentric2DI.H:97
Foam::Barycentric2D::labelType
Barycentric2D< label > labelType
Equivalent type of labels used for valid component indexing.
Definition: Barycentric2D.H:63
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::is_contiguous_scalar
A template class to specify if a data type is composed solely of Foam::scalar elements.
Definition: contiguous.H:91
contiguous.H
Foam::direction
uint8_t direction
Definition: direction.H:47
Foam::Barycentric2D::A
Definition: Barycentric2D.H:73
Foam::C
Graphite solid properties.
Definition: C.H:50
Foam::Barycentric2D::a
const Cmpt & a() const
Definition: Barycentric2DI.H:55
Foam::is_contiguous
A template class to specify that a data type can be considered as being contiguous in memory.
Definition: contiguous.H:75
Foam::zero
A class representing the concept of 0 (zero) that can be used to avoid manipulating objects known to ...
Definition: zero.H:62
Foam::Barycentric2D::components
components
Component labeling enumeration.
Definition: Barycentric2D.H:73