Utopia
2
Framework for studying models of complex & adaptive systems.
|
Dummy model with simple update rule. More...
#include <dummy.hh>
Public Types | |
using | Base = Model< Dummy, DummyTypes > |
The base model class. More... | |
using | Data = std::vector< double > |
The data type to use for _state and _bc members. More... | |
using | DataSet = Base::DataSet |
Public Types inherited from Utopia::Model< Dummy, DummyTypes > | |
using | Config = typename ModelTypes::Config |
Data type that holds the configuration. More... | |
using | DataManager = DataIO::Default::DefaultDataManager< Dummy > |
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 > | |
Dummy (const std::string &name, const ParentModel &parent_model, const Data &initial_state, const DataIO::Config &custom_cfg={}) | |
Construct the dummy model with an initial state. More... | |
void | perform_step () |
Iterate by one time step. More... | |
void | monitor () |
Monitor model information. More... | |
void | write_data () |
Write data into a dataset that corresponds to the current step. More... | |
Public Member Functions inherited from Utopia::Model< Dummy, DummyTypes > | |
Model (const std::string &name, const ParentModel &parent_model, const Config &custom_cfg={}, std::tuple< WriterArgs... > w_args={}, const DataIO::Default::DefaultDecidermap< Dummy > &w_deciders=DataIO::Default::default_deciders< Dummy >, const DataIO::Default::DefaultTriggermap< Dummy > &w_triggers=DataIO::Default::default_triggers< Dummy >) | |
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 Attributes | |
Data | _state |
The current state of the model. More... | |
Data | _bc |
The boundary conditions of the model. More... | |
std::shared_ptr< DataSet > | _dset_state |
Dataset to write the state to. More... | |
Additional Inherited Members | |
Protected Member Functions inherited from Utopia::Model< Dummy, DummyTypes > | |
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... | |
Dummy & | impl () |
cast to the derived class More... | |
const Dummy & | impl () const |
const cast to the derived interface More... | |
Protected Attributes inherited from Utopia::Model< Dummy, DummyTypes > | |
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< Dummy, DummyTypes > | |
static constexpr WriteMode | _write_mode |
Which data-writing mode the base model should use. More... | |
Dummy model with simple update rule.
Holds a vector of doubles and increments its entries by random numbers with the bounds determined by the boundary condition vector.
The base model class.
using Utopia::Models::Dummy::Dummy::Data = std::vector<double> |
The data type to use for _state and _bc members.
|
inline |
Construct the dummy model with an initial state.
name | Name of this model instance |
parent_model | The parent model instance this instance resides in |
initial_state | Initial state of the model |
custom_cfg | A custom configuration to use instead of the one extracted from the parent model using the instance name |
|
inline |
Monitor model information.
Supply a function that calculates the state mean, if the monitor will perform an emission.
|
inline |
Iterate by one time step.
This writes random numbers into the state vector, incrementing the already existing ones. Thus, with numbers between 0 and 1, the mean value of the state increases by 0.5 for each performed step.
|
inline |
Write data into a dataset that corresponds to the current step.
|
private |
The boundary conditions of the model.
|
private |
Dataset to write the state to.
|
private |
The current state of the model.