Utopia::Models::ForestFire::State Struct Reference

The full cell struct for the ForestFire model. More...

#include <ForestFire.hh>

Collaboration diagram for Utopia::Models::ForestFire::State:

Public Member Functions
	State ()=delete
	Remove default constructor, for safety.
template<class RNG >
	State (const DataIO::Config &cfg, const std::shared_ptr< RNG > &rng)
	Construct a cell from a configuration node and an RNG.

Public Attributes
Kind	kind
	The kind of object that populates this cell, e.g. a tree.
unsigned short	age
	The age of the tree on this cell.
unsigned int	cluster_id
	An ID denoting to which cluster this cell belongs (if it is a tree)

Detailed Description

The full cell struct for the ForestFire model.

Constructor & Destructor Documentation

State() [1/2]

Utopia::Models::ForestFire::State::State ( )

delete

Remove default constructor, for safety.

State() [2/2]

template<class RNG >

Utopia::Models::ForestFire::State::State ( const DataIO::Config &  cfg, const std::shared_ptr< RNG > &  rng  )

inline

Construct a cell from a configuration node and an RNG.

    :
        kind(Kind::empty),
        age(0),
        cluster_id(0)
    {
        // Get the desired probability to be a tree
        const auto p_tree = get_as<double>("p_tree", cfg);
 
        // Check obvious cases (no need to draw a random number)
        if (p_tree < 0. or p_tree > 1.) {
            throw std::invalid_argument("p_tree needs to be in interval "
                                        "[0., 1.], but was not!");
        }
        else if (p_tree == 0.) {
            return;
        }
        else if (p_tree == 1.) {
            kind = Kind::tree;
            return;
        }
 
        // With this probability, the cell state is a tree
        if (std::uniform_real_distribution<double>(0., 1.)(*rng) < p_tree) {
            kind = Kind::tree;
        }
        // NOTE Although the distribution object is created each time, this
        //      is not a significant slow-down compared to re-using an
        //      existing distribution object (<4%). When compiled with
        //      optimization flags, that slowdown is even smaller...
    }

Member Data Documentation

age

unsigned short Utopia::Models::ForestFire::State::age

The age of the tree on this cell.

cluster_id

unsigned int Utopia::Models::ForestFire::State::cluster_id

An ID denoting to which cluster this cell belongs (if it is a tree)

kind

Kind Utopia::Models::ForestFire::State::kind

The kind of object that populates this cell, e.g. a tree.

---

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

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