The CopyMeGrid Model; a good start for a CA-based model. More...

#include <CopyMeGrid.hh>

Inheritance diagram for Utopia::Models::CopyMeGrid::CopyMeGrid:

Collaboration diagram for Utopia::Models::CopyMeGrid::CopyMeGrid:

Public Types
using	Base = Model< CopyMeGrid, ModelTypes >
	The type of the Model base class of this derived class. More...

using	DataGroup = typename Base::DataGroup
	Data type of the group to write model data to, holding datasets. More...

using	DataSet = typename Base::DataSet
	Data type for a dataset. More...

using	CellManager = Utopia::CellManager< CellTraits, CopyMeGrid >
	Type of the CellManager to use. More...

using	RuleFunc = typename CellManager::RuleFunc
	Extract the type of the rule function from the CellManager. More...

Public Types inherited from Utopia::Model< CopyMeGrid, ModelTypes >
using	Config = typename ModelTypes::Config
	Data type that holds the configuration. More...

using	DataManager = DataIO::Default::DefaultDataManager< CopyMeGrid >
	The data manager to use, specialized with the derived model. More...

using	DataGroup = typename ModelTypes::DataGroup
	Data type that is used for storing datasets. More...

using	DataSet = typename ModelTypes::DataSet
	Data type that is used for storing data. More...

using	RNG = typename ModelTypes::RNG
	Data type of the shared RNG. More...

using	Space = typename ModelTypes::Space
	Data type of the space this model resides in. More...

using	Time = typename ModelTypes::Time
	Data type for the model time. More...

using	Monitor = typename ModelTypes::Monitor
	Data type for the monitor. More...

using	MonitorManager = typename ModelTypes::MonitorManager
	Data type for the monitor manager. More...

using	Level = typename ModelTypes::Level
	Data type for the hierarchical level. More...

Public Member Functions
template<class ParentModel >
	CopyMeGrid (const std::string &name, ParentModel &parent_model, const DataIO::Config &custom_cfg={})
	Construct the CopyMeGrid model. More...

void	perform_step ()
	Iterate a single step. More...

void	monitor ()
	Monitor model information. More...

void	write_data ()
	Write data. More...

Public Member Functions inherited from Utopia::Model< CopyMeGrid, ModelTypes >
	Model (const std::string &name, const ParentModel &parent_model, const Config &custom_cfg={}, std::tuple< WriterArgs... > w_args={}, const DataIO::Default::DefaultDecidermap< CopyMeGrid > &w_deciders=DataIO::Default::default_deciders< CopyMeGrid >, const DataIO::Default::DefaultTriggermap< CopyMeGrid > &w_triggers=DataIO::Default::default_triggers< CopyMeGrid >)
	Constructs a Model instance. More...

const std::shared_ptr< Space > &	get_space () const
	Return the space this model resides in. More...

Time	get_time () const
	Return the current time of this model. More...

Time	get_time_max () const
	Return the maximum time possible for this model. More...

Config	get_cfg () const
	Return the config node of this model. More...

std::string	get_name () const
	Return the name of this model instance. More...

std::string	get_full_name () const
	Return the full name of this model within the model hierarchy. More...

std::shared_ptr< DataGroup >	get_hdfgrp () const
	Return a pointer to the HDF group this model stores data in. More...

Time	get_write_start () const
	Return the parameter that controls when write_data is called first. More...

Time	get_write_every () const
	Return the parameter that controls how often write_data is called. More...

DataManager	get_datamanager () const
	return the datamanager More...

hsize_t	get_remaining_num_writes () const
	Return the number of remaining `write_data` calls this model will make. More...

std::shared_ptr< RNG >	get_rng () const
	Return a pointer to the shared RNG. More...

std::shared_ptr< spdlog::logger >	get_logger () const
	Return a pointer to the logger of this model. More...

Monitor	get_monitor () const
	Return the monitor of this model. More...

std::shared_ptr< MonitorManager >	get_monitor_manager () const
	Get the monitor manager of the root model. More...

Level	get_level () const
	Return the hierarchical level within the model hierarchy. More...

virtual void	prolog ()
	A function that is called before starting model iteration. More...

virtual void	epilog ()
	A function that is called after the last iteration of a model. More...

void	iterate ()
	Iterate one (time) step of this model. More...

void	run ()
	Run the model from the current time to the maximum time. More...

