faunus
Public Member Functions | List of all members
Faunus::SmarterMonteCarlo::MoveSupport< T > Class Template Reference

Helper class for constructing smart monte carlo moves. More...

#include <smart_montecarlo.h>

Public Member Functions

 MoveSupport (const Space &spc, const json &j)
 
double bias ()
 Returns the bias energy. More...
 
void to_json (json &j) const
 
template<std::ranges::range Range>
OptionalElement select (Range &mollist, Random &random)
 

Detailed Description

template<GroupOrParticle T>
class Faunus::SmarterMonteCarlo::MoveSupport< T >

Helper class for constructing smart monte carlo moves.

Member Function Documentation

◆ bias()

template<GroupOrParticle T>
double Faunus::SmarterMonteCarlo::MoveSupport< T >::bias ( )

Returns the bias energy.

Requires the total number of elements inside the region, Nin, which is explicitly sampled until Nin is converged whereafter a constant, mean value is assigned. (speed optimization; approximation)

Returns
Bias energy (kT)

◆ select()

template<GroupOrParticle T>
template<std::ranges::range Range>
MoveSupport< T >::OptionalElement Faunus::SmarterMonteCarlo::MoveSupport< T >::select ( Range &  mollist,
Random random 
)
Template Parameters
TElement type, typically Group or Particle
Parameters
mollistRange of elements
randomRandom number generator
Returns
Optional reference to selected element

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