jarvis.analysis.solarefficiency.solar
=====================================

.. py:module:: jarvis.analysis.solarefficiency.solar

.. autoapi-nested-parse::

   Modules for calculating theoretical solar-cell efficiency.

   Please find more detailsin:
   https://pubs.acs.org/doi/abs/10.1021/acs.chemmater.9b02166



Classes
-------

.. autoapisummary::

   jarvis.analysis.solarefficiency.solar.SolarEfficiency


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

.. py:class:: SolarEfficiency(formalism='slme')

   Bases: :py:obj:`object`


   Calculate theoretical solar-efficiency using SLME or SQ approach.


   .. py:attribute:: formalism
      :value: 'slme'



   .. py:method:: calculate_SQ(bandgap_ev, temperature=300, fr=1, plot_current_voltage=False, filename='sq.png')

      Calcualte efficeincy using shockley queisser formalism.

      Requires only two inputs unlike SLME.
      Args:
            bandgap_ev: bandga in electron-volt

            temperature: temperature in K



   .. py:method:: slme(material_energy_for_absorbance_data, material_absorbance_data, material_direct_allowed_gap, material_indirect_gap, thickness=5e-05, temperature=293.15, absorbance_in_inverse_centimeters=False, cut_off_absorbance_below_direct_allowed_gap=True, plot_current_voltage=False, filename='slme.png')

      Calculate spectroscopic limited maximum efficiency.

      Reuires more info than SQ.
      Args:
          material_energy_for_absorbance_data:
          energy grid for absorbance data

          material_absorbance_data: absorption coefficient in m^-1

          material_direct_allowed_gap: direct bandgap in eV

          material_indirect_gap: indirect bandgap in eV

          thickness: thickness of the material in m

          temperature: working temperature in K

          absorbance_in_inverse_centimeters:
          whether the absorbance data is in the unit of cm^-1

          cut_off_absorbance_below_direct_allowed_gap:
          whether to discard all absorption below bandgap

          plot_current_voltage: whether to plot the current-voltage curve

      Returns:
          The calculated maximum efficiency.