HarmonicAngleForceImpl Class Reference

This is the internal implementation of HarmonicAngleForce. More...

#include <HarmonicAngleForceImpl.h>

Inheritance diagram for HarmonicAngleForceImpl:
ForceImpl

List of all members.

Public Member Functions

 HarmonicAngleForceImpl (HarmonicAngleForce &owner)
 ~HarmonicAngleForceImpl ()
void initialize (ContextImpl &context)
 This is called after the ForceImpl is created and before updateContextState(), calcForces(), or calcEnergy() is called on it.
HarmonicAngleForcegetOwner ()
 Get the Force object from which this ForceImpl was created.
void updateContextState (ContextImpl &context)
 This method is called at the beginning of each time step.
void calcForces (ContextImpl &context)
 Calculate the force on each particle generated by this ForceImpl.
double calcEnergy (ContextImpl &context)
 Calculate this ForceImpl's contribution to the potential energy of the system.
std::map< std::string, double > getDefaultParameters ()
 Get a map containing the default values for all adjustable parameters defined by this ForceImpl.
std::vector< std::string > getKernelNames ()
 Get the names of all Kernels used by this Force.

Detailed Description

This is the internal implementation of HarmonicAngleForce.


Constructor & Destructor Documentation


Member Function Documentation

double calcEnergy ( ContextImpl context  )  [virtual]

Calculate this ForceImpl's contribution to the potential energy of the system.

Parameters:
context the context in which the system is being simulated
Returns:
this force's contribution to the potential energy of the system, or 0 if this force does not contribute to potential energy

Implements ForceImpl.

void calcForces ( ContextImpl context  )  [virtual]

Calculate the force on each particle generated by this ForceImpl.

The forces should be added to the values already present in the array that is passed in. If this ForceImpl does not generate any new forces, it should simply return without modifying the array.

Parameters:
context the context in which the system is being simulated
forces new forces should be added to the value already stored in this

Implements ForceImpl.

std::map<std::string, double> getDefaultParameters (  )  [inline, virtual]

Get a map containing the default values for all adjustable parameters defined by this ForceImpl.

These parameters and their default values will automatically be added to the Context.

Implements ForceImpl.

std::vector<std::string> getKernelNames (  )  [virtual]

Get the names of all Kernels used by this Force.

Implements ForceImpl.

HarmonicAngleForce& getOwner (  )  [inline, virtual]

Get the Force object from which this ForceImpl was created.

Implements ForceImpl.

void initialize ( ContextImpl context  )  [virtual]

This is called after the ForceImpl is created and before updateContextState(), calcForces(), or calcEnergy() is called on it.

This allows it to do any necessary initialization.

Implements ForceImpl.

void updateContextState ( ContextImpl context  )  [inline, virtual]

This method is called at the beginning of each time step.

It give the ForceImpl a chance to modify the state variables (positions, velocities, and parameters) stored in the Context in arbitrary ways before integration is performed.

Parameters:
context the context in which the system is being simulated

Implements ForceImpl.


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

Generated by  doxygen 1.6.2