circuit_schemas

BaseCircuitConfiguration

Bases: BaseModel

Base schema for a cable configuration within a circuit.

CircuitConfiguration

Bases: BaseCircuitConfiguration

Circuit configuration that holds a pre-built FDCable instance.

CircuitConfigurationCableNotBuild

Bases: BaseCircuitConfiguration

Circuit configuration where the cable is not pre-constructed.

fd_cable_class property

fd_cable_class: type[FDCable]

Determine FDCable implementation for this configuration.

Returns:

Type	Description
type[FDCable]	type[FDCable]: FDCableTrefoilCircuitInSinglePipe when a trefoil single-pipe configuration is requested, otherwise FDCable.

CircuitConfigurationFromCableId

Bases: CircuitConfigurationCableNotBuild

Circuit configuration where the cable is identified by a string cable ID.

CircuitConfigurationFromCableConstructionalInputSchema

Bases: CircuitConfigurationCableNotBuild

Circuit configuration where the cable is built from a constructional input schema.

BaseCircuitInputSchema

Bases: BaseModel, Generic[BaseCircuitConfigurationT]

Base input schema shared by all circuit types.

Cable

Bases: BaseModel, Generic[CableT]

Schema carrying a pre-built cable instance.

CableId

Bases: BaseModel

Schema identifying a cable by its string ID and source file path.

CircuitInSoilProperties

Bases: BaseModel

Properties for a circuit buried in soil.

CircuitInAirProperties

Bases: BaseModel

Properties for a circuit in air.

CircuitFromCableInputSchema

Bases: BaseCircuitInputSchema[CircuitConfiguration], Cable[CableT], Generic[CableT]

Input schema for the add_circuit_from_cable method of the StaticEnvironment class.

CircuitFromCableConstructionalInputSchema

Bases: BaseCircuitInputSchema[CircuitConfigurationFromCableConstructionalInputSchema]

Input schema used in the StaticEnvironment class.

Input schema for the add_circuit_from_cable_constructional_information method.

CircuitFromCableIdInputSchema

Bases: BaseCircuitInputSchema[CircuitConfigurationFromCableId], CableId

Input schema for the add_circuit_from_cable_id method of the StaticEnvironment class.

CircuitInSoilFromCableInputSchema

Bases: CircuitFromCableInputSchema[FDCable], CircuitInSoilProperties

Input schema for the add_circuit_from_cable method of the StaticEnvironmentSoil class.

CircuitInSoilFromCableConstructionalInputSchema

Bases: CircuitFromCableConstructionalInputSchema, CircuitInSoilProperties

Input schema used in the StaticEnvironmentSoil class.

Input schema for the add_circuit_from_cable_constructional_information method.

CircuitInSoilFromCableIdInputSchema

Bases: CircuitFromCableIdInputSchema, CircuitInSoilProperties

Input schema for the add_circuit_from_cable_id method of the StaticEnvironmentSoil class.

CircuitInAirFromCableInputSchema

Bases: CircuitFromCableInputSchema[FDCableInAir], CircuitInAirProperties

Input schema for the add_circuit_from_cable method of the StaticEnvironmentAir class.

CircuitInAirFromCableConstructionalInputSchema

Bases: CircuitFromCableConstructionalInputSchema, CircuitInAirProperties

Input schema used in the StaticEnvironmentAir class.

Input schema for the add_circuit_from_cable_constructional_information method.

CircuitInAirFromCableIdInputSchema

Bases: CircuitFromCableIdInputSchema, CircuitInAirProperties

Input schema for the add_circuit_from_cable_id method of the StaticEnvironmentAir class.