gnuplotinterface.hh

Go to the documentation of this file.

// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
//
// SPDX-FileCopyrightInfo: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
// SPDX-License-Identifier: GPL-3.0-or-later
//
#ifndef DUMUX_GNUPLOT_INTERFACE_HH
#define DUMUX_GNUPLOT_INTERFACE_HH
 
#if !DUMUX_HAVE_GNUPLOT
// Gnuplot has not been found by CMake, no output possible.
#define GNUPLOT_EXECUTABLE "/usr/bin/gnuplot"
#endif
 
#include <cassert>
#include <cmath>
#include <fstream>
#include <iostream>
#include <iomanip>
#include <sstream>
#include <string>
#include <vector>
 
#include <dune/common/exceptions.hh>
#include <dune/common/stdstreams.hh>
 
namespace Dumux {
 
template<class Scalar>
class GnuplotInterface
{
public:
    using StringVector = std::vector<std::string>;
    enum class CurveType
    { function, file, data };
    using CurveTypeVector = std::vector<CurveType>;
 
    explicit GnuplotInterface(bool persist = true) :
        pipeInteractive_(0), pipeImage_(0),
        openPlotWindow_(true), persist_(persist), createImage_(true),
        terminalType_("x11"), outputDirectory_("./"),
        datafileSeparator_(' '), linetype_("solid"),
        xRangeIsSet_(false), yRangeIsSet_(false),
        xLabel_(""), yLabel_(""),
        gnuplotPath_(GNUPLOT_EXECUTABLE)
    {
        open(persist_);
        resetPlot();
    }
 
    ~GnuplotInterface()
    {
        close();
    }
 
    void plot(const std::string &filename = "")
    {
        // set correct terminal and general options
        std::string plot = "set datafile separator \'" + std::string(1, datafileSeparator_) + "\'\n";
 
        // set the labels and axes ranges
        plot += "set xlabel \"" + xLabel_ + "\"\n";
        plot += "set ylabel \"" + yLabel_ + "\"\n";
        if (xRangeIsSet_)
            plot += "set xrange [" + toStringWithPrecision(xRangeMin_) + ":" + toStringWithPrecision(xRangeMax_) + "]" + "\n";
        if (yRangeIsSet_)
            plot += "set yrange [" + toStringWithPrecision(yRangeMin_) + ":" + toStringWithPrecision(yRangeMax_) + "]" + "\n";
 
        // set user defined options
        plot += plotOptions_ + "\n";
 
        // plot curves
        plot += "plot";
        std::string plotCommandForFile(plot);
        for (unsigned int i = 0; i < curve_.size(); ++i)
        {
            if (curveType_[i] == CurveType::function)
            {
                plot += + " " + curve_[i] + " " + curveOptions_[i];
                plotCommandForFile += + " " + curve_[i] + " " + curveOptions_[i];
            }
            else
            {
                plot += + " '" + outputDirectory_ + curve_[i] + "' " + curveOptions_[i];
                plotCommandForFile += + " '" + curve_[i] + "' " + curveOptions_[i];
            }
 
            if (i < curve_.size()-1)
            {
                plot += ",\\";
                plotCommandForFile += ",\\";
            }
            plot += "\n";
            plotCommandForFile += "\n";
        }
 
        // initialize the interactive plot
        std::string interactivePlot = "reset\n";
 
        // set the terminal if the defaults were overwritten
        if (terminalType_.compare("x11") != 0 || linetype_.compare("solid") != 0)
            interactivePlot += "set term " + terminalType_ + " " + linetype_ + " " + " \n";
 
        // add the plot command and plot
        interactivePlot += plot;
        if (openPlotWindow_)
            executeGnuplot(interactivePlot, pipeInteractive_);
 
        // create a gnuplot file if a filename is specified
        if (filename.compare("") != 0)
        {
            std::string filePlot = "reset\n";
            filePlot += "set term pngcairo size 800,600 " + linetype_ + " \n";
            filePlot += "set output \"" + filename + ".png\"\n";
            filePlot += plot;
            std::string gnuplotFileName = outputDirectory_ + filename + ".gp";
            std::ofstream file;
            file.open(gnuplotFileName);
            file << filePlot;
            file.close();
 
            // create the image if desired
            if (createImage_)
                executeGnuplot(filePlot, pipeImage_);
        }
    }
 
    void resetAll(const bool persist = true)
    {
        close();
        open(persist);
        resetPlot();
    }
 
    void resetPlot()
    {
        curve_.clear();
        curveOptions_.clear();
        plotOptions_ = "";
    }
 
    void open(const bool persist = true)
    {
        if (persist)
            pipeInteractive_ = popen((gnuplotPath_ + " -persist").c_str(), "w"); // "w" - writing
        else
            pipeInteractive_ = popen((gnuplotPath_).c_str(), "w");
 
        // the image pipe should not persist
        pipeImage_ = popen((gnuplotPath_).c_str(), "w");
    }
 
