OpenMPCD::CUDA::MPCFluid::Instrumentation::Simple Class Reference

Instrumentation for simple MPC fluids consisting of independent particles. More...

#include <Simple.hpp>

Inheritance diagram for OpenMPCD::CUDA::MPCFluid::Instrumentation::Simple:

Collaboration diagram for OpenMPCD::CUDA::MPCFluid::Instrumentation::Simple:

Public Member Functions
	Simple (const Simulation *const sim, DeviceMemoryManager *const devMemMgr, const MPCFluid::Simple *const mpcFluid_)
	The constructor. More...
virtual	~Simple ()
	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 LogicalEntityMeanSquareDisplacement *	getLogicalEntityMeanSquareDisplacement () const
	Returns the LogicalEntityMeanSquareDisplacement instance, or nullptr if none was configured. More...
const NormalModeAutocorrelation *	getNormalModeAutocorrelation () const
	Returns the NormalModeAutocorrelation instance, or nullptr if none was configured. More...

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

Protected Attributes
FourierTransformedVelocity::Base *	fourierTransformedVelocity
	Measures Fourier-transformed velocities. More...
LogicalEntityMeanSquareDisplacement *	logicalEntityMeanSquareDisplacement
	Measures the mean square displacement of the centers of mass of the logical entities of the fluid. More...
NormalModeAutocorrelation *	normalModeAutocorrelation
	Measures the autocorrelation of normal mode coordinates. More...
VelocityAutocorrelation::Base *	velocityAutocorrelation
	Measures velocity autocorrelation. More...

Detailed Description

Instrumentation for simple MPC fluids consisting of independent particles.

Definition at line 28 of file Instrumentation/Simple.hpp.

Constructor & Destructor Documentation

Simple()

OpenMPCD::CUDA::MPCFluid::Instrumentation::Simple::Simple	(	const Simulation *const	sim,
		DeviceMemoryManager *const	devMemMgr,
		const MPCFluid::Simple *const	mpcFluid_
	)

The constructor.

Parameters

[in]	sim	The simulation instance.
[in]	devMemMgr	The Device memory manager.
[in]	mpcFluid_	The MPC fluid to measure.

~Simple()

virtual OpenMPCD::CUDA::MPCFluid::Instrumentation::Simple::~Simple ( )

virtual

The destructor.

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

virtual void OpenMPCD::CUDA::MPCFluid::Instrumentation::Simple::measureSpecific ( )

protectedvirtual

Performs measurements specific to the fluid type.

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

save()

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

inlineinherited

Saves the data to the given run directory.

Parameters

[in]

rundir

The path to the run directory.

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

saveSpecific()

virtual void OpenMPCD::CUDA::MPCFluid::Instrumentation::Simple::saveSpecific ( const std::string &  rundir ) const

protectedvirtual

Saves measurements specific to the fluid type.

Parameters

[in]

rundir

The path to the run directory.

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

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 file:

• Instrumentation/Simple.hpp