faunus
Public Member Functions | List of all members
Faunus::Energy::Constrain Class Reference

Constrain system using reaction coordinates. More...

#include <energy.h>

Inheritance diagram for Faunus::Energy::Constrain:
Inheritance graph
[legend]
Collaboration diagram for Faunus::Energy::Constrain:
Collaboration graph
[legend]

Public Member Functions

 Constrain (const json &j, Space &space)
 
double energy (const Change &change) override
 energy due to change
 
void to_json (json &j) const override
 json output
 
- Public Member Functions inherited from Faunus::Energy::EnergyTerm
virtual void sync (EnergyTerm *other_energy, const Change &change)
 Sync (copy from) another energy instance. More...
 
virtual void init ()
 reset and initialize
 
virtual void updateState (const Change &change)
 Update internal state to reflect change in e.g. Space. More...
 
virtual void force (PointVector &forces)
 update forces on all particles
 

Additional Inherited Members

- Public Types inherited from Faunus::Energy::EnergyTerm
enum  MonteCarloState { ACCEPTED, TRIAL, NONE }
 
- Public Attributes inherited from Faunus::Energy::EnergyTerm
MonteCarloState state = MonteCarloState::NONE
 
std::string name
 Meaningful name.
 
std::string citation_information
 Possible reference; may be left empty.
 
TimeRelativeOfTotal< std::chrono::microseconds > timer
 Timer for measuring speed.
 

Detailed Description

Constrain system using reaction coordinates.

If outside specified range, infinity energy is returned, causing rejection.


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