ITHACADMD.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
    ITHACADMD
Description
    Implementation of a DMD of a general field
SourceFiles
    ITHACADMD.C
\*---------------------------------------------------------------------------*/

 
#ifndef ITHACADMD_H
#define ITHACADMD_H
 
#include "fvCFD.H"
#include "ITHACAutilities.H"
#include "ITHACAstream.H"
#include "ITHACAparameters.H"
#include "Foam2Eigen.H"
#include "EigenFunctions.H"
#include "ITHACAPOD.H"
#include <functional>
#include "Modes.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>
#include <unsupported/Eigen/MatrixFunctions>
#include <redsvd>
#pragma GCC diagnostic pop
 
/*---------------------------------------------------------------------------*\
                        Class reductionProblem Declaration
\*---------------------------------------------------------------------------*/

template<class Type, template<class> class PatchField, class GeoMesh>
class ITHACADMD
{
    public:

        ITHACADMD(PtrList<GeometricField<Type, PatchField, GeoMesh >> & snapshots,
                  double dt);

        PtrList<GeometricField<Type, PatchField, GeoMesh >> snapshotsDMD;

        Modes<Type, PatchField, GeoMesh> DMDmodesReal;

        Modes<Type, PatchField, GeoMesh> DMDmodesImag;

        Eigen::VectorXcd eigenValues;

        Eigen::MatrixXcd DMDEigenModes;

        List<Eigen::MatrixXcd> DMDEigenModesBC;

        Eigen::MatrixXcd PODm;

        List<Eigen::MatrixXcd> PODmBC;

        Eigen::VectorXd Amplitudes;

        Eigen::MatrixXcd dynamics;

        label NSnaps;

        label SVD_rank_public;

        double originalDT;

        bool redSVD;
 
        //--------------------------------------------------------------------------
        void getModes(label SVD_rank = -1, bool exact = true,
                      bool exportDMDmodes = false);
 
        //--------------------------------------------------------------------------
        void convert2Foam();
 
        //--------------------------------------------------------------------------
        void exportEigs(word exportFolder);
 
        //--------------------------------------------------------------------------
        void getDynamics(double tStart, double tFinal, double dt);
 
        //--------------------------------------------------------------------------
        void reconstruct(word exportFolder, word fieldName);
};
 
typedef ITHACADMD<scalar, fvPatchField, volMesh> ITHACADMDvolScalar;
typedef ITHACADMD<vector, fvPatchField, volMesh> ITHACADMDvolVector;
 
#endif