OpenMPCD
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
OpenMPCD::CUDA::MPCFluid::Instrumentation::GaussianRods Class Reference

Instrumentation for Gaussian Rod fluids. More...

#include <GaussianRods.hpp>

Inheritance diagram for OpenMPCD::CUDA::MPCFluid::Instrumentation::GaussianRods:
Inheritance graph
[legend]
Collaboration diagram for OpenMPCD::CUDA::MPCFluid::Instrumentation::GaussianRods:
Collaboration graph
[legend]

Public Member Functions

 GaussianRods (const Simulation *const sim, DeviceMemoryManager *const devMemMgr, const MPCFluid::GaussianRods *const mpcFluid_)
 The constructor. More...
 
virtual ~GaussianRods ()
 The destructor. More...
 
void measure ()
 Performs measurements. More...
 
void save (const std::string &rundir) const
 Saves the data to the given run directory. More...
 
const LogicalEntityMeanSquareDisplacementgetLogicalEntityMeanSquareDisplacement () const
 Returns the LogicalEntityMeanSquareDisplacement instance, or nullptr if none was configured. More...
 
const NormalModeAutocorrelationgetNormalModeAutocorrelation () const
 Returns the NormalModeAutocorrelation instance, or nullptr if none was configured. More...
 

Protected Member Functions

virtual void measureSpecific ()
 Performs measurements. More...
 
virtual void saveSpecific (const std::string &rundir) const
 Saves the data to the given run directory. More...
 

Protected Attributes

FourierTransformedVelocity::BasefourierTransformedVelocity
 Measures Fourier-transformed velocities. More...
 
LogicalEntityMeanSquareDisplacementlogicalEntityMeanSquareDisplacement
 Measures the mean square displacement of the centers of mass of the logical entities of the fluid. More...
 
NormalModeAutocorrelationnormalModeAutocorrelation
 Measures the autocorrelation of normal mode coordinates. More...
 
VelocityAutocorrelation::BasevelocityAutocorrelation
 Measures velocity autocorrelation. More...
 

Detailed Description

Instrumentation for Gaussian Rod fluids.

Definition at line 26 of file Instrumentation/GaussianRods.hpp.

Constructor & Destructor Documentation

◆ GaussianRods()

GaussianRods::GaussianRods ( const Simulation *const  sim,
DeviceMemoryManager *const  devMemMgr,
const MPCFluid::GaussianRods *const  mpcFluid_ 
)

The constructor.

Parameters
[in]simThe simulation instance.
[in]devMemMgrThe Device memory manager.
[in]mpcFluid_The MPC fluid to measure.

Definition at line 8 of file GaussianRods.cpp.

◆ ~GaussianRods()

virtual OpenMPCD::CUDA::MPCFluid::Instrumentation::GaussianRods::~GaussianRods ( )
inlinevirtual

The destructor.

Definition at line 42 of file Instrumentation/GaussianRods.hpp.

Member Function Documentation

◆ getLogicalEntityMeanSquareDisplacement()

const LogicalEntityMeanSquareDisplacement* OpenMPCD::CUDA::MPCFluid::Instrumentation::Base::getLogicalEntityMeanSquareDisplacement ( ) const
inlineinherited

Returns the LogicalEntityMeanSquareDisplacement instance, or nullptr if none was configured.

Definition at line 129 of file CUDA/MPCFluid/Instrumentation/Base.hpp.

◆ getNormalModeAutocorrelation()

const NormalModeAutocorrelation* OpenMPCD::CUDA::MPCFluid::Instrumentation::Base::getNormalModeAutocorrelation ( ) const
inlineinherited

Returns the NormalModeAutocorrelation instance, or nullptr if none was configured.

Definition at line 139 of file CUDA/MPCFluid/Instrumentation/Base.hpp.

◆ measure()

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

Performs measurements.

Definition at line 86 of file CUDA/MPCFluid/Instrumentation/Base.hpp.

◆ measureSpecific()

void GaussianRods::measureSpecific ( )
protectedvirtual

Performs measurements.

Implements OpenMPCD::CUDA::MPCFluid::Instrumentation::Base.

Definition at line 19 of file GaussianRods.cpp.

◆ save()

void OpenMPCD::CUDA::MPCFluid::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 107 of file CUDA/MPCFluid/Instrumentation/Base.hpp.

◆ saveSpecific()

void GaussianRods::saveSpecific ( const std::string &  rundir) const
protectedvirtual

Saves the data to the given run directory.

Parameters
[in]rundirThe path to the run directory.

Implements OpenMPCD::CUDA::MPCFluid::Instrumentation::Base.

Definition at line 34 of file GaussianRods.cpp.

Member Data Documentation

◆ fourierTransformedVelocity

FourierTransformedVelocity::Base* OpenMPCD::CUDA::MPCFluid::Instrumentation::Base::fourierTransformedVelocity
protectedinherited

Measures Fourier-transformed velocities.

Definition at line 160 of file CUDA/MPCFluid/Instrumentation/Base.hpp.

◆ logicalEntityMeanSquareDisplacement

LogicalEntityMeanSquareDisplacement* OpenMPCD::CUDA::MPCFluid::Instrumentation::Base::logicalEntityMeanSquareDisplacement
protectedinherited

Measures the mean square displacement of the centers of mass of the logical entities of the fluid.

Definition at line 163 of file CUDA/MPCFluid/Instrumentation/Base.hpp.

◆ normalModeAutocorrelation

NormalModeAutocorrelation* OpenMPCD::CUDA::MPCFluid::Instrumentation::Base::normalModeAutocorrelation
protectedinherited

Measures the autocorrelation of normal mode coordinates.

Definition at line 167 of file CUDA/MPCFluid/Instrumentation/Base.hpp.

◆ velocityAutocorrelation

VelocityAutocorrelation::Base* OpenMPCD::CUDA::MPCFluid::Instrumentation::Base::velocityAutocorrelation
protectedinherited

Measures velocity autocorrelation.

Definition at line 169 of file CUDA/MPCFluid/Instrumentation/Base.hpp.


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