SVDI.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-2018 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  return b >= 0 ? a : -a;
33 }
34 
35 
36 // * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
37 
38 inline const Foam::scalarRectangularMatrix& Foam::SVD::U() const
39 {
40  return U_;
41 }
42 
43 
44 inline const Foam::scalarRectangularMatrix& Foam::SVD::V() const
45 {
46  return V_;
47 }
48 
49 
50 inline const Foam::scalarDiagonalMatrix& Foam::SVD::S() const
51 {
52  return S_;
53 }
54 
55 
56 inline bool Foam::SVD::converged() const
57 {
58  return converged_;
59 }
60 
61 
62 inline Foam::label Foam::SVD::nZeros() const
63 {
64  return nZeros_;
65 }
66 
67 
68 inline Foam::scalar Foam::SVD::minNonZeroS() const
69 {
70  scalar minS = S_[0];
71  for (label i=1; i<S_.size(); i++)
72  {
73  scalar s = S_[i];
74  if (s > vSmall && s < minS) minS = s;
75  }
76  return minS;
77 }
78 
79 
80 // ************************************************************************* //
Foam::SVD::nZeros
label nZeros() const
Return the number of zero singular values.
Definition: SVDI.H:62
Foam::SVD::U
const scalarRectangularMatrix & U() const
Return U.
Definition: SVDI.H:38
Foam::SVD::minNonZeroS
scalar minNonZeroS() const
Return the minimum non-zero singular value.
Definition: SVDI.H:68
Foam::List::size
void size(const label)
Override size to be inconsistent with allocated storage.
Definition: ListI.H:164
Foam::constant::physicoChemical::b
const dimensionedScalar b
Wien displacement law constant: default SI units: [m K].
Definition: createFields.H:27
Foam::SVD::S
const scalarDiagonalMatrix & S() const
Return the singular values.
Definition: SVDI.H:50
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::converged
bool converged() const
Return the minimum non-zero singular value.
Definition: SVDI.H:56
Foam::SVD::V
const scalarRectangularMatrix & V() const
Return the square matrix V.
Definition: SVDI.H:44
T
const volScalarField & T
Definition: createFieldRefs.H:2