    void close()
    {
        if (pclose(pipeInteractive_) == -1 || pclose(pipeImage_) == -1)
            assert("Could not close pipe to Gnuplot!");
    }
 
    void addFunctionToPlot(const std::string& function,
                           const std::string& options = "with lines")
    {
        curve_.push_back(function);
        curveOptions_.push_back(options);
        curveType_.push_back(CurveType::function);
    }
 
    void addFileToPlot(const std::string& fileName,
                       const std::string& options = "with lines")
    {
        curve_.push_back(fileName);
        curveOptions_.push_back(options);
        curveType_.push_back(CurveType::file);
    }
 
    void addDataSetToPlot(const std::vector<Scalar>& x,
                          const std::vector<Scalar>& y,
                          const std::string& fileName,
                          const std::string& options = "with lines")
    {
        if (x.empty() || y.empty())
            DUNE_THROW(Dune::InvalidStateException, "Data vectors have to contain data!");
 
        if (x.size() > y.size())
            DUNE_THROW(Dune::InvalidStateException, "Non-matching data field sizes!");
 
        if (x.size() != y.size())
            std::cout << "GnuplotInterface warning: Added data fields of different size! "
                      << "Only plotting the first " << x.size() << " elements.\n";
 
        // write data to file
        std::ofstream file;
        file.open(outputDirectory_ + fileName);
        for (unsigned int i = 0; i < x.size(); i++)
        {
            checkNumber(x[i], "x[i] i=" + std::to_string(i) + " in " + fileName);
            checkNumber(y[i], "y[i] i=" + std::to_string(i) + " in " + fileName);
            file << x[i] << datafileSeparator_ << y[i] << std::endl;
        }
        file.close();
 
        // adding file to list of plotted lines
        curve_.push_back(fileName);
        curveOptions_.push_back(options);
        curveType_.push_back(CurveType::data);
    }
 
    void setXlabel(const std::string& label)
    {
        xLabel_ = label;
    }
 
    void setYlabel(const std::string& label)
    {
        yLabel_ = label;
    }
 
    void setXRange(Scalar min, Scalar max)
    {
        xRangeMin_ = min;
        xRangeMax_ = max;
        xRangeIsSet_ = true;
    }
 
    void setYRange(Scalar min, Scalar max)
    {
        yRangeMin_ = min;
        yRangeMax_ = max;
        yRangeIsSet_ = true;
    }
 
    void setOption(const std::string& option)
    {
        plotOptions_ += option + "\n";
    }
 
    void setOpenPlotWindow(bool openPlotWindow)
    {
        openPlotWindow_ = openPlotWindow;
    }
 
    void setCreateImage(bool createImage)
    {
        createImage_ = createImage;
    }
 
    void setDatafileSeparator(char separator)
    {
        datafileSeparator_ = separator;
    }
 
    void setTerminalType(std::string terminal)
    {
        terminalType_ = terminal;
    }
 
    void setOutputDirectory(const std::string& outputDirectory)
    {
        outputDirectory_ = outputDirectory + "/";
    }
 
    void useDashedLines(bool dashed)
    {
        linetype_ = dashed ? "dashed" : "solid";
    }
 
private:
    // Give plot command to gnuplot
    void executeGnuplot(const std::string& plotCommand, std::FILE * pipe) const
    {
#ifdef DUMUX_HAVE_GNUPLOT
        fputs((plotCommand + "\n").c_str(), pipe);
        fflush(pipe);
#else
        std::cerr << "Warning: Gnuplot has not been found by CMake, no image generation or interactive display possible." << std::endl;
        std::cerr << "Note: The data and the gnuplot instruction file will still be created." << std::endl;
#endif
    }
 
    // Check validity of number
    void checkNumber(Scalar number, const std::string& text = "") const
    {
        using std::isnan;
        using std::isinf;
        if (isnan(number))
            Dune::dwarn << "warning: " << text << " is not a number, adjust your data range" << std::endl;
        if (isinf(number))
            Dune::dwarn << "warning: " << text << " is infinity, adjust your data range" << std::endl;
    }
 
    // Convert string with higher precision
    template <typename T>
    std::string toStringWithPrecision(const T value, const int n = 8)
    {
        std::ostringstream out;
        out << std::setprecision(n) << value;
        return out.str();
    }
 
    std::FILE * pipeInteractive_;
    std::FILE * pipeImage_;
    bool openPlotWindow_;
    bool persist_;
    bool createImage_;
    std::string terminalType_;
    std::string outputDirectory_;
    char datafileSeparator_;
    std::string linetype_;
    StringVector curve_;
    StringVector curveOptions_;
    CurveTypeVector curveType_;
    Scalar xRangeMin_;
    Scalar xRangeMax_;
    bool xRangeIsSet_;
    Scalar yRangeMin_;
    Scalar yRangeMax_;
    bool yRangeIsSet_;
    std::string xLabel_;
    std::string yLabel_;
    std::string plotOptions_;
    std::string gnuplotPath_;
};
} // end namespace Dumux
#endif