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

Particle or groups selection for smart Monte Carlo (SMC) moves. More...

#include <smart_montecarlo.h>

Collaboration diagram for Faunus::SmarterMonteCarlo::Selection< T >:
Collaboration graph
[legend]

Public Member Functions

 Selection (T &item, int number_total, int number_inside, bool item_is_inside)
 

Public Attributes

Titem = nullptr
 Selected group, particle etc.
 
int n_total = 0
 
int n_inside = 0
 
bool is_inside = false
 

Detailed Description

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

Particle or groups selection for smart Monte Carlo (SMC) moves.

This contains data useful for performing a SMC move. This object should be created only with SmartMonteCarlo::select and hence has a protected constructor.

Constructor & Destructor Documentation

◆ Selection()

template<GroupOrParticle T>
Faunus::SmarterMonteCarlo::Selection< T >::Selection ( T item,
int  number_total,
int  number_inside,
bool  item_is_inside 
)
Template Parameters
TParticle or group (`item')
Parameters
itemReference to item
number_totalTotal number of items
number_insideNumber of items inside region
item_is_insideIs current `item' inside region?

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