.. _The_Dipole_class:

The Dipole class
================

*Dipole* is a variable class (not a handle class!).

.. warning::

    Unlike *handle* classes, with a *variable* class, the methods do not modify the object itself. For instance, :matlab:`DI.moveTo('x',1e-6)` does not affect ``DI``. One should write :matlab:`DI = DI.moveTo('x',1e-6);` or  :matlab:`DI2 = DI.moveTo('x',1e-6);`.


Properties
----------

.. list-table:: Public properties
    :widths: 30 30 30 100 
    :header-rows: 1
    :align: center

    * - name
      - type
      - default
      - description
    * - ``mat``
      - *char*
      - 'none'
      - nanoparticle material
    * - ``r``
      - double
      - 0
      - nanoparticle radius  
    * - ``eps``
      - *double*
      - 
      - complex permittivity of the material
    * - ``n``
      - *double*
      - 
      - complex refractive index of the material
    * - ``p``
      - *double*
      - 
      - electric dipolar moment
    * - ``EE0``
      - *double*
      - 
      - local electric field experienced by the dipole
    * - ``x``
      - *double*
      - 0
      - x position of the dipole [m]
    * - ``y``
      - *double*
      - 0
      - y position of the dipole [m]
    * - ``z``
      - *double*
      - ``r``
      - z position of the dipole [m]
    * - ``n_ext``
      - *double*
      - 
      - refractive index of the surroundings


.. list-table:: Read-only properties
    :widths: 30 30 30 100 
    :header-rows: 1
    :align: center

    * - name
      - type
      - dependence
      - description
    * - ``lambda``
      - double
      - 
      - wavelength of illumination
    * - ``pos``
      - (3,1) double
      - 
      - position vector [x,y,z]
    * - ``alphaMie``
      - complex
      - 
      - Mie complex polarizability
    * - ``CextMie``
      - double
      - 
      - Mie extinction cross section
    * - ``CscaMie``
      - 
      - 
      - Mie scattering cross section
    * - ``CabsMie``
      - double
      - 
      - Mie absprotion cross section


.. include:: Dipole/Dipole_constructor.txt


.. include:: Dipole/Dipole_methods.txt