DEIM.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
    DEIM
Description
    Implementation of the discrete empirical interpolation method
SourceFiles
    DEIM.C
\*---------------------------------------------------------------------------*/
#include "fvCFD.H"
#include "ITHACAPOD.H"
#include "Foam2Eigen.H"
#include "EigenFunctions.H"
#include "ITHACAutilities.H"
#include "fvMeshSubset.H"
 
 
template<typename T>
class DEIM
{
    public:
 
        //----------------------------------------------------------------------
        DEIM (PtrList<T>& SnapShotsMatrix, label MaxModes, word FunctionName,
              word FieldName);
 
        //----------------------------------------------------------------------
        DEIM (PtrList<T>& SnapShotsMatrix, label MaxModesA, label MaxModesB,
              word MatrixName);
 
        PtrList<T> SnapShotsMatrix;
 
        PtrList<T> modes;
 
        std::tuple<List<Eigen::SparseMatrix<double>>, List<Eigen::VectorXd>>
                Matrix_Modes;
 
        label MaxModes;
        label MaxModesA;
        label MaxModesB;
 
        word FunctionName;
 
        double tolerance;
 
        Eigen::VectorXd theta;
        Eigen::VectorXd thetaA;
        Eigen::VectorXd thetaB;
 
        label Ncells;
 
        bool source;
 
        word MatrixName;
 
        Eigen::MatrixXd MatrixModes;
 
        Eigen::MatrixXd MatrixOnline;
        List<Eigen::SparseMatrix<double>> MatrixOnlineA;
        Eigen::MatrixXd MatrixOnlineB;
 
        Eigen::MatrixXd U;
        List<Eigen::SparseMatrix<double>> UA;
        Eigen::MatrixXd UB;
 
        autoPtr<IOList<label>> magicPoints;
        autoPtr<IOList<label>> magicPointsArow;
        autoPtr<IOList<label>> magicPointsAcol;
        autoPtr<IOList<label>> magicPointsB;
 
        autoPtr<IOList<labelList>> totalMagicPoints;
        autoPtr<IOList<labelList>> totalMagicPointsA;
        autoPtr<IOList<labelList>> totalMagicPointsB;
 
        autoPtr<IOList<label>> uniqueMagicPoints;
        autoPtr<IOList<label>> uniqueMagicPointsA;
        autoPtr<IOList<label>> uniqueMagicPointsB;
 
        word Folder;
        word FolderM;
 
        autoPtr<IOList<label>> xyz;
        autoPtr<IOList<label>> xyz_Arow;
        autoPtr<IOList<label>> xyz_Acol;
        autoPtr<IOList<label>> xyz_B;
 
        List<label> localMagicPoints;
        List<label> localMagicPointsArow;
        List<label> localMagicPointsAcol;
        List<label> localMagicPointsB;
 
        Eigen::SparseMatrix<double> P;
        List<Eigen::SparseMatrix<double>> PA;
        Eigen::SparseMatrix<double> PB;
 
        autoPtr<fvMeshSubset> submesh;
        autoPtr<fvMeshSubset> submeshA;
        autoPtr<fvMeshSubset> submeshB;
 
        bool runSubMesh;
        bool runSubMeshA;
        bool runSubMeshB;
 
        //----------------------------------------------------------------------
        template <class S>
        S generateSubmesh(label layers, const fvMesh& mesh, S field,
                          label secondTime = 0);
 
        //----------------------------------------------------------------------
        template <class S>
        S generateSubmeshMatrix(label layers, const fvMesh& mesh, S field,
                                label secondTime = 0);
 
        //----------------------------------------------------------------------
        template <class S>
        S generateSubmeshVector(label layers, const fvMesh& mesh, S field,
                                label secondTime = 0);
 
        //----------------------------------------------------------------------
        template <class F>
        F generateSubField(F& field);
 
        //----------------------------------------------------------------------
        template <class F>
        F generateSubFieldMatrix(F& field);
 
        //----------------------------------------------------------------------
        template <class F>
        F generateSubFieldVector(F& field);
 
        //----------------------------------------------------------------------
        void onlineCoeffs();
 
        //----------------------------------------------------------------------
        List<label> global2local(List<label>& points,
                                 fvMeshSubset& submesh);
 
        //----------------------------------------------------------------------
        void check3DIndices(label& ind_rowA, label&  ind_colA, label& xyz_rowA,
                            label& xyz_colA);
 
        //----------------------------------------------------------------------
        void check3DIndices(label& ind_rowA, label& xyz_rowA);
 
        //----------------------------------------------------------------------
        label getNcells(label sizeM);
 
        //----------------------------------------------------------------------
        void setMagicPoints(labelList& newMagicPoints, labelList& newxyz);
 
};