catalyst.v2_internals Module

INTERNAL MODULE, NOT FOR PUBLIC CONSUMPTION.

Used by vtkCPPythonScriptV2Pipeline and may change without notice.

class paraview.catalyst.v2_internals.CatalystV1Information(dataDescription)

Bases: object

Provides information to the current catalyst_execute call.

property cycle

returns the current simulation cycle or timestep index

property dataDescription

avoid using this unless absolutely sure what you’re doing

property time

returns the current simulation time

property timestep

returns the current simulation cycle or timestep index

class paraview.catalyst.v2_internals.CatalystV2Information

Bases: object

property catalyst_params

returns a reference to the arguments (as a conduit node) passed in catalyst_execute for this timestep. This reference should be treated as a READ-ONLY since any change will affect the data passed by the simulation.

Note: This call will import the catalyst_conduit python package tha ships with catalyst. So make sure that your PYTHONPATH includes it. The path is available in the cmake variable CATALYST_PYTHONPATH during configuration.

property cycle

returns the current simulation cycle or timestep index

property time

returns the current simulation time

property timestep

returns the current simulation cycle or timestep index

paraview.catalyst.v2_internals.do_catalyst_execute(module)

paraview.catalyst.v2_internals.do_catalyst_finalize(module)

paraview.catalyst.v2_internals.do_catalyst_initialize(module)

paraview.catalyst.v2_internals.do_catalyst_results(module)

paraview.catalyst.v2_internals.do_request_data_description(module, dataDescription)

paraview.catalyst.v2_internals.has_customized_execution(module)

paraview.catalyst.v2_internals.import_and_validate(modulename)

paraview.catalyst.v2_internals.register_module(path)

register a file/directory as an importable module. Returns the name to use to import the module, on success, otherwise None.