medypt.maters
=============

.. py:module:: medypt.maters

.. autoapi-nested-parse::

   Classes defining example materials.



Attributes
----------

.. autoapisummary::

   medypt.maters.KB_E
   medypt.maters.M_H2
   medypt.maters.EPS0


Classes
-------

.. autoapisummary::

   medypt.maters.VO2


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

.. py:data:: KB_E
   :value: 8.61733326e-05


   k_B / e in SI units


.. py:data:: M_H2
   :value: 0.332420142


   m / h^2 in unit of eV^-1 nm^-2


.. py:data:: EPS0
   :value: 0.05526349406


   Vacuum permittivity in unit of e V^-1 nm^-1


.. py:class:: VO2

   Class defining required callables (see :py:meth:`~medypt.model.ModelBase.create_problem`) for the material VO2.
       


   .. py:method:: intrinsic_f(T, op, dop)

      Intrinsic free energy density.

      :param T: Temperature in eV.
      :param op: Order parameters (dimensionless), treated as an 1D array with 8 components. First 4 are electronic order parameters,
          last 4 are structural order parameters.
      :param dop: Gradient of order parameters in nm^-1, treated as a 2D array with shape (8, 3).
      :returns: Free energy density in eV / nm^3.



   .. py:method:: trans_strn(op)

      Transformation strain in Voigt notation.

      :param op: Order parameters (dimensionless), treated as an 1D array with 8 components. First 4 are electronic order parameters,
          last 4 are structural order parameters.
      :returns: Transformation strain in Voigt notation as a list with 6 components.



   .. py:method:: charge_gap(op)

      Charge gap.

      :param op: Order parameters (dimensionless), treated as an 1D array with 8 components. First 4 are electronic order parameters,
          last 4 are structural order parameters.
      :returns: Charge gap in eV.