An ideal inductor model. More...

#include <Inductor.hpp>

Inheritance diagram for Inductor< T >:

Collaboration diagram for Inductor< T >:

Public Member Functions
void	addDynamicStampTo (Stamp< T > &stamp, const Matrix< T > &solutionMatrix, const size_t currentSolutionIndex, T timestep) const
	Adds this component's dynamic stamp to the target stamp. More...

void	updateStoredState (const Matrix< T > &solutionMatrix, const size_t currentSolutionIndex, T timestep, size_t sizeG_A)
	Updates any stored state based on the current solution index. More...

void	updateDCStoredState (const Matrix< T > &solutionVector, size_t sizeG_A, size_t numCurrents)
	a function to update the stored state of a component based on a DC value More...

void	addDCAnalysisStampTo (Stamp< T > &stamp, const Matrix< T > &solutionVector, size_t numCurrents) const
	adds this component's DC stamp to the target stamp. More...

Public Member Functions inherited from Component< T >
virtual void	addStaticStampTo (Stamp< T > &destination) const
	Adds this component's static stamp to the target stamp. More...

virtual void	addNonLinearStampTo (Stamp< T > &destination, const Matrix< T > &solutionMatrix, const size_t currentSolutionIndex, T timestep=0) const
	adds this component's non-linear stamp to the target stamp. More...

virtual void	setTimestep (T timestep)
	initialises the component More...

virtual	~Component ()

Static Public Member Functions
static void	addToElements (const std::string &line, CircuitElements< T > &elements, size_t &numNodes, size_t &numCurrents, size_t &numDCCurrents)

Static Public Member Functions inherited from Component< T >
static void	addToElements (const std::string &line, CircuitElements< T > &elements, size_t &numNodes, size_t &numCurrents, size_t &numDCCurrents)
	Called as a helper to add the component to the elements class. More...

Public Attributes
T	value = 0

size_t	n1 = 0

size_t	n2 = 0

T	lastCurrent = 0

size_t	dcCurrentIndex = 0

bool	trapezoidalRule = true

Public Attributes inherited from Component< T >
std::string	designator = ""
	The designator as in the netlist for e.g. More...

Detailed Description

template<typename T>
struct Inductor< T >

An ideal inductor model.

Template Parameters

T	the value type

Definition at line 11 of file Inductor.hpp.

Member Function Documentation

◆ addDCAnalysisStampTo()

template<typename T >

void Inductor< T >::addDCAnalysisStampTo	(	Stamp< T > &	destination,
		const Matrix< T > &	solutionVector,
		size_t	numCurrents
	)		const

inlinevirtual

adds this component's DC stamp to the target stamp.

Parameters

destination	The stamp to be added to.
solutionMatrix	A vector containing all past solutions to the circuit
numCurrents	The number of currents used by the transient simulation

Reimplemented from Component< T >.

Definition at line 95 of file Inductor.hpp.

◆ addDynamicStampTo()

template<typename T >

void Inductor< T >::addDynamicStampTo	(	Stamp< T > &	destination,
		const Matrix< T > &	solutionMatrix,
		const size_t	currentSolutionIndex,
		T	timestep
	)		const

inlinevirtual

Adds this component's dynamic stamp to the target stamp.

Parameters

destination	The stamp to be added to.
solutionMatrix	A vector containing all past solutions to the circuit
currentSolutionIndex	The current timeStep index
timestep	The length of each time step

Reimplemented from Component< T >.

Definition at line 22 of file Inductor.hpp.

◆ addToElements()

template<typename T >

static void Inductor< T >::addToElements	(	const std::string &	line,
		CircuitElements< T > &	elements,
		size_t &	numNodes,
		size_t &	numCurrents,
		size_t &	numDCCurrents
	)

inlinestatic

Definition at line 114 of file Inductor.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateDCStoredState()

template<typename T >

void Inductor< T >::updateDCStoredState	(	const Matrix< T > &	solutionVector,
		size_t	sizeG_A,
		size_t	numCurrents
	)

inlinevirtual

a function to update the stored state of a component based on a DC value

Parameters

solutionVector	The DC vector
sizeG_A	the number of voltages
numCurrents	the number of transient currents

Reimplemented from Component< T >.

Definition at line 90 of file Inductor.hpp.

◆ updateStoredState()

template<typename T >

void Inductor< T >::updateStoredState	(	const Matrix< T > &	solutionMatrix,
		const size_t	currentSolutionIndex,
		T	timestep,
		size_t	numCurrents
	)

inlinevirtual

Updates any stored state based on the current solution index.

Parameters

solutionMatrix	A vector containing all past solutions to the circuit
currentSolutionIndex	The current timeStep index
timestep	The length of each time step
sizeG_A	the size of the A portion of G, marks the end of the equiv currents

Reimplemented from Component< T >.

Definition at line 64 of file Inductor.hpp.

Member Data Documentation

◆ dcCurrentIndex

template<typename T >

size_t Inductor< T >::dcCurrentIndex = 0

Definition at line 19 of file Inductor.hpp.

◆ lastCurrent

template<typename T >

T Inductor< T >::lastCurrent = 0

Definition at line 17 of file Inductor.hpp.

◆ n1

template<typename T >

size_t Inductor< T >::n1 = 0

Definition at line 15 of file Inductor.hpp.

◆ n2

template<typename T >

size_t Inductor< T >::n2 = 0

Definition at line 16 of file Inductor.hpp.

◆ trapezoidalRule

template<typename T >

bool Inductor< T >::trapezoidalRule = true

Definition at line 21 of file Inductor.hpp.

◆ value

template<typename T >

T Inductor< T >::value = 0

Definition at line 13 of file Inductor.hpp.

The documentation for this struct was generated from the following file:

D:/dslog/Documents/JUK1/C++/src/includes/CircuitElements/Inductor.hpp

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

template<typename T> struct Inductor< T >

Member Function Documentation

◆ addDCAnalysisStampTo()

◆ addDynamicStampTo()

◆ addToElements()

◆ updateDCStoredState()

◆ updateStoredState()

Member Data Documentation

◆ dcCurrentIndex

◆ lastCurrent

◆ n1

◆ n2

◆ trapezoidalRule

◆ value

template<typename T>
struct Inductor< T >