GeometricalDomain.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 GEOMETRICALDOMAIN_H
#define GEOMETRICALDOMAIN_H
 
#include "../Maths/Coord.h"
#include "../Models/Phase.h"
#include "../libTierces/tinyxml2.h"
#include "../Errors.h"
#include "../Tools.h"
 
class GeometricalDomain; //pre-declaration of GeometricalDomain class needed for Cell.h inclusion
#include "../Order1/Cell.h"

class GeometricalDomain
{
  public:
    GeometricalDomain(
      std::string name, std::vector<Phase*> vecPhases, Mixture* mixture, std::vector<Transport> vecTransports, const int& physicalEntity);
    virtual ~GeometricalDomain();

    virtual bool belong(Coord& /*posElement*/, const int& /*lvl*/) const = 0;
    virtual void fillIn(Cell* cell) const;
 
    const std::string& getName() { return m_name; };
    const int& getPhysicalEntity() { return m_physicalEntity; };
 
  protected:
    std::string m_name;                     
    std::vector<Phase*> m_vecPhases;        
    Mixture* m_mixture;                     
    std::vector<Transport> m_vecTransports; 
    int m_physicalEntity;                   
};
 
#endif // GEOMETRICALDOMAIN_H