polymerist.mdtools.lammpstools.unitstyles
=========================================

.. py:module:: polymerist.mdtools.lammpstools.unitstyles

.. autoapi-nested-parse::

   Reference for LAMMPS unit styles, as listed in https://docs.lammps.org/units.html



Classes
-------

.. autoapisummary::

   polymerist.mdtools.lammpstools.unitstyles.LAMMPSUnitStyle
   polymerist.mdtools.lammpstools.unitstyles.LAMMPSUnitStyleReal
   polymerist.mdtools.lammpstools.unitstyles.LAMMPSUnitStyleMetal
   polymerist.mdtools.lammpstools.unitstyles.LAMMPSUnitStyleSI
   polymerist.mdtools.lammpstools.unitstyles.LAMMPSUnitStyleCGS
   polymerist.mdtools.lammpstools.unitstyles.LAMMPSUnitStyleElectron
   polymerist.mdtools.lammpstools.unitstyles.LAMMPSUnitStyleMicro
   polymerist.mdtools.lammpstools.unitstyles.LAMMPSUnitStyleNano


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

.. py:class:: LAMMPSUnitStyle

   For encapsulating which units a particular LAMMPS unit style uses


   .. py:attribute:: STYLE_NAME
      :type:  ClassVar[str]
      :value: 'BASE'



   .. py:attribute:: mass
      :type:  openmm.unit.Unit


   .. py:attribute:: distance
      :type:  openmm.unit.Unit


   .. py:attribute:: time
      :type:  openmm.unit.Unit


   .. py:attribute:: energy
      :type:  openmm.unit.Unit


   .. py:attribute:: velocity
      :type:  openmm.unit.Unit


   .. py:attribute:: force
      :type:  openmm.unit.Unit


   .. py:attribute:: torque
      :type:  openmm.unit.Unit


   .. py:attribute:: temperature
      :type:  openmm.unit.Unit


   .. py:attribute:: pressure
      :type:  openmm.unit.Unit


   .. py:attribute:: dynamic_viscosity
      :type:  openmm.unit.Unit


   .. py:attribute:: charge
      :type:  openmm.unit.Unit


   .. py:attribute:: dipole_moment
      :type:  openmm.unit.Unit


   .. py:attribute:: electric_field
      :type:  openmm.unit.Unit


   .. py:attribute:: density
      :type:  openmm.unit.Unit


   .. py:attribute:: dt
      :type:  openmm.unit.Quantity


   .. py:attribute:: skin
      :type:  openmm.unit.Quantity


.. py:class:: LAMMPSUnitStyleReal

   Bases: :py:obj:`LAMMPSUnitStyle`


   For encapsulating which units a particular LAMMPS unit style uses


   .. py:attribute:: STYLE_NAME
      :value: 'real'



   .. py:attribute:: mass


   .. py:attribute:: distance


   .. py:attribute:: time


   .. py:attribute:: energy


   .. py:attribute:: velocity


   .. py:attribute:: force


   .. py:attribute:: torque


   .. py:attribute:: temperature


   .. py:attribute:: pressure


   .. py:attribute:: dynamic_viscosity


   .. py:attribute:: charge


   .. py:attribute:: dipole_moment


   .. py:attribute:: electric_field


   .. py:attribute:: density


   .. py:attribute:: dt


   .. py:attribute:: skin


.. py:class:: LAMMPSUnitStyleMetal

   Bases: :py:obj:`LAMMPSUnitStyle`


   For encapsulating which units a particular LAMMPS unit style uses


   .. py:attribute:: STYLE_NAME
      :value: 'metal'



   .. py:attribute:: mass


   .. py:attribute:: distance


   .. py:attribute:: time


   .. py:attribute:: energy


   .. py:attribute:: velocity


   .. py:attribute:: force


   .. py:attribute:: torque


   .. py:attribute:: temperature


   .. py:attribute:: pressure


   .. py:attribute:: dynamic_viscosity


   .. py:attribute:: charge


   .. py:attribute:: dipole_moment


   .. py:attribute:: electric_field


   .. py:attribute:: density


   .. py:attribute:: dt


   .. py:attribute:: skin


