:py:mod:`aiida_vasp.assistant.parameters`
=========================================

.. py:module:: aiida_vasp.assistant.parameters

.. autodoc2-docstring:: aiida_vasp.assistant.parameters
   :allowtitles:

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

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`ChargeEnum <aiida_vasp.assistant.parameters.ChargeEnum>`
     - .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ChargeEnum
          :summary:
   * - :py:obj:`IntSmearingEnum <aiida_vasp.assistant.parameters.IntSmearingEnum>`
     - .. autodoc2-docstring:: aiida_vasp.assistant.parameters.IntSmearingEnum
          :summary:
   * - :py:obj:`OrbitEnum <aiida_vasp.assistant.parameters.OrbitEnum>`
     - .. autodoc2-docstring:: aiida_vasp.assistant.parameters.OrbitEnum
          :summary:
   * - :py:obj:`RelaxAlgoEnum <aiida_vasp.assistant.parameters.RelaxAlgoEnum>`
     - .. autodoc2-docstring:: aiida_vasp.assistant.parameters.RelaxAlgoEnum
          :summary:
   * - :py:obj:`RelaxModeEnum <aiida_vasp.assistant.parameters.RelaxModeEnum>`
     - .. autodoc2-docstring:: aiida_vasp.assistant.parameters.RelaxModeEnum
          :summary:
   * - :py:obj:`ParametersMassage <aiida_vasp.assistant.parameters.ParametersMassage>`
     - .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParametersMassage
          :summary:
   * - :py:obj:`ParameterSetFunctions <aiida_vasp.assistant.parameters.ParameterSetFunctions>`
     - .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParameterSetFunctions
          :summary:

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`check_inputs <aiida_vasp.assistant.parameters.check_inputs>`
     - .. autodoc2-docstring:: aiida_vasp.assistant.parameters.check_inputs
          :summary:
   * - :py:obj:`inherit_and_merge_parameters <aiida_vasp.assistant.parameters.inherit_and_merge_parameters>`
     - .. autodoc2-docstring:: aiida_vasp.assistant.parameters.inherit_and_merge_parameters
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`_BASE_NAMESPACES <aiida_vasp.assistant.parameters._BASE_NAMESPACES>`
     - .. autodoc2-docstring:: aiida_vasp.assistant.parameters._BASE_NAMESPACES
          :summary:
   * - :py:obj:`_DEFAULT_OVERRIDE_NAMESPACE <aiida_vasp.assistant.parameters._DEFAULT_OVERRIDE_NAMESPACE>`
     - .. autodoc2-docstring:: aiida_vasp.assistant.parameters._DEFAULT_OVERRIDE_NAMESPACE
          :summary:

API
~~~

.. py:data:: _BASE_NAMESPACES
   :canonical: aiida_vasp.assistant.parameters._BASE_NAMESPACES
   :type: list[str]
   :value: ['electronic', 'smearing', 'charge', 'dynamics', 'bands', 'relax', 'converge']

   .. autodoc2-docstring:: aiida_vasp.assistant.parameters._BASE_NAMESPACES

.. py:data:: _DEFAULT_OVERRIDE_NAMESPACE
   :canonical: aiida_vasp.assistant.parameters._DEFAULT_OVERRIDE_NAMESPACE
   :type: str
   :value: 'incar'

   .. autodoc2-docstring:: aiida_vasp.assistant.parameters._DEFAULT_OVERRIDE_NAMESPACE

.. py:class:: ChargeEnum()
   :canonical: aiida_vasp.assistant.parameters.ChargeEnum

   Bases: :py:obj:`enum.IntEnum`

   .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ChargeEnum

   .. rubric:: Initialization

   .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ChargeEnum.__init__

   .. py:attribute:: WAVE
      :canonical: aiida_vasp.assistant.parameters.ChargeEnum.WAVE
      :value: 0

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ChargeEnum.WAVE

   .. py:attribute:: CHARGE
      :canonical: aiida_vasp.assistant.parameters.ChargeEnum.CHARGE
      :value: 1

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ChargeEnum.CHARGE

   .. py:attribute:: ATOMIC
      :canonical: aiida_vasp.assistant.parameters.ChargeEnum.ATOMIC
      :value: 2

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ChargeEnum.ATOMIC

   .. py:attribute:: POTENTIAL
      :canonical: aiida_vasp.assistant.parameters.ChargeEnum.POTENTIAL
      :value: 4

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ChargeEnum.POTENTIAL

   .. py:attribute:: CONSTANT_CHARGE
      :canonical: aiida_vasp.assistant.parameters.ChargeEnum.CONSTANT_CHARGE
      :value: 11

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ChargeEnum.CONSTANT_CHARGE

   .. py:attribute:: CONSTANT_ATOMIC
      :canonical: aiida_vasp.assistant.parameters.ChargeEnum.CONSTANT_ATOMIC
      :value: 12

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ChargeEnum.CONSTANT_ATOMIC

