jarvis.analysis.magnetism.magmom_setup
======================================

.. py:module:: jarvis.analysis.magnetism.magmom_setup

.. autoapi-nested-parse::

   Module for setting MAGMOM and AFM/FM orderings.



Classes
-------

.. autoapisummary::

   jarvis.analysis.magnetism.magmom_setup.MagneticOrdering


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

.. py:class:: MagneticOrdering(atoms=None)

   Bases: :py:obj:`object`


   Provide modules for enumerating magnetic ordering analysis.


   .. py:attribute:: atoms
      :value: None



   .. py:method:: apply_symmetry_operations(atoms, spg, tol=0.0001)

      Figure out the effects of all the symmetry operations.



   .. py:method:: get_unique_magnetic_structures(atoms, supercell_dim=[1, 1, 1], magnetic_ions=None, noferri=True, magmom=3.0)

      Generate supercells with unique magnetic orderings.

      noferri=False to get ferrimagnetic configurations.



   .. py:method:: tc_mean_field(energies=[-2, -1])

      Curie temperature using mean-field theory.



   .. py:method:: get_mag_ions()

      List all magnetic atoms in the Atoms object.



   .. py:method:: get_minimum_configs(min_configs=3, enforce_primitive=True)

      Get minimum number of spin structures for Tc calculations.