symmTensor.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-2012 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 Typedef
28  Foam::symmTensor
29 
30 Description
31  SymmTensor of scalars, i.e. SymmTensor<scalar>.
32 
33  Analytical functions for the computation of real eigenvalues and
34  real eigenvectors from a given symmTensor.
35 
36 See also
37  Test-SymmTensor.C
38 
39 SourceFiles
40  symmTensor.C
41 
42 \*---------------------------------------------------------------------------*/
43 
44 #ifndef symmTensor_H
45 #define symmTensor_H
46 
47 #include "SymmTensor.H"
48 #include "vector.H"
49 #include "sphericalTensor.H"
50 #include "tensor.H"
51 
52 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
53 
54 namespace Foam
55 {
56 
57 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
58 
59 typedef SymmTensor<scalar> symmTensor;
60 
61 typedef Tensor<scalar> tensor;
62 
63 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
64 
65 //- Return real ascending-order eigenvalues of a given symmTensor
66 // \param T symmTensor
67 //
68 // \return vector real eigenvalues
69 vector eigenValues(const symmTensor& T);
70 
71 
72 //- Return a real eigenvector corresponding to
73 //- a given real eigenvalue of a given symmTensor
74 // \param T symmTensor
75 // \param eVal real eigenvalue
76 // \param standardBasis1 symmTensor orthogonal component 1
77 // \param standardBasis2 symmTensor orthogonal component 2
78 //
79 // \return vector real eigenvector
80 vector eigenVector
81 (
82  const symmTensor& T,
83  const scalar eVal,
84  const vector& standardBasis1,
85  const vector& standardBasis2
86 );
87 
88 
89 //- Return real eigenvectors corresponding to
90 //- given real eigenvalues of a given symmTensor
91 // \param T symmTensor
92 // \param eVals real eigenvalues
93 //
94 // \return tensor real eigenvectors, each row is an eigenvector
95 tensor eigenVectors
96 (
97  const symmTensor& T,
98  const vector& eVals
99 );
100 
101 
102 //- Return real eigenvectors of a given symmTensor by computing
103 //- the real eigenvalues of the tensor in the background
104 // \param T symmTensor
105 //
106 // \return tensor real eigenvectors, each row is an eigenvector
107 tensor eigenVectors(const symmTensor& T);
108 
109 
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
111 
112 } // End namespace Foam
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 #endif
117 
118 // ************************************************************************* //
Foam::Tensor< scalar >
Foam::SymmTensor< scalar >
Foam::eigenVector
vector eigenVector(const symmTensor &T, const scalar eVal, const vector &standardBasis1, const vector &standardBasis2)
Definition: symmTensor.C:152
Foam::eigenValues
dimensionedVector eigenValues(const dimensionedSymmTensor &dt)
Definition: dimensionedTensor.C:149
SymmTensor.H
Foam::eigenVectors
dimensionedTensor eigenVectors(const dimensionedSymmTensor &dt)
Definition: dimensionedTensor.C:160
tensor.H
sphericalTensor.H
Foam::T
void T(FieldField< Field, Type > &f1, const FieldField< Field, Type > &f2)
Definition: FieldFieldFunctions.C:58
Foam::symmTensor
SymmTensor< scalar > symmTensor
SymmTensor of scalars, i.e. SymmTensor<scalar>.
Definition: symmTensor.H:59
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::Vector< scalar >
vector.H
Foam::tensor
Tensor< scalar > tensor
Tensor of scalars, i.e. Tensor<scalar>.
Definition: symmTensor.H:61