OpenMPCD
Public Member Functions | List of all members
OpenMPCD::CUDA::Instrumentation Class Reference

Class doing measurements in a CUDA simulation. More...

#include <Instrumentation.hpp>

Public Member Functions

 Instrumentation (const Simulation *const sim, const unsigned int rngSeed_, const std::string &gitRevision_)
 The constructor. More...
 
 ~Instrumentation ()
 The destructor. More...
 
void measure ()
 Performs measurements on MPC fluids and solutes. More...
 
void setAutosave (const std::string &rundir)
 Sets the autosave flag. More...
 
void save (const std::string &rundir) const
 Saves the data to the given run directory. More...
 

Detailed Description

Class doing measurements in a CUDA simulation.

Definition at line 26 of file Instrumentation.hpp.

Constructor & Destructor Documentation

◆ Instrumentation()

CUDA::Instrumentation::Instrumentation ( const Simulation *const  sim,
const unsigned int  rngSeed_,
const std::string &  gitRevision_ 
)

The constructor.

Parameters
[in]simThe simulation to measure.
[in]rngSeed_The seed for the random number generator.
[in]gitRevision_A string containing the git revision, if available.

Definition at line 18 of file Instrumentation.cpp.

◆ ~Instrumentation()

CUDA::Instrumentation::~Instrumentation ( )

The destructor.

Definition at line 104 of file Instrumentation.cpp.

Member Function Documentation

◆ measure()

void CUDA::Instrumentation::measure ( )

Performs measurements on MPC fluids and solutes.

Definition at line 110 of file Instrumentation.cpp.

◆ save()

void CUDA::Instrumentation::save ( const std::string &  rundir) const

Saves the data to the given run directory.

Parameters
[in]rundirThe path to the run directory.

Definition at line 120 of file Instrumentation.cpp.

◆ setAutosave()

void OpenMPCD::CUDA::Instrumentation::setAutosave ( const std::string &  rundir)
inline

Sets the autosave flag.

Parameters
[in]rundirThe directory to save to.

Definition at line 58 of file Instrumentation.hpp.


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