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

Base class for MPC fluids instrumentation. More...

#include <Base.hpp>

Inheritance diagram for OpenMPCD::CUDA::MPCFluid::Instrumentation::Base:
Inheritance graph
[legend]
Collaboration diagram for OpenMPCD::CUDA::MPCFluid::Instrumentation::Base:
Collaboration 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...
 
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

 Base (const Configuration &config, const CUDA::MPCFluid::Base *const mpcFluid)
 The constructor. More...
 
virtual void measureSpecific ()=0
 Performs measurements specific to the fluid type. More...
 
virtual void saveSpecific (const std::string &rundir) const =0
 Saves measurements specific to the fluid type. 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

Base class for MPC fluids instrumentation.

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

Constructor & Destructor Documentation

◆ Base()

OpenMPCD::CUDA::MPCFluid::Instrumentation::Base::Base ( const Configuration config,
const CUDA::MPCFluid::Base *const  mpcFluid 
)
inlineprotected

The constructor.

Parameters
[in]configThe simulation configuration.
[in]mpcFluidThe fluid to measure.

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

◆ ~Base()

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

The destructor.

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

Member Function Documentation

◆ getLogicalEntityMeanSquareDisplacement()

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

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
inline

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

Performs measurements.

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

◆ measureSpecific()

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

◆ save()

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

◆ saveSpecific()

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

Member Data Documentation

◆ fourierTransformedVelocity

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

Measures Fourier-transformed velocities.

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

◆ logicalEntityMeanSquareDisplacement

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

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
protected

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
protected

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: