TauCLDGenerator.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-or-later
/***********************************************************************************/
/*  Copyright 2013 WSL Institute for Snow and Avalanche Research    SLF-DAVOS      */
/***********************************************************************************/
/* This file is part of MeteoIO.
    MeteoIO 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.
 
    MeteoIO 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 MeteoIO.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef TAUCLDGENERATOR_H
#define TAUCLDGENERATOR_H
 
#include <meteoio/dataGenerators/GeneratorAlgorithms.h>
#include <meteoio/meteoLaws/Sun.h>
#include <meteoio/dataClasses/DEMObject.h>
 
#include <map>
 
namespace mio {
 
class TauCLDGenerator : public GeneratorAlgorithm {
        public:
                typedef enum CLF_PARAMETRIZATION {
                        DEFAULT,        //will be mapped to KASTEN
                        CLF_LHOMME,
                        KASTEN,
                        CLF_CRAWFORD
                } clf_parametrization;
 
                TauCLDGenerator(const std::vector< std::pair<std::string, std::string> >& vecArgs, const std::string& i_algo, const std::string& i_section, const double& TZ, const Config &i_cfg);
                ~TauCLDGenerator() override;
                
                bool generate(const size_t& param, MeteoData& md, const std::vector<MeteoData>& vecMeteo) override;
                bool create(const size_t& param, const size_t& ii_min, const size_t& ii_max, std::vector<MeteoData>& vecMeteo) override;
 
        protected:
                struct CLOUDCACHE; //forward declaration
                typedef struct CLOUDCACHE cloudCache;
 
                double interpolateCloudiness(const std::string& station_hash, const double& julian_gmt) const;
                double getCloudiness(const MeteoData& md);
                double computeCloudiness(const MeteoData& md, bool &is_night);
                double getClearness(const double& cloudiness) const;
                static std::vector< std::pair<double,double> > computeMask(const DEMObject& i_dem, const StationData& sd);
                double getHorizon(const MeteoData& md, const double& sun_azi);
                
                std::map< std::string, cloudCache > last_cloudiness; //as < station_hash, <julian_gmt, cloudiness> >
                std::map< std::string , std::vector< std::pair<double,double> > > masks;
                std::string horizons_outfile;
                const Config &cfg;
                DEMObject dem;
                SunObject sun;
                clf_parametrization cloudiness_model;
                bool use_rswr, use_rad_threshold;
                bool write_mask_out, use_horizons, from_dem;
};
 
 
struct TauCLDGenerator::CLOUDCACHE {
        CLOUDCACHE() : last_valid(std::make_pair(IOUtils::nodata, IOUtils::nodata)) {}
        CLOUDCACHE(const double& julian_gmt, const double& cloudiness) : last_valid(std::make_pair(IOUtils::nodata, IOUtils::nodata)) { addCloudiness(julian_gmt, cloudiness); }
 
        void addCloudiness(const double& julian_gmt, const double& cloudiness);
 
        std::pair<double, double> last_valid;
};
 
} //end namespace mio
 
#endif