idstools.compute.tf¶

This module provides compute functions and classes for tf ids data

refer data dictionary.

Module Contents¶

class idstools.compute.tf.TFCompute(ids: object)[source]¶

This class provides compute functions for tf ids.

ids¶

The toroidal field (TF) IDS (Integrated Data Structure) object containing toroidal field coil data including coil geometry, conductors, electrical properties, and mechanical support information.

Type:¶

object

Initialization TFCompute object.

Parameters:¶

ids: object¶

tf ids object

ids¶

get_tf_coils(select_coil=':', select_conductor=':') → dict[source]¶

Retrieve information about the Toroidal Field (TF) coils and their conductors.

Parameters:¶

select_coil=':'¶

A string representing the selection of coils. Defaults to “:” which selects all coils.

select_conductor=':'¶

A string representing the selection of conductors. Defaults to “:” which selects all conductors.

Returns:¶

A dictionary containing information about the selected TF coils and their conductors.

If no coils are found, a warning is logged and None is returned.

Return type:¶

dict

idstools.compute.tf.logger¶