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

colvar::distance_vec Class Reference

#include <colvarcomp.h>

Inheritance diagram for colvar::distance_vec:

List of all members.

Public Methods

distance_vec (std::string const &conf)

distance_vec ()

virtual ~distance_vec ()

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

Redefined to handle the box periodicity. More...

virtual colvarvalue dist2_lgrad (colvarvalue const &x1, colvarvalue const &x2) const

Redefined to handle the box periodicity. More...

virtual colvarvalue dist2_rgrad (colvarvalue const &x1, colvarvalue const &x2) const

Redefined to handle the box periodicity. More...

Constructor & Destructor Documentation

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

colvar::distance_vec::distance_vec ( )

Definition at line 111 of file colvarcomp_distances.C.

References colvardeps::disable, colvardeps::enable, colvardeps::f_cvc_com_based, colvardeps::f_cvc_explicit_gradient, colvar::cvc::set_function_type, colvarvalue::type, colvarvalue::type_3vector, and colvar::cvc::x.

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

Definition at line 388 of file colvarcomp.h.

Member Function Documentation

void colvar::distance_vec::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::distance.

Definition at line 139 of file colvarcomp_distances.C.

References force, colvar::distance::group1, colvar::distance::group2, and colvarvalue::rvector_value.

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

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

Reimplemented from colvar::distance.

Definition at line 132 of file colvarcomp_distances.C.

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

\brief Calculate the variable.

Reimplemented from colvar::distance.

Definition at line 121 of file colvarcomp_distances.C.

References colvardeps::f_cvc_pbc_minimum_image, colvar::distance::group1, colvar::distance::group2, colvardeps::is_enabled, colvarmodule::position_distance, colvarvalue::rvector_value, and colvar::cvc::x.

cvm::real colvar::distance_vec::dist2 ( colvarvalue const & x1,

colvarvalue const & x2

) const [virtual]

Redefined to handle the box periodicity.

Reimplemented from colvar::distance.

Definition at line 149 of file colvarcomp_distances.C.

References colvarmodule::position_distance, and colvarvalue::rvector_value.

colvarvalue colvar::distance_vec::dist2_lgrad ( colvarvalue const & x1,

colvarvalue const & x2

) const [virtual]

Redefined to handle the box periodicity.

Reimplemented from colvar::distance.

Definition at line 156 of file colvarcomp_distances.C.

References colvarmodule::position_distance, and colvarvalue::rvector_value.

colvarvalue colvar::distance_vec::dist2_rgrad ( colvarvalue const & x1,

colvarvalue const & x2

) const [virtual]

Redefined to handle the box periodicity.

Reimplemented from colvar::distance.

Definition at line 163 of file colvarcomp_distances.C.

References colvarmodule::position_distance, and colvarvalue::rvector_value.

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

Generated on Mon Nov 17 02:48:13 2025 for VMD (current) by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002