.. py:class:: LAMMPSUnitStyleSI

   Bases: :py:obj:`LAMMPSUnitStyle`


   For encapsulating which units a particular LAMMPS unit style uses


   .. py:attribute:: STYLE_NAME
      :value: 'si'



   .. py:attribute:: mass


   .. py:attribute:: distance


   .. py:attribute:: time


   .. py:attribute:: energy


   .. py:attribute:: velocity


   .. py:attribute:: force


   .. py:attribute:: torque


   .. py:attribute:: temperature


   .. py:attribute:: pressure


   .. py:attribute:: dynamic_viscosity


   .. py:attribute:: charge


   .. py:attribute:: dipole_moment


   .. py:attribute:: electric_field


   .. py:attribute:: density


   .. py:attribute:: dt


   .. py:attribute:: skin


.. py:class:: LAMMPSUnitStyleCGS

   Bases: :py:obj:`LAMMPSUnitStyle`


   For encapsulating which units a particular LAMMPS unit style uses


   .. py:attribute:: STYLE_NAME
      :value: 'cgs'



   .. py:attribute:: mass


   .. py:attribute:: distance


   .. py:attribute:: time


   .. py:attribute:: energy


   .. py:attribute:: velocity


   .. py:attribute:: force


   .. py:attribute:: torque


   .. py:attribute:: temperature


   .. py:attribute:: pressure


   .. py:attribute:: dynamic_viscosity


   .. py:attribute:: charge


   .. py:attribute:: dipole_moment


   .. py:attribute:: electric_field


   .. py:attribute:: density


   .. py:attribute:: dt


   .. py:attribute:: skin


.. py:class:: LAMMPSUnitStyleElectron

   Bases: :py:obj:`LAMMPSUnitStyle`


   For encapsulating which units a particular LAMMPS unit style uses


   .. py:attribute:: STYLE_NAME
      :value: 'electron'



   .. py:attribute:: mass


   .. py:attribute:: distance


   .. py:attribute:: time


   .. py:attribute:: energy


   .. py:attribute:: velocity


   .. py:attribute:: force


   .. py:attribute:: temperature


   .. py:attribute:: pressure


   .. py:attribute:: charge


   .. py:attribute:: dipole_moment


   .. py:attribute:: electric_field


   .. py:attribute:: density
      :value: None



   .. py:attribute:: dt


   .. py:attribute:: skin


.. py:class:: LAMMPSUnitStyleMicro

   Bases: :py:obj:`LAMMPSUnitStyle`


   For encapsulating which units a particular LAMMPS unit style uses


   .. py:attribute:: STYLE_NAME
      :value: 'micro'



   .. py:attribute:: mass


   .. py:attribute:: distance


   .. py:attribute:: time


   .. py:attribute:: energy


   .. py:attribute:: velocity


   .. py:attribute:: force


   .. py:attribute:: torque


   .. py:attribute:: temperature


   .. py:attribute:: pressure


   .. py:attribute:: dynamic_viscosity


   .. py:attribute:: charge


   .. py:attribute:: dipole


   .. py:attribute:: electric_field


   .. py:attribute:: density


   .. py:attribute:: dt


   .. py:attribute:: skin


.. py:class:: LAMMPSUnitStyleNano

   Bases: :py:obj:`LAMMPSUnitStyle`


   For encapsulating which units a particular LAMMPS unit style uses


   .. py:attribute:: STYLE_NAME
      :value: 'nano'



   .. py:attribute:: mass


   .. py:attribute:: distance


   .. py:attribute:: time


   .. py:attribute:: energy


   .. py:attribute:: velocity


   .. py:attribute:: force


   .. py:attribute:: torque


   .. py:attribute:: temperature


   .. py:attribute:: pressure


   .. py:attribute:: dynamic_viscosity


   .. py:attribute:: charge


   .. py:attribute:: dipole


   .. py:attribute:: electric_field


   .. py:attribute:: density


   .. py:attribute:: dt


   .. py:attribute:: skin