GDCylinder.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 GDCYLINDER_H
#define GDCYLINDER_H
 
#include "GeometricalDomain.h"
 
#define ECOGEN_CYLINDER_DIMENSION 3 // For convenience purpose: a cylinder is always 3D

class GDCylinder : public GeometricalDomain
{
  public:
    GDCylinder(std::string name,
               std::vector<Phase*> vecPhases,
               Mixture* mixture,
               std::vector<Transport> vecTransports,
               tinyxml2::XMLElement* element,
               const int& physicalEntity,
               std::string fileName = "Unknown file");
    ~GDCylinder() override;
 
    bool belong(Coord& posElement, const int& /*lvl*/) const override;
 
  private:
    Coord m_centerPos;                      
    Axis m_axis1, m_axis2, m_axis3;         
    double m_radius;                        
    double m_length;                        
    Axis m_axes[ECOGEN_CYLINDER_DIMENSION]; 
};
 
#endif //GDCYLINDER_H