SphericalTensor.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-2013 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  enum
66  {
67  rank = 2 // Rank of SphericalTensor is 2
68  };
69 
70 
71  // Static data members
72 
73  static const char* const typeName;
74  static const char* componentNames[];
75  static const SphericalTensor zero;
76  static const SphericalTensor one;
77  static const SphericalTensor max;
78  static const SphericalTensor min;
79  static const SphericalTensor I;
80  static const SphericalTensor oneThirdI;
81  static const SphericalTensor twoThirdsI;
82 
83 
84  //- Component labeling enumeration
85  enum components { II };
86 
87 
88  // Constructors
89 
90  //- Construct null
91  inline SphericalTensor();
92 
93  //- Construct given VectorSpace
94  template<class Cmpt2>
95  inline SphericalTensor
96  (
97  const VectorSpace<SphericalTensor<Cmpt2>, Cmpt2, 1>&
98  );
99 
100  //- Construct given the component
101  inline SphericalTensor(const Cmpt& tii);
102 
103  //- Construct from Istream
104  inline SphericalTensor(Istream&);
105 
106 
107  // Member Functions
108 
109  // Access
110 
111  inline const Cmpt& ii() const;
112  inline Cmpt& ii();
113 
114 
115  //- Transpose
116  inline const SphericalTensor<Cmpt>& T() const;
117 };
118 
119 
120 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
121 
122 } // End namespace Foam
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 // Include inline implementations
127 #include "SphericalTensorI.H"
128 
129 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 
131 #endif
132 
133 // ************************************************************************* //
static const SphericalTensor zero
components
Component labeling enumeration.
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
const SphericalTensor< Cmpt > & T() const
Transpose.
static const char * componentNames[]
static const SphericalTensor max
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.
static const char *const typeName
Namespace for OpenFOAM.
SphericalTensor()
Construct null.
const Cmpt & ii() const
static const SphericalTensor min
static const SphericalTensor twoThirdsI
static const SphericalTensor one
SphericalTensor< label > labelType
Equivalent type of labels used for valid component indexing.
Templated vector space.
Definition: VectorSpace.H:52
static const SphericalTensor oneThirdI
static const SphericalTensor I