bluemira.codes._typing

Types for the plasmod module.

Classes

TransportSolver

Form for a transport solver function

Module Contents

class bluemira.codes._typing.TransportSolver

Bases: Protocol

Inheritance diagram of bluemira.codes._typing.TransportSolver

Form for a transport solver function

params: bluemira.codes.params.MappedParameterFrame
execute(run_mode: str | bluemira.codes.interface.BaseRunMode) → bluemira.codes.params.MappedParameterFrame

Execute the solver function

Parameters:

run_mode (str | bluemira.codes.interface.BaseRunMode)

Return type:

bluemira.codes.params.MappedParameterFrame

get_profile(profile: str | bluemira.codes.plasmod.mapping.Profiles) → numpy.ndarray

Gets the profiles for the solver function

Parameters:

profile (str | bluemira.codes.plasmod.mapping.Profiles)

Return type:

numpy.ndarray