.. py:class:: IntSmearingEnum()
   :canonical: aiida_vasp.assistant.parameters.IntSmearingEnum

   Bases: :py:obj:`enum.IntEnum`

   .. autodoc2-docstring:: aiida_vasp.assistant.parameters.IntSmearingEnum

   .. rubric:: Initialization

   .. autodoc2-docstring:: aiida_vasp.assistant.parameters.IntSmearingEnum.__init__

   .. py:attribute:: MP
      :canonical: aiida_vasp.assistant.parameters.IntSmearingEnum.MP
      :value: 1

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.IntSmearingEnum.MP

   .. py:attribute:: GAUSSIAN
      :canonical: aiida_vasp.assistant.parameters.IntSmearingEnum.GAUSSIAN
      :value: 0

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.IntSmearingEnum.GAUSSIAN

   .. py:attribute:: FERMI
      :canonical: aiida_vasp.assistant.parameters.IntSmearingEnum.FERMI
      :value: None

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.IntSmearingEnum.FERMI

   .. py:attribute:: PARTIAL
      :canonical: aiida_vasp.assistant.parameters.IntSmearingEnum.PARTIAL
      :value: None

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.IntSmearingEnum.PARTIAL

   .. py:attribute:: TETRA
      :canonical: aiida_vasp.assistant.parameters.IntSmearingEnum.TETRA
      :value: None

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.IntSmearingEnum.TETRA

.. py:class:: OrbitEnum()
   :canonical: aiida_vasp.assistant.parameters.OrbitEnum

   Bases: :py:obj:`enum.IntEnum`

   .. autodoc2-docstring:: aiida_vasp.assistant.parameters.OrbitEnum

   .. rubric:: Initialization

   .. autodoc2-docstring:: aiida_vasp.assistant.parameters.OrbitEnum.__init__

   .. py:attribute:: ATOM
      :canonical: aiida_vasp.assistant.parameters.OrbitEnum.ATOM
      :value: 0

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.OrbitEnum.ATOM

   .. py:attribute:: ATOM_LM
      :canonical: aiida_vasp.assistant.parameters.OrbitEnum.ATOM_LM
      :value: 1

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.OrbitEnum.ATOM_LM

   .. py:attribute:: ATOM_LM_PHASE
      :canonical: aiida_vasp.assistant.parameters.OrbitEnum.ATOM_LM_PHASE
      :value: 2

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.OrbitEnum.ATOM_LM_PHASE

   .. py:attribute:: NO_RWIGS_ATOM
      :canonical: aiida_vasp.assistant.parameters.OrbitEnum.NO_RWIGS_ATOM
      :value: 10

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.OrbitEnum.NO_RWIGS_ATOM

   .. py:attribute:: NO_RWIGS_ATOM_LM
      :canonical: aiida_vasp.assistant.parameters.OrbitEnum.NO_RWIGS_ATOM_LM
      :value: 11

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.OrbitEnum.NO_RWIGS_ATOM_LM

   .. py:attribute:: NO_RWIGS_ATOM_LM_PHASE
      :canonical: aiida_vasp.assistant.parameters.OrbitEnum.NO_RWIGS_ATOM_LM_PHASE
      :value: 12

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.OrbitEnum.NO_RWIGS_ATOM_LM_PHASE

   .. py:attribute:: NO_RWIGS_ATOM_LM_PHASE_AUTO
      :canonical: aiida_vasp.assistant.parameters.OrbitEnum.NO_RWIGS_ATOM_LM_PHASE_AUTO
      :value: 14

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.OrbitEnum.NO_RWIGS_ATOM_LM_PHASE_AUTO

   .. py:attribute:: ATOM_LM_WAVE
      :canonical: aiida_vasp.assistant.parameters.OrbitEnum.ATOM_LM_WAVE
      :value: 5

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.OrbitEnum.ATOM_LM_WAVE

   .. py:method:: get_lorbit_from_combination(**kwargs) -> aiida_vasp.assistant.parameters.OrbitEnum
      :canonical: aiida_vasp.assistant.parameters.OrbitEnum.get_lorbit_from_combination
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.OrbitEnum.get_lorbit_from_combination

