Analysis adaptor for Catalyst2-based analysis pipelines. More...

#include <Catalyst2AnalysisAdaptor.h>

Inheritance diagram for sensei::Catalyst2AnalysisAdaptor:

Collaboration diagram for sensei::Catalyst2AnalysisAdaptor:

Public Member Functions
	senseiTypeMacro (Catalyst2AnalysisAdaptor, AnalysisAdaptor)

void	PrintSelf (ostream &os, svtkIndent indent) override

virtual void	AddPythonScriptPipeline (const std::string &fileName)
	Adds a pipeline initialized from a Catalyst python script. More...

int	SetDataRequirements (const DataRequirements &reqs)
	Adds a set of sensei::DataRequirements, typically this will come from an XML configuratiopn file. More...

bool	Execute (DataAdaptor data, DataAdaptor *dataOut=nullptr) override
	Invokes in situ processing, data movement or I/O. More...

int	Finalize () override
	Clean up and shut down the data consuming library if needed. 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 Catalyst2AnalysisAdaptor *	New ()

Protected Member Functions
void	Initialize ()

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

void	operator= (const AnalysisAdaptor &)=delete

Protected Attributes
DataRequirements	Requirements
	meshes needed by the analysis. If empty, all meshes are needed. More...

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

Analysis adaptor for Catalyst2-based analysis pipelines.

AnalysisAdaptor is a subclass of AnalysisAdaptor that is that can be used as the superclass for all analysis that uses Catalyst 2.

Member Function Documentation

◆ AddPythonScriptPipeline()

virtual void sensei::Catalyst2AnalysisAdaptor::AddPythonScriptPipeline ( const std::string & fileName )

virtual

Adds a pipeline initialized from a Catalyst python script.

◆ Execute()

bool sensei::Catalyst2AnalysisAdaptor::Execute	(	DataAdaptor *	dataIn,
		DataAdaptor **	dataOut = `nullptr`
	)

overridevirtual

Invokes in situ processing, data movement or I/O.

The simulation will call this method when data is ready to be processed. Callers will pass a simulation specific sensei::DataAdaptor that can be used to fetch the needed simulation data for processing. Callers pass a non-null address to a pointer to a sensei::DataAdaptor to signal that output is desired if it is available. In that case a newly allocated data adaptor instance is returned in the pointer. This data adaptor can be used to fetch the output. The caller trakes ownership of the returned data adaptor instance and must call Delete on it when finished. Callers that do not want the output data should pass nullptr to signal that it is not needed.

Parameters

[in]	dataIn	the simulation provided data adaptor used to fetch data for processing
[out]	dataOut	the address of a pointer to a data adaptor that could be used to fetch data from the analysis. This should be null if the caller does not want to access the output data. If it is not null and if the implementation can provide output a data, a data adaptor is allocated and returned via this pointer. In that case the caller can use the adaptor to fetch the data. The caller takes ownership of the returned data adaptor and must call Delete on it when finished.

Returns: false if an error has occurred. Typically this means that in situ processing is not possible due to misconfiguration or communication error. In that case callers should abort so as not to waste compute resources.

Implements sensei::AnalysisAdaptor.

◆ Finalize()

int sensei::Catalyst2AnalysisAdaptor::Finalize ( )

overridevirtual

Clean up and shut down the data consuming library if needed.

This method is called when the run is finsihed clean up and shut down should occur here rather than in the destructor as MPI may not be available at desctruction time.

Returns: zero if successful.

Reimplemented from sensei::AnalysisAdaptor.

◆ SetDataRequirements()

int sensei::Catalyst2AnalysisAdaptor::SetDataRequirements ( const DataRequirements & reqs )

Adds a set of sensei::DataRequirements, typically this will come from an XML configuratiopn file.

Data requirements tell the adaptor what to fetch from the simulation and write to disk. If none are given then all available data is fetched and written.

Member Data Documentation

◆ Requirements

DataRequirements sensei::Catalyst2AnalysisAdaptor::Requirements

protected

meshes needed by the analysis. If empty, all meshes are needed.

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

checkouts/latest/sensei/Catalyst2AnalysisAdaptor.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members