Coord.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 COORD_H
#define COORD_H
 
#include <cmath>
#include <iostream>
 
class Coord;
#include "Tensor.h"

class Coord
{
  public:
    Coord();
    Coord(const double& x, const double& y = 0., const double& z = 0.);
    ~Coord();

    static const Coord defaultCoord;
    static Coord defaultCoordNonConst;

    void setXYZ(const double& x, const double& y, const double& z);
    void setX(const double& x);
    void setY(const double& y);
    void setZ(const double& z);
    const double& getX() const { return m_x; }
    const double& getY() const { return m_y; }
    const double& getZ() const { return m_z; }
    double norm() const;
    double squaredNorm() const;
    Coord abs() const;

    double scalar(const Coord& a) const;
    Coord scalar(const Tensor& t) const;
    Coord cross(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 setFromSubtractedVectors(const Coord& a, const Coord& b);
    static double scalarProduct(const Coord& v1, const Coord& v2);
    static Coord crossProduct(const Coord& v1, const Coord& v2);
    void changeSign();
    void normalized();
    void printInfo() const;

    static double determinant(const Coord& v1, const Coord& v2, const Coord& v3);

    static double cos(const Coord& v1, const Coord& v2);
    static Coord sin(const Coord& v1, const Coord& v2);
    void buildRelativeVelForRiemannMRF(const Coord& omega, const Coord& normal, const Coord& tangent, const Coord& binormal, const Coord& position);
 
    //Operator surcharges
    Coord& operator=(const double& scalar);
    Coord& operator+=(const double& scalar);
    Coord& operator-=(const double& scalar);
    Coord& operator*=(const double& scalar);
    Coord& operator/=(const double& scalar);
    Coord operator*(const double& scalar) const;
    Coord operator/(const double& scalar) const;
    Coord& operator+=(const Coord& a);
    Coord& operator-=(const Coord& a);
 
  protected:
    double m_x; 
    double m_y; 
    double m_z; 
};
 
extern Coord coordBuff;
extern Coord velocity;
extern Coord vFaceToElt;
extern Coord coordIdentity;
 
//Extern operator surcharges of the class because they take two arguments
Coord operator*(const double& scalar, const Coord& a);
Coord operator+(const Coord& a, const Coord& b);
Coord operator-(const Coord& a, const Coord& b);
 
#endif // COORD_H