ITHACAPOD.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
     ██╗████████╗██╗  ██╗ █████╗  ██████╗ █████╗       ███████╗██╗   ██╗
     ██║╚══██╔══╝██║  ██║██╔══██╗██╔════╝██╔══██╗      ██╔════╝██║   ██║
     ██║   ██║   ███████║███████║██║     ███████║█████╗█████╗  ██║   ██║
     ██║   ██║   ██╔══██║██╔══██║██║     ██╔══██║╚════╝██╔══╝  ╚██╗ ██╔╝
     ██║   ██║   ██║  ██║██║  ██║╚██████╗██║  ██║      ██║      ╚████╔╝
     ╚═╝   ╚═╝   ╚═╝  ╚═╝╚═╝  ╚═╝ ╚═════╝╚═╝  ╚═╝      ╚═╝       ╚═══╝
 
 * In real Time Highly Advanced Computational Applications for Finite Volumes
 * Copyright (C) 2017 by the ITHACA-FV authors
-------------------------------------------------------------------------------
License
    This file is part of ITHACA-FV
    ITHACA-FV is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
    ITHACA-FV is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    GNU Lesser General Public License for more details.
    You should have received a copy of the GNU Lesser General Public License
    along with ITHACA-FV. If not, see <http://www.gnu.org/licenses/>.
Class
    ITHACAPOD
Description
    Implementation of a POD decomposition of a general field
SourceFiles
    ITHACAPOD.C
\*---------------------------------------------------------------------------*/

 
#ifndef ITHACAPOD_H
#define ITHACAPOD_H
 
#include "fvCFD.H"
#include "ITHACAutilities.H"
#include "ITHACAstream.H"
#include "ITHACAparameters.H"
#include "Foam2Eigen.H"
#include "EigenFunctions.H"
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wold-style-cast"
#pragma GCC diagnostic ignored "-Wnon-virtual-dtor"
#include <Spectra/GenEigsSolver.h>
#include <Spectra/SymEigsSolver.h>
#include <Eigen/Eigen>
#include <unsupported/Eigen/SparseExtra>
#pragma GCC diagnostic pop
 
/*---------------------------------------------------------------------------*\
                        Class reductionProblem Declaration
\*---------------------------------------------------------------------------*/