std::shared_ptr< DataSet >	create_dset (const std::string name, const std::shared_ptr< DataGroup > &hdfgrp, std::vector< hsize_t > add_write_shape, const std::size_t compression_level=1, const std::vector< hsize_t > chunksize={})
	Create a new dataset within the given group. More...

std::shared_ptr< DataSet >	create_dset (const std::string name, const std::vector< hsize_t > add_write_shape, const std::size_t compression_level=1, const std::vector< hsize_t > chunksize={})
	Create a new dataset within the model's base data group. More...

std::shared_ptr< DataSet >	create_cm_dset (const std::string name, const CellManager &cm, const std::size_t compression_level=1, const std::vector< hsize_t > chunksize={})
	Create a dataset storing data from a CellManager. More...

std::shared_ptr< DataSet >	create_am_dset (const std::string name, const AgentManager &am, const std::size_t compression_level=1, const std::vector< hsize_t > chunksize={})
	Create a dataset storing data from a AgentManager. More...

Private Member Functions
double	calc_some_state_mean () const
	Calculate the mean of all cells' some_state. More...

Private Attributes
CellManager	_cm
	The cell manager. More...

double	_some_parameter
	Some parameter. More...

std::uniform_real_distribution< double >	_prob_distr
	A re-usable uniform real distribution to evaluate probabilities. More...

std::shared_ptr< DataSet >	_dset_some_state
	A dataset for storing all cells' some_state. More...

std::shared_ptr< DataSet >	_dset_some_trait
	A dataset for storing all cells' some_trait. More...

const RuleFunc	_some_interaction
	An interaction function of a single cell with its neighbors. More...

const RuleFunc	_some_other_rule
	Some other rule function. More...

Additional Inherited Members
Protected Member Functions inherited from Utopia::Model< CopyMeGrid, ModelTypes >
void	__perform_step ()
	Perform the computation of a step. More...

void	__monitor ()
	Monitor information in the terminal. More...

void	__write_data ()
	Write data; calls the implementation's write_data method. More...

void	__write_initial_state ()
	Write the initial state. More...

void	increment_time (const Time dt=1)
	Increment time. More...

void	__prolog ()
	The default prolog of a model. More...

void	__epilog ()
	The default epilog of a model. More...

CopyMeGrid &	impl ()
	cast to the derived class More...

const CopyMeGrid &	impl () const
	const cast to the derived interface More...

Protected Attributes inherited from Utopia::Model< CopyMeGrid, ModelTypes >
const std::string	_name
	Name of the model instance. More...

const std::string	_full_name
	The full name within the model hierarchy. More...

const Level	_level
	The level within the model hierarchy. More...

const Config	_cfg
	Config node belonging to this model instance. More...

const std::shared_ptr< RNG >	_rng
	The RNG shared between models. More...

const std::shared_ptr< spdlog::logger >	_log
	The (model) logger. More...

std::shared_ptr< Space >	_space
	The space this model resides in. More...

Time	_time
	Model-internal current time stamp. More...

const Time	_time_max
	Model-internal maximum time stamp. More...

const std::shared_ptr< DataGroup >	_hdfgrp
	The HDF group this model instance should write its data to. More...

const Time	_write_start
	First time at which write_data is called. More...

const Time	_write_every
	How often to call write_data from iterate. More...

Monitor	_monitor
	The monitor. More...

DataManager	_datamanager
	Manager object for handling data output; see DataManager. More...

Static Protected Attributes inherited from Utopia::Model< CopyMeGrid, ModelTypes >
static constexpr WriteMode	_write_mode
	Which data-writing mode the base model should use. More...

Detailed Description

The CopyMeGrid Model; a good start for a CA-based model.

TODO Add your model description here. This model's only right to exist is to be a template for new models. That means its functionality is based on nonsense but it shows how actually useful functionality could be implemented.

Member Typedef Documentation

◆ Base

using Utopia::Models::CopyMeGrid::CopyMeGrid::Base = Model<CopyMeGrid, ModelTypes>

The type of the Model base class of this derived class.

◆ CellManager

using Utopia::Models::CopyMeGrid::CopyMeGrid::CellManager = Utopia::CellManager<CellTraits, CopyMeGrid>

Type of the CellManager to use.

◆ DataGroup

using Utopia::Models::CopyMeGrid::CopyMeGrid::DataGroup = typename Base::DataGroup

Data type of the group to write model data to, holding datasets.

◆ DataSet

using Utopia::Models::CopyMeGrid::CopyMeGrid::DataSet = typename Base::DataSet

Data type for a dataset.

