OpenMPCD
Instrumentation/VelocityAutocorrelation/Simple.hpp
Go to the documentation of this file.
1 /**
2  * @file
3  * Defines the OpenMPCD::CUDA::MPCFluid::Instrumentation::VelocityAutocorrelation::Simple class.
4  */
5 
6 #ifndef OPENMPCD_CUDA_MPCFLUID_INSTRUMENTATION_VELOCITYAUTOCORRELATION_SIMPLE_HPP
7 #define OPENMPCD_CUDA_MPCFLUID_INSTRUMENTATION_VELOCITYAUTOCORRELATION_SIMPLE_HPP
8 
10 
11 namespace OpenMPCD
12 {
13 namespace CUDA
14 {
15 namespace MPCFluid
16 {
17 namespace Instrumentation
18 {
19 namespace VelocityAutocorrelation
20 {
21 /**
22  * Class for measurements of velocity autocorrelation in MPC fluids that consist of bare,
23  * individual MPC fluid particles.
24  */
25 class Simple : public Base
26 {
27  public:
28  /**
29  * The constructor.
30  * @param[in] sim The simulation instance.
31  * @param[in] devMemMgr The Device memory manager.
32  * @param[in] mpcFluid_ The MPC fluid to measure.
33  */
34  Simple(
35  const Simulation* const sim, DeviceMemoryManager* const devMemMgr,
36  const MPCFluid::Base* const mpcFluid_);
37 
38  private:
39  Simple(const Simple&); ///< The copy constructor.
40 
41  public:
42  /**
43  * The destructor.
44  */
45  virtual ~Simple()
46  {
47  }
48 
49  protected:
50  /**
51  * Populates the currentVelocities buffer with the current velocities of the fluid constituents.
52  */
53  virtual void populateCurrentVelocities();
54 }; //class Simple
55 } //namespace VelocityAutocorrelation
56 } //namespace Instrumentation
57 } //namespace MPCFluid
58 } //namespace CUDA
59 } //namespace OpenMPCD
60 
61 #endif
OpenMPCD::CUDA::MPCFluid::Base
Base class for MPC fluids.
Definition: CUDA/MPCFluid/Base.hpp:40
OpenMPCD::CUDA::MPCFluid::Instrumentation::VelocityAutocorrelation::Simple
Class for measurements of velocity autocorrelation in MPC fluids that consist of bare,...
Definition: Instrumentation/VelocityAutocorrelation/Simple.hpp:25
OpenMPCD::CUDA::MPCFluid::Instrumentation::VelocityAutocorrelation::Simple::~Simple
virtual ~Simple()
The destructor.
Definition: Instrumentation/VelocityAutocorrelation/Simple.hpp:45
OpenMPCD::CUDA::DeviceMemoryManager
Class for managing memory on the CUDA Device.
Definition: DeviceMemoryManager.hpp:21
Base.hpp
OpenMPCD::CUDA::MPCFluid::Instrumentation::VelocityAutocorrelation::Simple::Simple
Simple(const Simulation *const sim, DeviceMemoryManager *const devMemMgr, const MPCFluid::Base *const mpcFluid_)
The constructor.
OpenMPCD::CUDA::Simulation
MPCD simulation with Molecular Dynamics on CUDA-capable GPUs.
Definition: CUDA/Simulation.hpp:48
OpenMPCD::CUDA::MPCFluid::Instrumentation::VelocityAutocorrelation::Base
Base class for measurements of velocity autocorrelation in MPC fluids.
Definition: CUDA/MPCFluid/Instrumentation/VelocityAutocorrelation/Base.hpp:110
OpenMPCD::CUDA::MPCFluid::Instrumentation::VelocityAutocorrelation::Simple::populateCurrentVelocities
virtual void populateCurrentVelocities()
Populates the currentVelocities buffer with the current velocities of the fluid constituents.