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

colvar::euler_phi Class Reference

#include <colvarcomp.h>

Inheritance diagram for colvar::euler_phi:

List of all members.

Public Methods

euler_phi (std::string const &conf)

euler_phi ()

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

~euler_phi ()

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...

virtual void

wrap (colvarvalue &x_unwrapped) const

Redefined to handle the 2*PI periodicity. More...

Constructor & Destructor Documentation

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

Definition at line 448 of file colvarcomp_rotations.C.
References conf, colvardeps::enable, colvardeps::f_cvc_explicit_gradient, colvar::cvc::init_as_periodic_angle, and colvar::cvc::set_function_type.

colvar::euler_phi::euler_phi ( )

Definition at line 458 of file colvarcomp_rotations.C.
References colvardeps::enable, colvardeps::f_cvc_explicit_gradient, colvar::cvc::init_as_periodic_angle, and colvar::cvc::set_function_type.

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

Definition at line 1362 of file colvarcomp.h.

Member Function Documentation

void colvar::euler_phi::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 511 of file colvarcomp_rotations.C.
References colvar::orientation::atoms, force, and colvarvalue::real_value.

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

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

Reimplemented from colvar::orientation.
Definition at line 491 of file colvarcomp_rotations.C.
References colvar::orientation::atoms, PI, and colvar::orientation::rot.

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

\brief Calculate the variable.

Reimplemented from colvar::orientation.
Definition at line 475 of file colvarcomp_rotations.C.
References colvarmodule::atan2, colvar::orientation::atoms, colvar::orientation::atoms_cog, PI, colvarvalue::real_value, colvar::orientation::ref_pos, colvar::orientation::rot, and colvar::cvc::x.

cvm::real colvar::euler_phi::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.
Definition at line 520 of file colvarcomp_rotations.C.
References colvarvalue::real_value.

colvarvalue colvar::euler_phi::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.
Definition at line 529 of file colvarcomp_rotations.C.
References colvarvalue::real_value.

colvarvalue colvar::euler_phi::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.
Definition at line 538 of file colvarcomp_rotations.C.
References colvarvalue::real_value.

int colvar::euler_phi::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 467 of file colvarcomp_rotations.C.
References conf.

void colvar::euler_phi::wrap ( colvarvalue & x_unwrapped ) const [virtual]

Redefined to handle the 2*PI periodicity.

Reimplemented from colvar::cvc.
Definition at line 547 of file colvarcomp_rotations.C.
References colvarvalue::real_value, and colvar::cvc::wrap_center.

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

Generated on Thu Sep 19 02:45:46 2024 for VMD (current) by