ECOGEN 4.0
Evolutive, Compressible, Open, Genuine, Easy, N-phase
Loading...
Searching...
No Matches
GeometricalDomain.h
Go to the documentation of this file.
1//
2// ,---. ,--, .---. ,--, ,---. .-. .-.
3// | .-' .' .') / .-. ) .' .' | .-' | \| |
4// | `-. | |(_) | | |(_) | | __ | `-. | | |
5// | .-' \ \ | | | | \ \ ( _) | .-' | |\ |
6// | `--. \ `-. \ `-' / \ `-) ) | `--. | | |)|
7// /( __.' \____\ )---' )\____/ /( __.' /( (_)
8// (__) (_) (__) (__) (__)
9// Official webSite: https://code-mphi.github.io/ECOGEN/
10//
11// This file is part of ECOGEN.
12//
13// ECOGEN is the legal property of its developers, whose names
14// are listed in the copyright file included with this source
15// distribution.
16//
17// ECOGEN is free software: you can redistribute it and/or modify
18// it under the terms of the GNU General Public License as published
19// by the Free Software Foundation, either version 3 of the License,
20// or (at your option) any later version.
21//
22// ECOGEN is distributed in the hope that it will be useful,
23// but WITHOUT ANY WARRANTY; without even the implied warranty of
24// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25// GNU General Public License for more details.
26//
27// You should have received a copy of the GNU General Public License
28// along with ECOGEN (file LICENSE).
29// If not, see <http://www.gnu.org/licenses/>.
30
31#ifndef GEOMETRICALDOMAIN_H
32#define GEOMETRICALDOMAIN_H
33
34#include "../Maths/Coord.h"
35#include "../Models/Phase.h"
36#include "../libTierces/tinyxml2.h"
37#include "../Errors.h"
38#include "../Tools.h"
39
40class GeometricalDomain; //pre-declaration of GeometricalDomain class needed for Cell.h inclusion
41#include "../Order1/Cell.h"
42
47{
48public:
54 GeometricalDomain(std::string name, std::vector<Phase*> vecPhases, Mixture* mixture, std::vector<Transport> vecTransports, const int& physicalEntity);
55 virtual ~GeometricalDomain();
56
61 virtual bool belong(Coord& /*posElement*/, const int& /*lvl*/) const = 0;
64 virtual void fillIn(Cell* cell) const;
65
66 const std::string& getName() { return m_name; };
67 const int& getPhysicalEntity() { return m_physicalEntity; };
68
69protected:
70 std::string m_name;
75};
76
77#endif // GEOMETRICALDOMAIN_H
78
@ vecPhases
Definition Tools.h:39
Base class for a mesh cell.
Definition Cell.h:59
Class for a coordinate system object such as coordinates of the vertex or a vector.
Definition Coord.h:43
General class for geometrical domain.
Definition GeometricalDomain.h:47
Phase ** m_vecPhases
Phases variable vector.
Definition GeometricalDomain.h:71
Mixture * m_mixture
Mixture variables.
Definition GeometricalDomain.h:72
int m_physicalEntity
Physical entity number (see mesh software and mesh file)
Definition GeometricalDomain.h:74
virtual void fillIn(Cell *cell) const
Method to fill in the cell data with the ones of the corresponding domain.
Definition GeometricalDomain.cpp:64
virtual ~GeometricalDomain()
Definition GeometricalDomain.cpp:52
Transport * m_vecTransports
Transport variables vector.
Definition GeometricalDomain.h:73
const int & getPhysicalEntity()
Definition GeometricalDomain.h:67
virtual bool belong(Coord &, const int &) const =0
Method to verify inclusion of a vertex in geometrical domain.
const std::string & getName()
Definition GeometricalDomain.h:66
std::string m_name
Geometrical domain name.
Definition GeometricalDomain.h:70
Abstract class for mixture variables.
Definition Mixture.h:43
Abstract class for a phase.
Definition Phase.h:47
Class for additional transport equations.
Definition Transport.h:41