initialization helper for in situ environments. More...

#include <vtkInSituInitializationHelper.h>

Inheritance diagram for vtkInSituInitializationHelper:

Collaboration diagram for vtkInSituInitializationHelper:

[legend]

Public Types
typedef vtkObject	Superclass

Public Member Functions
virtual const char *	GetClassName ()

virtual int	IsA (const char *type)

void	PrintSelf (ostream &os, vtkIndent indent) override

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkInSituInitializationHelper *	SafeDownCast (vtkObject *o)

static void	Initialize (vtkTypeUInt64 comm, const std::vector< std::string > &python_paths)
	Initializes the engine. More...

static void	Finalize ()
	Finalizes the engine. More...

static vtkInSituPipeline *	AddPipeline (const std::string &pipeline_name, const std::string &path)
	Add Python analysis scripts or packages. More...

static vtkInSituPipeline *	GetPipeline (const std::string &pipeline_name)
	Returns the registered pipeline with the given name, or nullptr if no pipeline with that name has been registered. More...

static void	AddPipeline (vtkInSituPipeline *pipeline)
	Add a vtkInSituPipeline instance. More...

static void	SetProducer (const std::string &channelName, vtkSMSourceProxy *producer)
	Specify the algorithm or data-producer proxy that produces the mesh for named catalyst channel. More...

static vtkSMSourceProxy *	GetProducer (const std::string &channelName)
	Provides access to the producer proxy for a given channel, if any. More...

static void	UpdateAllProducers (double time)
	Convenience method to call Update/UpdatePipeline on all known producers. More...

static bool	ExecutePipelines (int timestep, double time, const std::vector< std::string > &pipelines={}, const std::vector< std::string > &parameters={})
	Executes pipelines. More...

static bool	ExecutePipelines (const conduit_node *catalyst_state)

static bool	GetResultsFromPipelines (conduit_node *catalyst_params)
	Call Results() on all pipelines. More...

static conduit_node *	GetCatalystParameters ()
	Provides access to the conduit node that the simulation passed as argument to "catalyst_execute" for this timestep. More...

static bool	IsInitialized ()
	Returns true if vtkInSituInitializationHelper has been initialized; which means that ParaView is operating in in situ mode. More...

static bool	IsPythonSupported ()
	Returns true if ParaView is built with Python support enabled. More...

static void	GetSteerableProxies (std::vector< std::pair< std::string, vtkSMProxy *>> &proxies)
	Fill the vector with all steerable proxies and extracts associated to the pipeline. More...

static void	UpdateSteerableParameters (vtkSMProxy steerableProxy, const char steerableSourceName)
	Update the internal list of steerable proxies or extracts by adding the proxy passed in parameters. More...


static void	MarkProducerModified (const std::string &channelName)
	This is provided as a convenience to indicate a particular producer has been modified or has new data for current timestep. More...

static void	MarkProducerModified (vtkSMSourceProxy *producer)
	This is provided as a convenience to indicate a particular producer has been modified or has new data for current timestep. More...


static int	GetTimeStep ()
	Provides access to current time and timestep during `ExecutePipelines` call. More...

static double	GetTime ()
	Provides access to current time and timestep during `ExecutePipelines` call. More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
	vtkInSituInitializationHelper ()

	~vtkInSituInitializationHelper () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Additional Inherited Members
Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

initialization helper for in situ environments.

vtkInSituInitializationHelper used by ParaView-Catalyst to initialize the ParaView engine. It simply setups up defaults for suitable for in situ use-cases. Internally, it relies on vtkInitializationHelper to do the actual initialization.

vtkInSituInitializationHelper is also intended to be used by other in situ codes includes custom Catalyst API implementations or other in situ frameworks.

See also: vtkInitializationHelper

Definition at line 49 of file vtkInSituInitializationHelper.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkInSituInitializationHelper::Superclass

Definition at line 52 of file vtkInSituInitializationHelper.h.

