gnuplotWriter.h

Go to the documentation of this file.

/*  This file is part of the OpenLB library
 *
 *  Copyright (C) 2016 Fabian Klemens
 *  E-mail contact: info@openlb.net
 *  The most recent release of OpenLB can be downloaded at
 *  <http://www.openlb.net/>
 *
 *  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, write to the Free
 *  Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 *  Boston, MA  02110-1301, USA.
*/
 
#ifndef GNUPLOT_WRITER_H
#define GNUPLOT_WRITER_H
 
#include <iomanip>
#include <iostream>
#include <vector>
#include "CSVWriter.h"
#include "CSVWriter.hh"
 
namespace olb {
 
template< typename T >
class Gnuplot {
public:
 
  enum AxisType {LINEAR, LOGLOG, LOGLOGINVERTED}; 
  enum Regression {OFF, LINREG};                  
 
  Gnuplot(std::string name, bool liveplot, std::string preCommand, AxisType axisType, Regression regressionType);
  explicit Gnuplot(std::string name);
  Gnuplot(std::string name, bool liveplot);
  Gnuplot(std::string name, AxisType axisType);
  Gnuplot(std::string name, AxisType axisType, Regression regressionType);
 
  void init();
 
  void setData(T xValue, T yValue, std::string name = "", std::string key = "", char plotType = 'l');
  void setData(bool noXvalue, T yValue, std::string name = "", std::string key = "", char plotType = 'l');
 
  void setData(T xValue, std::vector<T> yValues, std::vector<std::string> names = {""}, std::string key = "right", std::vector<char> plotType = {'l','l'});
  void setData(bool noXvalue, std::vector<T> yValues, std::vector<std::string> names = {""}, std::string key = "right", const std::vector<char> plotType = {'l','l'});
 
  void setLabel(std::string xLabel = "", std::string yLabel = "");
 
  void writePDF(std::string plotName = "");
 
  void writePNG(int iT = -1, double xRange = -1, std::string plotName = "");
 
 
private:
  std::string _xLabel;
  std::string _yLabel;
  std::string _name;
  bool _liveplot;
  std::string _type;
  std::string _dataFile;
  std::string _dir;
  std::vector<std::string> _names;
  std::string _key;
  std::string _preCommand;
  AxisType _axisType;
  Regression _regressionType;
 
  CSV<T> csvWriter;
 
  std::vector<char> _plotTypes;
  bool _init = true;
  unsigned int _dataSize = 0;
  int _iT = -1;
  double _xRange = -1;
  T _time = 0.;
 
  static constexpr int _rank {0};  // only process _rank will write output
  bool _gnuplotInstalled {false};
 
  void writePlotFile(std::string type, std::string plotName = "");
 
protected:
  void startGnuplot(std::string plotFile, std::string plotName = "");
 
  void linRegression(std::ofstream& fout, std::string x_axisType, std::string y_axisType);
 
  void scaleAxes(std::ofstream& fout);
};
 
}  // namespace olb
 
#endif