TimePlot.hpp

/*
    
Copyright (c) 2013 Centre for Water Systems,
                   University of Exeter

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

*/

#ifndef _TIMEPLOT_HPP_
#define _TIMEPLOT_HPP_


//! \file TimePlot.hpp
//! Contains the structure(s) of the various time plot(s) of the CA2D model.
//! \author Michele Guidolin, University of Exeter, 
//! contact: m.guidolin [at] exeter.ac.uk
//! \date 2013-03


#include"ca2D.hpp"
#include"BaseTypes.hpp"
#include"ArgsData.hpp"
#include"PointList.hpp"
#include<string>
#include<vector>
#include<fstream>


//! The configuration of output of a time plot of a physical variable
//! at a given coordinates/points using a given frequency.
struct TimePlot
{
  std::string    filename;	        //!< Name of the input file contains the time plot info. 

  std::string    name;		        //!< Name of the plot. 
  PV::Type       pv;		        //!< The physical variable.
  std::vector<std::string> pnames;	//!< The list of points name.
  std::vector<CA::Real> xcoos;	        //!< The list of X coordinates.
  std::vector<CA::Real> ycoos;	        //!< The list of Y coordinates.
  CA::Real period;		        //!< The period in second.
};


//! Initialise the time plot structure usign a CSV file. 
//! Each row represents a new "variable" where the 
//! first column is the name of the element 
//! and the following columns have the multiple/single values.
//! \attention The order of elements is not important.
//! \param[in]  filename This is the file where the data is read.
//! \param[out] tp       The structure containing the read data.
//! \return A non zero value if there was an error.
int initTimePlotFromCSV(const std::string& filename, TimePlot& tp);


//! Class that manage all Time Plots outputs
class TPManager
{
private:
  
  //! The structure used during the model computation to store the time plot data.
  struct Data
  {
    std::string   filename;	             //!< The name of the file to output. 
    cpp11::shared_ptr<std::ofstream> file;   //!< The file where to output the time plot data.
    CA::PointList pl;	                     //!< The coordinate of the points to plot.
    std::vector<CA::Real> pvals;	     //!< Buffer with the values of the points.
    std::vector<CA::Real> pelvs;	     //!< Eventual buffer with the values of the elevations.
    CA::Real      time_next;		     //!< The time of the next output.         
  };

public:

  //! Construct a Time Plot manager
  //! \param base  This is the base for all the output filenames of the various time plots.
  //! \param names This is a list of the names for the time plot outut files.
  TPManager(CA::Grid&  GRID, CA::CellBuffReal&  ELV, 
	    const std::vector<TimePlot>& tps, 
	    const std::string& base, std::vector<std::string> names);

  //! Destroy a Time Plot Manager.
  ~TPManager();
  

  //! Output the time plots.
  //! \params t       The simulation time.
  //! \param  iter    The iteration of the simulation.
  //! \params WD      The cell buffer with the water depth.
  //! \params V       The cell buffer with the velocity magnitude.
  //! \params output  If true, output information to console.
  void output(CA::Real t, CA::Unsigned iter, CA::CellBuffReal& WD, CA::CellBuffReal& V, bool output);


protected:


  //! Initialise the time plot data that is used during the
  //! computation from the time plot configuration.
  int initData(const std::string& filename, const TimePlot& tp, Data& tpdata);


private:

  //! Reference to the grid.
  CA::Grid& _grid;

  //! Reference to the elevation.
  CA::CellBuffReal& _elv;

  //! Reference to the List of time plot
  const std::vector<TimePlot>& _tps;

  //! List of rain event data.
  std::vector<Data> _datas;
};


#endif