Setup.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 _SETUP_HPP_
#define _SETUP_HPP_


//! \file Setup.hpp
//!  Contains the structure with the main setup for the CA2D model.
//! \author Michele Guidolin, University of Exeter, 
//! contact: m.guidolin [at] exeter.ac.uk
//! \date 2013-03

#include"BaseTypes.hpp"
#include<string>
#include<vector>


//! Structure with the data that define the main variables used to
//! execute the CA2D model. 
struct Setup
{
  //  --- SIMULATION  --- 
  std::vector<CA::Unsigned> sim_version; 
  std::string    sim_name;      //!< Name of the simulation.
  std::string    short_name;	//!< Short name used as base for output files. 
  std::string    preproc_name;	//!< Name used as base for the pre-processed files.
  MODEL::Type    model_type;	//!< The model used in the simulation

  //  --- TIME VALUES  ---  
  CA::Real      time_start;     //!< Starting time of the simulation (seconds).
  CA::Real      time_end;       //!< Ending time of the simulation (seconds).
  CA::Real      time_syncdt;    //!< Minimum time for synchronizing with 1D simulator.
  CA::Real      time_maxdt;     //!< The initial and maximum time step.
  CA::Real      time_mindt;     //!< The minimum time step.
  CA::Real      time_updatedt;	//!< The time step to update the time step.
  CA::Real      time_alpha;	    //!< The proportion of adaptive time step taken.
  CA::Unsigned  time_maxiters;	//!< The maximum number of iterations. 

  //  --- SIMULATION PARAMETERS ---
  CA::Real      roughness_global; //!< Global default value.  
  CA::Real      infrate_global;   //!< Global default value (mm/hr).  
  CA::Real      tolerance;	  //!< The water difference between cell that can be ignored.
  CA::Real      ignore_wd;	  //!< The water depth that can be ignored.
  CA::Real      tol_slope;	  //!< The slope difference (in %) between cell used to compute dt.


  //! The elevation of boundary cell, a high value represent a CLOSED
  //! boundary a low value represents an OPEN boundary.
  CA::Real      boundary_elv;	   

  //  --- ELEVATION  ---  
  //! ARC/INFO ASCII GRID format file with the specific
  //! elevation value for each cell and the no data value.
  std::string   elevation_ASCII; 
  
  //  --- MANNING  ---
  //! ARC/INFO ASCII GRID format file with the specific
  //! Manning roughness value for each cell and the no data value.
  std::string   manning_ASCII;

  //  --- PERMEABILITY  ---
  //! ARC/INFO ASCII GRID format file with the specific
  //! permeability value for each cell and the no data value.
  std::string   permeability_ASCII;

  //  --- LEVEL  ---
  //! ARC/INFO ASCII GRID format file with the specific
  //! absolute water level value for each cell and the no data value.
  std::string   level_ASCII;

  //  --- INFILTRATION  ---
  //! ARC/INFO ASCII GRID format file with the specific
  //! infiltration value for each cell and the no data value.
  std::string   infiltration_ASCII;

    //  --- RAIN EVENT  ---
  //! CSV file(s) with the configuration of the rain event(s) to add
  //! into the grid.
  std::vector<std::string> rainevent_files;

  //  --- WATER LEVEL EVENT  ---  
  //! CSV file(s) with the configuration of the water level event(s)
  //! to add into the grid.
  std::vector<std::string> wlevent_files;

  //  --- INFLOW EVENT  ---  
  //! CSV file(s) with the configuration of the inflow event(s)
  //! to add into the grid.
  std::vector<std::string> inflowevent_files;

  //  --- COUPLINGS  ---  
  //! CSV file(s) with the configuration of the 1D couplings
  //! to add into the grid.
  std::vector<std::string> coupling_files;

  
  //  --- TIMEPLOT  ---  
  //! CSV file(s) with the configuration of the time plot(s) to
  //! produce, i.e. the value of a physical variable (WD,WL,VEL) at
  //! specific time and location.
  std::vector<std::string> timeplot_files;

  //  --- RASTERS  ---  
  //! CSV file(s) with the configuration of the raster grid(s) to
  //! produce, i.e. the grid value of a physical variable (WD,WL,VEL) at
  //! specific time.
  std::vector<std::string> rastergrid_files;

  
  //  --- OUTPUT  ---  
  bool output_console;		//!< If true output info into console.
  CA::Real output_period;	//!< The period to ouput in seconds.
  bool output_computation;	//!< If true ouput computation time.
  bool terrain_info;		//!< If true print terrain info, like slope.
  bool ts_plot;                 //!< If true create a file that plot the time step.

  //  --- CHEKS  ---
  bool check_vols;		//!< If true compute the various input/ouput volumes. 

  //  --- REMOVE  ---
  bool remove_data;		//!< If true remove the data created by the model (no pre-proc).
  bool remove_prec_data;	//!< If true remove the data created by the pre-proces

  // ---  RASTER OUTPUT ---
  bool     rast_vel_as_vect;	//!< If true output the velocity raster as a vector field.  
  CA::Real rast_wd_tol;		//!< Ignore cell in raster that are lower than this tolerance.
  bool     rast_boundary;	//!< If true output the value of boundary cell. 
  int      rast_places;		//!< The number of decimal places after the comma.

  // ---  PEAK UPDATE ---
  bool  update_peak_dt;	        //!< If true update the peak at every time step. Default false.

  // --- OPTIMISATIONS ---
  bool     expand_domain;	//!< If true expand the computational domain when needed.
  bool     ignore_upstream;     //!< If true ignore upstream cells.
  CA::Real upstream_reduction;	//!< The amount of elevation to reduce
};


//! Initialise the setup 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] setup    The structure containing the read data.
//! \return A non zero value if there was an error.
int initSetupFromCSV(const std::string& filename, Setup& setup);


#endif