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

Create a 2d histogram of particle positions. More...

#include <estimator.h>

+ Inheritance diagram for PlaneParticlePositionEstimator:
+ Collaboration diagram for PlaneParticlePositionEstimator:

Public Member Functions

 PlaneParticlePositionEstimator (const Path &, ActionBase *, const MTRand &, double, int _frequency=1, string _label="planedensity")
 Constructor. More...
 
 ~PlaneParticlePositionEstimator ()
 Destructor.
 
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 output ()
 Output the estimator value to disk. More...
 
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

Create a 2d histogram of particle positions.

Definition at line 310 of file estimator.h.

Constructor & Destructor Documentation

◆ PlaneParticlePositionEstimator()

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

Constructor.

A 2-dimensional particle density histogram.

Note
Only tested for cubic boxes

Definition at line 1029 of file estimator.cpp.

1031  :
1032  EstimatorBase(_path,_actionPtr,_random,_maxR,_frequency,_label) {
1033 
1034 
1035  /* We choose an odd number to make sure (0,0) is the central
1036  * grid box. */
1037  numLinearGrid = 4*NGRIDSEP+1;
1038  numGrid = numLinearGrid*numLinearGrid;
1039 
1040  /* The spatial discretization */
1041  for (int i = 0; i < NDIM; i++)
1042  dl[i] = path.boxPtr->side[i] / numLinearGrid;
1043 
1044  /* This is a diagonal estimator that gets its own file */
1045  initialize(numGrid);
1046 
1047  /* The header contains information about the grid */
1048  header = str(format("# ESTINF: dx = %12.6E dy = %12.6E NGRIDSEP = %d\n")
1049  % dl[0] % dl[1] % numLinearGrid);
1050  header += str(format("#%15.3E") % 0.0);
1051  for (int n = 1; n < numGrid; n++)
1052  header.append(str(format("%16.3E") % (1.0*n)));
1053 
1054  /* Compute the area of a grid box */
1055  double A = 1.0;
1056  for (int i = 0; i < NDIM-1; i++)
1057  A *= dl[i];
1058 
1059  norm = 1.0/((endSlice-startSlice)*(1.0/actionPtr->period)*A*path.boxPtr->side[NDIM-1]);
1060  side = path.boxPtr->side;
1061 }
dVec side
The linear dimensions of the box.
Definition: container.h:31
int endSlice
Where imaginary time averages end.
Definition: estimator.h:96
ActionBase * actionPtr
A pointer to the action.
Definition: estimator.h:82
Array< double, 1 > norm
The normalization factor for each estimator.
Definition: estimator.h:91
string header
The data file header.
Definition: estimator.h:110
int startSlice
Where imaginary time averages begin.
Definition: estimator.h:95
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 NDIM
Number of spatial dimnsions.
Definition: common.h:71
#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:

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