Utopia::Models::CopyMeBare::CopyMeBare Class Reference

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.
using	DataGroup = typename Base::DataGroup
	Data type of the group to write model data to, holding datasets.
using	DataSet = typename Base::DataSet
	Data type for a dataset.
Public Types inherited from Utopia::Model< CopyMeBare, ModelTypes >
using	Config = typename ModelTypes::Config
	Data type that holds the configuration.
using	DataManager = DataIO::Default::DefaultDataManager< CopyMeBare >
	The data manager to use, specialized with the derived model.
using	DataGroup = typename ModelTypes::DataGroup
	Data type that is used for storing datasets.
using	DataSet = typename ModelTypes::DataSet
	Data type that is used for storing data.
using	RNG = typename ModelTypes::RNG
	Data type of the shared RNG.
using	Space = typename ModelTypes::Space
	Data type of the space this model resides in.
using	Time = typename ModelTypes::Time
	Data type for the model time.
using	Monitor = typename ModelTypes::Monitor
	Data type for the monitor.
using	MonitorManager = typename ModelTypes::MonitorManager
	Data type for the monitor manager.
using	Level = typename ModelTypes::Level
	Data type for the hierarchical level.

Public Member Functions
template<class ParentModel >
	CopyMeBare (const std::string &name, ParentModel &parent_model, const DataIO::Config &custom_cfg={})
	Construct the CopyMeBare model.
void	perform_step ()
	Iterate a single step.
void	monitor ()
	Monitor model information.
void	write_data ()
	Write data.
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.
const std::shared_ptr< Space > &	get_space () const
	Return the space this model resides in.
Time	get_time () const
	Return the current time of this model.
Time	get_time_max () const
	Return the maximum time possible for this model.
Config	get_cfg () const
	Return the config node of this model.
std::string	get_name () const
	Return the name of this model instance.
std::string	get_full_name () const
	Return the full name of this model within the model hierarchy.
std::shared_ptr< DataGroup >	get_hdfgrp () const
	Return a pointer to the HDF group this model stores data in.
Time	get_write_start () const
	Return the parameter that controls when write_data is called first.
Time	get_write_every () const
	Return the parameter that controls how often write_data is called.
DataManager	get_datamanager () const
	return the datamanager
hsize_t	get_remaining_num_writes () const
	Return the number of remaining write_data calls this model will make.
std::shared_ptr< RNG >	get_rng () const
	Return a pointer to the shared RNG.
std::shared_ptr< spdlog::logger >	get_logger () const
	Return a pointer to the logger of this model.
Monitor	get_monitor () const
	Return the monitor of this model.
std::shared_ptr< MonitorManager >	get_monitor_manager () const
	Get the monitor manager of the root model.
Level	get_level () const
	Return the hierarchical level within the model hierarchy.
virtual void	prolog ()
	A function that is called before starting model iteration.
virtual void	epilog ()
	A function that is called after the last iteration of a model.
void	iterate ()
	Iterate one (time) step of this model.
void	run ()
	Run the model from the current time to the maximum time.
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.
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.
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.
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.

Additional Inherited Members
Protected Member Functions inherited from Utopia::Model< CopyMeBare, ModelTypes >
void	__perform_step ()
	Perform the computation of a step.
void	__monitor ()
	Monitor information in the terminal.
void	__write_data ()
	Write data; calls the implementation's write_data method.
void	__write_initial_state ()
	Write the initial state.
void	increment_time (const Time dt=1)
	Increment time.
void	__prolog ()
	The default prolog of a model.
void	__epilog ()
	The default epilog of a model.
CopyMeBare &	impl ()
	cast to the derived class
const CopyMeBare &	impl () const
	const cast to the derived interface
Protected Attributes inherited from Utopia::Model< CopyMeBare, ModelTypes >
const std::string	_name
	Name of the model instance.
const std::string	_full_name
	The full name within the model hierarchy.
const Level	_level
	The level within the model hierarchy.
const Config	_cfg
	Config node belonging to this model instance.
const std::shared_ptr< RNG >	_rng
	The RNG shared between models.
const std::shared_ptr< spdlog::logger >	_log
	The (model) logger.
std::shared_ptr< Space >	_space
	The space this model resides in.
Time	_time
	Model-internal current time stamp.
const Time	_time_max
	Model-internal maximum time stamp.
const std::shared_ptr< DataGroup >	_hdfgrp
	The HDF group this model instance should write its data to.
const Time	_write_start
	First time at which write_data is called.
const Time	_write_every
	How often to call write_data from iterate.
Monitor	_monitor
	The monitor.
DataManager	_datamanager
	Manager object for handling data output; see DataManager.
Static Protected Attributes inherited from Utopia::Model< CopyMeBare, ModelTypes >
static constexpr WriteMode	_write_mode
	Which data-writing mode the base model should use.

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

                                         {}
    )
    :
        Base(name, parent_model, custom_cfg)
    {}

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.

                    {
        // Can supply information to the monitor here in two ways:
        // this->_monitor.set_entry("key", value);
        // this->_monitor.set_entry("key", [this](){return 42.;});
    }

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

                       {
        // Example:
        // _dset_foo->write(it.begin(), it.end(),
        //     [](const auto& element) {
        //         return element.get_value();
        // });
    }

---

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

• src/utopia/models/CopyMeBare/CopyMeBare.hh