.. py:class:: RelaxAlgoEnum()
   :canonical: aiida_vasp.assistant.parameters.RelaxAlgoEnum

   Bases: :py:obj:`enum.IntEnum`

   .. autodoc2-docstring:: aiida_vasp.assistant.parameters.RelaxAlgoEnum

   .. rubric:: Initialization

   .. autodoc2-docstring:: aiida_vasp.assistant.parameters.RelaxAlgoEnum.__init__

   .. py:attribute:: NO_UPDATE
      :canonical: aiida_vasp.assistant.parameters.RelaxAlgoEnum.NO_UPDATE
      :value: None

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.RelaxAlgoEnum.NO_UPDATE

   .. py:attribute:: IONIC_RELAXATION_RMM_DIIS
      :canonical: aiida_vasp.assistant.parameters.RelaxAlgoEnum.IONIC_RELAXATION_RMM_DIIS
      :value: 1

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.RelaxAlgoEnum.IONIC_RELAXATION_RMM_DIIS

   .. py:attribute:: IONIC_RELAXATION_CG
      :canonical: aiida_vasp.assistant.parameters.RelaxAlgoEnum.IONIC_RELAXATION_CG
      :value: 2

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.RelaxAlgoEnum.IONIC_RELAXATION_CG

.. py:class:: RelaxModeEnum()
   :canonical: aiida_vasp.assistant.parameters.RelaxModeEnum

   Bases: :py:obj:`enum.IntEnum`

   .. autodoc2-docstring:: aiida_vasp.assistant.parameters.RelaxModeEnum

   .. rubric:: Initialization

   .. autodoc2-docstring:: aiida_vasp.assistant.parameters.RelaxModeEnum.__init__

   .. py:attribute:: POS_ONLY
      :canonical: aiida_vasp.assistant.parameters.RelaxModeEnum.POS_ONLY
      :value: 2

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.RelaxModeEnum.POS_ONLY

   .. py:attribute:: POS_SHAPE_VOL
      :canonical: aiida_vasp.assistant.parameters.RelaxModeEnum.POS_SHAPE_VOL
      :value: 3

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.RelaxModeEnum.POS_SHAPE_VOL

   .. py:attribute:: POS_SHAPE
      :canonical: aiida_vasp.assistant.parameters.RelaxModeEnum.POS_SHAPE
      :value: 4

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.RelaxModeEnum.POS_SHAPE

   .. py:attribute:: SHAPE_ONLY
      :canonical: aiida_vasp.assistant.parameters.RelaxModeEnum.SHAPE_ONLY
      :value: 5

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.RelaxModeEnum.SHAPE_ONLY

   .. py:attribute:: SHAPE_VOL
      :canonical: aiida_vasp.assistant.parameters.RelaxModeEnum.SHAPE_VOL
      :value: 6

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.RelaxModeEnum.SHAPE_VOL

   .. py:attribute:: VOL_ONLY
      :canonical: aiida_vasp.assistant.parameters.RelaxModeEnum.VOL_ONLY
      :value: 7

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.RelaxModeEnum.VOL_ONLY

   .. py:method:: get_isif_from_dof(**kwargs) -> aiida_vasp.assistant.parameters.RelaxModeEnum
      :canonical: aiida_vasp.assistant.parameters.RelaxModeEnum.get_isif_from_dof
      :classmethod:

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.RelaxModeEnum.get_isif_from_dof

.. py:class:: ParametersMassage(parameters: typing.Any, unsupported_parameters: typing.Any = None, settings: typing.Any = None, skip_parameters_validation: bool = False)
   :canonical: aiida_vasp.assistant.parameters.ParametersMassage

   .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParametersMassage

   .. rubric:: Initialization

   .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParametersMassage.__init__

   .. py:attribute:: _valid_parameters_and_mtime
      :canonical: aiida_vasp.assistant.parameters.ParametersMassage._valid_parameters_and_mtime
      :type: tuple[list[str], int]
      :value: None

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParametersMassage._valid_parameters_and_mtime

   .. py:method:: _check_valid_namespaces() -> None
      :canonical: aiida_vasp.assistant.parameters.ParametersMassage._check_valid_namespaces

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParametersMassage._check_valid_namespaces

   .. py:method:: _load_valid_params() -> None
      :canonical: aiida_vasp.assistant.parameters.ParametersMassage._load_valid_params

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParametersMassage._load_valid_params

   .. py:method:: _fetch_additional_override_namespaces() -> list[str]
      :canonical: aiida_vasp.assistant.parameters.ParametersMassage._fetch_additional_override_namespaces

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParametersMassage._fetch_additional_override_namespaces

   .. py:method:: _set_vasp_parameters() -> None
      :canonical: aiida_vasp.assistant.parameters.ParametersMassage._set_vasp_parameters

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParametersMassage._set_vasp_parameters

   .. py:method:: _set_override_vasp_parameters() -> None
      :canonical: aiida_vasp.assistant.parameters.ParametersMassage._set_override_vasp_parameters

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParametersMassage._set_override_vasp_parameters

   .. py:method:: _set_extra_vasp_parameters() -> None
      :canonical: aiida_vasp.assistant.parameters.ParametersMassage._set_extra_vasp_parameters

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParametersMassage._set_extra_vasp_parameters

   .. py:method:: _set_additional_override_parameters() -> None
      :canonical: aiida_vasp.assistant.parameters.ParametersMassage._set_additional_override_parameters

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParametersMassage._set_additional_override_parameters

   .. py:method:: _valid_vasp_parameter(key: str) -> bool
      :canonical: aiida_vasp.assistant.parameters.ParametersMassage._valid_vasp_parameter

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParametersMassage._valid_vasp_parameter

   .. py:method:: _validate_vasp_parameters() -> None
      :canonical: aiida_vasp.assistant.parameters.ParametersMassage._validate_vasp_parameters

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParametersMassage._validate_vasp_parameters

   .. py:method:: _set(key: str) -> None
      :canonical: aiida_vasp.assistant.parameters.ParametersMassage._set

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParametersMassage._set

   .. py:property:: parameters
      :canonical: aiida_vasp.assistant.parameters.ParametersMassage.parameters
      :type: aiida.common.extendeddicts.AttributeDict

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParametersMassage.parameters

