Foam2Eigen.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
     foam2eigen
 Description
     Converts foam objects into Eigen and viceversa
 SourceFiles
     foam2eigen.C
 \*---------------------------------------------------------------------------*/

 
#ifndef Foam2Eigen_H
#define Foam2Eigen_H
 
#include "fvCFD.H"
#include "IOmanip.H"
#include "pointMesh.H"
#include "pointPatchField.H"
#include "ITHACAassert.H"
#include "ITHACAutilities.H"
#include <tuple>
#include <sys/stat.h>
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wold-style-cast"
#include <Eigen/Eigen>
#include <type_traits>
#pragma GCC diagnostic pop
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
 
/*---------------------------------------------------------------------------*\
  Class foam2eigen Declaration
\*---------------------------------------------------------------------------*/

class Foam2Eigen
{
    private:
 
    public:
 
        //----------------------------------------------------------------------
        template <class type_foam_matrix, class type_A, class type_B>
        static void fvMatrix2Eigen(fvMatrix<type_foam_matrix> foam_matrix, type_A& A,
                                   type_B& b);
        /*
        template <typename ScalarType, typename SparseMatType, typename VecType>
        static void fvMat2Eigen(fvMatrix<ScalarType> foam_matrix,
                                SparseMatType& A,
                                VecType& b);*/
        template<typename SparseMatType, typename VecType>
        static void fvMat2Eigen(Foam::fvMatrix<scalar> foam_matrix,
                                SparseMatType& A,
                                VecType& b);
 
        template<typename SparseMatType, typename VecType>
        static void fvMat2Eigen(Foam::fvMatrix<vector> foam_matrix,
                                SparseMatType& A,
                                VecType& b);
 
        //----------------------------------------------------------------------
        template <class type_foam_matrix, class type_A>
        static void fvMatrix2EigenM(fvMatrix<type_foam_matrix>& foam_matrix,
                                    type_A& A);
 
        //----------------------------------------------------------------------
        template <class type_foam_matrix, class type_B>
        static void fvMatrix2EigenV(fvMatrix<type_foam_matrix>& foam_matrix,
                                    type_B& b);
 
 
        //----------------------------------------------------------------------
        template<class Type, template<class> class PatchField, class GeoMesh>
        static Eigen::MatrixXd PtrList2Eigen(
            PtrList<GeometricField<Type, PatchField, GeoMesh >>& fields,
            label Nfields = -1);
 
        //----------------------------------------------------------------------
        template<class Type, template<class> class PatchField, class GeoMesh>
        static Eigen::MatrixXd field2Eigen(
            GeometricField<Type, PatchField, GeoMesh>& field);
 
 
        //----------------------------------------------------------------------
        template<class Type, template<class> class PatchField, class GeoMesh>
        static Eigen::Map<Eigen::MatrixXd> field2EigenMap(
            GeometricField<Type, PatchField, GeoMesh>& field);
 
        //----------------------------------------------------------------------
        template<class Type, template<class> class PatchField, class GeoMesh>
        static Eigen::Map<Eigen::MatrixXd> field2EigenMapBC(
            GeometricField<Type, PatchField, GeoMesh>&
            field, int BC_index);
 
        //----------------------------------------------------------------------
        template<class Type, class GeoMesh>
        static Eigen::VectorXd field2Eigen(const
                                           DimensionedField<Type, GeoMesh>& field);
 
        //----------------------------------------------------------------------
        template<class Type>
        static Eigen::VectorXd field2Eigen(const Field<Type>& field);
 
        //----------------------------------------------------------------------
        template<template<class> class PatchField, class GeoMesh>
        static List<Eigen::VectorXd> field2EigenBC(
            GeometricField<scalar, PatchField, GeoMesh>& field);
 
        //----------------------------------------------------------------------
        template<template<class> class PatchField, class GeoMesh>
        static List<Eigen::VectorXd> field2EigenBC(
            GeometricField<vector, PatchField, GeoMesh>& field);
 
        //----------------------------------------------------------------------
        template<template<class> class PatchField, class GeoMesh>
        static List<Eigen::VectorXd> field2EigenBC(
            GeometricField<tensor, PatchField, GeoMesh>& field);
 
 
        //----------------------------------------------------------------------
        template<template<class> class PatchField, class GeoMesh>
        static List<Eigen::MatrixXd> PtrList2EigenBC(
            PtrList<GeometricField<scalar, PatchField, GeoMesh >>& fields,
            label Nfields = -1);
 
