Gems.hpp

// Reaktoro is a unified framework for modeling chemically reactive systems.
//
// Copyright (C) 2014-2018 Allan Leal
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this library. If not, see <http://www.gnu.org/licenses/>.
 
#pragma once
 
// Reaktoro includes
#include <Reaktoro/Interfaces/Interface.hpp>
 
// Forward declarations
class TNode;
 
namespace Reaktoro {
 
struct GemsOptions
{
    bool warmstart = true;
};
 
class Gems : public Interface
{
public:
    Gems();
 
    Gems(std::string filename);
 
    virtual ~Gems();
 
    virtual auto temperature() const -> double;
 
    virtual auto pressure() const -> double;
 
    virtual auto speciesAmounts() const -> Vector;
 
    virtual auto numElements() const -> unsigned;
 
    virtual auto numSpecies() const -> unsigned;
 
    virtual auto numPhases() const -> unsigned;
 
    virtual auto numSpeciesInPhase(Index iphase) const -> unsigned;
 
    virtual auto elementName(Index ielement) const -> std::string;
 
    virtual auto elementMolarMass(Index ielement) const -> double;
 
    virtual auto elementStoichiometry(Index ispecies, Index ielement) const -> double;
 
    virtual auto speciesName(Index ispecies) const -> std::string;
 
    virtual auto phaseName(Index iphase) const -> std::string;
 
    virtual auto properties(ThermoModelResult& res, double T, double P) -> void;
 
    virtual auto properties(ChemicalModelResult& res, double T, double P, VectorConstRef n) -> void;
 
    virtual auto clone() const -> std::shared_ptr<Interface>;
 
    auto set(double T, double P) -> void;
 
    auto set(double T, double P, VectorConstRef n) -> void;
 
    auto setOptions(const GemsOptions& options) -> void;
 
    auto equilibrate(double T, double P, VectorConstRef b) -> void;
 
    auto converged() const -> bool;
 
    auto numIterations() const -> unsigned;
 
    auto elapsedTime() const -> double;
 
    auto node() const -> std::shared_ptr<TNode>;
 
private:
    struct Impl;
 
    std::shared_ptr<Impl> pimpl;
};
 
} // namespace Reaktoro