RT-WDF  0.0.1
Real-time Wave Digital Filter Framework
diodeApModel Class Reference

#include <rt-wdf_nlModels.h>

Inheritance diagram for diodeApModel:

Public Member Functions

 diodeApModel ()
 
void calculate (vec *fNL, mat *JNL, vec *x, int *currentPort)
 
int getNumPorts ()
 

Constructor & Destructor Documentation

§ diodeApModel()

diodeApModel::diodeApModel ( )

Anti-parallel diode pair model class.

Anti-Parallel Diode Model according to Kurt Werner et al ("An Improved and Generalized Diode Clipper Model for Wave Digital Filters")

Member Function Documentation

§ calculate()

void diodeApModel::calculate ( vec *  fNL,
mat *  JNL,
vec *  x,
int *  currentPort 
)
virtual

Calculate the non-linear current and it's Jacobian according to an input voltage.

Parameters
*fNLis a pointer to store result of fNL(x). This is a current.
*JNLis a pointer to store the result of the Jacobian of fNL(x).
*xis a pointer to read the input value x. This is a voltage.
*currentPortis a pointer to the first reading / writing position in fNL, JNL and x.

Implements nlModel.

§ getNumPorts()

int nlModel::getNumPorts ( )
inherited

Function which returns the number of ports on an NL model for memory house- keeping

Returns
the number of ports implemented in a particular NL model.

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