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

Protected Attributes

cvm::atom_group *

atoms

Dipole atom group. More...

cvm::atom_pos

dipoleV

Detailed Description

\brief Colvar component: dipole magnitude of a molecule.

Definition at line 607 of file colvarcomp.h.

Constructor & Destructor Documentation

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

Initialize by parsing the configuration.

Definition at line 744 of file colvarcomp_distances.C.
References atoms, conf, colvar::cvc::init_total_force_params, colvar::cvc::parse_group, colvar::cvc::set_function_type, colvarvalue::type, colvarvalue::type_scalar, and colvar::cvc::x.

colvar::dipole_magnitude::dipole_magnitude ( cvm::atom const & a1 )

Definition at line 754 of file colvarcomp_distances.C.
References colvarmodule::atom_group, atoms, colvar::cvc::register_atom_group, colvar::cvc::set_function_type, colvarvalue::type, colvarvalue::type_scalar, and colvar::cvc::x.

colvar::dipole_magnitude::dipole_magnitude ( )

Definition at line 763 of file colvarcomp_distances.C.
References colvar::cvc::set_function_type, colvarvalue::type, colvarvalue::type_scalar, and colvar::cvc::x.

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

Definition at line 619 of file colvarcomp.h.

Member Function Documentation

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

Implements colvar::cvc.
Definition at line 790 of file colvarcomp_distances.C.
References atoms, force, and colvarvalue::real_value.

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

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

Reimplemented from colvar::cvc.
Definition at line 779 of file colvarcomp_distances.C.
References atoms, and dipoleV.

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

\brief Calculate the variable.

Implements colvar::cvc.
Definition at line 770 of file colvarcomp_distances.C.
References atoms, dipoleV, colvarvalue::real_value, and colvar::cvc::x.

virtual cvm::real colvar::dipole_magnitude::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::cvc.

virtual colvarvalue colvar::dipole_magnitude::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::cvc.

virtual colvarvalue colvar::dipole_magnitude::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::cvc.

Member Data Documentation

cvm::atom_group* colvar::dipole_magnitude::atoms [protected]

Dipole atom group.

Definition at line 612 of file colvarcomp.h.
Referenced by apply_force, calc_gradients, calc_value, and dipole_magnitude.

cvm::atom_pos colvar::dipole_magnitude::dipoleV [protected]

Definition at line 613 of file colvarcomp.h.
Referenced by calc_gradients, and calc_value.

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

Generated on Fri Nov 8 02:46:37 2024 for VMD (current) by