seapy.junctions.junction.Junction

class seapy.junctions.junction.Junction(name, system, shape, **properties)

Bases: seapy.base.Base

Class for junctions between components.

__init__(name, system, shape, **properties)

Constructor.

Parameters:

• name (string) – Identifier
• system (SeaPy.system.System) – System

Methods

__init__(name, system, shape, **properties)	Constructor.
addComponent(component)	Add component to junction.
addCoupling(subsystem_from, subsystem_to[, name])	Add coupling to junction.
addCouplingManual(name, model, ...)	Add a coupling to the junction, specifying manually which model to use for the coupling.
Junction.df
disable([couplings])	Disable this junction.
enable([couplings])	Enable this junction.
info([attributes])	Return dataframe.
plot(quantity[, yscale])	Plot quantity.
removeComponent(component)	Remove component from junction.
removeCoupling(coupling)	Remove coupling from junction.
updateCouplings()	Update couplings.

Attributes

SORT	str(object=’‘) -> str
classname	Name of class of the object.
components	Components that are part of this junction.
enabled	Switch indicating whether the object is enabled.
frequency	Frequency.
impedance	Total impedance at the coupling.
included	Indicates whether the object is included in the analysis.
linked_couplings
name
shape	Shape of the junction.
subsystems	Subsystems that are used in this junction.
subsystems_available	All available subsystems in this junction.

__init__(name, system, shape, **properties)

Constructor.

Parameters:

• name (string) – Identifier
• system (SeaPy.system.System) – System

addComponent(component)

Add component to junction.

addCoupling(subsystem_from, subsystem_to, name=None, **properties)

Add coupling to junction.

Parameters:

• subsystem_from – Subsystem from
• subsystem_to – Subsystem to

addCouplingManual(name, model, subsystem_from, subsystem_to, **properties)

Add a coupling to the junction, specifying manually which model to use for the coupling.

Parameters:

• name – Name of coupling.
• model – Model or type of coupling. See seapy.couplings.couplings_map.
• properties – Other properties. Note that subsystem_from and subsystem_to are required.

components

Components that are part of this junction.

disable(couplings=False)

Disable this junction. Optionally disable junctions’ couplings.

Parameters:couplings (bool) – Disable couplings

enable(couplings=False)

Enable this junction. Optionally enable junctions’ couplings.

Parameters:couplings (bool) – Enable couplings

impedance

Total impedance at the coupling.

Return type:numpy.ndarray

linked_couplings = <generator object __get__ at 0x7f6dee2d83f0>

All couplings.

removeComponent(component)

Remove component from junction.

Parameters:component – Component to be removed.

removeCoupling(coupling)

Remove coupling from junction.

shape

Shape of the junction.

See also

seapy.junctions.junction_shapes

subsystems

Subsystems that are used in this junction.

Returns:Generator

See also

subsystems_available()

subsystems_available

All available subsystems in this junction.

Returns:Generator

The method subsystems() lists all the subsystems that are used in couplings in this junction. This method lists all the subsystems that are part of the components in this junction. It therefore also includes subsystems that are not coupled to others.

See also

subsystems()

updateCouplings()

Update couplings.

Attention

List of couplings should already be kept up to date. Is it neccessary to expose this function?