Utopia::Models::ForestFire::Param Struct Reference

ForestFire model parameter struct. More...

#include <ForestFire.hh>

Public Member Functions
	Param (const DataIO::Config &cfg)
	Construct the parameters from the given configuration node.

Public Attributes
const double	p_growth
	Rate of growth per cell.
const double	p_lightning
	Frequency of lightning occurring per cell.
const double	p_immunity
	The probability (per neighbor) to be immune to a spreading fire.

Detailed Description

ForestFire model parameter struct.

Constructor & Destructor Documentation

Param()

Utopia::Models::ForestFire::Param::Param ( const DataIO::Config &  cfg )

inline

Construct the parameters from the given configuration node.

    :
        p_growth(get_as<double>("p_growth", cfg)),
        p_lightning(get_as<double>("p_lightning", cfg)),
        p_immunity(get_as<double>("p_immunity", cfg))
    {
        if ((p_growth > 1.) or (p_growth < 0.)) {
            throw std::invalid_argument("Invalid p_growth! Need be a value "
                "in range [0, 1] and specify the probability per time step "
                "and cell with which an empty cell turns into a tree.");
        }
        if ((p_lightning > 1.) or (p_lightning < 0.)) {
            throw std::invalid_argument("Invalid p_lightning! Need be "
                "in range [0, 1] and specify the probability per cell and "
                "time step for lightning to strike.");
        }
        if ((p_immunity > 1.) or (p_immunity < 0.)) {
            throw std::invalid_argument("Invalid p_immunity! "
                "Need be a value in range [0, 1] and specify the probability "
                "per neighbor with which that neighbor is immune to fire.");
        }
    }

Member Data Documentation

p_growth

const double Utopia::Models::ForestFire::Param::p_growth

Rate of growth per cell.

p_immunity

const double Utopia::Models::ForestFire::Param::p_immunity

The probability (per neighbor) to be immune to a spreading fire.

p_lightning

const double Utopia::Models::ForestFire::Param::p_lightning

Frequency of lightning occurring per cell.

---

The documentation for this struct was generated from the following file:

• src/utopia/models/ForestFire/ForestFire.hh