Samples a matrix of group properties. More...

#include <analysis.h>

Inheritance diagram for Faunus::analysis::GroupMatrixAnalysis:

Collaboration diagram for Faunus::analysis::GroupMatrixAnalysis:

Public Member Functions
	GroupMatrixAnalysis (const json &j, const Space &spc, Energy::Hamiltonian &pot)

Public Member Functions inherited from Faunus::analysis::PairMatrixAnalysis
	PairMatrixAnalysis (const json &j, const Space &spc)

Public Member Functions inherited from Faunus::analysis::Analysis
void	to_json (json &j) const
	JSON report w. statistics, output etc.

void	from_json (const json &j)
	configure from json object

void	to_disk ()
	Save data to disk (if defined) More...

void	sample ()
	Increase step count and sample. More...

int	getNumberOfSteps () const
	Number of steps.

	Analysis (const Space &spc, std::string_view name)

	Analysis (const Space &spc, std::string_view name, int sample_interval, int number_of_skipped_steps)

Additional Inherited Members
Public Attributes inherited from Faunus::analysis::Analysis
const std::string	name
	descriptive name

std::string	cite
	url, doi etc. describing the analysis

Protected Attributes inherited from Faunus::analysis::PairMatrixAnalysis
const Space &	spc

std::function< bool(double)>	value_filter
	Used to filter values generated by `property`

Eigen::SparseMatrix< double >	pair_matrix
	Matrix of pair properties.

Protected Attributes inherited from Faunus::analysis::Analysis
const Space &	spc
	Instance of Space to analyse.

int	sample_interval = 0
	Steps in between each sample point (do not modify)

int	number_of_samples = 0
	counter for number of samples

Detailed Description

Samples a matrix of group properties.

This calculates a user-defined property between a set of selected groups and outputs a matrix as a function of steps.

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

Public Member Functions