.. py:class:: ParameterSetFunctions(parameters: aiida.common.extendeddicts.AttributeDict, incar: aiida.common.extendeddicts.AttributeDict)
   :canonical: aiida_vasp.assistant.parameters.ParameterSetFunctions

   .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParameterSetFunctions

   .. rubric:: Initialization

   .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParameterSetFunctions.__init__

   .. py:method:: set_encut() -> None
      :canonical: aiida_vasp.assistant.parameters.ParameterSetFunctions.set_encut

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParameterSetFunctions.set_encut

   .. py:method:: set_ibrion() -> None
      :canonical: aiida_vasp.assistant.parameters.ParameterSetFunctions.set_ibrion

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParameterSetFunctions.set_ibrion

   .. py:method:: set_ediffg() -> None
      :canonical: aiida_vasp.assistant.parameters.ParameterSetFunctions.set_ediffg

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParameterSetFunctions.set_ediffg

   .. py:method:: set_nsw() -> None
      :canonical: aiida_vasp.assistant.parameters.ParameterSetFunctions.set_nsw

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParameterSetFunctions.set_nsw

   .. py:method:: set_isif() -> None
      :canonical: aiida_vasp.assistant.parameters.ParameterSetFunctions.set_isif

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParameterSetFunctions.set_isif

   .. py:method:: set_ismear() -> None
      :canonical: aiida_vasp.assistant.parameters.ParameterSetFunctions.set_ismear

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParameterSetFunctions.set_ismear

   .. py:method:: set_icharg() -> None
      :canonical: aiida_vasp.assistant.parameters.ParameterSetFunctions.set_icharg

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParameterSetFunctions.set_icharg

   .. py:method:: set_lorbit() -> None
      :canonical: aiida_vasp.assistant.parameters.ParameterSetFunctions.set_lorbit

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParameterSetFunctions.set_lorbit

   .. py:method:: _set_wigner_seitz_radius() -> None
      :canonical: aiida_vasp.assistant.parameters.ParameterSetFunctions._set_wigner_seitz_radius

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParameterSetFunctions._set_wigner_seitz_radius

   .. py:method:: _relax() -> bool
      :canonical: aiida_vasp.assistant.parameters.ParameterSetFunctions._relax

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParameterSetFunctions._relax

   .. py:method:: _set_simple(target: str, value: typing.Any) -> None
      :canonical: aiida_vasp.assistant.parameters.ParameterSetFunctions._set_simple

      .. autodoc2-docstring:: aiida_vasp.assistant.parameters.ParameterSetFunctions._set_simple

.. py:function:: check_inputs(supplied_inputs: None | aiida.common.extendeddicts.AttributeDict | aiida.orm.Dict | dict) -> aiida.common.extendeddicts.AttributeDict
   :canonical: aiida_vasp.assistant.parameters.check_inputs

   .. autodoc2-docstring:: aiida_vasp.assistant.parameters.check_inputs

.. py:function:: inherit_and_merge_parameters(inputs: dict[str, typing.Any]) -> aiida.common.extendeddicts.AttributeDict
   :canonical: aiida_vasp.assistant.parameters.inherit_and_merge_parameters

   .. autodoc2-docstring:: aiida_vasp.assistant.parameters.inherit_and_merge_parameters