◆ RuleFunc

using Utopia::Models::CopyMeGrid::CopyMeGrid::RuleFunc = typename CellManager::RuleFunc

Extract the type of the rule function from the CellManager.

This is a function that receives a reference to a cell and returns the new cell state. For more details, check out Utopia::CellManager

Note: Whether the cell state gets applied directly or requires a synchronous update depends on the update mode specified in the cell traits.

Constructor & Destructor Documentation

◆ CopyMeGrid()

template<class ParentModel >

Utopia::Models::CopyMeGrid::CopyMeGrid::CopyMeGrid	(	const std::string &	name,
		ParentModel &	parent_model,
		const DataIO::Config &	custom_cfg = `{}`
	)

inline

Construct the CopyMeGrid model.

Parameters

name	Name of this model instance; is used to extract the configuration from the parent model and set up a HDFGroup for this instance
parent_model	The parent model this model instance resides in
custom_cfg	A custom configuration to use instead of the one extracted from the parent model using the instance name

Member Function Documentation

◆ calc_some_state_mean()

double Utopia::Models::CopyMeGrid::CopyMeGrid::calc_some_state_mean ( ) const

inlineprivate

Calculate the mean of all cells' some_state.

◆ monitor()

void Utopia::Models::CopyMeGrid::CopyMeGrid::monitor ( )

inline

Monitor model information.

Here, functions and values can be supplied to the monitor that are then available to the frontend. The monitor() function is only called if a certain emit interval has passed; thus, the performance hit is small. With this information, you can then define stop conditions on frontend side, that can stop a simulation once a certain set of conditions is fulfilled.

◆ perform_step()

void Utopia::Models::CopyMeGrid::CopyMeGrid::perform_step ( )

inline

Iterate a single step.

Here you can add a detailed description what exactly happens in a single iteration step

◆ write_data()

void Utopia::Models::CopyMeGrid::CopyMeGrid::write_data ( )

inline

Write data.

This function is called to write out data. The configuration determines the times at which it is invoked. See Utopia::DataIO::Dataset::write

Member Data Documentation

◆ _cm

CellManager Utopia::Models::CopyMeGrid::CopyMeGrid::_cm

private

The cell manager.

◆ _dset_some_state

std::shared_ptr<DataSet> Utopia::Models::CopyMeGrid::CopyMeGrid::_dset_some_state

private

A dataset for storing all cells' some_state.

◆ _dset_some_trait

std::shared_ptr<DataSet> Utopia::Models::CopyMeGrid::CopyMeGrid::_dset_some_trait

private

A dataset for storing all cells' some_trait.

◆ _prob_distr

std::uniform_real_distribution<double> Utopia::Models::CopyMeGrid::CopyMeGrid::_prob_distr

private

A re-usable uniform real distribution to evaluate probabilities.

◆ _some_interaction

const RuleFunc Utopia::Models::CopyMeGrid::CopyMeGrid::_some_interaction

private

Initial value:

= [this](const auto& cell){
        
        auto state = cell->state();
 
        state.some_state += 1;
 
        for (auto& nb : this->_cm.neighbors_of(cell)) {
            
            state.some_trait += nb->state().some_trait;
 
            state.some_trait += (this->_prob_distr(*this->_rng) * 2. - 1.);
        }
 
        state.some_trait /= this->_some_parameter;
 
        return state;
    }

An interaction function of a single cell with its neighbors.

◆ _some_other_rule

const RuleFunc Utopia::Models::CopyMeGrid::CopyMeGrid::_some_other_rule

private

Initial value:

= [this](const auto& cell){
        
        auto state = cell->state();
 
        if (this->_prob_distr(*this->_rng) < 0.3) {
            state.some_state = 0;
        }
 
        return state;
    }

Some other rule function.

◆ _some_parameter

double Utopia::Models::CopyMeGrid::CopyMeGrid::_some_parameter

private

Some parameter.

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

src/utopia/models/CopyMeGrid/CopyMeGrid.hh

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Base

◆ CellManager

◆ DataGroup

◆ DataSet

◆ RuleFunc

Constructor & Destructor Documentation

◆ CopyMeGrid()

Member Function Documentation

◆ calc_some_state_mean()

◆ monitor()

◆ perform_step()

◆ write_data()

Member Data Documentation

◆ _cm

◆ _dset_some_state

◆ _dset_some_trait

◆ _prob_distr

◆ _some_interaction

◆ _some_other_rule

◆ _some_parameter