ChemicalPlot.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
 
// C++ includes
#include <memory>
#include <vector>
#include <sstream>
#include <string>
 
namespace Reaktoro {
 
// Forward declarations
class ChemicalState;
class ChemicalSystem;
class ReactionSystem;
class StringList;
 
class ChemicalPlot
{
public:
    ChemicalPlot();
 
    explicit ChemicalPlot(const ChemicalSystem& system);
 
    explicit ChemicalPlot(const ReactionSystem& reactions);
 
    virtual ~ChemicalPlot();
 
    auto name(std::string name) -> void;
 
    auto x(std::string quantity) -> void;
 
    auto y(std::string quantity) -> void;
 
    auto y(std::string quantity, std::string label) -> void;
 
    auto points(std::string label, std::vector<double> xpoints, std::vector<double> ypoints) -> void;
 
    auto points(std::string label, std::string xpoints, std::string ypoints) -> void;
 
    auto legend(std::string) -> void;
 
    auto showlegend(bool active) -> void;
 
    auto showlegend() const -> bool;
 
    auto title(std::string title) -> void;
 
    auto xlabel(std::string) -> void;
 
    auto ylabel(std::string) -> void;
 
    auto xtics(std::string) -> void;
 
    auto ytics(std::string) -> void;
 
    auto xformat(std::string) -> void;
 
    auto yformat(std::string) -> void;
 
    auto xlogscale(int base=10) -> void;
 
    auto ylogscale(int base=10) -> void;
 
    auto frequency(unsigned frequency) -> void;
 
    auto operator<<(std::string command) -> ChemicalPlot&;
 
    auto operator<<(std::stringstream command) -> ChemicalPlot&;
 
    auto open() -> void;
 
    auto update(const ChemicalState& state, double t) -> void;
 
    auto operator==(const ChemicalPlot& other) -> bool;
 
private:
    struct Impl;
 
    std::shared_ptr<Impl> pimpl;
};
 
} // namespace Reaktoro