gnu_out.h

#ifndef __GNU_OUT_H__
#define __GNU_OUT_H__

#include <string>
#include <vector>

namespace PHiLiP {

namespace GridRefinement {


template <typename real>
class GnuFig
{
public:

    GnuFig();


    explicit GnuFig(const std::string &name_input);

    void set_name(
        const std::string &name_input);

    void set_title(
        const std::string &title_input);

    void set_x_label(
        const std::string &xlabel_input);

    void set_y_label(
        const std::string &ylabel_input);

    void set_grid(
        const bool grid_bool_input);

    void set_x_scale_log(
        const bool xlog_bool_input);

    void set_y_scale_log(
        const bool ylog_bool_input);

    void set_legend(
        const bool legend_bool_input);

    void add_xy_data(
        const std::vector<real> &x_data, 
        const std::vector<real> &y_data);

    // Adds 2D x vs. y data to be plotted (with a legend label)
    void add_xy_data(
        const std::vector<real> &x_data, 
        const std::vector<real> &y_data, 
        const std::string &      label_name);


    void write_gnuplot();


    void exec_gnuplot();

private:
    void write_gnuplot_header(
        std::ostream &out);

    void write_gnuplot_body(
        std::ostream &out);

    void write_gnuplot_footer(
        std::ostream &out);

    void write_xy_data(
        std::ostream &     out,
        const unsigned int data_id);

    // default settings
    const std::string DEFAULT_NAME   = "GnuFig"; 
    const std::string DEFAULT_TITLE  = "";       
    const std::string DEFAULT_XLABEL = "";       
    const std::string DEFAULT_YLABEL = "";       
    const bool        DEFAULT_GRID   = false;    
    const bool        DEFAULT_XLOG   = false;    
    const bool        DEFAULT_YLOG   = false;    
    const bool        DEFAULT_LEGEND = false;    

    // for the legend
    const std::string DEFAULT_LABEL_PREFIX = "data_"; 
    

    // properties
    std::string name;   
    std::string title;  
    std::string xlabel; 
    std::string ylabel; 
    bool        grid;   
    bool        xlog;   
    bool        ylog;   
    bool        legend; 

    // data
    std::vector<std::vector<real>> x_data_vec;     
    std::vector<std::vector<real>> y_data_vec;     
    std::vector<std::string>       label_name_vec; 
};

} // namespace GridRefinement

} //namespace PHiLiP

#endif // __GNU_OUT_H__