Class MutualInductance

A mutual inductance between two inductors.

Inheritance

object

ParameterSet

ParameterSetCollection

Entity

Entity<Parameters>

MutualInductance

Implements

IEntity

IParameterSetCollection

IParameterSet

ICloneable<IEntity>

IParameterized<Parameters>

Inherited Members

Entity<Parameters>.Parameters

Entity<Parameters>.Clone()

Entity.LinkParameters

Entity.Name

Entity.SetParameter(string, P)

Entity.ToString()

ParameterSetCollection.GetParameterSet()

ParameterSetCollection.TryGetParameterSet(out P)

ParameterSetCollection.ParameterSets

ParameterSetCollection.TrySetParameter(string, P)

ParameterSetCollection.GetProperty(string)

ParameterSetCollection.TryGetProperty(string, out P)

ParameterSetCollection.CreateParameterSetter(string)

ParameterSetCollection.CreatePropertyGetter(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: SpiceSharp.Components

Assembly: SpiceSharp.dll

Syntax

public class MutualInductance : Entity<Parameters>, IEntity, IParameterSetCollection, IParameterSet, ICloneable<IEntity>, IParameterized<Parameters>

Constructors

MutualInductance(string)

Initializes a new instance of the MutualInductance class.

Declaration

public MutualInductance(string name)

Parameters

Type	Name	Description
string	name	The name of the mutual inductance specification.

Exceptions

Type	Condition
ArgumentNullException	Thrown if `name` is `null`.

MutualInductance(string, string, string, double)

Initializes a new instance of the MutualInductance class.

Declaration

public MutualInductance(string name, string inductorName1, string inductorName2, double coupling)

Parameters

Type	Name	Description
string	name	The name of the mutual inductance specification.
string	inductorName1	The name of the first/primary inductor.
string	inductorName2	The name of the second/secondary inductor.
double	coupling	The coupling coefficient.

Exceptions

Type	Condition
ArgumentNullException	Thrown if `name` is `null`.

Properties

InductorName1

Gets or sets the name of the first/primary inductor.

Declaration

[ParameterName("inductor1")]
[ParameterName("primary")]
[ParameterInfo("First coupled inductor")]
public string InductorName1 { get; set; }

Property Value

Type	Description
string	The name of the first/primary inductor.

InductorName2

Gets or sets the name of the second/secondary inductor.

Declaration

[ParameterName("inductor2")]
[ParameterName("secondary")]
[ParameterInfo("Second coupled inductor")]
public string InductorName2 { get; set; }

Property Value

Type	Description
string	The name of the second/secondary inductor.

Methods

CreateBehaviors(ISimulation)

Creates the behaviors and stores them in the specified container.

Declaration

public override void CreateBehaviors(ISimulation simulation)

Parameters

Type	Name	Description
ISimulation	simulation	The simulation.

Overrides

Entity.CreateBehaviors(ISimulation)

Exceptions

Type	Condition
ArgumentNullException	Thrown if `simulation` is `null`.
ArgumentException	Thrown if the simulation does not use an IComplexSimulationState.
TypeNotFoundException	Thrown if a required behavior or parameter set could not be found.
AmbiguousTypeException	Thrown if a behavior or parameter set could not be resolved unambiguously.