bempp_cl.core.opencl_kernels
============================

.. py:module:: bempp_cl.core.opencl_kernels

.. autoapi-nested-parse::

   OpenCL routines.



Attributes
----------

.. autoapisummary::

   bempp_cl.core.opencl_kernels._CURRENT_PATH
   bempp_cl.core.opencl_kernels._INCLUDE_PATH
   bempp_cl.core.opencl_kernels._KERNEL_PATH
   bempp_cl.core.opencl_kernels._DEFAULT_CPU_DEVICE
   bempp_cl.core.opencl_kernels._DEFAULT_CPU_CONTEXT
   bempp_cl.core.opencl_kernels._DEFAULT_GPU_DEVICE
   bempp_cl.core.opencl_kernels._DEFAULT_GPU_CONTEXT


Functions
---------

.. autoapisummary::

   bempp_cl.core.opencl_kernels.select_cl_kernel
   bempp_cl.core.opencl_kernels.get_kernel_compile_options
   bempp_cl.core.opencl_kernels.build_program
   bempp_cl.core.opencl_kernels.get_kernel_from_operator_descriptor
   bempp_cl.core.opencl_kernels.get_kernel_from_name
   bempp_cl.core.opencl_kernels.get_vector_width
   bempp_cl.core.opencl_kernels.get_vec_string
   bempp_cl.core.opencl_kernels.default_cpu_device
   bempp_cl.core.opencl_kernels.default_gpu_device
   bempp_cl.core.opencl_kernels.default_device
   bempp_cl.core.opencl_kernels.default_context
   bempp_cl.core.opencl_kernels.default_cpu_context
   bempp_cl.core.opencl_kernels.default_gpu_context
   bempp_cl.core.opencl_kernels.find_cpu_driver
   bempp_cl.core.opencl_kernels.find_gpu_driver
   bempp_cl.core.opencl_kernels.set_default_cpu_device_by_name
   bempp_cl.core.opencl_kernels.set_default_cpu_device
   bempp_cl.core.opencl_kernels.set_default_gpu_device_by_name
   bempp_cl.core.opencl_kernels.set_default_gpu_device
   bempp_cl.core.opencl_kernels.show_available_platforms_and_devices
   bempp_cl.core.opencl_kernels.get_native_vector_width


Module Contents
---------------

.. py:data:: _CURRENT_PATH

.. py:data:: _INCLUDE_PATH
   :value: b'.'


.. py:data:: _KERNEL_PATH
   :value: b'.'


.. py:data:: _DEFAULT_CPU_DEVICE
   :value: None


.. py:data:: _DEFAULT_CPU_CONTEXT
   :value: None


.. py:data:: _DEFAULT_GPU_DEVICE
   :value: None


.. py:data:: _DEFAULT_GPU_CONTEXT
   :value: None


.. py:function:: select_cl_kernel(operator_descriptor, mode)

   Select OpenCL kernel.


.. py:function:: get_kernel_compile_options(options, precision)

   Create compiler options from parameters and precision.


.. py:function:: build_program(assembly_function, options, precision, device_type='cpu')

   Build the kernel and return it.


.. py:function:: get_kernel_from_operator_descriptor(operator_descriptor, options, mode, force_novec=False, device_type='cpu')

   Return compiled kernel from operator descriptor.


.. py:function:: get_kernel_from_name(name, options, precision='double', device_type='cpu')

   Return compiled kernel from name.


.. py:function:: get_vector_width(precision, device_type='cpu')

   Return vector width.


.. py:function:: get_vec_string(precision, device_type='cpu')

   Return vectorisation string.


.. py:function:: default_cpu_device()

   Return the default CPU device.


.. py:function:: default_gpu_device()

   Return the default GPU device.


.. py:function:: default_device(device_type='cpu')

   Return default device.


.. py:function:: default_context(device_type='cpu')

   Return the default context


.. py:function:: default_cpu_context()

   Return default CPU context.


.. py:function:: default_gpu_context()

   Return default GPU context.


.. py:function:: find_cpu_driver(name=None)

   Find the first available CPU OpenCL driver.


.. py:function:: find_gpu_driver(name=None)

   Find the first available GPU OpenCL driver.


.. py:function:: set_default_cpu_device_by_name(name)

   Set default CPU device by name.

   This method looks for the given string in the available OpenCL
   drivers and picks the first one that contains the given search
   string.



.. py:function:: set_default_cpu_device(platform_index, device_index)

   Set the default CPU device.


.. py:function:: set_default_gpu_device_by_name(name)

   Set default GPU device by name.

   This method looks for the given string in the available OpenCL
   drivers and picks the first one that contains the given search
   string.



.. py:function:: set_default_gpu_device(platform_index, device_index)

   Set the default GPU device.


.. py:function:: show_available_platforms_and_devices()

   Print available platforms and devices.


.. py:function:: get_native_vector_width(device, precision)

   Get default vector width for device.