SphericalTensor.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2021 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::SphericalTensor
26 
27 Description
28  Templated 3D SphericalTensor derived from VectorSpace adding construction
29  from 1 component, element access using th ii() member function and the
30  inner-product (dot-product) and outer-product operators.
31 
32 SourceFiles
33  SphericalTensorI.H
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef SphericalTensor_H
38 #define SphericalTensor_H
39 
40 #include "VectorSpace.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class SphericalTensor Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 template<class Cmpt>
52 class SphericalTensor
53 :
54  public VectorSpace<SphericalTensor<Cmpt>, Cmpt, 1>
55 {
56 
57 public:
58 
59  //- Equivalent type of labels used for valid component indexing
61 
62 
63  // Member constants
64 
65  //- Rank of SphericalTensor is 2
66  static const direction rank = 2;
67 
68 
69  // Static Data Members
70 
71  static const SphericalTensor I;
72  static const SphericalTensor oneThirdI;
73  static const SphericalTensor twoThirdsI;
74 
75 
76  //- Component labeling enumeration
77  enum components { II };
78 
79 
80  // Constructors
81 
82  //- Construct null
83  inline SphericalTensor();
84 
85  //- Construct initialised to zero
86  inline SphericalTensor(const Foam::zero);
87 
88  //- Construct given VectorSpace
89  template<class Cmpt2>
90  inline SphericalTensor
91  (
92  const VectorSpace<SphericalTensor<Cmpt2>, Cmpt2, 1>&
93  );
94 
95  //- Construct given the component
96  inline SphericalTensor(const Cmpt& tii);
97 
98  //- Construct from Istream
99  inline SphericalTensor(Istream&);
100 
101 
102  // Member Functions
103 
104  // Access
105 
106  inline const Cmpt& ii() const;
107  inline Cmpt& ii();
108 
109 
110  //- Transpose
111  inline const SphericalTensor<Cmpt>& T() const;
112 };
113 
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 } // End namespace Foam
118 
119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
120 
121 // Include inline implementations
122 #include "SphericalTensorI.H"
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 #endif
127 
128 // ************************************************************************* //
components
Component labeling enumeration.
uint8_t direction
Definition: direction.H:45
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
static const SphericalTensor oneThirdI
Templated vector space.
Definition: VectorSpace.H:53
static const direction rank
Rank of SphericalTensor is 2.
Templated 3D SphericalTensor derived from VectorSpace adding construction from 1 component, element access using th ii() member function and the inner-product (dot-product) and outer-product operators.
SphericalTensor()
Construct null.
const Cmpt & ii() const
static const SphericalTensor twoThirdsI
const SphericalTensor< Cmpt > & T() const
Transpose.
SphericalTensor< label > labelType
Equivalent type of labels used for valid component indexing.
A class representing the concept of 0 used to avoid unnecessary manipulations for objects that are kn...
Definition: zero.H:49
Namespace for OpenFOAM.
static const SphericalTensor I