Choose which Viskores devices VTK's accelerated filters run on.
VTK built with several Viskores devices – CUDA and TBB, say – runs each Viskores filter on the best one available. vtkmDeviceSelection lets that choice be made explicitly: force one device, disable or re-enable a device, or go back to the default.
Devices are named as Viskores names them, ignoring case: "Serial", "Cuda", "TBB", "OpenMP", "Kokkos". A request naming a device Viskores does not know is refused with a warning and leaves the selection as it was. So is forcing or enabling a device this build or machine cannot run; disabling one succeeds, since it was not running anyway.
- Warning
- The selection is per thread, as Viskores' runtime device tracker is: it applies to filters executed on the thread that made it. A thread starts from a copy of the first thread to use Viskores – usually the main thread – taken when it first runs a Viskores filter, so a selection made on the main thread before then is inherited, and later changes are not.
Definition at line 33 of file vtkmDeviceSelection.h.
|
| virtual vtkTypeBool | IsA (const char *type) |
| | Return 1 if this class is the same type of (or a subclass of) the named class.
|
| vtkmDeviceSelection * | NewInstance () const |
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| | Methods invoked by print to print information about the object including superclasses.
|
| | vtkBaseTypeMacro (vtkObject, vtkObjectBase) |
| virtual void | DebugOn () |
| | Turn debugging output on.
|
| virtual void | DebugOff () |
| | Turn debugging output off.
|
| bool | GetDebug () |
| | Get the value of the debug flag.
|
| void | SetDebug (bool debugFlag) |
| | Set the value of the debug flag.
|
| virtual void | Modified () |
| | Update the modification time for this object.
|
| virtual vtkMTimeType | GetMTime () |
| | Return this object's modified time.
|
| void | PrintSelf (ostream &os, vtkIndent indent) override |
| | Methods invoked by print to print information about the object including superclasses.
|
| void | RemoveObserver (unsigned long tag) |
| void | RemoveObservers (unsigned long event) |
| void | RemoveObservers (const char *event) |
| void | RemoveAllObservers () |
| vtkTypeBool | HasObserver (unsigned long event) |
| vtkTypeBool | HasObserver (const char *event) |
| vtkTypeBool | InvokeEvent (unsigned long event) |
| vtkTypeBool | InvokeEvent (const char *event) |
| std::string | GetObjectDescription () const override |
| | The object description printed in messages and PrintSelf output.
|
| unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| vtkCommand * | GetCommand (unsigned long tag) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| void | RemoveObserver (vtkCommand *) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| void | RemoveObservers (unsigned long event, vtkCommand *) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| void | RemoveObservers (const char *event, vtkCommand *) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
| | Allow people to add/remove/invoke observers (callbacks) to any VTK object.
|
| template<class U, class T> |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
| | Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
|
| template<class U, class T> |
| unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| | Overloads to AddObserver that allow developers to add class member functions as callbacks for events.
|
| template<class U, class T> |
| unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
| | Allow user to set the AbortFlagOn() with the return value of the callback method.
|
| vtkTypeBool | InvokeEvent (unsigned long event, void *callData) |
| | This method invokes an event and return whether the event was aborted or not.
|
| vtkTypeBool | InvokeEvent (const char *event, void *callData) |
| | This method invokes an event and return whether the event was aborted or not.
|
| virtual void | SetObjectName (const std::string &objectName) |
| | Set/get the name of this object for reporting purposes.
|
| virtual std::string | GetObjectName () const |
| | Set/get the name of this object for reporting purposes.
|
| const char * | GetClassName () const |
| | Return the class name as a string.
|
| virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
| | Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
|
| virtual void | Delete () |
| | Delete a VTK object.
|
| virtual void | FastDelete () |
| | Delete a reference to this object.
|
| void | InitializeObjectBase () |
| void | Print (ostream &os) |
| | Print an object to an ostream.
|
| void | Register (vtkObjectBase *o) |
| | Increase the reference count (mark as used by another object).
|
| virtual void | UnRegister (vtkObjectBase *o) |
| | Decrease the reference count (release by another object).
|
| int | GetReferenceCount () |
| | Return the current reference count of this object.
|
| void | SetReferenceCount (int) |
| | Sets the reference count.
|
| bool | GetIsInMemkind () const |
| | A local state flag that remembers whether this object lives in the normal or extended memory space.
|
| virtual void | PrintHeader (ostream &os, vtkIndent indent) |
| | Methods invoked by print to print information about the object including superclasses.
|
| virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
| | Methods invoked by print to print information about the object including superclasses.
|
| virtual bool | UsesGarbageCollector () const |
| | Indicate whether the class uses vtkGarbageCollector or not.
|
|
| static vtkmDeviceSelection * | New () |
| static vtkTypeBool | IsTypeOf (const char *type) |
| static vtkmDeviceSelection * | SafeDownCast (vtkObjectBase *o) |
| static bool | ForceDevice (const char *name) |
| | Run on name only, disabling every other device.
|
| static bool | DisableDevice (const char *name) |
| | Stop running on name; other devices are unaffected.
|
| static bool | EnableDevice (const char *name) |
| | Undo ForceDevice() or DisableDevice() for name, making it available again.
|
| static void | Reset () |
| | Make every device this build and machine can run available again.
|
| static const char * | GetAvailableDevices () |
| | The devices filters can currently run on, separated by spaces.
|
| static vtkObject * | New () |
| | Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
|
| static void | BreakOnError () |
| | This method is called when vtkErrorMacro executes.
|
| static void | SetGlobalWarningDisplay (vtkTypeBool val) |
| | This is a global flag that controls whether any debug, warning or error messages are displayed.
|
| static void | GlobalWarningDisplayOn () |
| | This is a global flag that controls whether any debug, warning or error messages are displayed.
|
| static void | GlobalWarningDisplayOff () |
| | This is a global flag that controls whether any debug, warning or error messages are displayed.
|
| static vtkTypeBool | GetGlobalWarningDisplay () |
| | This is a global flag that controls whether any debug, warning or error messages are displayed.
|
| static vtkTypeBool | IsTypeOf (const char *name) |
| | Return 1 if this class type is the same type of (or a subclass of) the named class.
|
| static vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
| | Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
|
| static vtkObjectBase * | New () |
| | Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
|
| static void | SetMemkindDirectory (const char *directoryname) |
| | The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
|
| static bool | GetUsingMemkind () |
| | A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
|
1.16.1