Computes a histogram in parallel. More...

#include <Histogram.h>

Inheritance diagram for sensei::Histogram:

Collaboration diagram for sensei::Histogram:

Classes
struct	Data
	the computed histogram may be accessed through the following data structure. More...

Public Member Functions
	senseiTypeMacro (Histogram, AnalysisAdaptor)

void	Initialize (int bins, const std::string &meshName, int association, const std::string &arrayName, const std::string &fileName)
	initialize for the run More...

bool	Execute (DataAdaptor data, DataAdaptor *) override
	compute the histogram for this time step More...

int	Finalize () override
	finalize the run More...

int	GetHistogram (Histogram::Data &data)
	return the histogram computed by the most recent call to Execute More...

Public Member Functions inherited from sensei::AnalysisAdaptor
	senseiBaseTypeMacro (AnalysisAdaptor, svtkObjectBase)

void	PrintSelf (ostream &os, svtkIndent indent) override
	Prints the current state of the adaptor. More...

virtual int	SetCommunicator (MPI_Comm comm)
	Set the MPI communicator to be used by the adaptor. More...

MPI_Comm	GetCommunicator ()
	returns the MPI communicator to be used for all communication More...

virtual void	SetVerbose (int val)
	Set the level of verbosity of console output. More...

virtual int	GetVerbose ()
	Get the level of verbosity of console output. More...

virtual void	SetAsynchronous (int val)
	When set the analysis should buffer the simulation data and run in the background returning to the simulation immediately. More...

virtual int	GetAsynchronous ()
	Get asynchronous mode. More...

virtual void	SetDeviceId (int val)
	Set the device that the analysis should run on. More...

virtual int	GetDeviceId ()
	Get the device that the analysis should run on. More...

virtual void	SetDevicesToUse (int val)
	Set the number of devices to use per node. More...

virtual int	GetDevicesToUse ()
	Get the number of devices to use per node. More...

virtual void	SetDeviceStart (int val)
	Set the first on node device to use in automatic device selection. More...

virtual int	GetDeviceStart ()
	Get the first device to use. More...

virtual void	SetDeviceStride (int val)
	Set the number of devices to skip in automatic device selection. More...

virtual int	GetDeviceStride ()
	Get the number of devices to skip. More...

Static Public Member Functions
static Histogram *	New ()
	allocates a new instance More...

Protected Member Functions
	Histogram (const Histogram &)=delete

void	operator= (const Histogram &)=delete

svtkDataArray *	GetArray (svtkDataObject *dobj, const std::string &arrayname)

Protected Member Functions inherited from sensei::AnalysisAdaptor
	AnalysisAdaptor (const AnalysisAdaptor &)=delete

void	operator= (const AnalysisAdaptor &)=delete

Static Protected Member Functions
static const char *	GetGhostArrayName ()

Protected Attributes
int	NumberOfBins

std::string	MeshName

std::string	ArrayName

int	Association

std::string	FileName

Histogram::Data	LastResult

Protected Attributes inherited from sensei::AnalysisAdaptor
MPI_Comm	Comm

int	Verbose

int	DeviceId

int	DevicesPerNode

int	DevicesToUse

int	DeviceStart

int	DeviceStride

int	Asynchronous

Additional Inherited Members
Public Types inherited from sensei::AnalysisAdaptor
enum	{ DEVICE_HOST =-1, DEVICE_AUTO =-2 }
	values controling device selection More...

Detailed Description

Computes a histogram in parallel.

Member Function Documentation

◆ Execute()

bool sensei::Histogram::Execute	(	DataAdaptor *	data,
		DataAdaptor **
	)

overridevirtual

compute the histogram for this time step

Implements sensei::AnalysisAdaptor.

◆ Finalize()

int sensei::Histogram::Finalize ( )

overridevirtual

finalize the run

Reimplemented from sensei::AnalysisAdaptor.

◆ GetHistogram()

int sensei::Histogram::GetHistogram ( Histogram::Data & data )

return the histogram computed by the most recent call to Execute

◆ Initialize()

void sensei::Histogram::Initialize	(	int	bins,
		const std::string &	meshName,
		int	association,
		const std::string &	arrayName,
		const std::string &	fileName
	)

initialize for the run

◆ New()

static Histogram* sensei::Histogram::New ( )

static

allocates a new instance

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

checkouts/latest/sensei/Histogram.h

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes