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::ComplementSwitchingFunction< TOriginalSwitchingFunction > Class Template Reference

#include <ComplementSwitchingFunction.h>

Inheritance diagram for ProtoMol::ComplementSwitchingFunction< TOriginalSwitchingFunction >:

ProtoMol::ComplementSwitchingFunctionBase List of all members.

Public Types

enum  { USE = 1 }

Public Member Functions

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

Static Public Member Functions

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

Private Attributes

TOriginalSwitchingFunction myOrigFunc

Detailed Description

template<class TOriginalSwitchingFunction>
class ProtoMol::ComplementSwitchingFunction< TOriginalSwitchingFunction >

Defines the complement of a given switching function (TOriginalSwitchingFunction).

Member Enumeration Documentation

template<class TOriginalSwitchingFunction>
anonymous enum
 

Enumeration values:
USE 

Constructor & Destructor Documentation

template<class TOriginalSwitchingFunction>
ProtoMol::ComplementSwitchingFunction< TOriginalSwitchingFunction >::ComplementSwitchingFunction (   )  [inline]
 

template<class TOriginalSwitchingFunction>
ProtoMol::ComplementSwitchingFunction< TOriginalSwitchingFunction >::ComplementSwitchingFunction (  const TOriginalSwitchingFunction  sw  )  [inline]
 

Member Function Documentation

template<class TOriginalSwitchingFunction>
Real ProtoMol::ComplementSwitchingFunction< TOriginalSwitchingFunction >::cutoffSquared (   )  const [inline]
 

template<class TOriginalSwitchingFunction>
std::string ProtoMol::ComplementSwitchingFunction< TOriginalSwitchingFunction >::getId (   )  [inline, static]
 

template<class TOriginalSwitchingFunction>
void ProtoMol::ComplementSwitchingFunction< TOriginalSwitchingFunction >::getParameters (  std::vector< Parameter > &  parameters  )  const [inline]
 

template<class TOriginalSwitchingFunction>
unsigned int ProtoMol::ComplementSwitchingFunction< TOriginalSwitchingFunction >::getParameterSize (   )  [inline, static]
 

template<class TOriginalSwitchingFunction>
ComplementSwitchingFunction ProtoMol::ComplementSwitchingFunction< TOriginalSwitchingFunction >::make (  std::string &  errMsg,
std::vector< Value >  values
)  [inline, static]
 

template<class TOriginalSwitchingFunction>
void ProtoMol::ComplementSwitchingFunction< TOriginalSwitchingFunction >::operator() (  Real &  value,
Real &  derivOverD,
Real  distSquared
)  const [inline]
 

template<class TOriginalSwitchingFunction>
bool ProtoMol::ComplementSwitchingFunction< TOriginalSwitchingFunction >::roughTest (  Real   )  const [inline]
 

simple and fast test if we should apply the switching function

Member Data Documentation

template<class TOriginalSwitchingFunction>
TOriginalSwitchingFunction ProtoMol::ComplementSwitchingFunction< TOriginalSwitchingFunction >::myOrigFunc [private]
 

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