ECOGEN 4.0
Evolutive, Compressible, Open, Genuine, Easy, N-phase
Loading...
Searching...
No Matches
QuantitiesAddPhys.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 QUANTITIESADDPHYS_H
32#define QUANTITIESADDPHYS_H
33
34class QuantitiesAddPhys; //pre-declaration of QuantitiesAddPhys class needed for AddPhys.h inclusion
35
36#include "AddPhys.h"
37
42{
43 public:
46 QuantitiesAddPhys(AddPhys* addPhys);
47 virtual ~QuantitiesAddPhys();
48
51 virtual void computeQuantities(Cell* /*cell*/) { Errors::errorMessage("computeQuantities not implemented for used quantities of additional physics"); };
53 double computeEnergyAddPhys();
54
55 //Accessors for the different gradients
59 virtual void setGrad(const Coord& /*grad*/, const int& /*num*/ = -1) { Errors::errorMessage("setGrad not implemented for used quantities of additional physics"); };
62 virtual const Coord& getGrad(const int& /*num*/ = -1) const { Errors::errorMessage("getGrad not implemented for used quantities of additional physics"); return Coord::defaultCoord; };
63
66 virtual void setGradU(const Coord& /*grad*/) { Errors::errorMessage("setGradU not implemented for used quantities of additional physics"); };
69 virtual void setGradV(const Coord& /*grad*/) { Errors::errorMessage("setGradV not implemented for used quantities of additional physics"); };
72 virtual void setGradW(const Coord& /*grad*/) { Errors::errorMessage("setGradW not implemented for used quantities of additional physics"); };
76 virtual void setGradTk(const int& /*phaseNum*/, const Coord& /*grad*/) { Errors::errorMessage("setGradTk not implemented for used quantities of additional physics"); };
78 virtual Coord getGradU() const { Errors::errorMessage("getGradU not implemented for used quantities of additional physics"); return 0; };
80 virtual Coord getGradV() const { Errors::errorMessage("getGradV not implemented for used quantities of additional physics"); return 0; };
82 virtual Coord getGradW() const { Errors::errorMessage("getGradW not implemented for used quantities of additional physics"); return 0; };
85 virtual const Coord& getGradTk(const int& /*phaseNum*/) const { Errors::errorMessage("getGradTk not implemented for used quantities of additional physics"); return Coord::defaultCoord; };
86
89
90 protected:
92
93 private:
94};
95
96extern std::vector<Variable> variableNameSurfTens;
97extern std::vector<int> numPhaseSurfTens;
98extern std::vector<Variable> variableNamesVisc;
99extern std::vector<int> numPhasesVisc;
100extern std::vector<Variable> variableNamesCond;
101extern std::vector<int> numPhasesCond;
102
103#endif // QUANTITIESADDPHYS_H
std::vector< Variable > variableNameSurfTens
Variable name of the corresponding gradient.
Definition QuantitiesAddPhys.cpp:33
std::vector< int > numPhaseSurfTens
Number of the phase (here transport)
Definition QuantitiesAddPhys.cpp:34
std::vector< Variable > variableNamesCond
Variable names of the corresponding gradients.
Definition QuantitiesAddPhys.cpp:37
std::vector< int > numPhasesCond
Number of the phase.
Definition QuantitiesAddPhys.cpp:38
std::vector< Variable > variableNamesVisc
Variable names of the corresponding gradients.
Definition QuantitiesAddPhys.cpp:35
std::vector< int > numPhasesVisc
Number of the phase (0: for Euler compatibility and not used for multiphase models)
Definition QuantitiesAddPhys.cpp:36
General class for additional physics.
Definition AddPhys.h:46
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
static const Coord defaultCoord
Default Coord object (const version)
Definition Coord.h:55
static void errorMessage(const std::string &message)
Definition Errors.cpp:56
General class for additional-physics quantities.
Definition QuantitiesAddPhys.h:42
virtual void setGradW(const Coord &)
Set the gradient of the velocity along the z-direction with the transmitted values.
Definition QuantitiesAddPhys.h:72
virtual Coord getGradU() const
Return the gradient of the velocity along the x-direction.
Definition QuantitiesAddPhys.h:78
double computeEnergyAddPhys()
Compute and send back mass energy linked to the physic (0 if no linked energy)
Definition QuantitiesAddPhys.cpp:51
virtual void setGradU(const Coord &)
Set the gradient of the velocity along the x-direction with the transmitted values.
Definition QuantitiesAddPhys.h:66
virtual void setGradV(const Coord &)
Set the gradient of the velocity along the y-direction with the transmitted values.
Definition QuantitiesAddPhys.h:69
virtual const Coord & getGrad(const int &=-1) const
Get the additional-physic gradient.
Definition QuantitiesAddPhys.h:62
virtual Coord getGradV() const
Return the gradient of the velocity along the y-direction.
Definition QuantitiesAddPhys.h:80
virtual void computeQuantities(Cell *)
Compute the needed quantities for the additional physic.
Definition QuantitiesAddPhys.h:51
AddPhys * m_addPhys
Corresponding additional-physic class of this quantities class.
Definition QuantitiesAddPhys.h:91
virtual const Coord & getGradTk(const int &) const
Return the gradient of the phase temperature.
Definition QuantitiesAddPhys.h:85
AddPhys * getAddPhys()
Return the corresponding additional-physic class of this quantities class.
Definition QuantitiesAddPhys.h:88
virtual void setGradTk(const int &, const Coord &)
Set the gradient of the phase temperature with the transmitted values.
Definition QuantitiesAddPhys.h:76
virtual void setGrad(const Coord &, const int &=-1)
Set the additional-physic gradient with the transmitted values.
Definition QuantitiesAddPhys.h:59
virtual Coord getGradW() const
Return the gradient of the velocity along the z-direction.
Definition QuantitiesAddPhys.h:82
virtual ~QuantitiesAddPhys()
Definition QuantitiesAddPhys.cpp:47