A time series voltage source model. More...

#include <TimeSeriesVoltageSource.hpp>

Inheritance diagram for TimeSeriesVoltageSource< T >:

Collaboration diagram for TimeSeriesVoltageSource< T >:

Public Member Functions
T	lerp (size_t lowIndex, T timeVal) const

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	addDCAnalysisStampTo (Stamp< T > &stamp, const Matrix< T > &solutionVector, size_t numCurrents) const
	adds this component's DC stamp to the target stamp. More...

void	readInTimeSeries (T timescale, const std::string &seriesPath)

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	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...

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
size_t	n1 = 0

size_t	n2 = 0

size_t	currentIndex = 0

size_t	lastTimeSeriesIndex = 0

std::vector< T >	timeSeries

std::vector< T >	dataSeries

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 TimeSeriesVoltageSource< T >

A time series voltage source model.

Template Parameters

T	the value type

Definition at line 11 of file TimeSeriesVoltageSource.hpp.

Member Function Documentation

◆ addDCAnalysisStampTo()

template<typename T >

void TimeSeriesVoltageSource< 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 67 of file TimeSeriesVoltageSource.hpp.

Here is the call graph for this function:

◆ addDynamicStampTo()

template<typename T >

void TimeSeriesVoltageSource< 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 29 of file TimeSeriesVoltageSource.hpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addToElements()

template<typename T >

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

inlinestatic

Definition at line 73 of file TimeSeriesVoltageSource.hpp.

Here is the call graph for this function:

◆ lerp()

template<typename T >

T TimeSeriesVoltageSource< T >::lerp	(	size_t	lowIndex,
		T	timeVal
	)		const

inline

Definition at line 20 of file TimeSeriesVoltageSource.hpp.

Here is the caller graph for this function:

◆ readInTimeSeries()

template<typename T >

void TimeSeriesVoltageSource< T >::readInTimeSeries	(	T	timescale,
		const std::string &	seriesPath
	)

inline

Definition at line 117 of file TimeSeriesVoltageSource.hpp.

Here is the caller graph for this function:

◆ updateStoredState()

template<typename T >

void TimeSeriesVoltageSource< 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 55 of file TimeSeriesVoltageSource.hpp.