Constructor & Destructor Documentation

◆ vtkInSituInitializationHelper()

vtkInSituInitializationHelper::vtkInSituInitializationHelper ( )

protected

◆ ~vtkInSituInitializationHelper()

vtkInSituInitializationHelper::~vtkInSituInitializationHelper ( )

overrideprotected

Member Function Documentation

◆ GetClassName()

virtual const char* vtkInSituInitializationHelper::GetClassName ( )

virtual

◆ IsTypeOf()

static int vtkInSituInitializationHelper::IsTypeOf ( const char * type )

static

◆ IsA()

virtual int vtkInSituInitializationHelper::IsA ( const char * type )

virtual

Reimplemented from vtkObjectBase.

◆ SafeDownCast()

static vtkInSituInitializationHelper* vtkInSituInitializationHelper::SafeDownCast ( vtkObject * o )

static

◆ PrintSelf()

void vtkInSituInitializationHelper::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Reimplemented from vtkObject.

◆ Initialize()

static void vtkInSituInitializationHelper::Initialize	(	vtkTypeUInt64	comm,
		const std::vector< std::string > &	python_paths
	)

static

Initializes the engine.

This can only be called once in the lifetime of the process. Calling this after the first call has no effect.

'comm' is used to determine the 'MPI_Comm' handle to be used for ParaView. In non-MPI builds of ParaView, this argument is simply ignored. In MPI-enabled builds of ParaView, this argument must be 'MPI_Fint' that represents the Fortran handle for MPI_Comm to use. The Fortran handle is an integer and hence we use 'vtkTypeUInt64' as a wide-enough container for the Fortran handle without having to include 'mpi.h' in this public header. The Fortran MPI communicator handle can be obtained from a MPI_Comm using MPI_Comm_c2f(). Refer to MPI specification for details.

