Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

colvar::orientation_proj Class Reference

\brief Colvar component: cosine of the angle of rotation with respect to a set of reference coordinates (colvarvalue::type_scalar type, range [-1:1]). More...

#include <colvarcomp.h>

Inheritance diagram for colvar::orientation_proj:

colvar::orientation colvar::cvc colvarparse colvardeps colvarparams List of all members.

Public Methods

 orientation_proj (std::string const &conf)
 orientation_proj ()
virtual int init (std::string const &conf)
 An init function should be defined for every class inheriting from cvc
Parameters:
conf  Contents of the configuration file pertaining to this cvc.
 More...

virtual ~orientation_proj ()
virtual void calc_value ()
 \brief Calculate the variable. More...

virtual void calc_gradients ()
 \brief Calculate the atomic gradients, to be reused later in order to apply forces. More...

virtual void apply_force (colvarvalue const &force)
 \brief Apply the collective variable force, by communicating the atomic forces to the simulation program (Note: the ft member is not altered by this function) Note: multiple calls to this function within the same simulation step will add the forces altogether
Parameters:
cvforce  The collective variable force, usually coming from the biases and eventually manipulated by the parent colvar object.
 More...

virtual cvm::real dist2 (colvarvalue const &x1, colvarvalue const &x2) const
 \brief Square distance between x1 and x2 (can be redefined to transparently implement constraints, symmetries and periodicities) colvar::cvc::dist2() and the related functions are declared as "const" functions, but not "static", because additional parameters defining the metrics (e.g. the periodicity) may be specific to each colvar::cvc object. If symmetries or periodicities are present, the colvar::cvc::dist2() should be redefined to return the "closest distance" value and colvar::cvc::dist2_lgrad(), colvar::cvc::dist2_rgrad() to return its gradients. If constraints are present (and not already implemented by any of the colvarvalue types), the colvar::cvc::dist2_lgrad() and colvar::cvc::dist2_rgrad() functions should be redefined to provide a gradient which is compatible with the constraint, i.e. already deprived of its component normal to the constraint hypersurface. Finally, another useful application, if you are performing very many operations with these functions, could be to override the colvarvalue member functions and access directly its member data. For instance: to define dist2(x1,x2) as (x2.real_value-x1.real_value)*(x2.real_value-x1.real_value) in case of a scalar colvarvalue type. More...

virtual colvarvalue dist2_lgrad (colvarvalue const &x1, colvarvalue const &x2) const
 \brief Gradient(with respect to x1) of the square distance (can be redefined to transparently implement constraints, symmetries and periodicities). More...

virtual colvarvalue dist2_rgrad (colvarvalue const &x1, colvarvalue const &x2) const
 \brief Gradient(with respect to x2) of the square distance (can be redefined to transparently implement constraints, symmetries and periodicities). More...

Detailed Description

\brief Colvar component: cosine of the angle of rotation with respect to a set of reference coordinates (colvarvalue::type_scalar type, range [-1:1]).

Definition at line 1274 of file colvarcomp.h.

Constructor & Destructor Documentation

colvar::orientation_proj::orientation_proj (  std::string const &    conf ) 
 

colvar::orientation_proj::orientation_proj (    ) 
 

virtual colvar::orientation_proj::~orientation_proj (    )  [inline, virtual]
 

Definition at line 1282 of file colvarcomp.h.

Member Function Documentation

void colvar::orientation_proj::apply_force (  colvarvalue const &    force )  [virtual]
 

\brief Apply the collective variable force, by communicating the atomic forces to the simulation program (Note: the ft member is not altered by this function) Note: multiple calls to this function within the same simulation step will add the forces altogether

Parameters:
cvforce  The collective variable force, usually coming from the biases and eventually manipulated by the parent colvar object.

Reimplemented from colvar::orientation.

Definition at line 255 of file colvarcomp_rotations.C.

References colvar::orientation::atoms, force, and colvarvalue::real_value.

void colvar::orientation_proj::calc_gradients (    )  [virtual]
 

\brief Calculate the atomic gradients, to be reused later in order to apply forces.

Reimplemented from colvar::orientation.

Definition at line 246 of file colvarcomp_rotations.C.

References colvar::orientation::atoms, and colvar::orientation::rot.

void colvar::orientation_proj::calc_value (    )  [virtual]
 

\brief Calculate the variable.

Reimplemented from colvar::orientation.

Definition at line 238 of file colvarcomp_rotations.C.

References colvar::orientation::atoms, colvar::orientation::atoms_cog, colvarvalue::real_value, colvar::orientation::ref_pos, colvar::orientation::rot, and colvar::cvc::x.

virtual cvm::real colvar::orientation_proj::dist2 (  colvarvalue const &    x1,
colvarvalue const &    x2
)  const [virtual]
 

\brief Square distance between x1 and x2 (can be redefined to transparently implement constraints, symmetries and periodicities) colvar::cvc::dist2() and the related functions are declared as "const" functions, but not "static", because additional parameters defining the metrics (e.g. the periodicity) may be specific to each colvar::cvc object. If symmetries or periodicities are present, the colvar::cvc::dist2() should be redefined to return the "closest distance" value and colvar::cvc::dist2_lgrad(), colvar::cvc::dist2_rgrad() to return its gradients. If constraints are present (and not already implemented by any of the colvarvalue types), the colvar::cvc::dist2_lgrad() and colvar::cvc::dist2_rgrad() functions should be redefined to provide a gradient which is compatible with the constraint, i.e. already deprived of its component normal to the constraint hypersurface. Finally, another useful application, if you are performing very many operations with these functions, could be to override the colvarvalue member functions and access directly its member data. For instance: to define dist2(x1,x2) as (x2.real_value-x1.real_value)*(x2.real_value-x1.real_value) in case of a scalar colvarvalue type.

Reimplemented from colvar::orientation.

virtual colvarvalue colvar::orientation_proj::dist2_lgrad (  colvarvalue const &    x1,
colvarvalue const &    x2
)  const [virtual]
 

\brief Gradient(with respect to x1) of the square distance (can be redefined to transparently implement constraints, symmetries and periodicities).

Reimplemented from colvar::orientation.

virtual colvarvalue colvar::orientation_proj::dist2_rgrad (  colvarvalue const &    x1,
colvarvalue const &    x2
)  const [virtual]
 

\brief Gradient(with respect to x2) of the square distance (can be redefined to transparently implement constraints, symmetries and periodicities).

Reimplemented from colvar::orientation.

int colvar::orientation_proj::init (  std::string const &    conf )  [virtual]
 

An init function should be defined for every class inheriting from cvc

Parameters:
conf  Contents of the configuration file pertaining to this cvc.

Reimplemented from colvar::orientation.

Definition at line 232 of file colvarcomp_rotations.C.

References conf.

The documentation for this class was generated from the following files:
Generated on Tue Apr 16 02:47:23 2024 for VMD (current) by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002