ModUEq.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 MODUEQ_H
#define MODUEQ_H
 
#include "../Model.h"
#include "../../Order1/Cell.h"
#include "MixUEq.h"
#include "PhaseUEq.h"
#include "GradPhaseUEq.h"
#include "GradMixUEq.h"
 
class ModUEq;
 
#include "FluxUEq.h"

class ModUEq : public Model
{
  public:
    ModUEq(const int& numbTransports, const int& numbPhases);
    ModUEq(const std::string& name, const int& numbTransports);
    ~ModUEq() override;
 
    void allocateCons(Flux** cons) override;
    void allocatePhase(Phase** phase) override;
    void allocateMixture(Mixture** mixture) override;
    void allocatePhaseGradient(GradPhase** phase) override;
    void allocateMixtureGradient(GradMixture** mixture) override;

    void fulfillState(Phase** phases, Mixture* mixture) override;

    void fulfillStateResume(Phase** /*phases*/, Mixture* /*mixture*/) override {};

    void initializeAugmentedVariables(Cell* /*cell*/) override {};
 
    //Fluid-flow Riemann solvers
    //--------------------------
    void solveRiemannIntern(Cell& cellLeft,
                            Cell& cellRight,
                            const double& dxLeft,
                            const double& dxRight,
                            double& dtMax,
                            std::vector<double>& boundData = DEFAULT_VEC_INTERFACE_DATA) const override; // Riemann between two computed cells
    void solveRiemannInternMRF(Cell& cellLeft,
                               Cell& cellRight,
                               const double& dxLeft,
                               const double& dxRight,
                               double& dtMax,
                               const Coord& omega,
                               const Coord& normal,
                               const Coord& tangent,
                               const Coord& binormal,
                               const Coord& position) const override;
    void solveRiemannWall(Cell& cellLeft,
                          const double& dxLeft,
                          double& dtMax,
                          std::vector<double>& boundData) const override; // Riemann between left cell and wall
    void
    solveRiemannMovingWall(Cell& cellLeft, const double& dxLeft, double& dtMax, double wallVelocity, std::vector<double>& boundData) const override;
    void solveRiemannInletTank(Cell& cellLeft,
                               const double& dxLeft,
                               double& dtMax,
                               const double* ak0,
                               const double* rhok0,
                               const double& p0,
                               const double& /*T0*/,
                               std::vector<double>& boundData) const override;
    void solveRiemannInletInjStagState(Cell& cellLeft,
                                       const double& dxLeft,
                                       double& dtMax,
                                       const double m0,
                                       const double* ak0,
                                       const double* rhok0,
                                       const double* pk0,
                                       std::vector<double>& boundData) const override;
    void solveRiemannInletInjTemp(Cell& cellLeft,
                                  const double& dxLeft,
                                  double& dtMax,
                                  const double m0,
                                  const double* Tk0,
                                  const double* ak0,
                                  std::vector<double>& boundData) const override;
    void
    solveRiemannOutletPressure(Cell& cellLeft, const double& dxLeft, double& dtMax, const double p0, std::vector<double>& boundData) const override;
    void
    solveRiemannOutletMassflow(Cell& cellLeft, const double& dxLeft, double& dtMax, const double m0, std::vector<double>& boundData) const override;
    void solveRiemannNullFlux() const override;
 
    //Transports Riemann solvers
    //--------------------------
    void solveRiemannTransportIntern(Cell& cellLeft, Cell& cellRight) override;
    void solveRiemannTransportWall() override;
    void solveRiemannTransportMovingWall(Cell& cellLeft, double wallVelocity) override;
    void solveRiemannTransportInletTank(Cell& cellLeft, double* valueTransports) override;
    void solveRiemannTransportInletInjStagState(Cell& cellLeft, double* valueTransports) override;
    void solveRiemannTransportOutletPressure(Cell& cellLeft, double* valueTransport) override;
 
    void reverseProjection(const Coord normal, const Coord tangent, const Coord binormal) const override;
 
    //Low-Mach preconditioning
    //------------------------
    void lowMachSoundSpeed(
      double& machRef, const double& uL, double& cL, const double& uR = Errors::defaultDouble, double& cR = Tools::uselessDouble) const override;
 
    //Moving Reference Frame
    //----------------------
    void addNonConsMrfFlux(Phase** phases) override;
    void reverseProjectionMrfFlux(const Coord normal, const Coord tangent, const Coord binormal) const override;
 
    //Accessors
    //---------
    double selectScalar(Phase** phases, Mixture* mixture, Transport* transports, Variable nameVariable, int num = 0) const override;
    const double& getSM() override;
    const Coord& getVelocity(const Cell* cell) const override { return cell->getMixture()->getVelocity(); };
    Coord& getVelocity(Cell* cell) override { return cell->getMixture()->getVelocity(); };
 
    const std::string& whoAmI() const override { return m_name; };
 
    void setSmoothCrossSection1d(const bool& applySmooth) override { m_smoothCrossSection1d = applySmooth; };
 
  private:
    static const std::string NAME;
 
    friend class FluxUEq;
};
 
#endif // MODUEQ_H