OpenStructure
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions
ReferenceCalcDensityForceKernel Class Reference

#include <reference_density_kernels.hh>

Inherits CalcDensityForceKernel.

Public Member Functions

 ReferenceCalcDensityForceKernel (std::string name, const OpenMM::Platform &platform)
 
 ~ReferenceCalcDensityForceKernel ()
 
void initialize (const OpenMM::System &system, const DensityForce &force)
 
double execute (OpenMM::ContextImpl &context, bool includeForces, bool includeEnergy)
 
void copyParametersToContext (OpenMM::ContextImpl &context, const DensityForce &force)
 
- Public Member Functions inherited from CalcDensityForceKernel
 CalcDensityForceKernel (std::string name, const OpenMM::Platform &platform)
 

Additional Inherited Members

- Static Public Member Functions inherited from CalcDensityForceKernel
static std::string Name ()
 

Detailed Description

This kernel is invoked by DensityForce to calculate the forces acting on the system and the energy of the system.

Definition at line 46 of file reference_density_kernels.hh.

Constructor & Destructor Documentation

ReferenceCalcDensityForceKernel ( std::string  name,
const OpenMM::Platform &  platform 
)
inline

Definition at line 48 of file reference_density_kernels.hh.

Member Function Documentation

void copyParametersToContext ( OpenMM::ContextImpl &  context,
const DensityForce force 
)
virtual

Copy changed parameters over to a context.

Parameters
contextthe context to copy parameters to
forcethe DensityForce to copy the parameters from

Implements CalcDensityForceKernel.

double execute ( OpenMM::ContextImpl &  context,
bool  includeForces,
bool  includeEnergy 
)
virtual

Execute the kernel to calculate the forces and/or energy.

Parameters
contextthe context in which to execute this kernel
includeForcestrue if forces should be calculated
includeEnergytrue if the energy should be calculated
Returns
the potential energy due to the force

Implements CalcDensityForceKernel.

void initialize ( const OpenMM::System &  system,
const DensityForce force 
)
virtual

Initialize the kernel.

Parameters
systemthe System this kernel will be applied to
forcethe DensityForce this kernel will be used for

Implements CalcDensityForceKernel.


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