bluemira.codes.plasmod.api._run
===============================

.. py:module:: bluemira.codes.plasmod.api._run

.. autoapi-nested-parse::

   Defines the 'Run' stage of the plasmod solver.



Classes
-------

.. autoapisummary::

   bluemira.codes.plasmod.api._run.Run


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

.. py:class:: Run(params: bluemira.codes.plasmod.params.PlasmodSolverParams, input_file: str, output_file: str, profiles_file: str, directory: str = './', binary=PLASMOD_BINARY)

   Bases: :py:obj:`bluemira.codes.interface.CodesTask`

   .. autoapi-inheritance-diagram:: bluemira.codes.plasmod.api._run.Run
      :parts: 1
      :private-bases:


   The 'Run' class for plasmod transport solver.

   :param params: The bluemira parameters for the task. Note that this task does
                  not apply any mappings to the ParameterFrame, so they should
                  already be set. Most likely by a solver.
   :param input_file: The path to the plasmod input file.
   :param output_file: The path to which the plasmod scalar output file should be
                       written.
   :param profiles_file: The path to which the plasmod profiles output file should be
                         written.
   :param directory: The directory to run the code in
   :param binary: The name of, or path to, the plasmod binary. If this is not an
                  absolute path, the binary must be on the system path.


   .. py:attribute:: params
      :type:  bluemira.codes.plasmod.params.PlasmodSolverParams


   .. py:attribute:: binary
      :value: 'plasmod'



   .. py:attribute:: input_file


   .. py:attribute:: output_file


   .. py:attribute:: profiles_file


   .. py:attribute:: directory
      :value: './'



   .. py:method:: run()

      Run the plasmod shell task.

      Runs plasmod on the command line using the given input files and
      output path.

      :raises CodesError: If the subprocess returns a non-zero exit code or raises an
          OSError (e.g., the plasmod binary does not exist).