Runoff.h

Go to the documentation of this file.

/***********************************************************************************/
/*  Copyright 2009-2015 WSL Institute for Snow and Avalanche Research    SLF-DAVOS      */
/***********************************************************************************/
/* This file is part of Alpine3D.
    Alpine3D is free software: you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Alpine3D 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 Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public License
    along with Alpine3D.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef RUNOFF_H
#define RUNOFF_H

#include <iostream>
#include <vector>
#include <map>
#include <limits>
#include <sstream>
#include <meteoio/MeteoIO.h>
#include <alpine3d/SnowpackInterface.h>
#include <alpine3d/SnowpackInterfaceWorker.h>

typedef unsigned long long longuint;

class SnowpackInterface; // forward declaration, cyclic header include

class Runoff
{
        public:
                Runoff(const mio::Config& in_cfg, const mio::DEMObject& in_dem,
                       const double& in_thresh_rain);
                Runoff(const Runoff& copy);

                // Methods to set other modules
                void setSnowPack(SnowpackInterface &sn_interface);

                virtual void output(const mio::Date& i_date, const mio::Grid2DObject& psum,
                                    const mio::Grid2DObject& ta, mio::IOManager& io_in);
                virtual ~Runoff();

                std::string getGridsRequirements() const;
                double getTiming() const;

        protected:
                mio::IOManager *io;
                SnowpackInterface *snowpack;  

                const double thresh_rain;
                const double tz_out;
                bool output_grids; //< output grid of runoff data? (for taking it over with an external hydro model)
                bool output_sums;  //< output total runoff per subcatchment?
                std::string catchment_out_path; //< folder in which the extracted catchment sums should be written
                double resampling_cell_size; //< cell size [m] to which the runoff grids should be resampled
                double grid_size_factor;
                const size_t n_grid_cells;
                enum NumberingType {Alpine3DOld, TauDEM} const catchment_numbering;

                mio::Timer timer;
                const mio::Grid2DObject slope_correction;
                const bool is_glacier_mask_dynamic;
                bool is_glacier_mask_set;
                mio::Grid2DObject total_runoff, glacier_mask;
                std::vector<SnGrids::Parameters> extra_meteo_variables;
                size_t n_extra_meteo_variables;
                std::map<size_t, mio::Grid2DObject> catchment_masks;
                bool use_external_iomanager_for_grids; // To know if the same io manager than for the other grids must be used
                                                       // (to avoid having multiple netcdf files open)
                static const double MIN_CELL_SIZE; //< [m] two points closer to each other than this value will be assumed to overlap
                static const double DISTANCE_ABSOLUTE_PRECISION; //< [m] minimum size of a grid cell

                virtual void constructCatchmentMasks(mio::Grid2DObject catchmentGrid);
                virtual void updateTotalRunoffGrid();
                virtual void updateGlacierMask();
                virtual mio::Grid2DObject computePrecipRunoff(const mio::Grid2DObject& psum, const mio::Grid2DObject& ta) const;
                virtual void getExtraMeteoGrids(std::vector<mio::Grid2DObject>& grids) const;
                virtual void initializeOutputFiles(const mio::Grid2DObject& dem) const;
                virtual void updateOutputFile(const size_t& catchId, const mio::Date& currTime,
                                              const double& totalRunoff, const double& precipRunoff,
                                              const double& snowRunoff, const double& glacierRunoff,
                                              const std::vector<double>& meteoVars) const;

                static mio::IOManager* getIOManager(mio::Config in_cfg, const bool& outputGrids);
                static mio::Grid2DObject getSlopeCorrection(const mio::DEMObject& dem);
                static NumberingType getCatchmentNumberingScheme(const mio::Config& in_cfg);
                static bool getIsGlacierDynamic(const mio::Config& cfg);
                static std::vector<SnGrids::Parameters> getExtraMeteoVariables(const mio::Config& cfg);
                static double getResamplingCellSize(const mio::DEMObject& in_dem, const mio::Grid2DObject& catchments);
                static bool isMultiple(const double& a, const double& b);
                static double estimateResamplingCellSize(const double& llOffset, const double& currSizeEstimate);
                static std::vector<size_t> factorizeCatchmentNumber(longuint value);
                static void cropMask(mio::Grid2DObject& mask);
                static double sumOverMask(const mio::Grid2DObject& grid, const mio::Grid2DObject& mask);
                static double averageOverMask(const mio::Grid2DObject& grid, const mio::Grid2DObject& mask);

        private:
                Runoff& operator=(const Runoff&) {return *this;} //< private in order to avoid being used and suppress compiler warning
};

#endif