litter_cover.h

Go to the documentation of this file.

#ifndef LITTER_COVER_H
#define LITTER_COVER_H
 
#include "../framework/module.h"
#include "../framework/state_map.h"
 
namespace standardBML
{
class litter_cover : public direct_module
{
   public:
    litter_cover(
        state_map const& input_quantities,
        state_map* output_quantities)
        : direct_module{},
 
          // Get pointers to input quantities
          LeafLitter{get_input(input_quantities, "LeafLitter")},
          km_leaf_litter{get_input(input_quantities, "km_leaf_litter")},
 
          // Get pointers to output quantities
          lcf_op{get_op(output_quantities, "litter_cover_fraction")}
    {
    }
    static string_vector get_inputs();
    static string_vector get_outputs();
    static std::string get_name() { return "litter_cover"; }
 
   private:
    // References to input quantities
    double const& LeafLitter;
    double const& km_leaf_litter;
 
    // Pointers to output quantities
    double* lcf_op;
 
    // Main operation
    void do_operation() const;
};
 
string_vector litter_cover::get_inputs()
{
    return {
        "LeafLitter",     // Mg / ha
        "km_leaf_litter"  // Mg / ha
    };
}
 
string_vector litter_cover::get_outputs()
{
    return {
        "litter_cover_fraction"  // dimensionless
    };
}
 
void litter_cover::do_operation() const
{
    update(lcf_op, LeafLitter / (LeafLitter + km_leaf_litter));
}
 
}  // namespace standardBML
#endif