Plugins module

This module contains classes the Simphony plugins for the Mayavi2 application.

Classes

simphony_mayavi.plugins.add_source_panel.AddSourcePanel
simphony_mayavi.plugins.add_engine_panel.AddEnginePanel
simphony_mayavi.plugins.engine_manager.EngineManager
simphony_mayavi.plugins.engine_manager_mayavi2.EngineManagerMayavi2
simphony_mayavi.plugins.engine_manager_standalone_ui.EngineManagerStandaloneUI
RunAndAnimate Standalone non-GUI based controller for running a Simphony Modeling Engine and animating the CUDS dataset in Mayavi.
simphony_mayavi.plugins.run_and_animate_panel.RunAndAnimatePanel
simphony_mayavi.plugins.tabbed_panel_collection.TabbedPanelCollection

Functions

simphony_mayavi.plugins.add_source_panel.add_source_and_modules_to_scene

Descriptions

class simphony_mayavi.plugins.run_and_animate.RunAndAnimate(engine, mayavi_engine)[source]

Bases: object

Standalone non-GUI based controller for running a Simphony Modeling Engine and animating the CUDS dataset in Mayavi.

Precondition: The required CUDS datasets are already visible in the Mayavi scene(s)

Parameters:
  • engine (ABCModelingEngine) – Simphony Modeling Engine
  • mayavi_engine (mayavi.api.Engine) – for retrieving scenes and visible datasets
animate(number_of_runs, delay=None, ui=False, update_all_scenes=False)[source]

Run the modeling engine, and animate the scene. If there is no source in the scene or none of the sources belongs to the selected Engine engine, a RuntimeError is raised.

Parameters:
  • number_of_runs (int) – the number of times the engine.run() is called
  • delay (int) – delay between each run. If None, use previous setting or the Mayavi’s default (500)
  • ui (bool) – whether an UI is shown, default is False
  • update_all_scenes (bool) – whether all scenes are updated, default is False: i.e. only the current scene is updated
Raises:
RuntimeError
if nothing in scene(s) belongs to engine

Engine_wrapper module

class simphony_mayavi.plugins.engine_wrappers.abc_engine_factory.ABCEngineFactory[source]

Bases: traits.has_traits.ABCHasStrictTraits

create()[source]

Return a new engine wrapper instance

class simphony_mayavi.plugins.engine_wrappers.jyulb.JyulbFileIOEngineFactory[source]

Bases: simphony_mayavi.plugins.engine_wrappers.abc_engine_factory.ABCEngineFactory

class simphony_mayavi.plugins.engine_wrappers.jyulb.JyulbInternalEngineFactory[source]

Bases: simphony_mayavi.plugins.engine_wrappers.abc_engine_factory.ABCEngineFactory

class simphony_mayavi.plugins.engine_wrappers.openfoam.OpenFoamFileIOEngineFactory[source]

Bases: simphony_mayavi.plugins.engine_wrappers.abc_engine_factory.ABCEngineFactory

class simphony_mayavi.plugins.engine_wrappers.openfoam.OpenFoamInternalEngineFactory[source]

Bases: simphony_mayavi.plugins.engine_wrappers.abc_engine_factory.ABCEngineFactory