nlModel Class Reference

#include <rt-wdf_nlModels.h>

Inheritance diagram for nlModel:

Public Member Functions
	nlModel (int numPorts)
virtual	~nlModel ()
virtual void	calculate (vec *fNL, mat *JNL, vec *x, int *currentPort)=0
int	getNumPorts ()

Constructor & Destructor Documentation

nlModel()

nlModel::nlModel

(

int

numPorts

)

Parent class for all non-linear models.

Parameters

numPorts

defines the number of ports that are used to implement a specific NL model.

~nlModel()

nlModel::~nlModel ( )

virtual

Deconstructor.

Member Function Documentation

calculate()

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

pure virtual

Virtual function to calculate the non-linear current(s) fNL and Jacobian JNL according to a vector of input voltage(s).

Parameters

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

Implemented in triDwModel, npnEmModel, diodeApModel, and diodeModel.

getNumPorts()

int nlModel::getNumPorts

(

)

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:

• Libs/rt-wdf/rt-wdf_nlModels.h
• Libs/rt-wdf/rt-wdf_nlModels.cpp