        //----------------------------------------------------------------------
        template<template<class> class PatchField, class GeoMesh >
        static List<Eigen::MatrixXd> PtrList2EigenBC(
            PtrList<GeometricField<vector, PatchField, GeoMesh >>& fields,
            label Nfields = -1);
 
        //----------------------------------------------------------------------
        template<template<class> class PatchField, class GeoMesh >
        static List<Eigen::MatrixXd> PtrList2EigenBC(
            PtrList<GeometricField<tensor, PatchField, GeoMesh >>& fields,
            label Nfields = -1);
 
        //----------------------------------------------------------------------
        template<template<class> class PatchField, class GeoMesh >
        static GeometricField<scalar, PatchField, GeoMesh> Eigen2field(
            GeometricField<scalar, PatchField, GeoMesh>& field,
            Eigen::VectorXd& eigen_vector, bool correctBC = true);
 
        //----------------------------------------------------------------------
        template<template<class> class PatchField, class GeoMesh>
        static GeometricField<vector, PatchField, GeoMesh> Eigen2field(
            GeometricField<vector, PatchField, GeoMesh>& field,
            Eigen::VectorXd& eigen_vector, bool correctBC = true);
 
        //----------------------------------------------------------------------
        template<template<class> class PatchField, class GeoMesh>
        static GeometricField<scalar, PatchField, GeoMesh> Eigen2field(
            GeometricField<scalar, PatchField, GeoMesh>& field,
            Eigen::VectorXd& eigen_vector, List<Eigen::VectorXd>& eigen_vector_boundary);
 
        //----------------------------------------------------------------------
        template<template<class> class PatchField, class GeoMesh>
        static GeometricField<vector, PatchField, GeoMesh> Eigen2field(
            GeometricField<vector, PatchField, GeoMesh>& field,
            Eigen::VectorXd& eigen_vector, List<Eigen::VectorXd>& eigen_vector_boundary);
 
 
        //----------------------------------------------------------------------
        template<template<class> class PatchField, class GeoMesh>
        static GeometricField<tensor, PatchField, GeoMesh> Eigen2field(
            GeometricField<tensor, PatchField, GeoMesh>& field,
            Eigen::VectorXd& eigen_vector, bool correctBC = true);
 
        //----------------------------------------------------------------------
        template <class Type>
        static Field<Type> Eigen2field(
            Field<Type>& field, Eigen::MatrixXd& matrix, bool correctBC = true);
 
        //----------------------------------------------------------------------
        template<class Type, template<class> class PatchField, class GeoMesh>
        static std::tuple<Eigen::MatrixXd, Eigen::VectorXd> projectFvMatrix(
            fvMatrix<Type>& matrix,
            PtrList<GeometricField<Type, PatchField, GeoMesh >>& modes, label Nmodes);
 
 
        //----------------------------------------------------------------------
        template<class Type, template<class> class PatchField, class GeoMesh >
        static Eigen::VectorXd projectField(
            GeometricField<Type, PatchField, GeoMesh>& field,
            PtrList<GeometricField<Type, PatchField, GeoMesh >>& modes,
            label Nmodes);
 
        //----------------------------------------------------------------------
        template<class Type, template<class> class PatchField, class GeoMesh >
        static Eigen::MatrixXd MassMatrix(
            PtrList<GeometricField<Type, PatchField, GeoMesh >>& modes, label Nmodes);
 
        //----------------------------------------------------------------------
        template<class Type>
        static std::tuple<List<Eigen::SparseMatrix<double >>, List<Eigen::VectorXd >>
        LFvMatrix2LSM(PtrList<fvMatrix<Type >>& MatrixList);
 
        //--------------------------------------------------------------------------
        template <class type_matrix>
        static Eigen::Matrix<type_matrix, Eigen::Dynamic, Eigen::Dynamic>
        List2EigenMatrix ( List<type_matrix> list );
 
        //--------------------------------------------------------------------------
        template <class type_matrix>
        static List<type_matrix> EigenMatrix2List (
            Eigen::Matrix<type_matrix, Eigen::Dynamic, Eigen::Dynamic> matrix );
 
        //----------------------------------------------------------------------
        template <class type_list>
        static Eigen::MatrixXd field2Eigen(const List<type_list>& list);
};
 
#endif