Skip to content

power_balance.modelica_templating.pfmagnets#

Source: power_balance/modelica_templating/pfmagnets.py

            Power Balance Models PFMagnet Templating

Creates template entries for multiple PF Magnets in Magnets model using parameter sets

generate_pfmagnets#

generate_pfmagnets(parameter_set: power_balance.parameters.PBMParameterSet) -> str
Source: power_balance/modelica_templating/pfmagnets.py

Generate a new script for the Magnets model using templating In cases where the number of PF magnets specified exceeds the default 6, this function generates a new Modelica script appending these additional magnets to the model.

Parameters#

  • parameter_set: power_balance.parameters.PBMParameterSet

    parameter set to read PF magnet specifications from

Returns#

  • str

    rendered magnet model Modelica script

get_pfmagnet_ids_from_params#

get_pfmagnet_ids_from_params(parameter_set: power_balance.parameters.PBMParameterSet) -> List[int]
Source: power_balance/modelica_templating/pfmagnets.py

Extracts the IDs of PF magnets within the current parameter set

Parameters#

  • parameter_set: power_balance.parameters.PBMParameterSet

    parameter set containing PF magnet parameters

Returns#

  • typing.List

    list of IDs for PF magnet parameters in the parameter set


Last update: April 1, 2022