src/POD/PODOrthoNormalBase/PODOrthoNormalBase.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend is free software: you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation, either version 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     PODOrthoNormalBase
  26
  27 Description
  28     Establish POD ortho-normal base and interpolation coefficients give a list
  29     of fields. Size of ortho-normal base is calculated from the desired
  30     accuracy, e.g. 0.99-0.99999 (in energy terms)
  31
  32 Author
  33     Hrvoje Jasak, Wikki Ltd.  All rights reserved.
  34
  35 SourceFiles
  36     PODOrthoNormalBase.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef PODOrthoNormalBase_H
  41 #define PODOrthoNormalBase_H
  42
  43 #include "volFields.H"
  44 #include "RectangularMatrix.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50
  51 /*---------------------------------------------------------------------------*\
  52                        Class PODOrthoNormalBase Declaration
  53 \*---------------------------------------------------------------------------*/
  54
  55 template<class Type>
  56 class PODOrthoNormalBase
  57 {
  58 public:
  59
  60     // Public typedefs
  61
  62         typedef GeometricField<Type, fvPatchField, volMesh> GeoTypeField;
  63
  64         typedef Field<Type> TypeField;
  65
  66
  67 private:
  68
  69     // Private data
  70
  71         //- List of ortho-normal fields
  72         PtrList<GeoTypeField> orthoFields_;
  73
  74         //- Interpolation coefficients
  75         RectangularMatrix<Type>* interpolationCoeffsPtr_;
  76
  77
  78     // Private Member Functions
  79
  80         //- Disallow default bitwise copy construct
  81         PODOrthoNormalBase(const PODOrthoNormalBase&);
  82
  83         //- Disallow default bitwise assignment
  84         void operator=(const PODOrthoNormalBase&);
  85
  86         //- Calculate ortho-normal base
  87         void calcOrthoBase
  88         (
  89             const PtrList<GeoTypeField>& snapshots,
  90             const scalar accuracy
  91         );
  92
  93
  94 public:
  95
  96     // Constructors
  97
  98         //- Construct given list of snapshots and accuracy
  99         PODOrthoNormalBase
 100         (
 101             const PtrList<GeoTypeField>& snapshots,
 102             const scalar accuracy
 103         );
 104
 105
 106     // Destructor
 107
 108         ~PODOrthoNormalBase();
 109
 110
 111     // Member Functions
 112
 113         //- Return base size
 114         label baseSize() const
 115         {
 116             return orthoFields_.size();
 117         }
 118
 119         //- Return n-th ortho-normal base field
 120         const GeoTypeField& orthoField(const label n) const
 121         {
 122             return orthoFields_[n];
 123         }
 124
 125         //- Return interpolation coefficients (snapshots x orthoVectors)
 126         const RectangularMatrix<Type>& interpolationCoeffs() const
 127         {
 128             return *interpolationCoeffsPtr_;
 129         }
 130 };
 131
 132
 133 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 134
 135 } // End namespace Foam
 136
 137 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 138
 139 #ifdef NoRepository
 140 #   include "PODOrthoNormalBase.C"
 141 #endif
 142
 143
 144 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 145
 146 #endif
 147
 148 // ************************************************************************* //