Performs a temporal autocorrelation on the simulation data. More...

#include <Autocorrelation.h>

Inheritance diagram for sensei::Autocorrelation:

Collaboration diagram for sensei::Autocorrelation:

Public Member Functions
	senseiTypeMacro (Autocorrelation, AnalysisAdaptor)

void	Initialize (size_t window, const std::string &meshName, int association, const std::string &arrayName, size_t kMax, int numThreads=1)
	Initialize the adaptor. More...

bool	Execute (DataAdaptor data, DataAdaptor *) override
	Incrementally computes autocorrelation on the current simulation state. More...

int	Finalize () override
	Finishes the calculation and dumps the results. 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 Autocorrelation *	New ()
	Allocate a new Autocorrelation instance. More...

Protected Member Functions
void	PrintResults (size_t k_max)

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

void	operator= (const AnalysisAdaptor &)=delete

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

Protected Attributes inherited from sensei::AnalysisAdaptor
MPI_Comm	Comm

int	Verbose

int	DeviceId

int	DevicesPerNode

int	DevicesToUse

int	DeviceStart

int	DeviceStride

int	Asynchronous

Detailed Description

Performs a temporal autocorrelation on the simulation data.

Member Function Documentation

◆ Execute()

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

overridevirtual

Incrementally computes autocorrelation on the current simulation state.

Implements sensei::AnalysisAdaptor.

◆ Finalize()

int sensei::Autocorrelation::Finalize ( )

overridevirtual

Finishes the calculation and dumps the results.

Reimplemented from sensei::AnalysisAdaptor.

◆ Initialize()

void sensei::Autocorrelation::Initialize	(	size_t	window,
		const std::string &	meshName,
		int	association,
		const std::string &	arrayName,
		size_t	kMax,
		int	numThreads = `1`
	)

Initialize the adaptor.

This method must be called to initialize the adaptor with configuration parameters for the analysis to perform.

Parameters

window	analysis window in timestep count.
meshName	of mesh containing the array to process
association	together with `arrayname`, identifies the array to compute autocorrelation for.
arrayName	together with `association`, identifies the array to compute autocorrelation for.
kMax	number of strongest autocorrelations to report
numThreads	number of threads in sdiy's thread pool

◆ New()

static Autocorrelation* sensei::Autocorrelation::New ( )

static

Allocate a new Autocorrelation instance.

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

checkouts/latest/sensei/Autocorrelation.h

Public Member Functions

Static Public Member Functions