[io - gnuplotinterface]

add a generic gnuplotinterface with a simple
the gnuplot interface currently only works with CMake

reviewed by Beatrix



git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@14428 2fb0f335-1f38-0410-981e-8018bf24f1b0

cmake/modules/DumuxMacros.cmake

@@ -2,3 +2,5 @@
 include(CheckConstexpr)
 # additional macros
 include(DumuxTestMacros)
+
+find_package(Gnuplot)
\ No newline at end of file

config.h.cmake

@@ -34,11 +34,17 @@
 /* Define to 1 if constexpr is supported */
 #cmakedefine HAVE_CONSTEXPR @HAVE_CONSTEXPR@
 
-/* 'set 'constexpr' to 'const' if constexpr is not supported */
+/* Set 'constexpr' to 'const' if constexpr is not supported */
 #ifndef HAVE_CONSTEXPR
 #define constexpr const
 #endif
 
+/* Define to 1 if gnuplot was found */
+#define HAVE_GNUPLOT @GNUPLOT_FOUND@
+
+/* Define path to gnuplot executable */
+#cmakedefine GNUPLOT_EXECUTABLE "@GNUPLOT_EXECUTABLE@"
+
 /* end dumux
    Everything below here will be overwritten
 */

configure.ac

@@ -100,6 +100,8 @@ AC_CONFIG_FILES([dumux.pc
     test/implicit/co2/Makefile
     test/implicit/mpnc/Makefile
     test/implicit/richards/Makefile
+    test/io/Makefile
+    test/io/gnuplotinterface/Makefile
     test/common/Makefile
     test/common/generalproblem/Makefile
     test/common/propertysystem/Makefile

dumux/io/gnuplotinterface.hh

+// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+// vi: set et ts=4 sw=4 sts=4:
+/*****************************************************************************
+ *   See the file COPYING for full copying permissions.                      *
+ *                                                                           *
+ *   This program 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 2 of the License, or       *
+ *   (at your option) any later version.                                     *
+ *                                                                           *
+ *   This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.   *
+ *****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief Interface for passing data sets to a file and plotting them, if gnuplot
+ *        is installed.
+ *
+ * The data sets for a specific window have to be passed by the addDataSet function
+ * and then plotted by using the plot function.
+ */
+
+#ifndef HAVE_GNUPLOT
+#warning Gnuplot has not been found or cmake has not been used.
+#else
+
+#ifndef DUMUX_GNUPLOT_INTERFACE_HH
+#define DUMUX_GNUPLOT_INTERFACE_HH
+
+#include <cassert>
+#include <cmath>
+#include <fstream>
+#include <iostream>
+#include <sstream>
+#include <string>
+#include <vector>
+
+namespace Dumux
+{
+/*!
+ * \brief Interface for passing data sets to a file and plotting them, if gnuplot
+ *        is installed.
+ */
+template<class Scalar>
+class GnuplotInterface
+{
+public:
+    typedef std::vector<std::string> StringVector;
+    enum PlotStyle
+    {
+        lines, points, linesPoints, impulses, dots
+    };
+
+    GnuplotInterface() :
+        plotStyle_("lines"), pipe_(0),
+        fileName_(0), plotName_(0),
+        xRangeMin_(0), xRangeMax_(0),
+        yRangeMin_(0), yRangeMax_(0),
+        xLabel_(0), yLabel_(0),
+        gnuplotPath_(GNUPLOT_EXECUTABLE),
+        terminalType_("wxt"),
+        numberOfGnuplotWindows_(8+1)
+    {
+        {
+            pipe_ = popen((gnuplotPath_ + " -persist").c_str(), "w"); // "w" - writing
+        }
+        fileName_.resize(numberOfGnuplotWindows_);
+        plotName_.resize(numberOfGnuplotWindows_);
+        xRangeMin_.resize(numberOfGnuplotWindows_, 1e100);
+        xRangeMax_.resize(numberOfGnuplotWindows_, -1e100);
+        yRangeMin_.resize(numberOfGnuplotWindows_, 1e100);
+        yRangeMax_.resize(numberOfGnuplotWindows_, -1e100);
+        xLabel_.resize(numberOfGnuplotWindows_, "");
+        yLabel_.resize(numberOfGnuplotWindows_, "");
+    }
+
+    ~GnuplotInterface()
+    {
+        if (pclose(pipe_) == -1)
+            assert("Could not close pipe to Gnuplot!");
+    }
+    
+    /*!
+     * \brief Plots the files for a specific window number, writes a gnuplot and png file.
+     *
+     * \param title The name of the output file
+     * \param plottingWindowNumber The ID of the specific plot
+     */
+    void plot(const std::string &title,
+              int plottingWindowNumber,
+              bool interaction)
+    {
+        // setting correct terminal
+        std::string plot = "set term ";
+
+        if (interaction)
+            plot += "wxt " + numberToString(plottingWindowNumber) + "\n";
+        else
+            plot += " pngcairo size 800,600 \nset output \"" + title + ".png\"\n";
+
+        plot += "set yrange [" + numberToString(yRangeMin_[plottingWindowNumber])
+                + ":" + numberToString(yRangeMax_[plottingWindowNumber]) + "]" + "\n";
+        plot += "set xrange [" + numberToString(xRangeMin_[plottingWindowNumber])
+                + ":" + numberToString(xRangeMax_[plottingWindowNumber]) + "]" + "\n";
+
+        plot += "set xlabel \"" + xLabel_[plottingWindowNumber] + "\"\n";
+        plot += "set ylabel \"" + yLabel_[plottingWindowNumber] + "\"\n";
+        
+        // plot curves
+        plot += "plot \"" + fileName_[plottingWindowNumber][0]
+               + "\" title \"" + plotName_[plottingWindowNumber][0]
+               + "\" with " + plotStyle_;
+
+        for (unsigned int i = 1; i < fileName_[plottingWindowNumber].size(); ++i)
+        {
+            plot += ", \"" + fileName_[plottingWindowNumber][i]
+                    + "\" title \"" + plotName_[plottingWindowNumber][i]
+                    + "\" with " + plotStyle_;
+        }
+        plot += "\n";
+
+        if (!interaction)
+        {
+            std::string fileName = title + ".gp";
+            std::ofstream file;
+            file.open(fileName);
+            file << plot;
+            file.close();
+        }
+
+        executeGnuplot(plot.c_str());
+    }
+
+    /*!
+     * \brief Adds data set for specific window number and writes a data file
+     *
+     * \param x Vector containing the x-axis data points
+     * \param y Vector containing the y-axis data points
+     * \param plotName The name of the data set
+     * \param plottingWindowNumber The ID of the specific plot
+     */
+    void addDataSet(const std::vector<Scalar>& x,
+                    const std::vector<Scalar>& y,
+                    const std::string &plotName,
+                    int plottingWindowNumber)
+    {
+        assert(x.size() == y.size());
+
+        //write data to file
+        std::string fileName = numberToString(plottingWindowNumber) + "_" + plotName + ".dat";
+        std::ofstream file;
+        file.open(fileName);
+        for (unsigned int i = 0; i < x.size(); i++)
+        {
+            checkNumber(x[i], "x[i] i=" + numberToString(i) + " in " + fileName);
+            checkNumber(y[i], "y[i] i=" + numberToString(i) + " in " + fileName);
+            file << x[i] << " " << y[i] << std::endl;
+        }
+        file.close();
+
+        // adding file to list of plotted lines
+        fileName_[plottingWindowNumber].push_back(fileName);
+        plotName_[plottingWindowNumber].push_back(plotName);
+    }
+
+    /*!
+     * \brief Sets the label for the x-axis
+     *
+     * \param label The label of the x-axis
+     * \param plottingWindowNumber The ID of the specific plot
+     */
+    void setXlabel(const std::string& label,
+                   unsigned int plottingWindowNumber)
+    {
+        xLabel_[plottingWindowNumber] = label;
+    }
+
+    /*!
+     * \brief Sets the label for the y-axis
+     *
+     * \param label The label of the y-axis
+     * \param plottingWindowNumber The ID of the specific plot
+     */
+    void setYlabel(const std::string& label,
+                   unsigned int plottingWindowNumber)
+    {
+        yLabel_[plottingWindowNumber] = label;
+    }
+
+    /*!
+     * \brief Sets the range for the x-axis
+     *
+     * \param lowerEnd The lowest plotted value for the x-axis
+     * \param upperEnd The highest plotted value for the x-axis
+     * \param plottingWindowNumber The ID of the specific plot
+     */
+    void setXRange(Scalar lowerEnd,
+                   Scalar upperEnd,
+                   unsigned int plottingWindowNumber)
+    {
+        xRangeMin_[plottingWindowNumber] = std::min(xRangeMin_[plottingWindowNumber], lowerEnd);
+        xRangeMax_[plottingWindowNumber] = std::max(xRangeMax_[plottingWindowNumber], upperEnd);
+    }
+
+    /*!
+     * \brief Sets the range for the y-axis
+     *
+     * \param lowerEnd The lowest plotted value for the y-axis
+     * \param upperEnd The highest plotted value for the y-axis
+     * \param plottingWindowNumber The ID of the specific plot
+     */
+    void setYRange(Scalar lowerEnd,
+                   Scalar upperEnd,
+                   unsigned int plottingWindowNumber)
+    {
+        yRangeMin_[plottingWindowNumber] = std::min(yRangeMin_[plottingWindowNumber], lowerEnd);
+        yRangeMax_[plottingWindowNumber] = std::max(yRangeMax_[plottingWindowNumber], upperEnd);
+    }
+
+    /*!
+     * \brief Sets the plotting style for the data sets
+     *
+     * \param style Plot style of the data sets
+     */
+    void setStyle(const PlotStyle& style)
+    {
+        switch (style)
+        {
+        case lines:
+            plotStyle_ = "lines";
+            break;
+        case points:
+            plotStyle_ = "points";
+            break;
+        case linesPoints:
+            plotStyle_ = "linespoints";
+            break;
+        case impulses:
+            plotStyle_ = "impulses";
+            break;
+        case dots:
+            plotStyle_ = "dots";
+            break;
+        default:
+            assert(!"Unknown plot style");
+        }
+    }
+
+private:
+    // Give plot command to gnuplot
+    void executeGnuplot(const std::string& plotCommand) const
+    {
+        fputs((plotCommand + "\n").c_str(), pipe_);
+        fflush(pipe_);
+    }
+
+    // Check validity of number
+    void checkNumber(Scalar number, std::string text = "") const
+    {
+        if (std::isnan(number))
+            std::cout << "warning: " << text << " is not a number, adjust your data range" << std::endl;
+        if (std::isinf(number))
+            std::cout << "warning: " << text << " is infinity, adjust your data range" << std::endl;
+    }
+
+    // Convert number to string
+    template<class T> std::string numberToString(const T number) const
+    {
+        std::ostringstream stream;
+        stream << number;
+        return stream.str();
+    }
+
+    std::string plotStyle_;
+    std::FILE * pipe_;
+    std::vector<StringVector> fileName_;
+    std::vector<StringVector> plotName_;
+    std::vector<Scalar> xRangeMin_;
+    std::vector<Scalar> xRangeMax_;
+    std::vector<Scalar> yRangeMin_;
+    std::vector<Scalar> yRangeMax_;
+    StringVector xLabel_;
+    StringVector yLabel_;
+    std::string gnuplotPath_;
+    std::string terminalType_;
+    const unsigned int numberOfGnuplotWindows_;
+};
+} // end of namespace
+#endif // DUMUX_GNUPLOT_INTERFACE_HH
+
+#endif // HAVE_GNUPLOT
\ No newline at end of file

test/CMakeLists.txt

@@ -3,6 +3,7 @@ add_subdirectory("decoupled")
 add_subdirectory("freeflow")
 add_subdirectory("geomechanics")
 add_subdirectory("implicit")
+add_subdirectory("io")
 add_subdirectory("material")
 add_subdirectory("multidomain")
 

test/Makefile.am

@@ -3,6 +3,7 @@ SUBDIRS = common \
           freeflow \
           geomechanics \
           implicit \
+          io \
           material \
           multidomain \
           references

test/io/CMakeLists.txt

+add_subdirectory("gnuplotinterface")
\ No newline at end of file

test/io/Makefile.am

+SUBDIRS = gnuplotinterface
+
+EXTRA_DIST = CMakeLists.txt
+
+include $(top_srcdir)/am/global-rules
+

test/io/gnuplotinterface/CMakeLists.txt

+add_dumux_test(test_gnuplotinterface test_gnuplotinterface test_gnuplotinterface.cc
+  ${CMAKE_CURRENT_BINARY_DIR}/test_gnuplotinterface)

test/io/gnuplotinterface/Makefile.am

+check_PROGRAMS = test_gnuplotinterface
+
+test_fluidsystems_SOURCES = test_gnuplotinterface.cc
+
+EXTRA_DIST=CMakeLists.txt
+noinst_HEADERS:=$(wildcard *.hh)
+include $(top_srcdir)/am/global-rules

test/io/gnuplotinterface/test_gnuplotinterface.cc

+// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+// vi: set et ts=4 sw=4 sts=4:
+/*****************************************************************************
+ *   See the file COPYING for full copying permissions.                      *
+ *                                                                           *
+ *   This program 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 2 of the License, or       *
+ *   (at your option) any later version.                                     *
+ *                                                                           *
+ *   This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.   *
+ *****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief Simple test for the gnuplot interface, which plots a parabola
+ */
+#include "config.h"
+#include <vector>
+#include <dumux/io/gnuplotinterface.hh>
+
+////////////////////////
+// the main function
+////////////////////////
+int main()
+{
+    Dumux::GnuplotInterface<double> gnuplot;
+
+    unsigned int numIntervals = 100;
+    std::vector<double> x(101);
+    std::vector<double> y(101);
+    double xMin = -5.0;
+    double xMax = 5.0;
+    double xRange = xMax - xMin;
+    double yMin = 1e100;
+    double yMax = -1e100;
+
+    for (int i = 0; i <= numIntervals; i++)
+    {
+        x[i] = xMin + xRange * double(i) /double(numIntervals);
+        y[i] = x[i]*x[i];
+        yMin = std::min(yMin, y[i]);
+        yMax = std::max(yMax, y[i]);
+    }
+
+    unsigned int windowNumber = 0;
+    gnuplot.setXRange(xMin, xMax, windowNumber);
+    gnuplot.setYRange(yMin, yMax, windowNumber);
+    gnuplot.setXlabel("x [-]", windowNumber);
+    gnuplot.setYlabel("f(x) [-]", windowNumber);
+    gnuplot.addDataSet(x, y, "f(x) = x^2", windowNumber);
+    gnuplot.plot("plot", windowNumber, false);
+    exit(0);
+}