OpenMPCD
Public Member Functions | Protected Member Functions | List of all members
OpenMPCD::CUDA::MPCSolute::Instrumentation::Base Class Referenceabstract

Base class for MPC solutes instrumentation. More...

#include <Base.hpp>

Inheritance diagram for OpenMPCD::CUDA::MPCSolute::Instrumentation::Base:
Inheritance graph
[legend]

Public Member Functions

virtual ~Base ()
 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

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

Detailed Description

Base class for MPC solutes instrumentation.

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

Constructor & Destructor Documentation

◆ Base()

OpenMPCD::CUDA::MPCSolute::Instrumentation::Base::Base ( )
inlineprotected

The constructor.

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

◆ ~Base()

virtual OpenMPCD::CUDA::MPCSolute::Instrumentation::Base::~Base ( )
inlinevirtual

The destructor.

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

Member Function Documentation

◆ measure()

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

Performs measurements.

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

◆ measureSpecific()

virtual void OpenMPCD::CUDA::MPCSolute::Instrumentation::Base::measureSpecific ( )
protectedpure virtual

Performs measurements specific to the solute type.

Implemented in OpenMPCD::CUDA::MPCSolute::Instrumentation::StarPolymers< PositionCoordinate, VelocityCoordinate >.

◆ save()

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

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()

virtual void OpenMPCD::CUDA::MPCSolute::Instrumentation::Base::saveSpecific ( const std::string &  rundir) const
protectedpure virtual

Saves measurements specific to the solute type.

Parameters
[in]rundirThe path to the run directory.

Implemented in OpenMPCD::CUDA::MPCSolute::Instrumentation::StarPolymers< PositionCoordinate, VelocityCoordinate >.


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