SVDI.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 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 \*---------------------------------------------------------------------------*/
25 
26 // * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * * //
27 
28 template<class T>
29 inline const T Foam::SVD::sign(const T& a, const T& b)
30 {
31  return b >= 0 ? (a >= 0 ? a : -a) : (a >= 0 ? -a : a);
32 }
33 
34 
35 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
36 
38 {
39  return U_;
40 }
41 
43 {
44  return V_;
45 }
46 
48 {
49  return S_;
50 }
51 
53 {
54  return VSinvUt_;
55 }
56 
58 {
59  return nZeros_;
60 }
61 
62 inline Foam::scalar Foam::SVD::minNonZeroS() const
63 {
64  scalar minS = S_[0];
65  for (label i = 1; i < S_.size(); i++)
66  {
67  scalar s = S_[i];
68  if (s > VSMALL && s < minS) minS = s;
69  }
70  return minS;
71 }
72 
73 
74 // ************************************************************************* //
Foam::SVD::minNonZeroS
scalar minNonZeroS() const
Return the minimum non-zero singular value.
Definition: SVDI.H:62
Foam::SVD::sign
const T sign(const T &a, const T &b)
Definition: SVDI.H:29
Foam::DiagonalMatrix< scalar >
Foam::label
intWM_LABEL_SIZE_t label
A label is an int32_t or int64_t as specified by the pre-processor macro WM_LABEL_SIZE.
Definition: label.H:59
Foam::constant::physicoChemical::b
const dimensionedScalar b
Wien displacement law constant: default SI units: [m.K].
Definition: createFields.H:28
Foam::RectangularMatrix< scalar >
s
gmvFile<< "tracers "<< particles.size()<< nl;forAllConstIter(Cloud< passiveParticle >, particles, iter){ gmvFile<< iter().position().x()<< " ";}gmvFile<< nl;forAllConstIter(Cloud< passiveParticle >, particles, iter){ gmvFile<< iter().position().y()<< " ";}gmvFile<< nl;forAllConstIter(Cloud< passiveParticle >, particles, iter){ gmvFile<< iter().position().z()<< " ";}gmvFile<< nl;forAll(lagrangianScalarNames, i){ word name=lagrangianScalarNames[i];IOField< scalar > s(IOobject(name, runTime.timeName(), cloud::prefix, mesh, IOobject::MUST_READ, IOobject::NO_WRITE))
Foam::SVD::S
const scalarDiagonalMatrix & S() const
Return the singular values.
Definition: SVDI.H:47
T
const volScalarField & T
Definition: createFields.H:25
Foam::SVD::VSinvUt
const scalarRectangularMatrix & VSinvUt() const
Return VSinvUt (the pseudo inverse)
Definition: SVDI.H:52
Foam::SVD::nZeros
label nZeros() const
Return the number of zero singular values.
Definition: SVDI.H:57
Foam::SVD::V
const scalarRectangularMatrix & V() const
Return the square matrix V.
Definition: SVDI.H:42
Foam::SVD::U
const scalarRectangularMatrix & U() const
Return U.
Definition: SVDI.H:37