JUK1
SinusoidalVoltageSource< T > Struct Template Reference

A sinusoidal voltage source model. More...

#include <SinusoidalVoltageSource.hpp>

Inheritance diagram for SinusoidalVoltageSource< T >:
Collaboration diagram for SinusoidalVoltageSource< 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 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 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
 
V = 1
 
phase = 0
 
frequency = 1
 
offset = 0
 
bool degrees = 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 SinusoidalVoltageSource< T >

A sinusoidal voltage source model.

Template Parameters
Tthe value type

Definition at line 11 of file SinusoidalVoltageSource.hpp.

Member Function Documentation

◆ addDCAnalysisStampTo()

template<typename T >
void SinusoidalVoltageSource< 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
destinationThe stamp to be added to.
solutionMatrixA vector containing all past solutions to the circuit
numCurrentsThe number of currents used by the transient simulation

Reimplemented from Component< T >.

Definition at line 56 of file SinusoidalVoltageSource.hpp.

Here is the call graph for this function:

◆ addDynamicStampTo()

template<typename T >
void SinusoidalVoltageSource< T >::addDynamicStampTo ( Stamp< T > &  destination,
const Matrix< T > &  solutionMatrix,
const size_t  currentSolutionIndex,
timestep 
) const
inlinevirtual

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

Parameters
destinationThe stamp to be added to.
solutionMatrixA vector containing all past solutions to the circuit
currentSolutionIndexThe current timeStep index
timestepThe length of each time step

Reimplemented from Component< T >.

Definition at line 22 of file SinusoidalVoltageSource.hpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ addToElements()

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

Definition at line 62 of file SinusoidalVoltageSource.hpp.

Here is the call graph for this function:

◆ updateStoredState()

template<typename T >
void SinusoidalVoltageSource< T >::updateStoredState ( const Matrix< T > &  solutionMatrix,
const size_t  currentSolutionIndex,
timestep,
size_t  numCurrents 
)
inlinevirtual

Updates any stored state based on the current solution index.

Parameters
solutionMatrixA vector containing all past solutions to the circuit
currentSolutionIndexThe current timeStep index
timestepThe length of each time step
sizeG_Athe size of the A portion of G, marks the end of the equiv currents

Reimplemented from Component< T >.

Definition at line 51 of file SinusoidalVoltageSource.hpp.

Member Data Documentation

◆ currentIndex

template<typename T >
size_t SinusoidalVoltageSource< T >::currentIndex = 0

Definition at line 14 of file SinusoidalVoltageSource.hpp.

◆ degrees

template<typename T >
bool SinusoidalVoltageSource< T >::degrees = true

Definition at line 20 of file SinusoidalVoltageSource.hpp.

◆ frequency

template<typename T >
T SinusoidalVoltageSource< T >::frequency = 1

Definition at line 18 of file SinusoidalVoltageSource.hpp.

◆ n1

template<typename T >
size_t SinusoidalVoltageSource< T >::n1 = 0

Definition at line 12 of file SinusoidalVoltageSource.hpp.

◆ n2

template<typename T >
size_t SinusoidalVoltageSource< T >::n2 = 0

Definition at line 13 of file SinusoidalVoltageSource.hpp.

◆ offset

template<typename T >
T SinusoidalVoltageSource< T >::offset = 0

Definition at line 19 of file SinusoidalVoltageSource.hpp.

◆ phase

template<typename T >
T SinusoidalVoltageSource< T >::phase = 0

Definition at line 17 of file SinusoidalVoltageSource.hpp.

◆ V

template<typename T >
T SinusoidalVoltageSource< T >::V = 1

Definition at line 16 of file SinusoidalVoltageSource.hpp.


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