soil_sunlight.h

Go to the documentation of this file.

#ifndef SOIL_SUNLIGHT_H
#define SOIL_SUNLIGHT_H
 
#include "../framework/module.h"
#include "../framework/state_map.h"
 
namespace standardBML
{
class soil_sunlight : public direct_module
{
   public:
    soil_sunlight(
        state_map const& input_quantities,
        state_map* output_quantities)
        : direct_module{},
 
          // Get pointers to input quantities
          canopy_direct_transmission_fraction{get_input(input_quantities, "canopy_direct_transmission_fraction")},
          litter_cover_fraction{get_input(input_quantities, "litter_cover_fraction")},
 
          // Get pointers to output quantities
          soil_sunlit_fraction_op{get_op(output_quantities, "soil_sunlit_fraction")}
    {
    }
    static string_vector get_inputs();
    static string_vector get_outputs();
    static std::string get_name() { return "soil_sunlight"; }
 
   private:
    // References to input quantities
    double const& canopy_direct_transmission_fraction;
    double const& litter_cover_fraction;
 
    // Pointers to output quantities
    double* soil_sunlit_fraction_op;
 
    // Main operation
    void do_operation() const;
};
 
string_vector soil_sunlight::get_inputs()
{
    return {
        "canopy_direct_transmission_fraction",  // dimensionless
        "litter_cover_fraction"                 // dimensionless
    };
}
 
string_vector soil_sunlight::get_outputs()
{
    return {
        "soil_sunlit_fraction"  // dimensionless
    };
}
 
void soil_sunlight::do_operation() const
{
    update(soil_sunlit_fraction_op, canopy_direct_transmission_fraction *
                                        (1.0 - litter_cover_fraction));
}
 
}  // namespace standardBML
#endif