piel.models.transient.photonic
==============================

.. py:module:: piel.models.transient.photonic


Submodules
----------

.. toctree::
   :maxdepth: 1

   /autoapi/piel/models/transient/photonic/propagation/index


Functions
---------

.. autoapisummary::

   piel.models.transient.photonic.v_g_from_n_g
   piel.models.transient.photonic.n_g_from_v_g


Package Contents
----------------

.. py:function:: v_g_from_n_g(n_g: float) -> float

       Calculate the Group Velocity (v₉) from the Group Index (n_g).

       The relationship between group velocity and group index is given by the equation:

       \[
       v_g =
   rac{c}{n_g}
       \]

       where:
           - \( v_g \) is the **group velocity** (m/s),
           - \( n_g \) is the **group index** (dimensionless),
           - \( c \) is the **speed of light in vacuum** (m/s).

       **Parameters:**
           n_g (float):
               The group index, representing the factor by which the group velocity is reduced
               relative to the speed of light in vacuum.

       **Returns:**
           float:
               The calculated group velocity in meters per second (m/s).



.. py:function:: n_g_from_v_g(v_g: float) -> float

       Calculate the Group Index (n_g) from the Group Velocity (v₉).

       The relationship between group velocity and group index is given by the equation:

       \[
       n_g =
   rac{c}{v_g}
       \]

       where:
           - \( n_g \) is the **group index** (dimensionless),
           - \( v_g \) is the **group velocity** (m/s),
           - \( c \) is the **speed of light in vacuum** (m/s).

       **Parameters:**
           v_g (float):
               The group velocity in meters per second (m/s).

       **Returns:**
           float:
               The calculated group index (dimensionless).