VoltageSource< T > Struct Template Reference
An ideal voltageSource. More...
#include <VoltageSource.hpp>
Inheritance diagram for VoltageSource< T >:
Collaboration diagram for VoltageSource< T >:
Public Member Functions | |
| void | addStaticStampTo (Stamp< T > &stamp) const |
| Adds this component's static stamp to the target stamp. 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 | addDynamicStampTo (Stamp< T > &destination, const Matrix< T > &solutionMatrix, const size_t currentSolutionIndex, T timestep) const |
| Adds this component's dynamic 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 | updateStoredState (const Matrix< T > &solutionMatrix, const size_t currentSolutionIndex, T timestep, size_t numCurrents) |
| Updates any stored state based on the current solution index. 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 | |
| T | value = 0 |
| size_t | n1 = 0 |
| size_t | n2 = 0 |
| size_t | currentIndex = 0 |
| 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 VoltageSource< T >
An ideal voltageSource.
- Template Parameters
-
T The value type
Definition at line 10 of file VoltageSource.hpp.
Member Function Documentation
◆ addDCAnalysisStampTo()
template<typename T >
|
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 36 of file VoltageSource.hpp.
Here is the call graph for this function:
◆ addStaticStampTo()
template<typename T >
|
inlinevirtual |
Adds this component's static stamp to the target stamp.
- Parameters
-
destination The stamp to be added to.
Reimplemented from Component< T >.
Definition at line 18 of file VoltageSource.hpp.
Here is the caller graph for this function:
◆ addToElements()
template<typename T >
|
inlinestatic |
Definition at line 42 of file VoltageSource.hpp.
Here is the call graph for this function:
Here is the caller graph for this function:
Member Data Documentation
◆ currentIndex
template<typename T >
| size_t VoltageSource< T >::currentIndex = 0 |
Definition at line 16 of file VoltageSource.hpp.
◆ n1
template<typename T >
| size_t VoltageSource< T >::n1 = 0 |
Definition at line 14 of file VoltageSource.hpp.
◆ n2
template<typename T >
| size_t VoltageSource< T >::n2 = 0 |
Definition at line 15 of file VoltageSource.hpp.
◆ value
template<typename T >
| T VoltageSource< T >::value = 0 |
Definition at line 12 of file VoltageSource.hpp.
The documentation for this struct was generated from the following file:
- D:/dslog/Documents/JUK1/C++/src/includes/CircuitElements/VoltageSource.hpp
