Cell State for the SandPile model. More...

#include <SandPile.hh>

Public Member Functions
	State ()=delete
	Default constructor.

template<typename RNG >
	State (const DataIO::Config &cfg, const std::shared_ptr< RNG > &rng)
	Configuration based constructor.

Public Attributes
Slope	slope
	The current value of the slope.

bool	in_avalanche
	Whether the cell was touched by an avalanche; useful for updating.

Detailed Description

Cell State for the SandPile model.

Constructor & Destructor Documentation

◆ State() [1/2]

Utopia::Models::SandPile::State::State ( )

delete

Default constructor.

◆ State() [2/2]

template<typename RNG >

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

inline

Configuration based constructor.

    :
    in_avalanche{false}
    {
        // Read in the initial slope range
        const auto initial_slope_lower_limit =
            get_as<Slope>("initial_slope_lower_limit", cfg);
 
        const auto initial_slope_upper_limit =
            get_as<Slope>("initial_slope_upper_limit", cfg);
 
        // Make sure the parameters are valid
        if (initial_slope_upper_limit <= initial_slope_lower_limit) {
            throw std::invalid_argument("The `inital_slope_*_limit` "
                "parameters need to specify a valid range, i.e. with `lower` "
                "being strictly smaller than the `upper`!");
        }
 
        // Depending on initial slope, set the initial slope of all cells to
        // a random value in that interval
        std::uniform_int_distribution<Slope>
            dist(initial_slope_lower_limit, initial_slope_upper_limit);
 
        // Set the initial slopes that are not relaxed, yet.
        slope = dist(*rng);
    }

Member Data Documentation

◆ in_avalanche

bool Utopia::Models::SandPile::State::in_avalanche

Whether the cell was touched by an avalanche; useful for updating.

◆ slope

Slope Utopia::Models::SandPile::State::slope

The current value of the slope.

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

src/utopia/models/SandPile/SandPile.hh

Public Member Functions