PlaneParticleAveragePositionEstimator Class Reference

Create a 2d histogram of particle positions but only store the average. More...

#include <estimator.h>

Inheritance diagram for PlaneParticleAveragePositionEstimator:

Collaboration diagram for PlaneParticleAveragePositionEstimator:

Public Member Functions
	PlaneParticleAveragePositionEstimator (const Path &, ActionBase *, const MTRand &, double, int _frequency=1, string _label="planeavedensity")
	Constructor. More...
	~PlaneParticleAveragePositionEstimator ()
	Destructor.
string	getName () const
	Get the name of the estimator.
void	output ()
	Output the estimator value to disk. More...
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 Path &	path
	A constant reference to the paths.
ActionBase *	actionPtr
	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 but only store the average.

Definition at line 335 of file estimator.h.

Constructor & Destructor Documentation

PlaneParticleAveragePositionEstimator()

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

Constructor.

A 2-dimensional particle density averaged histogram.

Note

Only tested for cubic boxes

Definition at line 1112 of file estimator.cpp.

                                                     : 
    EstimatorBase(_path,_actionPtr,_random,_maxR,_frequency,_label) {
 
    /* We choose an odd number to make sure (0,0) is the central 
     * grid box. */
    numLinearGrid = 4*NGRIDSEP+1;
    numGrid = numLinearGrid*numLinearGrid;
 
    /* The spatial discretization */
    for (int i = 0; i < NDIM; i++)
        dl[i]  = path.boxPtr->side[i] / numLinearGrid;
 
    /* This is a diagonal estimator that gets its own file */
    initialize(numGrid);
 
    /* The header contains information about the grid  */
    header = str(format("# PIMCID: %s\n") % constants()->id());
    header = str(format("# ESTINF: dx = %12.6E dy = %12.6E NGRIDSEP = %d\n") 
            % dl[0] % dl[1] % numLinearGrid);
    header += str(format("#%15s") % "plane density");
 
    /* Compute the area of a grid box */
    double A = 1.0;
    for (int i = 0; i < NDIM-1; i++)
        A *= dl[i];
 
    norm = 1.0/((endSlice-startSlice)*(1.0/actionPtr->period)*A*path.boxPtr->side[NDIM-1]);
    side = path.boxPtr->side;
}

Here is the call graph for this function:

Member Function Documentation

output()

void PlaneParticleAveragePositionEstimator::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 345 of file estimator.h.

{outputFlat();}  // overload the output

Here is the call graph for this function:

---

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

• include/estimator.h
• src/estimator.cpp