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

Record the time distances are below a threshold. More...

#include <ContactTimes.hpp>

+ Inheritance diagram for Accumulators::ContactTimes:
+ Collaboration diagram for Accumulators::ContactTimes:

Public Member Functions

 ContactTimes (::System::System const *system, int delta_N, double contact_threshold, std::shared_ptr< Observables::Observable > obs)
 
void update (boost::mpi::communicator const &comm) override
 
std::string get_internal_state () const final
 
void set_internal_state (std::string const &) final
 
auto const & contact_times () const
 
std::vector< std::size_t > shape () const override
 
void clear ()
 
double get_contact_threshold () const
 
- Public Member Functions inherited from Accumulators::AccumulatorBase
 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)
 

Additional Inherited Members

- Protected Attributes inherited from Accumulators::AccumulatorBase
void const * m_system
 for bookkeeping purposes
 

Detailed Description

Record the time distances are below a threshold.

The contact time is defined as \( \tau = t_f - t_0 \) where \( t_f \) is the last measured time at which a pairwise distance was below the threshold and \( t_0 \) is the first measured time at which the same distance was below the threshold.

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

Constructor & Destructor Documentation

◆ ContactTimes()

Accumulators::ContactTimes::ContactTimes ( ::System::System const *  system,
int  delta_N,
double  contact_threshold,
std::shared_ptr< Observables::Observable obs 
)
inline

Definition at line 45 of file core/accumulators/ContactTimes.hpp.

Member Function Documentation

◆ clear()

void Accumulators::ContactTimes::clear ( )
inline

Definition at line 61 of file core/accumulators/ContactTimes.hpp.

◆ contact_times()

auto const & Accumulators::ContactTimes::contact_times ( ) const
inline

Definition at line 59 of file core/accumulators/ContactTimes.hpp.

◆ get_contact_threshold()

double Accumulators::ContactTimes::get_contact_threshold ( ) const
inline

Definition at line 62 of file core/accumulators/ContactTimes.hpp.

◆ get_internal_state()

std::string Accumulators::ContactTimes::get_internal_state ( ) const
finalvirtual

Implements Accumulators::AccumulatorBase.

Definition at line 70 of file ContactTimes.cpp.

◆ set_internal_state()

void Accumulators::ContactTimes::set_internal_state ( std::string const &  state)
finalvirtual

◆ shape()

std::vector< std::size_t > Accumulators::ContactTimes::shape ( ) const
inlineoverridevirtual

Implements Accumulators::AccumulatorBase.

Definition at line 60 of file core/accumulators/ContactTimes.hpp.

◆ update()

void Accumulators::ContactTimes::update ( boost::mpi::communicator const &  comm)
overridevirtual

Implements Accumulators::AccumulatorBase.

Definition at line 32 of file ContactTimes.cpp.

References System::get_system().


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