namespace ITHACAPOD
{
 
// Public Members
 
//------------------------------------------------------------------------------
template<class Type, template<class> class PatchField, class GeoMesh>
void getModes(
    PtrList<GeometricField<Type, PatchField, GeoMesh >> & snapshots,
    PtrList<GeometricField<Type, PatchField, GeoMesh >>& modes,
    word fieldName, bool podex, bool supex = 0, bool sup = 0,
    label nmodes = 0, bool correctBC = true);
 
//------------------------------------------------------------------------------
template<class Type, template<class> class PatchField, class GeoMesh>
void getModesSVD(
    PtrList<GeometricField<Type, PatchField, GeoMesh >> &
    snapshots, PtrList<GeometricField<Type, PatchField, GeoMesh >>& modes,
    word fieldName, bool podex, bool supex = 0, bool sup = 0,
    label nmodes = 0, bool correctBC = true);
 
 
//------------------------------------------------------------------------------
template<class Type, template<class> class PatchField, class GeoMesh>
void getNestedSnapshotMatrix(
    PtrList<GeometricField<Type, PatchField, GeoMesh >> & snapshots,
    PtrList<GeometricField<Type, PatchField, GeoMesh >>& modes,
    word fieldName, label Npar,
    label NnestedOut);
 
 
//------------------------------------------------------------------------------
template<class Type, template<class> class PatchField, class GeoMesh>
void getWeightedModes(
    PtrList<GeometricField<Type, PatchField, GeoMesh >> & snapshots,
    PtrList<GeometricField<Type, PatchField, GeoMesh >>& modes,
    word fieldName, bool podex, bool supex = 0, bool sup = 0,
    label nmodes = 0, bool correctBC = true);
 
//------------------------------------------------------------------------------
void GrammSchmidt(Eigen::MatrixXd& Matrix);
 
//------------------------------------------------------------------------------
template<class Field_type>
Eigen::MatrixXd corMatrix(Field_type& snapshots);
 
 
//------------------------------------------------------------------------------
template<class Type, template<class> class PatchField, class GeoMesh>
void exportBases(
    PtrList<GeometricField<Type, PatchField, GeoMesh >> & snapshots,
    PtrList<GeometricField<Type, PatchField, GeoMesh >>& bases,
    word fieldName,
    bool sup = 0);
 
//------------------------------------------------------------------------------
void exportEigenvalues(scalarField Eigenvalues, fileName name,
                       bool sup = 0);
 
//------------------------------------------------------------------------------
void exportcumEigenvalues(scalarField cumEigenvalues,  fileName name,
                          bool sup = 0);
 
//------------------------------------------------------------------------------
template<class Type, template<class> class PatchField, class GeoMesh>
PtrList<GeometricField<Type, PatchField, GeoMesh >> DEIMmodes(
    PtrList<GeometricField<Type, PatchField, GeoMesh >>& SnapShotsMatrix,
    label nmodes, word FunctionName, word FieldName);
 
//------------------------------------------------------------------------------
template<typename type_matrix>
std::tuple<List<Eigen::SparseMatrix<double >>, List<Eigen::VectorXd >>
DEIMmodes(PtrList<type_matrix> & MatrixList, label nmodesA, label nmodesB,
          word MatrixName = "Matrix");
 
//------------------------------------------------------------------------------
std::tuple<List<Eigen::SparseMatrix<double >>, List<Eigen::VectorXd >>
DEIMmodes(List<Eigen::SparseMatrix<double >> & A, List<Eigen::VectorXd>& b,
          label nmodesA, label nmodesB, word MatrixName = "Matrix");
 
 
//------------------------------------------------------------------------------
template<class Type, template<class> class PatchField, class GeoMesh>
void getModes(PtrList<GeometricField<Type, PatchField, GeoMesh >> & snapshots,
              PtrList<GeometricField<Type, PatchField, GeoMesh >>& modes,
              PtrList<volScalarField>& Volumes, word fieldName, bool podex, bool supex = 0,
              bool sup = 0,
              label nmodes = 0);
 
//------------------------------------------------------------------------------
template<class Field_type, class Field_type_2>
void getModes(PtrList<Field_type>& snapshots, PtrList<Field_type>& modes,
              PtrList<Field_type_2>& fields2, word fieldName, bool podex, bool supex = 0,
              bool sup = 0,
              label nmodes = 0);
 
//------------------------------------------------------------------------------
template<class Type, template<class> class PatchField, class GeoMesh>
void getModesMemoryEfficient(
    GeometricField<Type, PatchField, GeoMesh>& templateField,
    word snapshotsPath,
    PtrList<GeometricField<Type, PatchField, GeoMesh >> & modes,
    word fieldName,
    bool podex = false,
    bool supex = false,
    bool sup = false,
    label nmodes = 0,
    bool correctBC = true,
    autoPtr<GeometricField<Type, PatchField, GeoMesh >> meanField = NULL);
 
//------------------------------------------------------------------------------
template<class Type, template<class> class PatchField, class GeoMesh>
void getMeanMemoryEfficient(
    GeometricField<Type, PatchField, GeoMesh>& templateField,
    word snapshotsPath,
    autoPtr<GeometricField<Type, PatchField, GeoMesh >> & meanField,
    bool meanex = false);
 
//------------------------------------------------------------------------------
template<class Type, template<class> class PatchField, class GeoMesh >
scalar computeInnerProduct(
    const GeometricField<Type, PatchField, GeoMesh>& field1,
    const GeometricField<Type, PatchField, GeoMesh>& field2);
 
//------------------------------------------------------------------------------
template<class Type, template<class> class PatchField, class GeoMesh>
scalar computeFrobeniusInnerProduct(
    const GeometricField<Type, PatchField, GeoMesh>& field1,
    const GeometricField<Type, PatchField, GeoMesh>& field2);
 
};
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif