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 | www.openfoam.com
6 \\/ M anipulation |
7-------------------------------------------------------------------------------
8 Copyright (C) 2011-2016 OpenFOAM Foundation
9 Copyright (C) 2019-2020 OpenCFD Ltd.
10-------------------------------------------------------------------------------
11License
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
27Class
28 Foam::SphericalTensor
29
30Description
31 A templated (3 x 3) diagonal tensor of objects of <T>, effectively
32 containing 1 element, derived from VectorSpace.
33
34See also
35 Test-SphericalTensor.C
36
37SourceFiles
38 SphericalTensorI.H
39
40\*---------------------------------------------------------------------------*/
41
42#ifndef Foam_SphericalTensor_H
43#define Foam_SphericalTensor_H
44
45#include "contiguous.H"
46#include "VectorSpace.H"
47
48// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49
50namespace Foam
51{
52
53/*---------------------------------------------------------------------------*\
54 Class SphericalTensor Declaration
55\*---------------------------------------------------------------------------*/
56
57template<class Cmpt>
59:
60 public VectorSpace<SphericalTensor<Cmpt>, Cmpt, 1>
61{
62public:
63
64 // Typedefs
65
66 //- Equivalent type of labels used for valid component indexing
68
69
70 // Member Constants
71
72 //- Rank of SphericalTensor is 2
73 static constexpr direction rank = 2;
74
75
76 // Static Data Members
78 static const SphericalTensor I;
80 static const SphericalTensor twoThirdsI;
81
82
83 //- Component labeling enumeration
84 enum components { II };
85
86
87 // Generated Methods
88
89 //- Default construct
90 SphericalTensor() = default;
91
92 //- Copy construct
93 SphericalTensor(const SphericalTensor&) = default;
94
95 //- Copy assignment
96 SphericalTensor& operator=(const SphericalTensor&) = default;
97
98
99 // Constructors
100
101 //- Construct initialized to zero
102 inline SphericalTensor(const Foam::zero);
103
104 //- Construct given VectorSpace
105 template<class Cmpt2>
106 inline SphericalTensor
107 (
108 const VectorSpace<SphericalTensor<Cmpt2>, Cmpt2, 1>&
109 );
110
111 //- Construct given the component
112 inline explicit SphericalTensor(const Cmpt& tii);
113
114 //- Construct from Istream
115 inline explicit SphericalTensor(Istream& is);
116
117
118 // Member Functions
119
120 // Access
121
122 inline const Cmpt& ii() const;
123 inline Cmpt& ii();
124
125
126 // Tensor Operations
127
128 //- Return non-Hermitian transpose (no-op)
129 inline const SphericalTensor<Cmpt>& T() const;
130};
131
132
133// * * * * * * * * * * * * * * * * * Traits * * * * * * * * * * * * * * * * //
134
135//- Data are contiguous if component type is contiguous
136template<class Cmpt>
137struct is_contiguous<SphericalTensor<Cmpt>> : is_contiguous<Cmpt> {};
138
139//- Data are contiguous label if component type is label
140template<class Cmpt>
142:
144{};
145
146//- Data are contiguous scalar if component type is scalar
147template<class Cmpt>
149:
151{};
152
153
154template<class Cmpt>
155class typeOfSolve<SphericalTensor<Cmpt>>
156{
157public:
160};
161
162
163// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
164
165} // End namespace Foam
166
167// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
168
169#include "SphericalTensorI.H"
170
171// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
172
173#endif
174
175// ************************************************************************* //
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:64
A templated (3 x 3) diagonal tensor of objects of <T>, effectively containing 1 element,...
SphericalTensor()=default
Default construct.
static const SphericalTensor twoThirdsI
SphericalTensor< label > labelType
Equivalent type of labels used for valid component indexing.
static const SphericalTensor I
components
Component labeling enumeration.
SphericalTensor & operator=(const SphericalTensor &)=default
Copy assignment.
SphericalTensor(const SphericalTensor &)=default
Copy construct.
static const SphericalTensor oneThirdI
static constexpr direction rank
Rank of SphericalTensor is 2.
const Cmpt & ii() const
const SphericalTensor< Cmpt > & T() const
Return non-Hermitian transpose (no-op)
Templated vector space.
Definition: VectorSpace.H:79
The extended precision type (solveScalar for float)
Definition: products.H:79
A class representing the concept of 0 (zero) that can be used to avoid manipulating objects known to ...
Definition: zero.H:63
Namespace for OpenFOAM.
uint8_t direction
Definition: direction.H:56
A template class to specify if a data type is composed solely of Foam::label elements.
Definition: contiguous.H:86
A template class to specify if a data type is composed solely of Foam::scalar elements.
Definition: contiguous.H:94
A template class to specify that a data type can be considered as being contiguous in memory.
Definition: contiguous.H:78