FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

SVD Class Reference

Singular value decomposition of a rectangular matrix. More...

#include <OpenFOAM/SVD.H>


Detailed Description

Singular value decomposition of a rectangular matrix.

Source files

Definition at line 53 of file SVD.H.

Collaboration diagram for SVD:

List of all members.

Public Member Functions

 SVD (const scalarRectangularMatrix &A, const scalar minCondition=0)
 Construct from a rectangular Matrix.
const scalarRectangularMatrix &  U () const
 Return U.
const scalarRectangularMatrix &  V () const
 Return the square matrix V.
const scalarDiagonalMatrix &  S () const
 Return the singular values.
const scalarRectangularMatrix &  VSinvUt () const
 Return VSinvUt (the pseudo inverse)
label  nZeros () const
 Return the number of zero singular values.
scalar  minNonZeroS () const
 Return the minimum non-zero singular value.

Constructor & Destructor Documentation

SVD ( const scalarRectangularMatrix &   A,
const scalar   minCondition = 0  
)

Member Function Documentation

const Foam::scalarRectangularMatrix & U (  ) const [inline]

Return U.

Definition at line 37 of file SVDI.H.

const Foam::scalarRectangularMatrix & V (  ) const [inline]

Return the square matrix V.

Definition at line 42 of file SVDI.H.

const Foam::scalarDiagonalMatrix & S (  ) const [inline]

Return the singular values.

Definition at line 47 of file SVDI.H.

const Foam::scalarRectangularMatrix & VSinvUt (  ) const [inline]

Return VSinvUt (the pseudo inverse)

Definition at line 52 of file SVDI.H.

Referenced by FitData< FitDataType, ExtendedStencil, Polynomial >::calcFit(), and Foam::SVDinv().

Foam::label nZeros (  ) const [inline]

Return the number of zero singular values.

Definition at line 57 of file SVDI.H.

Foam::scalar minNonZeroS (  ) const [inline]

Return the minimum non-zero singular value.

Definition at line 62 of file SVDI.H.


The documentation for this class was generated from the following files:
  • src/OpenFOAM/matrices/scalarMatrices/SVD/SVD.H
  • src/OpenFOAM/matrices/scalarMatrices/SVD/SVD.C
  • src/OpenFOAM/matrices/scalarMatrices/SVD/SVDI.H