Collective Variables Module - Developer Documentation
Loading...
Searching...
No Matches
colvarproxy.h
Go to the documentation of this file.
1// -*- c++ -*-
2
3// This file is part of the Collective Variables module (Colvars).
4// The original version of Colvars and its updates are located at:
5// https://github.com/Colvars/colvars
6// Please update all Colvars source files before making any changes.
7// If you wish to distribute your changes, please submit them to the
8// Colvars repository at GitHub.
9
10#ifndef COLVARPROXY_H
11#define COLVARPROXY_H
12
13#include <functional>
14
15#include "colvarmodule.h"
16#include "colvartypes.h"
17#include "colvarproxy_io.h"
18#include "colvarproxy_replicas.h"
19#include "colvarproxy_system.h"
20#include "colvarproxy_tcl.h"
21#include "colvarproxy_volmaps.h"
22
36
37
38// forward declarations
39class colvarscript;
40
41
44
45public:
46
49
51 virtual ~colvarproxy_atoms();
52
55 virtual int init_atom(int atom_number);
56
59 virtual int check_atom_id(int atom_number);
60
63
67 virtual int init_atom(cvm::residue_id const &residue,
68 std::string const &atom_name,
69 std::string const &segment_id);
70
72 virtual int check_atom_id(cvm::residue_id const &residue,
73 std::string const &atom_name,
74 std::string const &segment_id);
75
78 virtual void clear_atom(int index);
79
81 int reset();
82
85 inline int get_atom_id(int index) const
86 {
87 return atoms_ids[index];
88 }
89
92 inline cvm::real get_atom_mass(int index) const
93 {
94 return atoms_masses[index];
95 }
96
99 inline void increase_refcount(int index)
100 {
101 atoms_refcount[index] += 1;
102 }
103
106 inline cvm::real get_atom_charge(int index) const
107 {
108 return atoms_charges[index];
109 }
110
113 inline cvm::rvector get_atom_position(int index) const
114 {
115 return atoms_positions[index];
116 }
117
120 inline cvm::rvector get_atom_total_force(int index) const
121 {
122 return atoms_total_forces[index];
123 }
124
128 inline void apply_atom_force(int index, cvm::rvector const &new_force)
129 {
130 atoms_new_colvar_forces[index] += new_force;
131 }
132
134 inline cvm::rvector get_atom_velocity(int /* index */)
135 {
136 cvm::error("Error: reading the current velocity of an atom "
137 "is not yet implemented.\n",
138 COLVARS_NOT_IMPLEMENTED);
139 return cvm::rvector(0.0);
140 }
141
142 inline std::vector<int> const *get_atom_ids() const
143 {
144 return &atoms_ids;
145 }
146
148 size_t get_num_active_atoms() const;
149
150 inline std::vector<cvm::real> const *get_atom_masses() const
151 {
152 return &atoms_masses;
153 }
154
155 inline std::vector<cvm::real> *modify_atom_masses()
156 {
157 // assume that we are requesting masses to change them
158 updated_masses_ = true;
159 return &atoms_masses;
160 }
161
162 inline std::vector<cvm::real> const *get_atom_charges()
163 {
164 return &atoms_charges;
165 }
166
167 inline std::vector<cvm::real> *modify_atom_charges()
168 {
169 // assume that we are requesting charges to change them
170 updated_charges_ = true;
171 return &atoms_charges;
172 }
173
174 inline std::vector<cvm::rvector> const *get_atom_positions() const
175 {
176 return &atoms_positions;
177 }
178
179 inline std::vector<cvm::rvector> *modify_atom_positions()
180 {
181 return &atoms_positions;
182 }
183
184 inline std::vector<cvm::rvector> const *get_atom_total_forces() const
185 {
186 return &atoms_total_forces;
187 }
188
189 inline std::vector<cvm::rvector> *modify_atom_total_forces()
190 {
191 return &atoms_total_forces;
192 }
193
194 inline std::vector<cvm::rvector> const *get_atom_applied_forces() const
195 {
197 }
198
199 inline std::vector<cvm::rvector> *modify_atom_applied_forces()
200 {
202 }
203
206
209
212 {
214 }
215
218 {
220 }
221
223 inline int max_atoms_applied_force_id() const
224 {
226 }
227
229 inline bool modified_atom_list() const
230 {
231 return modified_atom_list_;
232 }
233
236 {
237 modified_atom_list_ = false;
238 }
239
241 inline bool updated_masses() const
242 {
243 return updated_masses_;
244 }
245
247 inline bool updated_charges() const
248 {
249 return updated_charges_;
250 }
251
252protected:
253
256 std::vector<int> atoms_ids;
258 std::vector<size_t> atoms_refcount;
260 std::vector<cvm::real> atoms_masses;
262 std::vector<cvm::real> atoms_charges;
264 std::vector<cvm::rvector> atoms_positions;
266 std::vector<cvm::rvector> atoms_total_forces;
268 std::vector<cvm::rvector> atoms_new_colvar_forces;
269
272
275
278
281
283 bool updated_masses_, updated_charges_;
284
287 int add_atom_slot(int atom_id);
288
289};
290
291
295
296public:
297
300
302 virtual ~colvarproxy_atom_groups();
303
305 int reset();
306
308 virtual int scalable_group_coms();
309
311 virtual int init_atom_group(std::vector<int> const &atoms_ids);
312
314 virtual void clear_atom_group(int index);
315
317 inline int get_atom_group_id(int index) const
318 {
319 return atom_groups_ids[index];
320 }
321
323 inline cvm::real get_atom_group_mass(int index) const
324 {
325 return atom_groups_masses[index];
326 }
327
329 inline cvm::real get_atom_group_charge(int index) const
330 {
331 return atom_groups_charges[index];
332 }
333
335 inline cvm::rvector get_atom_group_com(int index) const
336 {
337 return atom_groups_coms[index];
338 }
339
342 {
343 return atom_groups_total_forces[index];
344 }
345
347 inline void apply_atom_group_force(int index, cvm::rvector const &new_force)
348 {
349 atom_groups_new_colvar_forces[index] += new_force;
350 }
351
353 inline cvm::rvector get_atom_group_velocity(int /* index */)
354 {
355 cvm::error("Error: reading the current velocity of an atom group is not yet implemented.\n",
356 COLVARS_NOT_IMPLEMENTED);
357 return cvm::rvector(0.0);
358 }
359
360 inline std::vector<int> const *get_atom_group_ids() const
361 {
362 return &atom_groups_ids;
363 }
364
366 size_t get_num_active_atom_groups() const;
367
368 inline std::vector<cvm::real> *modify_atom_group_masses()
369 {
370 // TODO updated_masses
371 return &atom_groups_masses;
372 }
373
374 inline std::vector<cvm::real> *modify_atom_group_charges()
375 {
376 // TODO updated masses
377 return &atom_groups_charges;
378 }
379
380 inline std::vector<cvm::rvector> *modify_atom_group_positions()
381 {
382 return &atom_groups_coms;
383 }
384
385 inline std::vector<cvm::rvector> *modify_atom_group_total_forces()
386 {
388 }
389
390 inline std::vector<cvm::rvector> *modify_atom_group_applied_forces()
391 {
393 }
394
397
400
403 {
405 }
406
409 {
411 }
412
413protected:
414
417 std::vector<int> atom_groups_ids;
419 std::vector<size_t> atom_groups_refcount;
421 std::vector<cvm::real> atom_groups_masses;
423 std::vector<cvm::real> atom_groups_charges;
425 std::vector<cvm::rvector> atom_groups_coms;
427 std::vector<cvm::rvector> atom_groups_total_forces;
429 std::vector<cvm::rvector> atom_groups_new_colvar_forces;
430
433
436
438 int add_atom_group_slot(int atom_group_id);
439};
440
441
442#if defined(_OPENMP)
443#include <omp.h>
444#else
445struct omp_lock_t;
446#endif
447
450
451public:
452
453 enum class smp_mode_t {cvcs, inner_loop, none};
454
457
459 virtual ~colvarproxy_smp();
460
462 virtual smp_mode_t get_smp_mode() const;
463
465 virtual int set_smp_mode(smp_mode_t mode);
466
468 virtual int smp_loop(int n_items, std::function<int (int)> const &worker);
469
471 virtual int smp_biases_loop();
472
474 virtual int smp_biases_script_loop();
475
477 virtual int smp_thread_id();
478
480 virtual int smp_num_threads();
481
483 virtual int smp_lock();
484
486 virtual int smp_trylock();
487
489 virtual int smp_unlock();
490
491protected:
492
494 omp_lock_t *omp_lock_state;
495
498 smp_mode_t smp_mode;
499};
500
501
504
505public:
506
509
511 virtual ~colvarproxy_script();
512
516
519
521 virtual int run_force_callback();
522
523 virtual int run_colvar_callback(
524 std::string const &name,
525 std::vector<const colvarvalue *> const &cvcs,
526 colvarvalue &value);
527
528 virtual int run_colvar_gradient_callback(
529 std::string const &name,
530 std::vector<const colvarvalue *> const &cvcs,
531 std::vector<cvm::matrix2d<cvm::real> > &gradient);
532};
533
534
535
540 : public colvarproxy_system,
541 public colvarproxy_atoms,
543 public colvarproxy_volmaps,
544 public colvarproxy_smp,
546 public colvarproxy_script,
547 public colvarproxy_tcl,
548 public colvarproxy_io
549{
550
551public:
552
555
557 colvarproxy();
558
560 ~colvarproxy() override;
561
562 inline std::string const &engine_name() const
563 {
564 return engine_name_;
565 }
566
567 bool io_available() override;
568
570 virtual int request_deletion();
571
573 inline bool delete_requested() const
574 {
575 return b_delete_requested;
576 }
577
579 virtual int reset();
580
582 virtual int parse_module_config();
583
590 virtual int load_atoms_pdb(char const *filename, cvm::atom_group &atoms,
591 std::string const &pdb_field, double pdb_field_value);
592
600 virtual int load_coords_pdb(char const *filename, std::vector<cvm::atom_pos> &pos,
601 std::vector<int> const &sorted_ids, std::string const &pdb_field,
602 double pdb_field_value);
603
605 virtual int setup();
606
608 inline bool engine_ready() const
609 {
610 return engine_ready_;
611 }
612
614 void add_config(std::string const &cmd, std::string const &conf);
615
619 virtual int update_input();
620
622 virtual int update_output();
623
625 int end_of_step();
626
628 virtual void log(std::string const &message);
629
631 virtual void error(std::string const &message);
632
634 void add_error_msg(std::string const &message);
635
637 std::string const & get_error_msgs();
638
640 void clear_error_msgs();
641
643 inline bool simulation_running() const
644 {
646 }
647
651 inline bool simulation_continuing() const
652 {
654 }
655
657 int post_run();
658
661
664
666 int get_version_from_string(char const *version_string);
667
669 int version_number() const
670 {
671 return version_int;
672 }
673
674protected:
675
678
680 std::string error_output;
681
684
689
692
695
698
699protected:
700
702 std::string engine_name_ = "standalone";
703
706
707};
708
709
710#endif
Group of atom objects, mostly used by a colvar::cvc object to gather all atomic data.
Definition: colvaratoms.h:159
Arbitrary size array (two dimensions) suitable for linear algebra operations (i.e....
Definition: colvartypes.h:372
vector of real numbers with three components
Definition: colvartypes.h:723
Collective variables module (main class)
Definition: colvarmodule.h:64
double real
Defining an abstract real number allows to switch precision.
Definition: colvarmodule.h:100
int residue_id
Residue identifier.
Definition: colvarmodule.h:225
static int error(std::string const &message, int code=-1)
Print a message to the main log and set global error code.
Definition: colvarmodule.cpp:2070
Container of atom group data (allow collection of aggregated atomic data)
Definition: colvarproxy.h:294
cvm::rvector get_atom_group_total_force(int index) const
Read the current total force of the given atom group.
Definition: colvarproxy.h:341
int get_atom_group_id(int index) const
Get the numeric ID of the given atom group (for the MD program)
Definition: colvarproxy.h:317
virtual void clear_atom_group(int index)
Used by the atom_group class destructor.
Definition: colvarproxy.cpp:206
colvarproxy_atom_groups()
Constructor.
Definition: colvarproxy.cpp:153
cvm::real get_atom_group_charge(int index) const
Get the charge of the given atom group.
Definition: colvarproxy.h:329
std::vector< cvm::real > atom_groups_charges
Total charges of the atom groups (allow redefinition during a run, as done e.g. in LAMMPS)
Definition: colvarproxy.h:423
int add_atom_group_slot(int atom_group_id)
Used by all init_atom_group() functions: create a slot for an atom group not requested yet.
Definition: colvarproxy.cpp:178
virtual int scalable_group_coms()
Whether this proxy implementation has capability for scalable groups.
Definition: colvarproxy.cpp:191
std::vector< cvm::rvector > atom_groups_new_colvar_forces
Forces applied from colvars, to be communicated to the MD integrator.
Definition: colvarproxy.h:429
std::vector< size_t > atom_groups_refcount
Keep track of how many times each group is used by a separate cvc.
Definition: colvarproxy.h:419
void compute_max_atom_groups_applied_force()
Compute the maximum norm among all applied forces.
Definition: colvarproxy.cpp:236
cvm::rvector get_atom_group_velocity(int)
Read the current velocity of the given atom group.
Definition: colvarproxy.h:353
cvm::real atom_groups_max_applied_force_
Maximum norm among all applied group forces.
Definition: colvarproxy.h:435
cvm::real rms_atom_groups_applied_force() const
Get the root-mean-square of the applied forces.
Definition: colvarproxy.h:402
cvm::real get_atom_group_mass(int index) const
Get the mass of the given atom group.
Definition: colvarproxy.h:323
int reset()
Clear atom group data.
Definition: colvarproxy.cpp:165
void compute_rms_atom_groups_applied_force()
Compute the root-mean-square of the applied forces.
Definition: colvarproxy.cpp:229
cvm::real max_atom_groups_applied_force() const
Get the maximum norm among all applied forces.
Definition: colvarproxy.h:408
std::vector< cvm::real > atom_groups_masses
Total masses of the atom groups.
Definition: colvarproxy.h:421
virtual ~colvarproxy_atom_groups()
Destructor.
Definition: colvarproxy.cpp:159
size_t get_num_active_atom_groups() const
Return number of atom groups with positive reference count.
Definition: colvarproxy.cpp:219
cvm::rvector get_atom_group_com(int index) const
Read the current position of the center of mass given atom group.
Definition: colvarproxy.h:335
void apply_atom_group_force(int index, cvm::rvector const &new_force)
Request that this force is applied to the given atom group.
Definition: colvarproxy.h:347
cvm::real atom_groups_rms_applied_force_
Root-mean-square of the applied group forces.
Definition: colvarproxy.h:432
virtual int init_atom_group(std::vector< int > const &atoms_ids)
Prepare this group for collective variables calculation, selecting atoms by internal ids (0-based)
Definition: colvarproxy.cpp:197
std::vector< cvm::rvector > atom_groups_total_forces
Most recently updated total forces on the com of each group.
Definition: colvarproxy.h:427
std::vector< int > atom_groups_ids
Array of 0-based integers used to uniquely associate atom groups within the host program.
Definition: colvarproxy.h:417
std::vector< cvm::rvector > atom_groups_coms
Current centers of mass of the atom groups.
Definition: colvarproxy.h:425
Container of atomic data for processing by Colvars.
Definition: colvarproxy.h:43
cvm::real get_atom_mass(int index) const
Definition: colvarproxy.h:92
int reset()
Clear atomic data.
Definition: colvarproxy.cpp:38
int add_atom_slot(int atom_id)
Definition: colvarproxy.cpp:51
bool updated_masses() const
Record whether masses have been updated.
Definition: colvarproxy.h:241
virtual int init_atom(int atom_number)
Definition: colvarproxy.cpp:65
size_t get_num_active_atoms() const
Return number of atoms with positive reference count.
Definition: colvarproxy.cpp:114
cvm::real atoms_rms_applied_force_
Root-mean-square of the applied forces.
Definition: colvarproxy.h:271
colvarproxy_atoms()
Constructor.
Definition: colvarproxy.cpp:23
void apply_atom_force(int index, cvm::rvector const &new_force)
Definition: colvarproxy.h:128
cvm::rvector get_atom_velocity(int)
Read the current velocity of the given atom.
Definition: colvarproxy.h:134
cvm::real get_atom_charge(int index) const
Definition: colvarproxy.h:106
virtual ~colvarproxy_atoms()
Destructor.
Definition: colvarproxy.cpp:32
void increase_refcount(int index)
Definition: colvarproxy.h:99
cvm::real rms_atoms_applied_force() const
Get the root-mean-square of the applied forces.
Definition: colvarproxy.h:211
virtual int check_atom_name_selections_available()
Check whether it is possible to select atoms by residue number name.
Definition: colvarproxy.cpp:77
bool modified_atom_list_
Whether the atom list has been modified internally.
Definition: colvarproxy.h:280
cvm::rvector get_atom_position(int index) const
Definition: colvarproxy.h:113
bool modified_atom_list() const
Whether the atom list has been modified internally.
Definition: colvarproxy.h:229
void compute_max_atoms_applied_force()
Compute the maximum norm among all applied forces.
Definition: colvarproxy.cpp:131
virtual void clear_atom(int index)
Used by the atom class destructor: rather than deleting the array slot (costly) set the corresponding...
Definition: colvarproxy.cpp:102
int atoms_max_applied_force_id_
ID of the atom with the maximum norm among all applied forces.
Definition: colvarproxy.h:277
void reset_modified_atom_list()
Reset the modified atom list flag.
Definition: colvarproxy.h:235
std::vector< cvm::rvector > atoms_total_forces
Most recent total forces on each atom.
Definition: colvarproxy.h:266
cvm::rvector get_atom_total_force(int index) const
Definition: colvarproxy.h:120
int max_atoms_applied_force_id() const
Get the atom ID with the largest applied force.
Definition: colvarproxy.h:223
bool updated_masses_
Whether the masses and charges have been updated from the host code.
Definition: colvarproxy.h:283
std::vector< cvm::real > atoms_charges
Charges of the atoms (allow redefinition during a run, as done e.g. in LAMMPS)
Definition: colvarproxy.h:262
cvm::real atoms_max_applied_force_
Maximum norm among all applied forces.
Definition: colvarproxy.h:274
std::vector< size_t > atoms_refcount
Keep track of how many times each atom is used by a separate colvar object.
Definition: colvarproxy.h:258
bool updated_charges() const
Record whether masses have been updated.
Definition: colvarproxy.h:247
cvm::real max_atoms_applied_force() const
Get the maximum norm among all applied forces.
Definition: colvarproxy.h:217
void compute_rms_atoms_applied_force()
Compute the root-mean-square of the applied forces.
Definition: colvarproxy.cpp:124
std::vector< cvm::rvector > atoms_positions
Current three-dimensional positions of the atoms.
Definition: colvarproxy.h:264
virtual int check_atom_id(int atom_number)
Definition: colvarproxy.cpp:71
std::vector< cvm::real > atoms_masses
Masses of the atoms (allow redefinition during a run, as done e.g. in LAMMPS)
Definition: colvarproxy.h:260
int get_atom_id(int index) const
Definition: colvarproxy.h:85
std::vector< cvm::rvector > atoms_new_colvar_forces
Forces applied from colvars, to be communicated to the MD integrator.
Definition: colvarproxy.h:268
std::vector< int > atoms_ids
Array of 0-based integers used to uniquely associate atoms within the host program.
Definition: colvarproxy.h:256
Methods for data input/output.
Definition: colvarproxy_io.h:20
Methods for multiple-replica communication.
Definition: colvarproxy_replicas.h:23
Methods for scripting language interface (Tcl or Python)
Definition: colvarproxy.h:503
bool have_scripts
Do we have a scripting interface?
Definition: colvarproxy.h:518
virtual ~colvarproxy_script()
Destructor.
Definition: colvarproxy.cpp:418
colvarproxy_script()
Constructor.
Definition: colvarproxy.cpp:411
virtual int run_force_callback()
Run a user-defined colvar forces script.
Definition: colvarproxy.cpp:427
colvarscript * script
Definition: colvarproxy.h:515
Methods for SMP parallelization.
Definition: colvarproxy.h:449
virtual smp_mode_t get_smp_mode() const
Get the current SMP mode.
Definition: colvarproxy.cpp:268
smp_mode_t smp_mode
Definition: colvarproxy.h:498
virtual int smp_biases_script_loop()
Distribute calculation of biases across threads 2nd through last, with all scripted biased on 1st thr...
Definition: colvarproxy.cpp:333
virtual int smp_thread_id()
Index of this thread.
Definition: colvarproxy.cpp:362
virtual int smp_trylock()
Attempt to lock the proxy's shared data.
Definition: colvarproxy.cpp:391
virtual int smp_lock()
Lock the proxy's shared data for access by a thread, if threads are implemented; if not implemented,...
Definition: colvarproxy.cpp:382
virtual int set_smp_mode(smp_mode_t mode)
Set the current SMP mode.
Definition: colvarproxy.cpp:276
virtual int smp_num_threads()
Number of threads sharing this address space.
Definition: colvarproxy.cpp:372
omp_lock_t * omp_lock_state
Lock state for OpenMP.
Definition: colvarproxy.h:494
virtual int smp_unlock()
Release the lock.
Definition: colvarproxy.cpp:401
virtual int smp_biases_loop()
Distribute calculation of biases across threads.
Definition: colvarproxy.cpp:310
virtual int smp_loop(int n_items, std::function< int(int)> const &worker)
Distribute computation over threads using OpenMP, unless overridden in the backend (e....
Definition: colvarproxy.cpp:291
virtual ~colvarproxy_smp()
Destructor.
Definition: colvarproxy.cpp:257
colvarproxy_smp()
Constructor.
Definition: colvarproxy.cpp:244
Methods for accessing the simulation system (PBCs, integrator, etc)
Definition: colvarproxy_system.h:15
Methods for using Tcl within Colvars.
Definition: colvarproxy_tcl.h:28
Container of grid-based objects.
Definition: colvarproxy_volmaps.h:8
Definition: colvarproxy.h:549
virtual int update_input()
Definition: colvarproxy.cpp:564
colvarproxy()
Constructor.
Definition: colvarproxy.cpp:450
std::string error_output
Collected error messages.
Definition: colvarproxy.h:680
virtual int update_output()
Update data based on the results of a Colvars call (e.g. send forces)
Definition: colvarproxy.cpp:570
void add_config(std::string const &cmd, std::string const &conf)
Enqueue new configuration text, to be parsed as soon as possible.
Definition: colvarproxy.cpp:504
virtual int request_deletion()
Request deallocation of the module (currently only implemented by VMD)
Definition: colvarproxy.cpp:496
colvarmodule * colvars
Pointer to the main object.
Definition: colvarproxy.h:554
bool simulation_continuing() const
Definition: colvarproxy.h:651
void clear_error_msgs()
As the name says.
Definition: colvarproxy.cpp:739
void add_error_msg(std::string const &message)
Record error message (used by VMD to collect them after a script call)
Definition: colvarproxy.cpp:729
int version_int
Integer representing the version string (allows comparisons)
Definition: colvarproxy.h:694
std::string const & get_error_msgs()
Retrieve accumulated error messages.
Definition: colvarproxy.cpp:745
int end_of_step()
Carry out operations needed before next simulation step is run.
Definition: colvarproxy.cpp:576
virtual void log(std::string const &message)
Print a message to the main log.
Definition: colvarproxy.cpp:716
bool b_delete_requested
Whether the entire module should be deallocated by the host engine.
Definition: colvarproxy.h:691
std::string engine_name_
Name of the simulation engine that the derived proxy object supports.
Definition: colvarproxy.h:702
void print_input_atomic_data()
Print a full list of all input atomic arrays for debug purposes.
Definition: colvarproxy.cpp:609
virtual int parse_module_config()
(Re)initialize the module
Definition: colvarproxy.cpp:516
bool engine_ready() const
Whether the engine allows to fully initialize Colvars immediately.
Definition: colvarproxy.h:608
virtual int load_coords_pdb(char const *filename, std::vector< cvm::atom_pos > &pos, std::vector< int > const &sorted_ids, std::string const &pdb_field, double pdb_field_value)
Load a set of coordinates from a PDB file.
Definition: colvarproxy.cpp:551
int get_version_from_string(char const *version_string)
Convert a version string "YYYY-MM-DD" into an integer.
Definition: colvarproxy.cpp:751
bool simulation_running() const
Whether a simulation is running (warn against irrecovarable errors)
Definition: colvarproxy.h:643
virtual int reset()
Reset proxy state, e.g. requested atoms.
Definition: colvarproxy.cpp:482
void * config_queue_
Queue of config strings or files to be fed to the module.
Definition: colvarproxy.h:705
int post_run()
Called at the end of a simulation segment (i.e. "run" command)
Definition: colvarproxy.cpp:597
bool b_simulation_continuing
Definition: colvarproxy.h:688
bool engine_ready_
Whether the engine allows to fully initialize Colvars immediately.
Definition: colvarproxy.h:677
bool delete_requested() const
Whether deallocation was requested.
Definition: colvarproxy.h:573
size_t features_hash
Track which features have been acknowledged during the last run.
Definition: colvarproxy.h:697
void print_output_atomic_data()
Print a full list of all applied forces for debug purposes.
Definition: colvarproxy.cpp:691
int version_number() const
Get the version number (higher = more recent)
Definition: colvarproxy.h:669
bool io_available() override
Ensure that we're on the main thread (derived class will do actual check)
Definition: colvarproxy.cpp:475
virtual int setup()
(Re)initialize required member data (called after the module)
Definition: colvarproxy.cpp:510
virtual int load_atoms_pdb(char const *filename, cvm::atom_group &atoms, std::string const &pdb_field, double pdb_field_value)
Read a selection of atom IDs from a PDB coordinate file.
Definition: colvarproxy.cpp:539
virtual void error(std::string const &message)
Print a message to the main log and/or let the host code know about it.
Definition: colvarproxy.cpp:722
bool b_simulation_running
Whether a simulation is running (warn against irrecovarable errors)
Definition: colvarproxy.h:683
~colvarproxy() override
Destructor.
Definition: colvarproxy.cpp:464
Definition: colvarscript.h:29
Value of a collective variable: this is a metatype which can be set at runtime. By default it is set ...
Definition: colvarvalue.h:43
Collective variables main module.