The CopyMeBare Model; the bare-basics a model needs. More...

#include <CopyMeBare.hh>

Inheritance diagram for Utopia::Models::CopyMeBare::CopyMeBare:

Collaboration diagram for Utopia::Models::CopyMeBare::CopyMeBare:

Public Types
using	Base = Model< CopyMeBare, 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...

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

using	DataManager = DataIO::Default::DefaultDataManager< CopyMeBare >
	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 >
	CopyMeBare (const std::string &name, ParentModel &parent_model, const DataIO::Config &custom_cfg={})
	Construct the CopyMeBare 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< CopyMeBare, ModelTypes >
	Model (const std::string &name, const ParentModel &parent_model, const Config &custom_cfg={}, std::tuple< WriterArgs... > w_args={}, const DataIO::Default::DefaultDecidermap< CopyMeBare > &w_deciders=DataIO::Default::default_deciders< CopyMeBare >, const DataIO::Default::DefaultTriggermap< CopyMeBare > &w_triggers=DataIO::Default::default_triggers< CopyMeBare >)
	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...

Additional Inherited Members
Protected Member Functions inherited from Utopia::Model< CopyMeBare, 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...

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

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

Protected Attributes inherited from Utopia::Model< CopyMeBare, 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< CopyMeBare, ModelTypes >
static constexpr WriteMode	_write_mode
	Which data-writing mode the base model should use. More...

Detailed Description

The CopyMeBare Model; the bare-basics a model needs.

TODO Add your class description here. ...

Member Typedef Documentation

◆ Base

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

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

◆ DataGroup

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

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

◆ DataSet

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

Data type for a dataset.

Constructor & Destructor Documentation

◆ CopyMeBare()

template<class ParentModel >

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

inline

Construct the CopyMeBare 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

◆ monitor()

void Utopia::Models::CopyMeBare::CopyMeBare::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.

◆ perform_step()

void Utopia::Models::CopyMeBare::CopyMeBare::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::CopyMeBare::CopyMeBare::write_data ( )

inline

Write data.

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

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

src/utopia/models/CopyMeBare/CopyMeBare.hh

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Base

◆ DataGroup

◆ DataSet

Constructor & Destructor Documentation

◆ CopyMeBare()

Member Function Documentation

◆ monitor()

◆ perform_step()

◆ write_data()