OpenMPCD
Public Member Functions | Protected Member Functions | List of all members
OpenMPCD::CUDA::MPCSolute::Instrumentation::StarPolymers< PositionCoordinate, VelocityCoordinate > Class Template Reference

Instrumentation for OpenMPCD::CUDA::MPCSolute::StarPolymers. More...

#include <StarPolymers.hpp>

Inheritance diagram for OpenMPCD::CUDA::MPCSolute::Instrumentation::StarPolymers< PositionCoordinate, VelocityCoordinate >:
Inheritance graph
[legend]
Collaboration diagram for OpenMPCD::CUDA::MPCSolute::Instrumentation::StarPolymers< PositionCoordinate, VelocityCoordinate >:
Collaboration graph
[legend]

Public Member Functions

 StarPolymers (MPCSolute::StarPolymers< PositionCoordinate, VelocityCoordinate > *const starPolymers_, const Configuration::Setting &settings_)
 The constructor. More...
 
virtual ~StarPolymers ()
 The destructor. More...
 
void measure ()
 Performs measurements. More...
 
void save (const std::string &rundir) const
 Saves the data to the given run directory. More...
 

Protected Member Functions

virtual void measureSpecific ()
 Performs measurements specific to the solute type. More...
 
virtual void saveSpecific (const std::string &rundir) const
 Saves measurements specific to the solute type. More...
 

Detailed Description

template<typename PositionCoordinate, typename VelocityCoordinate>
class OpenMPCD::CUDA::MPCSolute::Instrumentation::StarPolymers< PositionCoordinate, VelocityCoordinate >

Instrumentation for OpenMPCD::CUDA::MPCSolute::StarPolymers.

Template Parameters
PositionCoordinateThe type to store position coordinates.
VelocityCoordinateThe type to store velocity coordinates.

Definition at line 33 of file Instrumentation/StarPolymers.hpp.

Constructor & Destructor Documentation

◆ StarPolymers()

template<typename PositionCoordinate , typename VelocityCoordinate >
OpenMPCD::CUDA::MPCSolute::Instrumentation::StarPolymers< PositionCoordinate, VelocityCoordinate >::StarPolymers ( MPCSolute::StarPolymers< PositionCoordinate, VelocityCoordinate > *const  starPolymers_,
const Configuration::Setting settings_ 
)

The constructor.

Parameters
[in]starPolymers_The solute instance.
[in]settings_The configuration settings that have been used to configure the given star polymers instance.

Definition at line 17 of file StarPolymers.cpp.

◆ ~StarPolymers()

template<typename PositionCoordinate , typename VelocityCoordinate >
OpenMPCD::CUDA::MPCSolute::Instrumentation::StarPolymers< PositionCoordinate, VelocityCoordinate >::~StarPolymers
virtual

The destructor.

Definition at line 27 of file StarPolymers.cpp.

Member Function Documentation

◆ measure()

void OpenMPCD::CUDA::MPCSolute::Instrumentation::Base::measure ( )
inlineinherited

Performs measurements.

Definition at line 50 of file CUDA/MPCSolute/Instrumentation/Base.hpp.

◆ measureSpecific()

template<typename PositionCoordinate , typename VelocityCoordinate >
void OpenMPCD::CUDA::MPCSolute::Instrumentation::StarPolymers< PositionCoordinate, VelocityCoordinate >::measureSpecific ( )
protectedvirtual

Performs measurements specific to the solute type.

Implements OpenMPCD::CUDA::MPCSolute::Instrumentation::Base.

Definition at line 34 of file StarPolymers.cpp.

◆ save()

void OpenMPCD::CUDA::MPCSolute::Instrumentation::Base::save ( const std::string &  rundir) const
inlineinherited

Saves the data to the given run directory.

Parameters
[in]rundirThe path to the run directory.

Definition at line 60 of file CUDA/MPCSolute/Instrumentation/Base.hpp.

◆ saveSpecific()

template<typename PositionCoordinate , typename VelocityCoordinate >
void OpenMPCD::CUDA::MPCSolute::Instrumentation::StarPolymers< PositionCoordinate, VelocityCoordinate >::saveSpecific ( const std::string &  rundir) const
protectedvirtual

Saves measurements specific to the solute type.

Parameters
[in]rundirThe path to the run directory.

Implements OpenMPCD::CUDA::MPCSolute::Instrumentation::Base.

Definition at line 40 of file StarPolymers.cpp.


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