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

#include <rt-wdf.h>

Inheritance diagram for wdfRootNL:

Public Member Functions

 wdfRootNL (int numSubtrees, std::vector< int > nlList, int solverType)
 
 ~wdfRootNL ()
 
virtual void processAscendingWaves (vec *ascendingWaves, vec *descendingWaves)
 
virtual matDatagetRootMatrPtr ()
 
virtual std::string getType () const
 
void setPortResistances (double *Rp)
 

Constructor & Destructor Documentation

§ wdfRootNL()

wdfRootNL::wdfRootNL ( int  numSubtrees,
std::vector< int >  nlList,
int  solverType 
)

Multiple/Multiport Non-Linearities root implementation.

Parameters
numSubtreesspecifies the number of subtrees which are connected to the root to correctly allocate memory for rootMatrixData
nlListis a vector defines that map to available NL models. See nlModelClass.h for all models
solverTypesets the solver to use in this root. See nlSolverClass.h for all solvers.

§ ~wdfRootNL()

wdfRootNL::~wdfRootNL ( )

Deconstructor

Member Function Documentation

§ getRootMatrPtr()

matData * wdfRootNL::getRootMatrPtr ( )
virtual

Function that returns a pointer to the rootMatrixData element.

The pointer is be used to populate or update the E,-F-,M-,N-Matrices of the root loop by the setRootMatrData() function of the tree.

Returns
matData* to the rootMatrixData element

Reimplemented from wdfRoot.

§ getType()

std::string wdfRootNL::getType ( ) const
virtual

Returns a String describing the type of this root.

Returns
a String describing the type of this root as "Root (NL-type)"

Implements wdfRoot.

§ processAscendingWaves()

void wdfRootNL::processAscendingWaves ( vec *  ascendingWaves,
vec *  descendingWaves 
)
virtual

Function to process a vector of ascending waves in the root and return the descending result.

Scatters the waves according to the R-type connector towards the non-linearities, solves the inner loop with a NLSolver and returns the result.

Parameters
*ascendingWavesis a pointer to a vector of waves that were collected at the upfacing ports of the subtrees, traveling into the root.
*descendingWavesis a pointer to a vector to store the resulting waves that leave the root afterprocessing into the subtrees

Implements wdfRoot.

§ setPortResistances()

void wdfRoot::setPortResistances ( double *  Rp)
inherited

Function that does nothing if not overwritten by a method in a subclass.

Acts as an interface towards the tree to do anything with the subtree's upfacing port resistances in the root. Is called during adaptation of the WDF structure.

Parameters
Rpis a vector of port resistances of all subtrees of the root.

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