bluemira.codes.wrapper

Bluemira External Codes Wrapper

Functions

systems_code_solver(→ bluemira.codes.interface.CodesSolver)

Runs, reads or mocks systems code according to the build configuration dictionary.

transport_code_solver(...)

Transport solver

neutronics_code_solver(...)

Neutronics solver

Module Contents

bluemira.codes.wrapper.systems_code_solver(params: bluemira.base.parameter_frame.Parameter, build_config: bluemira.base.builder.BuildConfig, module: str = 'PROCESS', params_cls: type[bluemira.codes.params.MappedParameterFrame] | None = None) → bluemira.codes.interface.CodesSolver

Runs, reads or mocks systems code according to the build configuration dictionary.

Parameters:

  • params (bluemira.base.parameter_frame.Parameter) – ParameterFrame for code

  • build_config (bluemira.base.builder.BuildConfig) – build configuration dictionary

  • module (str) – Module to use

  • params_cls (type[bluemira.codes.params.MappedParameterFrame] | None) – A custom MappedParameterFrame to be used by the systems code solver. If not provided, the default one will be used.

Returns:

The solver that has been run.

Raises:

CodesError – If the system code is not being mocked and is not installed, or there is a problem running the system code.

Return type:

bluemira.codes.interface.CodesSolver

bluemira.codes.wrapper.transport_code_solver(params: bluemira.base.parameter_frame.Parameter, build_config: bluemira.base.builder.BuildConfig, module: str = 'PLASMOD') → bluemira.codes._typing.TransportSolver

Transport solver

Parameters:

  • params (bluemira.base.parameter_frame.Parameter) – ParameterFrame for plasmod

  • build_config (bluemira.base.builder.BuildConfig) – build configuration dictionary

  • module (str) – Module to use

Returns:

The solver object to be run

Return type:

bluemira.codes._typing.TransportSolver

bluemira.codes.wrapper.neutronics_code_solver(params: bluemira.base.parameter_frame.Parameter, build_config: bluemira.base.builder.BuildConfig, neutronics_model, eq: bluemira.equilibria.equilibrium.Equilibrium, source: bluemira.codes.openmc.solver.NeutronSourceCreator, op_cond: matproplib.conditions.OperationalConditions, tally_function=None, module: str = 'OPENMC') → bluemira.codes.interface.CodesSolver

Neutronics solver

Parameters:

  • params (bluemira.base.parameter_frame.Parameter) – ParameterFrame for neutronics code

  • build_config (bluemira.base.builder.BuildConfig) – build configuration dictionary

  • module (str) – Module to use

  • eq (bluemira.equilibria.equilibrium.Equilibrium)

  • source (bluemira.codes.openmc.solver.NeutronSourceCreator)

  • op_cond (matproplib.conditions.OperationalConditions)

Returns:

The solver object to be run

Return type:

bluemira.codes.interface.CodesSolver