Modes.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
    EigenFunctions
Description
    Container that contains a list of modes with additional operations
SourceFiles
    Modes.C
\*---------------------------------------------------------------------------*/
 
 
 
#ifndef Modes_H
#define Modes_H
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wold-style-cast"
#include <Eigen/Eigen>
#include <unsupported/Eigen/SparseExtra>
#include <unsupported/Eigen/CXX11/Tensor>
#pragma GCC diagnostic pop
#include "fvCFD.H"
#include "Foam2Eigen.H"
#include "ITHACAutilities.H"
#include "ITHACAstream.H"
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
/*---------------------------------------------------------------------------*\
  Class Modes Declaration
\*---------------------------------------------------------------------------*/
 
//--------------------------------------------------------------------------
template<class Type, template<class> class PatchField, class GeoMesh>
class Modes : public PtrList<GeometricField<Type, PatchField, GeoMesh>>
{
    public:
 
        List<Eigen::MatrixXd> EigenModes;
 
        label NBC;
 
        List<Eigen::MatrixXd> toEigen();
 
        //--------------------------------------------------------------------------
        PtrList<GeometricField<Type, PatchField, GeoMesh>>& toPtrList()
        {
            return static_cast<PtrList<GeometricField<Type, PatchField, GeoMesh>>&>(*this);
        }
 
        //----------------------------------------------------------------------
        List<Eigen::MatrixXd> project(fvMatrix<Type>& Af, label numberOfModes = 0,
                                      word projType = "G");
 
        //----------------------------------------------------------------------
        Eigen::MatrixXd project(GeometricField<Type, PatchField, GeoMesh>& field,
                                label numberOfModes = 0, word projType = "G", fvMatrix<Type>* Af = NULL);
 
        //----------------------------------------------------------------------
        Eigen::MatrixXd project(PtrList<GeometricField<Type, PatchField, GeoMesh>>&
                                fields,
                                label numberOfModes = 0, word projType = "G", fvMatrix<Type>* Af = NULL);
 
        //----------------------------------------------------------------------
        GeometricField<Type, PatchField, GeoMesh> projectSnapshot(
            GeometricField<Type, PatchField, GeoMesh>& field,
            label numberOfModes = 0, word projType = "G", fvMatrix<Type>* Af = NULL);
 
        //----------------------------------------------------------------------
        GeometricField<Type, PatchField, GeoMesh> reconstruct(
            GeometricField<Type, PatchField, GeoMesh>& inputField, Eigen::MatrixXd Coeff,
            word Name);
 
        //----------------------------------------------------------------------
        PtrList<GeometricField<Type, PatchField, GeoMesh>> reconstruct(
                    GeometricField<Type, PatchField, GeoMesh>& inputField,
                    List < Eigen::MatrixXd> Coeff,
                    word Name);
 
        //----------------------------------------------------------------------
        void projectSnapshots(PtrList<GeometricField<Type, PatchField, GeoMesh>>
                              snapshots, PtrList<GeometricField<Type, PatchField, GeoMesh>>& projSnapshots,
                              label numberOfModes = 0, word innerProduct = "L2");
 
        //----------------------------------------------------------------------
        void projectSnapshots(PtrList<GeometricField<Type, PatchField, GeoMesh>>
                              snapshots, PtrList<GeometricField<Type, PatchField, GeoMesh>>& projSnapshots,
                              word innerProduct = "L2");
 
        //----------------------------------------------------------------------
        void projectSnapshots(PtrList<GeometricField<Type, PatchField, GeoMesh>>
                              snapshots, PtrList<GeometricField<Type, PatchField, GeoMesh>>& projSnapshots,
                              PtrList<volScalarField> Volumes,
                              label numberOfModes = 0, word innerProduct = "L2");
 
        //----------------------------------------------------------------------
        void projectSnapshots(PtrList<GeometricField<Type, PatchField, GeoMesh>>
                              snapshots, PtrList<GeometricField<Type, PatchField, GeoMesh>>& projSnapshots,
                              PtrList<volScalarField> Volumes,
                              word innerProduct);
 
        void operator=(const PtrList<GeometricField<Type, PatchField, GeoMesh>>& modes);
};
 
typedef Modes<scalar, fvPatchField, volMesh> volScalarModes;
typedef Modes<vector, fvPatchField, volMesh> volVectorModes;
typedef Modes<scalar, fvsPatchField, surfaceMesh> surfaceScalarModes;
 
#endif