Path Integral Quantum Monte Carlo
Public Member Functions | Static Public Attributes
LocalPermutationEstimator Class Reference

Particle permutation number density histogram. More...

#include <estimator.h>

+ Inheritance diagram for LocalPermutationEstimator:
+ Collaboration diagram for LocalPermutationEstimator:

Public Member Functions

 LocalPermutationEstimator (const Path &, ActionBase *, const MTRand &, double, int _frequency=1, string _label="locperm")
 Constructor. More...
 
 ~LocalPermutationEstimator ()
 Destructor.
 
void output ()
 Output the estimator value to disk. More...
 
string getName () const
 Get the name of the estimator.
 
- Public Member Functions inherited from EstimatorBase
 EstimatorBase (const Path &_path, ActionBase *_actionPtr, const MTRand &_random, double _maxR, int _frequency=1, string _label="")
 Constructor. More...
 
virtual ~EstimatorBase ()
 Destructor.
 
virtual void sample ()
 Sample the estimator. More...
 
void reset ()
 Reset numAccumulated and the estimator to 0.
 
void restart (const uint32, const uint32)
 Restart the measurment process from a previous state.
 
virtual void outputFlat ()
 Output a flat estimator value to disk. More...
 
virtual void outputFooter ()
 Ouptut the fooder to disk.
 
bool baseSample ()
 Determine the basic sampling condition. More...
 
uint32 getTotNumAccumulated () const
 Get the total number of accumulated measurments.
 
uint32 getNumAccumulated () const
 Get the number of accumulated measurements since the last reset.
 
uint32 getNumSampled () const
 Get the number of samples since the last reset.
 
void prepare ()
 Prepare the estimator for i/o. More...
 
void addEndLine ()
 Add a carriage return to estimator files.
 
void appendLabel (string append)
 Append to default label. More...
 
string getLabel () const
 Get the estimator label.
 

Static Public Attributes

static const string name
 

Additional Inherited Members

- Protected Member Functions inherited from EstimatorBase
void initialize (int)
 Initialize estimator. More...
 
void initialize (vector< string >)
 Initialize estimator. More...
 
- Protected Attributes inherited from EstimatorBase
const Pathpath
 A constant reference to the paths.
 
ActionBaseactionPtr
 A pointer to the action.
 
MTRand random
 
double maxR
 
fstream * outFilePtr
 The output fie.
 
map< string, int > estIndex
 Map estimator labels to indices.
 
Array< double, 1 > estimator
 The estimator array.
 
Array< double, 1 > norm
 The normalization factor for each estimator.
 
int numEst
 The number of individual quantities measured.
 
int frequency
 The frequency at which we accumulate.
 
int startSlice
 Where imaginary time averages begin.
 
int endSlice
 Where imaginary time averages end.
 
int endDiagSlice
 Where imaginary time averages end for diagonal estimiators.
 
vector< double > sliceFactor
 Used to properly incorporate end affects.
 
string label
 The label used for the output file.
 
uint32 numSampled
 The number of times we have sampled.
 
uint32 numAccumulated
 The number of accumulated values.
 
uint32 totNumAccumulated
 The total number of accumulated values.
 
int numBeads0
 The target number of beads for the canonical ensemble.
 
bool diagonal
 Is this a diagonal estimator?
 
bool endLine
 Should we output a carriage return?
 
bool canonical
 Are we in the canonical ensemble?
 
string header
 The data file header.
 

Detailed Description

Particle permutation number density histogram.

NORMALIZATION NEEDS TO BE FIXED!!

Definition at line 613 of file estimator.h.

Constructor & Destructor Documentation

◆ LocalPermutationEstimator()

LocalPermutationEstimator::LocalPermutationEstimator ( const Path _path,
ActionBase _actionPtr,
const MTRand &  _random,
double  _maxR,
int  _frequency = 1,
string  _label = "locperm" 
)

Constructor.

Local particle permutation number density histogram.

We setup the permuatation cycle estimator to measure cycles which can contain up to 40 particles.

Definition at line 2117 of file estimator.cpp.

2119  :
2120  EstimatorBase(_path,_actionPtr,_random,_maxR,_frequency,_label) {
2121 
2122  /* We just choose arbitrarily to only count cycles including up to 40 particles */
2123  maxNumCycles = 40;
2124 
2125  /* The local permutation cycle estimator has its own file, and consists of
2126  * maxNumCycles permutation cycles */
2128 
2129  /* vector to hold number of worldlines put into a grid space */
2130  numBeadInGrid.resize(estimator.size());
2131 
2132  /* Set estimator header */
2133  header = str(format("#%15d") % NGRIDSEP);
2134 
2135 }
int numGrid
The number of grid boxes for the position grid.
Definition: container.h:41
Array< double, 1 > estimator
The estimator array.
Definition: estimator.h:90
string header
The data file header.
Definition: estimator.h:110
EstimatorBase(const Path &_path, ActionBase *_actionPtr, const MTRand &_random, double _maxR, int _frequency=1, string _label="")
Constructor.
Definition: estimator.cpp:103
const Path & path
A constant reference to the paths.
Definition: estimator.h:78
void initialize(int)
Initialize estimator.
Definition: estimator.cpp:201
const Container * boxPtr
A constant reference to the container class.
Definition: path.h:43
#define NGRIDSEP
Spatial separations to be used in each dimension of the particle position grid.
Definition: common.h:93
+ Here is the call graph for this function:

Member Function Documentation

◆ output()

void LocalPermutationEstimator::output ( )
inlinevirtual

Output the estimator value to disk.


We only attempt an output if we have accumulated at least numBins measurements. This works because the final 'scalar' estimator is the diagonal estimator which gets measured for both diaagonal and off diagonal configurations.

Reimplemented from EstimatorBase.

Definition at line 620 of file estimator.h.

620 {outputFlat();}
virtual void outputFlat()
Output a flat estimator value to disk.
Definition: estimator.cpp:305
+ Here is the call graph for this function:

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