Collective Variables Module - Developer Documentation
Loading...
Searching...
No Matches
colvarparams Class Reference
Inheritance diagram for colvarparams:

Public Member Functions

int param_exists (std::string const &param_name)
 Whether the parameter param_name exists.
virtual std::vector< std::string > get_param_names ()
 Get a copy of the names of registered parameters.
virtual std::vector< std::string > get_param_grad_names ()
 Get a copy of the names of registered parameter gradients.
virtual void const * get_param_ptr (std::string const &param_name)
 Pointer to the parameter param_name.
virtual void const * get_param_grad_ptr (std::string const &param_name)
 Pointer to the gradient of parameter param_name.
virtual cvm::real get_param (std::string const &param_name)
 Value of the parameter param_name (must be a scalar).
virtual int set_param (std::string const &param_name, void const *new_value)
 Set the named parameter to the given value.

Protected Member Functions

 colvarparams ()
 Default constructor.
virtual ~colvarparams ()
 Default destructor.
void register_param (std::string const &param_name, void *param_ptr)
 Register the given parameter.
void register_param_grad (std::string const &param_name, colvarvalue *param_grad_ptr)
 Register the gradient of the given parameter.

Protected Attributes

std::map< std::string, void const * > param_map
 Pointers to relevant parameters that may be accessed by other objects.
std::map< std::string, colvarvalue const * > param_grad_map
 Derivatives of the object with respect to internal parameters.

Member Function Documentation

◆ set_param()

int colvarparams::set_param ( std::string const & param_name,
void const * new_value )
virtual

Set the named parameter to the given value.

Reimplemented in colvar::cvc.


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