Writes AMR data to disk in VTK format. More...

#include <VTKAmrWriter.h>

Inheritance diagram for sensei::VTKAmrWriter:

Collaboration diagram for sensei::VTKAmrWriter:

Public Member Functions
	senseiTypeMacro (VTKAmrWriter, AnalysisAdaptor)

bool	Execute (DataAdaptor data, DataAdaptor *) override
	Invokes the write. More...

int	Finalize () override
	Finalizes output, flushes buffers, creates metadata files, and closes all streams. 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 VTKAmrWriter *	New ()
	constructs a new VTKAmrWriter More...

Protected Member Functions
	VTKAmrWriter (const VTKAmrWriter &)=delete

void	operator= (const VTKAmrWriter &)=delete

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

void	operator= (const AnalysisAdaptor &)=delete

Run time configuration
enum	{ MODE_PARAVIEW =0, MODE_VISIT =1 }

int	SetOutputDir (const std::string &outputDir)
	Sets the directory files will be written to. More...

int	SetMode (int mode)
	Sets the file creation mode. MODE_PARAVIEW=0, MODE_VISIT=1. More...

int	SetMode (std::string mode)
	Set the file creation mode by string Use either "paraview" or "visit". 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...

int	Initialize ()
	Must be called before Execute to configure for the run. More...

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

Writes AMR data to disk in VTK format.

This can be useful for generating preview datasets that allow configuration of Catalyst and/or Libsim scripts, or for staging data on resources such as burst buffers. This adaptor supports writing to a VTK(PXML), VisIt(.visit) or ParaView(.pvd) compatible format. One must provide a set of data requirments, consisting of a list of meshes and the arrays to write from each mesh. File names are derived using the output directory, the mesh name, and the mode.

Member Function Documentation

◆ AddDataRequirement()

int sensei::VTKAmrWriter::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::VTKAmrWriter::Execute	(	DataAdaptor *	data,
		DataAdaptor **
	)

overridevirtual

Invokes the write.

Implements sensei::AnalysisAdaptor.

◆ Finalize()

int sensei::VTKAmrWriter::Finalize ( )

overridevirtual

Finalizes output, flushes buffers, creates metadata files, and closes all streams.

Reimplemented from sensei::AnalysisAdaptor.

◆ Initialize()

int sensei::VTKAmrWriter::Initialize ( )

Must be called before Execute to configure for the run.

◆ New()

static VTKAmrWriter* sensei::VTKAmrWriter::New ( )

static

constructs a new VTKAmrWriter

◆ SetDataRequirements()

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

◆ SetMode() [1/2]

int sensei::VTKAmrWriter::SetMode ( int mode )

Sets the file creation mode. MODE_PARAVIEW=0, MODE_VISIT=1.

◆ SetMode() [2/2]

int sensei::VTKAmrWriter::SetMode ( std::string mode )

Set the file creation mode by string Use either "paraview" or "visit".

◆ SetOutputDir()

int sensei::VTKAmrWriter::SetOutputDir ( const std::string & outputDir )

Sets the directory files will be written to.

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

checkouts/latest/sensei/VTKAmrWriter.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Run time configuration

Additional Inherited Members