ProtoMol - an object-oriented component based framework for Molecular Dynamics simulations.
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members

ProtoMol::CutoffSwitchingFunction Class Reference

#include <CutoffSwitchingFunction.h>

Inheritance diagram for ProtoMol::CutoffSwitchingFunction:

ProtoMol::CutoffSwitchingFunctionBase List of all members.

Public Types

enum  { USE = 1 }

Public Member Functions

 CutoffSwitchingFunction ()
 CutoffSwitchingFunction (Real cutoff)
bool roughTest (Real distSquared) const
Real cutoffSquared () const
void operator() (Real &value, Real &derivOverD, Real distSquared) const
void getParameters (std::vector< Parameter > &parameters) const

Static Public Member Functions

const std::string & getId ()
unsigned int getParameterSize ()
CutoffSwitchingFunction make (std::string &errMsg, std::vector< Value > values)

Private Attributes

Real myCutoff
Real myCutoff2

Detailed Description

Cutoff switching function, implements a simple truncation of the potential.

Member Enumeration Documentation

anonymous enum
 

Enumeration values:
USE 

Constructor & Destructor Documentation

ProtoMol::CutoffSwitchingFunction::CutoffSwitchingFunction (   ) 
 

ProtoMol::CutoffSwitchingFunction::CutoffSwitchingFunction (  Real  cutoff  ) 
 

Member Function Documentation

Real ProtoMol::CutoffSwitchingFunction::cutoffSquared (   )  const [inline]
 

const std::string& ProtoMol::CutoffSwitchingFunction::getId (   )  [inline, static]
 

void ProtoMol::CutoffSwitchingFunction::getParameters (  std::vector< Parameter > &  parameters  )  const
 

unsigned int ProtoMol::CutoffSwitchingFunction::getParameterSize (   )  [inline, static]
 

CutoffSwitchingFunction ProtoMol::CutoffSwitchingFunction::make (  std::string &  errMsg,
std::vector< Value >  values
)  [static]
 

void ProtoMol::CutoffSwitchingFunction::operator() (  Real &  value,
Real &  derivOverD,
Real  distSquared
)  const [inline]
 

bool ProtoMol::CutoffSwitchingFunction::roughTest (  Real  distSquared  )  const [inline]
 

simple and fast test if we should apply the switching function

Member Data Documentation

Real ProtoMol::CutoffSwitchingFunction::myCutoff [private]
 

Real ProtoMol::CutoffSwitchingFunction::myCutoff2 [private]
 

The documentation for this class was generated from the following files: Last update: . GNU GENERAL PUBLIC LICENSE, copyrighted by the University of Notre Dame and the University of Bergen, Norway.