Tensor.h

Go to the documentation of this file.

//
//       ,---.     ,--,    .---.     ,--,    ,---.    .-. .-.
//       | .-'   .' .')   / .-. )  .' .'     | .-'    |  \| |
//       | `-.   |  |(_)  | | |(_) |  |  __  | `-.    |   | |
//       | .-'   \  \     | | | |  \  \ ( _) | .-'    | |\  |
//       |  `--.  \  `-.  \ `-' /   \  `-) ) |  `--.  | | |)|
//       /( __.'   \____\  )---'    )\____/  /( __.'  /(  (_)
//      (__)              (_)      (__)     (__)     (__)
//      Official webSite: https://code-mphi.github.io/ECOGEN/
//
//  This file is part of ECOGEN.
//
//  ECOGEN is the legal property of its developers, whose names
//  are listed in the copyright file included with this source
//  distribution.
//
//  ECOGEN is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published
//  by the Free Software Foundation, either version 3 of the License,
//  or (at your option) any later version.
//
//  ECOGEN 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 General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with ECOGEN (file LICENSE).
//  If not, see <http://www.gnu.org/licenses/>.
 
#ifndef TENSOR_H
#define TENSOR_H
 
#include "../Errors.h"
#include <array>
 
class Tensor;
#include "Coord.h"

enum TensorElement
{
  XX,
  XY,
  XZ,
  YX,
  YY,
  YZ,
  ZX,
  ZY,
  ZZ
};

class Tensor
{
  public:
    Tensor();
    Tensor(const Tensor& tensor);
    Tensor(const double& xx,
           const double& xy,
           const double& xz,
           const double& yx,
           const double& yy,
           const double& yz,
           const double& zx,
           const double& zy,
           const double& zz);
    Tensor(const Coord& x, const Coord& y, const Coord& z);
    ~Tensor();

    static const Tensor defaultTensor;
    static Tensor defaultTensorNonConst;

    const double& getElement(const int& element) const { return m_array[element]; }
    const double& getXX() const { return m_array[XX]; }
    const double& getXY() const { return m_array[XY]; }
    const double& getXZ() const { return m_array[XZ]; }
    const double& getYX() const { return m_array[YX]; }
    const double& getYY() const { return m_array[YY]; }
    const double& getYZ() const { return m_array[YZ]; }
    const double& getZX() const { return m_array[ZX]; }
    const double& getZY() const { return m_array[ZY]; }
    const double& getZZ() const { return m_array[ZZ]; }
    void setXX(const double& xx);
    void setXY(const double& xy);
    void setXZ(const double& xz);
    void setYX(const double& xx);
    void setYY(const double& xy);
    void setYZ(const double& xz);
    void setZX(const double& xx);
    void setZY(const double& xy);
    void setZZ(const double& xz);
    void setTensor(const Tensor& tensor);
    void setTensor(const double& value);
    void identity();
    void correctZeros();

    Coord scalar(const Coord& a) const;
    void localProjection(const Coord& normal, const Coord& tangent, const Coord& binormal);
    void reverseProjection(const Coord& normal, const Coord& tangent, const Coord& binormal);
    void setTensorByLines(const Coord& x, const Coord& y, const Coord& z);
    void setTensorByColumns(const Coord& x, const Coord& y, const Coord& z);

    void tensorToCoords(Coord& x, Coord& y, Coord& z) const;
    void tensorToArray(double* array) const;
    void arrayToTensor(const double* array);

    void transpose(Tensor& transposedTensor) const;
    void matrixProduct(const Tensor& tensor2, Tensor& resultingTensor) const;
    double trace() const;
    double determinant() const;
    void inverse(Tensor& inverseTensor) const;
    double infinityNorm() const;
    double frobeniusNorm() const;
    void exponentialPade(Tensor& tensorExpPade);

    bool isIdentity() const;

    void eigen(Tensor& eigenvalues, Tensor& eigenvectors) const;
 
    //Operator surcharges
    Tensor& operator=(const double& scalar);
    Tensor& operator=(const Tensor& a);
    Tensor& operator*=(const double& scalar);
    Tensor& operator/=(const double& scalar);
    Tensor operator*(const double& scalar) const;
    Tensor operator/(const double& scalar) const;
    Tensor& operator+=(const Tensor& a);
    Tensor& operator-=(const Tensor& a);
 
  protected:
    std::array<double, 9> m_array; 
};
 
//KS//Clean up unused variables
extern Tensor tensorBuff;
extern Tensor tensorBuff2;
extern Tensor tensorIdentity;
extern Tensor tensorCobase;
extern Tensor tensorNonConsCobase;
extern Tensor tensorF;
extern Tensor tensorG;
extern Tensor tensorG2;
extern Tensor tensorA;
extern Tensor tensorEigenvalues;
extern Tensor tensorP;
extern Tensor tensorPinverse;
extern Tensor tensorD;
extern Tensor tensorDLogCobaseDt;
extern Tensor tensorPade;
extern Tensor tensorX2;
extern Tensor tensorX4;
extern Tensor tensorX6;
extern Tensor tensorU;
extern Tensor tensorV;
extern Tensor tensorQ;
extern Tensor tensorStrainRate;          //<! S: Strain rate tensor (gradU)
extern Tensor tensorStrainRateTranspose; //<! S^T: Transposed strain rate tensor (gradU)
 
//Extern operator surcharges of the class because they take two arguments
Tensor operator*(const double& scalar, const Tensor& a);
Tensor operator+(const Tensor& a, const Tensor& b);
Tensor operator-(const Tensor& a, const Tensor& b);
 
#endif // TENSOR_H