mcpele  1.0.0
The Monte Carlo Python Energy Landscape Explorer
 All Classes Namespaces Functions Variables Typedefs
Public Member Functions | Protected Attributes
mcpele::AdaptiveTakeStep Class Reference

#include <adaptive_takestep.h>

Inheritance diagram for mcpele::AdaptiveTakeStep:
mcpele::TakeStep

List of all members.

Public Member Functions

virtual ~AdaptiveTakeStep ()
 AdaptiveTakeStep (std::shared_ptr< TakeStep > ts, const size_t interval=100, const double factor=0.9, const double min_acceptance_ratio=0.2, const double max_acceptance_ratio=0.5)
void displace (pele::Array< double > &coords, MC *mc)
void report (pele::Array< double > &old_coords, const double old_energy, pele::Array< double > &new_coords, const double new_energy, const bool success, MC *mc)
double get_min_acceptance_ratio () const
double get_max_acceptance_ratio () const

Protected Attributes

std::shared_ptr< TakeStepm_ts
size_t m_interval
size_t m_total_steps
size_t m_accepted_steps
const double m_factor
const double m_min_acceptance_ratio
const double m_max_acceptance_ratio

Detailed Description

Definition at line 8 of file adaptive_takestep.h.


Constructor & Destructor Documentation

virtual mcpele::AdaptiveTakeStep::~AdaptiveTakeStep ( ) [inline, virtual]

Definition at line 18 of file adaptive_takestep.h.

mcpele::AdaptiveTakeStep::AdaptiveTakeStep ( std::shared_ptr< TakeStep ts,
const size_t  interval = 100,
const double  factor = 0.9,
const double  min_acceptance_ratio = 0.2,
const double  max_acceptance_ratio = 0.5 
)

Definition at line 5 of file adaptive_takestep.cpp.


Member Function Documentation

void mcpele::AdaptiveTakeStep::displace ( pele::Array< double > &  coords,
MC mc 
) [inline, virtual]

Implements mcpele::TakeStep.

Definition at line 22 of file adaptive_takestep.h.

Definition at line 27 of file adaptive_takestep.h.

Definition at line 26 of file adaptive_takestep.h.

void mcpele::AdaptiveTakeStep::report ( pele::Array< double > &  old_coords,
const double  old_energy,
pele::Array< double > &  new_coords,
const double  new_energy,
const bool  success,
MC mc 
) [virtual]

Reimplemented from mcpele::TakeStep.

Definition at line 21 of file adaptive_takestep.cpp.


Member Data Documentation

Definition at line 13 of file adaptive_takestep.h.

const double mcpele::AdaptiveTakeStep::m_factor [protected]

Definition at line 14 of file adaptive_takestep.h.

Definition at line 11 of file adaptive_takestep.h.

Definition at line 16 of file adaptive_takestep.h.

Definition at line 15 of file adaptive_takestep.h.

Definition at line 12 of file adaptive_takestep.h.

std::shared_ptr<TakeStep> mcpele::AdaptiveTakeStep::m_ts [protected]

Definition at line 10 of file adaptive_takestep.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs