colvarproxy_volmaps.h

// -*- c++ -*-
 
#ifndef COLVARPROXY_VOLMAPS_H
#define COLVARPROXY_VOLMAPS_H
 
#include "colvarmodule.h"
 
 
class colvarproxy_volmaps {
 
public:
 
  colvarproxy_volmaps();
 
  virtual ~colvarproxy_volmaps();
 
  int reset();
 
  virtual int check_volmaps_available();
 
  int add_volmap_slot(int volmap_id);
 
  virtual int request_engine_volmap_by_id(int volmap_id);
 
  virtual int request_engine_volmap_by_name(std::string const &volmap_name);
 
  virtual int init_internal_volmap_by_id(int volmap_id);
 
  virtual int init_internal_volmap_by_name(std::string const &filename);
 
  virtual int load_internal_volmap_from_file(std::string const &filename);
 
  virtual int clear_volmap(int index);
 
  inline int get_volmap_id(int index) const
  {
    return volmaps_ids[index];
  }
 
  inline cvm::real get_engine_volmap_value(int index) const
  {
    return volmaps_values[index];
  }
 
  inline void apply_engine_volmap_force(int index, cvm::real const &new_force)
  {
    volmaps_new_colvar_forces[index] += new_force;
  }
 
 
  virtual int compute_volmap(int flags,
                             int volmap_index,
                             cvm::atom_group* ag,
                             cvm::real *value,
                             cvm::real *atom_field);
 
  enum {
    volmap_flag_null = 0,
    volmap_flag_gradients = 1,
    volmap_flag_use_atom_field = (1<<8)
  };
 
  void compute_rms_volmaps_applied_force();
 
  void compute_max_volmaps_applied_force();
 
protected:
 
  std::vector<int>          volmaps_ids;
 
  std::vector<size_t>       volmaps_refcount;
 
  std::vector<cvm::real>    volmaps_values;
 
  std::vector<cvm::real>    volmaps_new_colvar_forces;
 
  std::vector<std::string>  volmaps_filenames;
 
  cvm::real volmaps_rms_applied_force_;
 
  cvm::real volmaps_max_applied_force_;
};
 
 
#endif