:py:mod:`pemtk.sym._dipoleTerms`
================================

.. py:module:: pemtk.sym._dipoleTerms

.. autoapi-nested-parse::

   Compute dipole terms and allowed product functions for libmsym and symmetrized harmonics routines.

   17/04/23 v1



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


Functions
~~~~~~~~~

.. autoapisummary::

   pemtk.sym._dipoleTerms.dipoleTermsSymHarm
   pemtk.sym._dipoleTerms.allowedProductsTable
   pemtk.sym._dipoleTerms.assignSymMuTerms
   pemtk.sym._dipoleTerms.assignMissingSym
   pemtk.sym._dipoleTerms.assignMissingSymProd



.. py:function:: dipoleTermsSymHarm(self, reCartMap={-1: 'y', 0: 'z', 1: 'x'}, dimMap={'C': 'Cont', 'mu': 'it'})

   Compute dipole terms from symHarm object.


.. py:function:: allowedProductsTable(self)

   Compute allowed continuum X dipole terms.


.. py:function:: assignSymMuTerms(self, keyDim='Cont', dataType='matE', dimMap=None, dataTypeOut='symAllowed')

   Assign matrix elements from dipole-allowed symmetries, and associated mu values.

   20/04/23 v2 - use self.continuum instead of basic direct product for assignments
   18/04/23 v1



.. py:function:: assignMissingSym(self, dim, values, dataType='matE', multiInd='Sym')

   Replace values in dim, for levels of a (Symmetry style) MultiIndex.

   Use this to change symmetry labels, e.g. to replace missing symmetries assigned as 'U'.

   :param dim: Dimension to replace, from matE dataType.
               Can be ['Cont','Targ','Total']
   :type dim: str
   :param values: If string, all values are replace by this.
                  If list or array must match size of existing coords.
   :type values: str, list or array
   :param dataType: DataType to use, from self.coeffs[dataType]
                    Must correspond to Xarray variable with multiInd present.
   :type dataType: str, optional, default = 'matE'
   :param multiInd: MultiIndex containing levels to replace.
   :type multiInd: str, optional, default = 'Sym'


.. py:function:: assignMissingSymProd(self, dim='Total', dataType='matE', multiIndName='Sym')

   Assign missing symmetry label as direct product of other existing labels.

   For a given dimension, assign values from other dims of the same multiindex set.

   :param dim: Dimension to replace, from matE dataType.
               For usual matrix elements definition this can be ['Cont','Targ','Total']
   :type dim: str, default = 'Total'
   :param dataType: DataType to use, from self.coeffs[dataType]
                    Must correspond to Xarray variable with multiInd present.
   :type dataType: str, optional, default = 'matE'
   :param multiIndName: MultiIndex containing levels to replace.
   :type multiIndName: str, optional, default = 'Sym'

   .. rubric:: Notes

   Default case uses dim = 'Total', dataType = 'matE', multiIndName = 'Sym'.
   Sym contains dims 'Sym': ['Cont', 'Targ', 'Total']
   (See ep.dataTypesList())