species.hh

Go to the documentation of this file.

#ifndef UTOPIA_MODELS_PREDATORPREYPLANT_SPECIES_HH
#define UTOPIA_MODELS_PREDATORPREYPLANT_SPECIES_HH
 
#include <utility>
 
#include <utopia/models/PredatorPrey/PredatorPrey.hh>
 
namespace Utopia::Models::PredatorPreyPlant {
 
 
struct PlantState{
    bool on_cell;
 
 
    unsigned int regeneration_counter = 0;
};
 
enum class GrowthModel {
    none,
    deterministic,
    stochastic
};
 
struct PlantParams {
    const GrowthModel growth_model;
 
    const unsigned int regen_time;
 
    const double regen_prob;
    
    // .. Constructors ........................................................
    PlantParams(const Utopia::DataIO::Config& cfg)
    :
        // Set the growth model from the configuration
        growth_model([&cfg](){
            auto gm = get_as<std::string>("growth_model", cfg);
            if (gm == "deterministic") return GrowthModel::deterministic;
            else if (gm == "stochastic") return GrowthModel::stochastic;
            else return GrowthModel::none;
        }()),
        // Extract regeneration time and probability
        regen_time([&cfg](){
            const auto t = get_as<int>("regen_time", cfg);
            return t;
        }()),
        regen_prob(get_as<double>("regen_prob", cfg))
    {};
 
    // Do not allow the default constructor
    PlantParams() = delete;
};
 
struct SpeciesBaseParams : PredatorPrey::SpeciesBaseParams{
    unsigned int move_limit;
 
    // .. Constructors ........................................................
    SpeciesBaseParams(const Utopia::DataIO::Config& cfg)
    :
        PredatorPrey::SpeciesBaseParams(cfg),
        move_limit([&cfg](){
            const auto lim = get_as<int>("move_limit", cfg);
            return lim;
        }())
    {}
 
    SpeciesBaseParams() = delete;
};
 
struct PredatorParams : public SpeciesBaseParams{
    // .. Constructors ........................................................
    PredatorParams(const Utopia::DataIO::Config& cfg)
    :
        SpeciesBaseParams(cfg)
    {
        double repro_cost = get_as<double>("repro_cost", cfg);
        double repro_resource_requ = get_as<double>("repro_resource_requ", cfg);
        if (repro_cost > repro_resource_requ) {
            throw std::invalid_argument("Parameter repro_cost needs to be "
                "smaller than or equal to the minimal resources required for "
                "reproduction!");
        }
    };
 
    PredatorParams() = delete;
};
 
struct PreyParams : public SpeciesBaseParams {
    // .. Interaction .........................................................
    double p_flee;
 
    // .. Constructors ........................................................
    PreyParams(const Utopia::DataIO::Config& cfg)
    :
        SpeciesBaseParams(cfg),
        p_flee(get_as<double>("p_flee", cfg))
    {
        double repro_cost = get_as<double>("repro_cost", cfg);
        double repro_resource_requ = get_as<double>("repro_resource_requ", cfg);
        if (repro_cost > repro_resource_requ) {
            throw std::invalid_argument("Parameter repro_cost needs to be "
                "smaller than or equal to the minimal resources required for "
                "reproduction!");
        }
    };
 
    PreyParams() = delete;
};
 
 
struct SpeciesParams{
    PreyParams prey;
 
    PredatorParams predator;
 
    PlantParams plant;
 
    // .. Constructors ........................................................
    SpeciesParams(const Utopia::DataIO::Config& cfg)
    :
        prey(cfg["prey"]),
        predator(cfg["predator"]),
        plant(cfg["plant"])
    {};
 
    SpeciesParams() = delete;
};
 
 
} // namespace Utopia::Models::PredatorPreyPlant
 
#endif // UTOPIA_MODELS_PREDATORPREYPLANT_SPECIES_HH