bluemira.codes.plasmod.api._run

Defines the ‘Run’ stage of the plasmod solver.

Classes

Run

The 'Run' class for plasmod transport solver.

Module Contents

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

Bases: bluemira.codes.interface.CodesTask

Inheritance diagram of bluemira.codes.plasmod.api._run.Run

The ‘Run’ class for plasmod transport solver.

Parameters:

  • params (bluemira.codes.plasmod.params.PlasmodSolverParams) – 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.

  • input_file (str) – The path to the plasmod input file.

  • output_file (str) – The path to which the plasmod scalar output file should be written.

  • profiles_file (str) – The path to which the plasmod profiles output file should be written.

  • directory (str) – The directory to run the code in

  • 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.

params: bluemira.codes.plasmod.params.PlasmodSolverParams
binary = 'plasmod'
input_file
output_file
profiles_file
directory = './'
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).