rt-wdf_nlModels.h

Go to the documentation of this file.

/*
 ==============================================================================

 This file is part of the RT-WDF library.
 Copyright (c) 2015,2016 - Maximilian Rest, Ross Dunkel, Kurt Werner.

 Permission is granted to use this software under the terms of either:
 a) the GPL v2 (or any later version)
 b) the Affero GPL v3

 Details of these licenses can be found at: www.gnu.org/licenses

 RT-WDF is distributed in the hope that it will be useful, but WITHOUT ANY
 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 -----------------------------------------------------------------------------
 To release a closed-source product which uses RT-WDF, commercial licenses are
 available: write to rt-wdf@e-rm.de for more information.

 ==============================================================================

 rt-wdf_nlModels.h
 Created: 2 Dec 2015 4:10:47pm
 Author:  mrest

 ==============================================================================
*/

#ifndef RTWDF_NLMODELS_H_INCLUDED
#define RTWDF_NLMODELS_H_INCLUDED

//==============================================================================
#include "rt-wdf_types.h"

//==============================================================================
// Defines for NL identifiers
// TODO: introduce enums


// Diodes:
#define DIODE       00

#define DIODE_AP    01

// Bipolar Transistors:
#define NPN_EM      10

// Triode Tubes:
#define TRI_DW      20



//==============================================================================
// Forward declarations
class nlModel;
class diodeModel;
class diodeApModel;
class bjtEmModel;
class triDwModel;



//==============================================================================
class nlModel {

public:
    //----------------------------------------------------------------------
    nlModel( int numPorts );

    //----------------------------------------------------------------------
    virtual ~nlModel( );

    //----------------------------------------------------------------------
    virtual void calculate( vec* fNL,
                            mat* JNL,
                            vec* x,
                            int* currentPort ) = 0;

    //----------------------------------------------------------------------
    int getNumPorts( );

private:
    //----------------------------------------------------------------------
    unsigned int numPorts;

};


//==============================================================================
class diodeModel : public nlModel {

public:
    //----------------------------------------------------------------------
    diodeModel( );

    //----------------------------------------------------------------------
    void calculate( vec* fNL,
                    mat* JNL,
                    vec* x,
                    int* currentPort );

};


//==============================================================================
class diodeApModel : public nlModel {

public:
    //----------------------------------------------------------------------
    diodeApModel();

    //----------------------------------------------------------------------
    void calculate( vec* fNL,
                    mat* JNL,
                    vec* x,
                    int* currentPort );

};


//==============================================================================
class npnEmModel : public nlModel {

public:
    //----------------------------------------------------------------------
    npnEmModel();

    //----------------------------------------------------------------------
    void calculate( vec* fNL,
                    mat* JNL,
                    vec* x,
                    int* currentPort );

};


//==============================================================================
class triDwModel : public nlModel {

public:
    //----------------------------------------------------------------------
    triDwModel();

    //----------------------------------------------------------------------
    void calculate( vec* fNL,
                    mat* JNL,
                    vec* x,
                    int* currentPort );

};



#endif  // RTWDF_NLMODELS_H_INCLUDED