:py:mod:`aiida_lammps.workflows.relax`
======================================

.. py:module:: aiida_lammps.workflows.relax

.. autodoc2-docstring:: aiida_lammps.workflows.relax
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`LammpsRelaxWorkChain <aiida_lammps.workflows.relax.LammpsRelaxWorkChain>`
     - .. autodoc2-docstring:: aiida_lammps.workflows.relax.LammpsRelaxWorkChain
          :summary:

API
~~~

.. py:class:: LammpsRelaxWorkChain(inputs: dict | None = None, logger: logging.Logger | None = None, runner: aiida.engine.runners.Runner | None = None, enable_persistence: bool = True)
   :canonical: aiida_lammps.workflows.relax.LammpsRelaxWorkChain

   Bases: :py:obj:`aiida.engine.WorkChain`

   .. autodoc2-docstring:: aiida_lammps.workflows.relax.LammpsRelaxWorkChain

   .. rubric:: Initialization

   .. autodoc2-docstring:: aiida_lammps.workflows.relax.LammpsRelaxWorkChain.__init__

   .. py:method:: define(spec)
      :canonical: aiida_lammps.workflows.relax.LammpsRelaxWorkChain.define
      :classmethod:

      .. autodoc2-docstring:: aiida_lammps.workflows.relax.LammpsRelaxWorkChain.define

   .. py:method:: validate_inputs(value, ctx) -> typing.Union[str, None]
      :canonical: aiida_lammps.workflows.relax.LammpsRelaxWorkChain.validate_inputs
      :classmethod:

      .. autodoc2-docstring:: aiida_lammps.workflows.relax.LammpsRelaxWorkChain.validate_inputs

   .. py:method:: setup()
      :canonical: aiida_lammps.workflows.relax.LammpsRelaxWorkChain.setup

      .. autodoc2-docstring:: aiida_lammps.workflows.relax.LammpsRelaxWorkChain.setup

   .. py:method:: should_run_relax()
      :canonical: aiida_lammps.workflows.relax.LammpsRelaxWorkChain.should_run_relax

      .. autodoc2-docstring:: aiida_lammps.workflows.relax.LammpsRelaxWorkChain.should_run_relax

   .. py:method:: run_relax()
      :canonical: aiida_lammps.workflows.relax.LammpsRelaxWorkChain.run_relax

      .. autodoc2-docstring:: aiida_lammps.workflows.relax.LammpsRelaxWorkChain.run_relax

   .. py:method:: inspect_relax()
      :canonical: aiida_lammps.workflows.relax.LammpsRelaxWorkChain.inspect_relax

      .. autodoc2-docstring:: aiida_lammps.workflows.relax.LammpsRelaxWorkChain.inspect_relax

   .. py:method:: results()
      :canonical: aiida_lammps.workflows.relax.LammpsRelaxWorkChain.results

      .. autodoc2-docstring:: aiida_lammps.workflows.relax.LammpsRelaxWorkChain.results
