JUK1
SParameterBlockVF< T > Struct Template Reference

A vectorfitting based model of an s-parameter block. More...

#include <SParameterBlockVF.hpp>

Inheritance diagram for SParameterBlockVF< T >:
Collaboration diagram for SParameterBlockVF< T >:

Public Member Functions

std::complex< T > history_p (const size_t p, const Matrix< T > &solutionMatrix, const size_t currentSolutionIndex, T timestep, const size_t sizeG_A) const
 
V_p (const size_t p, const Matrix< T > &solutionMatrix, const size_t currentSolutionIndex, T timestep, const size_t sizeG_A) const
 
awave_p (const size_t p, const Matrix< T > &solutionMatrix, const size_t currentSolutionIndex, const size_t sizeG_A) const
 
bwave_p (const size_t p, const Matrix< T > &solutionMatrix, const size_t currentSolutionIndex, const size_t sizeG_A) const
 
void addStaticStampTo (Stamp< T > &stamp) const
 Adds this component's static stamp to the target stamp. More...
 
void addDynamicStampTo (Stamp< T > &stamp, const Matrix< T > &solutionMatrix, const size_t currentSolutionIndex, T simulationTimestep) 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 setConstants (T timestep)
 
void setFirstOrder (T timestep)
 
void setSecondOrder (T timestep)
 
void setTimestep (T timestep)
 initialises the component More...
 
void readInPRR (std::string filePath, size_t numPorts)
 
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 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 ~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

std::vector< SParameterPortVF< T > > port
 
size_t numPorts = 0
 
bool firstOrder = true
 
z_ref = 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 SParameterBlockVF< T >

A vectorfitting based model of an s-parameter block.

Template Parameters
T

Definition at line 78 of file SParameterBlockVF.hpp.

Member Function Documentation

◆ addDCAnalysisStampTo()

template<typename T >
void SParameterBlockVF< 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 445 of file SParameterBlockVF.hpp.

◆ addDynamicStampTo()

template<typename T >
void SParameterBlockVF< 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 192 of file SParameterBlockVF.hpp.

Here is the call graph for this function:

◆ addStaticStampTo()

template<typename T >
void SParameterBlockVF< T >::addStaticStampTo ( Stamp< T > &  destination) const
inlinevirtual

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

Parameters
destinationThe stamp to be added to.

Reimplemented from Component< T >.

Definition at line 153 of file SParameterBlockVF.hpp.

◆ addToElements()

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

Definition at line 502 of file SParameterBlockVF.hpp.

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

◆ awave_p()

template<typename T >
T SParameterBlockVF< T >::awave_p ( const size_t  p,
const Matrix< T > &  solutionMatrix,
const size_t  currentSolutionIndex,
const size_t  sizeG_A 
) const
inline

Definition at line 113 of file SParameterBlockVF.hpp.

Here is the caller graph for this function:

◆ bwave_p()

template<typename T >
T SParameterBlockVF< T >::bwave_p ( const size_t  p,
const Matrix< T > &  solutionMatrix,
const size_t  currentSolutionIndex,
const size_t  sizeG_A 
) const
inline

Definition at line 133 of file SParameterBlockVF.hpp.

◆ history_p()

template<typename T >
std::complex<T> SParameterBlockVF< T >::history_p ( const size_t  p,
const Matrix< T > &  solutionMatrix,
const size_t  currentSolutionIndex,
timestep,
const size_t  sizeG_A 
) const
inline

Definition at line 85 of file SParameterBlockVF.hpp.

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

◆ readInPRR()

template<typename T >
void SParameterBlockVF< T >::readInPRR ( std::string  filePath,
size_t  numPorts 
)
inline

Definition at line 385 of file SParameterBlockVF.hpp.

Here is the caller graph for this function:

◆ setConstants()

template<typename T >
void SParameterBlockVF< T >::setConstants ( timestep)
inline

Definition at line 235 of file SParameterBlockVF.hpp.

Here is the caller graph for this function:

◆ setFirstOrder()

template<typename T >
void SParameterBlockVF< T >::setFirstOrder ( timestep)
inline

Definition at line 256 of file SParameterBlockVF.hpp.

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

◆ setSecondOrder()

template<typename T >
void SParameterBlockVF< T >::setSecondOrder ( timestep)
inline

Definition at line 285 of file SParameterBlockVF.hpp.

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

◆ setTimestep()

template<typename T >
void SParameterBlockVF< T >::setTimestep ( timestep)
inlinevirtual

initialises the component

Parameters
timestepThe length of each time step

Reimplemented from Component< T >.

Definition at line 319 of file SParameterBlockVF.hpp.

Here is the call graph for this function:

◆ updateStoredState()

template<typename T >
void SParameterBlockVF< 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 204 of file SParameterBlockVF.hpp.

Here is the call graph for this function:

◆ V_p()

template<typename T >
T SParameterBlockVF< T >::V_p ( const size_t  p,
const Matrix< T > &  solutionMatrix,
const size_t  currentSolutionIndex,
timestep,
const size_t  sizeG_A 
) const
inline

Definition at line 106 of file SParameterBlockVF.hpp.

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

Member Data Documentation

◆ firstOrder

template<typename T >
bool SParameterBlockVF< T >::firstOrder = true

Definition at line 81 of file SParameterBlockVF.hpp.

◆ numPorts

template<typename T >
size_t SParameterBlockVF< T >::numPorts = 0

Definition at line 80 of file SParameterBlockVF.hpp.

◆ port

template<typename T >
std::vector<SParameterPortVF<T> > SParameterBlockVF< T >::port

Definition at line 79 of file SParameterBlockVF.hpp.

◆ z_ref

template<typename T >
T SParameterBlockVF< T >::z_ref = 0

Definition at line 83 of file SParameterBlockVF.hpp.


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