chowdsp_wdf  1.0.0
Wave Digital Filters library for chowdsp
Public Member Functions | Public Attributes | List of all members
DiodePairT< T, Next, Quality, OmegaProvider > Class Template Referencefinal

WDF diode pair (non-adaptable) See Werner et al., "An Improved and Generalized Diode Clipper Model for Wave Digital Filters" https://www.researchgate.net/publication/299514713_An_Improved_and_Generalized_Diode_Clipper_Model_for_Wave_Digital_Filters. More...

+ Inheritance diagram for DiodePairT< T, Next, Quality, OmegaProvider >:

Public Member Functions

 DiodePairT (Next &n, T Is, T Vt=NumericType< T >(25.85e-3), T nDiodes=1)
 Creates a new WDF diode pair, with the given diode specifications. More...
 
void setDiodeParameters (T newIs, T newVt, T nDiodes)
 Sets diode specific parameters. More...
 
void calcImpedance () override
 
void incident (T x) noexcept
 Accepts an incident wave into a WDF diode pair. More...
 
reflected () noexcept
 Propogates a reflected wave from a WDF diode pair. More...
 
 DiodePairT (Next &n, T Is, T Vt=NumericType< T >(25.85e-3), T nDiodes=1)
 Creates a new WDF diode pair, with the given diode specifications. More...
 
void setDiodeParameters (T newIs, T newVt, T nDiodes)
 Sets diode specific parameters. More...
 
void calcImpedance () override
 
void incident (T x) noexcept
 Accepts an incident wave into a WDF diode pair. More...
 
reflected () noexcept
 Propogates a reflected wave from a WDF diode pair. More...
 
- Public Member Functions inherited from RootWDF
void propagateImpedanceChange () override
 
void propagateImpedanceChange () override
 
- Public Member Functions inherited from BaseWDF
virtual ~BaseWDF ()=default
 
void connectToParent (BaseWDF *p)
 
virtual ~BaseWDF ()=default
 
void connectToParent (BaseWDF *p)
 

Public Attributes

WDFMembers< T > wdf
 

Additional Inherited Members

- Protected Attributes inherited from BaseWDF
BaseWDFparent = nullptr
 

Detailed Description

template<typename T, typename Next, DiodeQuality Quality = DiodeQuality::Best, typename OmegaProvider = Omega::Omega>
class chowdsp::wdft::DiodePairT< T, Next, Quality, OmegaProvider >

WDF diode pair (non-adaptable) See Werner et al., "An Improved and Generalized Diode Clipper Model for Wave Digital Filters" https://www.researchgate.net/publication/299514713_An_Improved_and_Generalized_Diode_Clipper_Model_for_Wave_Digital_Filters.

Constructor & Destructor Documentation

◆ DiodePairT() [1/2]

DiodePairT ( Next &  n,
Is,
Vt = NumericType<T> (25.85e-3),
nDiodes = 1 
)

Creates a new WDF diode pair, with the given diode specifications.

Parameters
nthe next element in the WDF connection tree
Isreverse saturation current
Vtthermal voltage
nDiodesthe number of series diodes

References DiodePairT< T, Next, Quality, OmegaProvider >::setDiodeParameters().

◆ DiodePairT() [2/2]

DiodePairT ( Next &  n,
Is,
Vt = NumericType<T> (25.85e-3),
nDiodes = 1 
)

Creates a new WDF diode pair, with the given diode specifications.

Parameters
nthe next element in the WDF connection tree
Isreverse saturation current
Vtthermal voltage
nDiodesthe number of series diodes

References DiodePairT< T, Next, Quality, OmegaProvider >::setDiodeParameters().

Member Function Documentation

◆ setDiodeParameters() [1/2]

void setDiodeParameters ( newIs,
newVt,
nDiodes 
)

◆ calcImpedance() [1/2]

void calcImpedance ( )
overridevirtual

◆ incident() [1/2]

void incident ( x)
noexcept

Accepts an incident wave into a WDF diode pair.

References DiodePairT< T, Next, Quality, OmegaProvider >::wdf.

◆ reflected() [1/2]

T reflected ( )
noexcept

Propogates a reflected wave from a WDF diode pair.

References DiodePairT< T, Next, Quality, OmegaProvider >::wdf.

◆ setDiodeParameters() [2/2]

void setDiodeParameters ( newIs,
newVt,
nDiodes 
)

Sets diode specific parameters.

References DiodePairT< T, Next, Quality, OmegaProvider >::calcImpedance().

◆ calcImpedance() [2/2]

void calcImpedance ( )
overridevirtual

Implements BaseWDF.

◆ incident() [2/2]

void incident ( x)
noexcept

Accepts an incident wave into a WDF diode pair.

References DiodePairT< T, Next, Quality, OmegaProvider >::wdf.

◆ reflected() [2/2]

T reflected ( )
noexcept

Propogates a reflected wave from a WDF diode pair.

References DiodePairT< T, Next, Quality, OmegaProvider >::wdf.

Member Data Documentation

◆ wdf

WDFMembers< T > wdf

The documentation for this class was generated from the following files: