ESPResSo
Extensible Simulation Package for Research on Soft Matter Systems
Loading...
Searching...
No Matches
Accumulators::AccumulatorBase Class Referenceabstract

#include <AccumulatorBase.hpp>

+ Inheritance diagram for Accumulators::AccumulatorBase:

Public Member Functions

 AccumulatorBase (::System::System const *system, int delta_N)
 
virtual ~AccumulatorBase ()=default
 
int & delta_N ()
 
bool has_same_system_handle (::System::System const *system) const
 
void override_system_handle (::System::System const *system)
 
virtual void update (boost::mpi::communicator const &comm)=0
 
virtual std::vector< std::size_t > shape () const =0
 Dimensions needed to reshape the flat array returned by the accumulator.
 
virtual std::string get_internal_state () const =0
 Serialization of private members.
 
virtual void set_internal_state (std::string const &)=0
 

Protected Attributes

void const * m_system
 for bookkeeping purposes
 

Detailed Description

Definition at line 37 of file core/accumulators/AccumulatorBase.hpp.

Constructor & Destructor Documentation

◆ AccumulatorBase()

Accumulators::AccumulatorBase::AccumulatorBase ( ::System::System const *  system,
int  delta_N 
)
inline

Definition at line 39 of file core/accumulators/AccumulatorBase.hpp.

◆ ~AccumulatorBase()

virtual Accumulators::AccumulatorBase::~AccumulatorBase ( )
virtualdefault

Member Function Documentation

◆ delta_N()

int & Accumulators::AccumulatorBase::delta_N ( )
inline

Definition at line 43 of file core/accumulators/AccumulatorBase.hpp.

◆ get_internal_state()

virtual std::string Accumulators::AccumulatorBase::get_internal_state ( ) const
pure virtual

Serialization of private members.

Implemented in Accumulators::Correlator, Accumulators::MeanVarianceCalculator, and Accumulators::TimeSeries.

◆ has_same_system_handle()

bool Accumulators::AccumulatorBase::has_same_system_handle ( ::System::System const *  system) const
inline

Definition at line 44 of file core/accumulators/AccumulatorBase.hpp.

References m_system.

Referenced by Accumulators::AutoUpdateAccumulators::add().

◆ override_system_handle()

void Accumulators::AccumulatorBase::override_system_handle ( ::System::System const *  system)
inline

Definition at line 47 of file core/accumulators/AccumulatorBase.hpp.

References m_system.

Referenced by Accumulators::AutoUpdateAccumulators::add().

◆ set_internal_state()

virtual void Accumulators::AccumulatorBase::set_internal_state ( std::string const &  )
pure virtual

◆ shape()

virtual std::vector< std::size_t > Accumulators::AccumulatorBase::shape ( ) const
pure virtual

Dimensions needed to reshape the flat array returned by the accumulator.

Implemented in Accumulators::Correlator, Accumulators::MeanVarianceCalculator, and Accumulators::TimeSeries.

◆ update()

virtual void Accumulators::AccumulatorBase::update ( boost::mpi::communicator const &  comm)
pure virtual

Member Data Documentation

◆ m_system


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