Element.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 ELEMENT_H
#define ELEMENT_H
 
#include <fstream>
#include <sstream>
#include "../Maths/Coord.h"
#include "../Maths/GeometricObject.h"
#include "../Errors.h"
#include "../Tools.h"
#include "../Parallel/key.hpp"
 
class Element;
 
#include "Face.h"
 
class Element
{
public:
  Element();
  virtual ~Element();
 
  //Accesseurs
  void setCellAssociee(const int& numCell){ m_numCellAssociee = numCell; };
  const Coord& getPosition() const { return m_position; };
  const double& getLCFL() const { return m_lCFL; };
  const double& getVolume() const { return m_volume; };
  const int& getNumCellAssociee() const { return m_numCellAssociee; };
 
  virtual const int& getIndex() const { Errors::errorMessage("getIndex not available for requested element"); return Errors::defaultInt; };
  virtual const int& getAppartenancePhysique() const { return Errors::defaultInt; }; 
  virtual void setVolume(const double& /*volume*/){ Errors::errorMessage("setVolume not available for requested element"); };
  virtual void setLCFL(const double& /*lCFL*/){ Errors::errorMessage("setlCFL not available for requested element"); };
  virtual void setPos(const double& /*X*/, const double& /*Y*/, const double& /*Z*/){ Errors::errorMessage("setPos not available for requested element"); };
  virtual void setPos(const Coord& /*pos*/) { Errors::errorMessage("setPos not available for requested element"); };
  virtual void setPosX(const double& /*X*/) { Errors::errorMessage("setPosX not available for requested element"); };
  virtual void setPosY(const double& /*Y*/) { Errors::errorMessage("setPosY not available for requested element"); };
  virtual void setPosZ(const double& /*Z*/) { Errors::errorMessage("setPosZ not available for requested element"); };
  virtual void setSize(const double& /*sizeX*/, const double& /*sizeY*/, const double& /*sizeZ*/) { Errors::errorMessage("setSize not available for requested element"); };
  virtual void setSize(const Coord& /*size*/) { Errors::errorMessage("setSize not available for requested element"); };
  
  void writePos(std::ofstream& fileStream, Axis axis);
 
  virtual void printInfo() const{ Errors::errorMessage("AfficheInfos not available for requested element"); };
  
  Coord vector(const Element* e); 
  Coord vector(const Face* f);    
  double distance(const Element* e);  
  double distanceX(const Element* e); 
  double distanceY(const Element* e); 
  double distanceZ(const Element* e); 
  double distance(const Face* f);     
  double distanceX(const Face* f);    
  double distanceY(const Face* f);    
  double distanceZ(const Face* f);    
  virtual const double& getSizeX() { Errors::errorMessage("getSizeX not available for requested element"); return Errors::defaultDouble; };
  virtual const double& getSizeY() { Errors::errorMessage("getSizeY not available for requested element"); return Errors::defaultDouble; };
  virtual const double& getSizeZ() { Errors::errorMessage("getSizeZ not available for requested element"); return Errors::defaultDouble; };
  virtual const Coord& getSize() { Errors::errorMessage("getSize not available for requested element"); return Coord::defaultCoord; };
 
  bool traverseObjet(const GeometricObject &objet) const;
 
  //Pour methode AMR
  virtual void creerElementChild() { Errors::errorMessage("creerElementsChildren not available for requested element"); };
  virtual Element* getElementChild(const int& /*numberChild*/) { Errors::errorMessage("getElementChild not available for requested element"); return 0; };
  virtual Element* getElementChildBack() { Errors::errorMessage("getElementChild not available for requested element"); return 0; };
  virtual void finalizeElementsChildren() { Errors::errorMessage("finalizeElementsChildren not available for requested element"); };
 
  //For parallel load balancing
  virtual void setKey(const decomposition::Key<3>& key);
  virtual const decomposition::Key<3>& getKey() const { return m_key; };
 
protected:
 
  Coord m_position;             
  double m_volume;              
  double m_lCFL;                
  int m_numCellAssociee;
  decomposition::Key<3> m_key;  
};
 
#endif // ELEMENT_H