'python_paths' is used to update the PYTHONPATH visible to catalyst scripts. In particular, in Python-enabled builds, the python_paths are prepended into the current path of the vtkPythonInterpreter that executes the catalyst script. This allows to add paths to python packages that a catalyst script can use. A prime example for this is path to custom scripts or CATALYST_PYTHONPATH which at the time of writing holds the necessary package to access the conduit node used in each of the catalyst_*1 calls i.e.node = info.catalyst_params`.

◆ Finalize()

static void vtkInSituInitializationHelper::Finalize ( )

static

Finalizes the engine.

This can be called only once in the lifetime of the progress, and that too only after Initialize has been called.

◆ AddPipeline() [1/2]

static vtkInSituPipeline* vtkInSituInitializationHelper::AddPipeline	(	const std::string &	pipeline_name,
		const std::string &	path
	)

static

Add Python analysis scripts or packages.

This should be called after Initialize but before Finalize to add analysis pipelines. The path can point to a Python script, a directory containing a Python package or a zip-file which containing a Python package.

◆ GetPipeline()

static vtkInSituPipeline* vtkInSituInitializationHelper::GetPipeline ( const std::string & pipeline_name )

static

Returns the registered pipeline with the given name, or nullptr if no pipeline with that name has been registered.

Lookup is by exact name match against names set via AddPipeline.

◆ AddPipeline() [2/2]

static void vtkInSituInitializationHelper::AddPipeline ( vtkInSituPipeline * pipeline )

static

Add a vtkInSituPipeline instance.

◆ SetProducer()

static void vtkInSituInitializationHelper::SetProducer	(	const std::string &	channelName,
		vtkSMSourceProxy *	producer
	)

static

Specify the algorithm or data-producer proxy that produces the mesh for named catalyst channel.

This cannot be changed once specified.

On success, this registers the producer with the session proxy manager using the same name as the channelName.

◆ GetProducer()

static vtkSMSourceProxy* vtkInSituInitializationHelper::GetProducer ( const std::string & channelName )

static

Provides access to the producer proxy for a given channel, if any.

◆ UpdateAllProducers()

static void vtkInSituInitializationHelper::UpdateAllProducers ( double time )

static

Convenience method to call Update/UpdatePipeline on all known producers.

◆ MarkProducerModified() [1/2]

static void vtkInSituInitializationHelper::MarkProducerModified ( const std::string & channelName )

static

This is provided as a convenience to indicate a particular producer has been modified or has new data for current timestep.

◆ MarkProducerModified() [2/2]

static void vtkInSituInitializationHelper::MarkProducerModified ( vtkSMSourceProxy * producer )

static

This is provided as a convenience to indicate a particular producer has been modified or has new data for current timestep.

◆ ExecutePipelines() [1/2]

static bool vtkInSituInitializationHelper::ExecutePipelines	(	int	timestep,
		double	time,
		const std::vector< std::string > &	pipelines = `{}`,
		const std::vector< std::string > &	parameters = `{}`
	)

static

Executes pipelines.

◆ ExecutePipelines() [2/2]

static bool vtkInSituInitializationHelper::ExecutePipelines ( const conduit_node * catalyst_state )

static

◆ GetResultsFromPipelines()

static bool vtkInSituInitializationHelper::GetResultsFromPipelines ( conduit_node * catalyst_params )

static

Call Results() on all pipelines.

◆ GetTimeStep()

static int vtkInSituInitializationHelper::GetTimeStep ( )

static

Provides access to current time and timestep during ExecutePipelines call.

The value is not valid outside ExecutePipelines.

◆ GetTime()

static double vtkInSituInitializationHelper::GetTime ( )

static

Provides access to current time and timestep during ExecutePipelines call.

The value is not valid outside ExecutePipelines.

◆ GetCatalystParameters()

static conduit_node* vtkInSituInitializationHelper::GetCatalystParameters ( )

static

Provides access to the conduit node that the simulation passed as argument to "catalyst_execute" for this timestep.

This should be treated as READ-ONLY since any change could directly modify simulation data. The value is not valid outside ExecutePipelines.

◆ IsInitialized()

static bool vtkInSituInitializationHelper::IsInitialized ( )

inlinestatic

Returns true if vtkInSituInitializationHelper has been initialized; which means that ParaView is operating in in situ mode.

Definition at line 170 of file vtkInSituInitializationHelper.h.

◆ IsPythonSupported()

static bool vtkInSituInitializationHelper::IsPythonSupported ( )

static

Returns true if ParaView is built with Python support enabled.

◆ GetSteerableProxies()

static void vtkInSituInitializationHelper::GetSteerableProxies ( std::vector< std::pair< std::string, vtkSMProxy *>> & proxies )

static

Fill the vector with all steerable proxies and extracts associated to the pipeline.

◆ UpdateSteerableParameters()

static void vtkInSituInitializationHelper::UpdateSteerableParameters	(	vtkSMProxy *	steerableProxy,
		const char *	steerableSourceName
	)

static

Update the internal list of steerable proxies or extracts by adding the proxy passed in parameters.

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

/builds/gitlab-kitware-sciviz-ci/Clients/InSitu/vtkInSituInitializationHelper.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkInSituInitializationHelper()

◆ ~vtkInSituInitializationHelper()

Member Function Documentation

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ Initialize()

◆ Finalize()

◆ AddPipeline() [1/2]

◆ GetPipeline()

◆ AddPipeline() [2/2]

◆ SetProducer()

◆ GetProducer()

◆ UpdateAllProducers()

◆ MarkProducerModified() [1/2]

◆ MarkProducerModified() [2/2]

◆ ExecutePipelines() [1/2]

◆ ExecutePipelines() [2/2]

◆ GetResultsFromPipelines()

◆ GetTimeStep()

◆ GetTime()

◆ GetCatalystParameters()

◆ IsInitialized()

◆ IsPythonSupported()

◆ GetSteerableProxies()

◆ UpdateSteerableParameters()