An analysis adaptor for ascent-based analysis pipelines. More...

#include <AscentAnalysisAdaptor.h>

Inheritance diagram for sensei::AscentAnalysisAdaptor:

Collaboration diagram for sensei::AscentAnalysisAdaptor:

Public Member Functions
	senseiTypeMacro (AscentAnalysisAdaptor, AnalysisAdaptor)

bool	Execute (DataAdaptor data, DataAdaptor *) override
	Invoke in situ processing using Ascent. More...

int	Finalize () override
	Shut down and clean up the Ascent library. More...

Run time configuration
int	Initialize (const std::string &json_file_path, const std::string &options_file_path)
	Initialize the Ascent library using Ascent specific json configurations. More...

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

int	AddDataRequirement (const std::string &meshName, int association, const std::vector< std::string > &arrays)
	Add an indivudal data requirement. 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 AscentAnalysisAdaptor *	New ()
	Creates an AscentAnalysisAdaptor instance. More...

Protected Member Functions
	AscentAnalysisAdaptor (const AscentAnalysisAdaptor &)=delete

void	operator= (const AscentAnalysisAdaptor &)=delete

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

An analysis adaptor for ascent-based analysis pipelines.

Member Function Documentation

◆ AddDataRequirement()

int sensei::AscentAnalysisAdaptor::AddDataRequirement	(	const std::string &	meshName,
		int	association,
		const std::vector< std::string > &	arrays
	)

Add an indivudal data requirement.

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.

Parameters

[in]	meshName	the name of the mesh to fetch and write
[in]	association	the type of data array to fetch and write vtkDataObject::POINT or vtkDataObject::CELL
[in]	arrays	a list of arrays to fetch and write

Returns: zero if successful.

◆ Execute()

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

overridevirtual

Invoke in situ processing using Ascent.

Implements sensei::AnalysisAdaptor.

◆ Finalize()

int sensei::AscentAnalysisAdaptor::Finalize ( )

overridevirtual

Shut down and clean up the Ascent library.

Reimplemented from sensei::AnalysisAdaptor.

◆ Initialize()

int sensei::AscentAnalysisAdaptor::Initialize	(	const std::string &	json_file_path,
		const std::string &	options_file_path
	)

Initialize the Ascent library using Ascent specific json configurations.

◆ New()

static AscentAnalysisAdaptor* sensei::AscentAnalysisAdaptor::New ( )

static

Creates an AscentAnalysisAdaptor instance.

◆ SetDataRequirements()

int sensei::AscentAnalysisAdaptor::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.

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

checkouts/latest/sensei/AscentAnalysisAdaptor.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members