rt-wdf_nlSolvers.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_nlSolvers.h
 Created: 2 Dec 2015 4:08:19pm
 Author:  mrest

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

#ifndef RTWDF_NLSOLVERS_H_INCLUDED
#define RTWDF_NLSOLVERS_H_INCLUDED

//==============================================================================
#include <float.h>

#include "rt-wdf_types.h"
#include "rt-wdf_nlModels.h"



//==============================================================================
// Define enums for solver identifiers


// Iterative:
// TODO: introduce enums!
#define NEWTON_SOLVER   1



//==============================================================================
// Newton Solver config parameters

#define TOL     1.0e-06                     // TODO: evaluate physically meaningful tolerance.

#define ITMAX   50


//==============================================================================
// Forward declarations
class nlSolver;
class nlNewtonSolver;


//==============================================================================
class nlSolver {

public:
    //----------------------------------------------------------------------
    nlSolver();

    //----------------------------------------------------------------------
    virtual ~nlSolver();

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

    //----------------------------------------------------------------------
    virtual void nlSolve( vec* inWaves,
                          vec* outWaves ) = 0;

    //----------------------------------------------------------------------
    std::vector<nlModel*> nlModels;
    int numNLPorts;

};


//==============================================================================
class nlNewtonSolver : public nlSolver {

protected:
    //----------------------------------------------------------------------
    matData* myMatData;
    vec* x0;
    vec* fNL;
    mat* JNL;
    vec* F;
    mat* J;
    vec* Fmat_fNL;
    bool firstRun = true;

public:
    //----------------------------------------------------------------------
    nlNewtonSolver( std::vector<int> nlList,
                matData* myMatData );

    ~nlNewtonSolver( );

    //----------------------------------------------------------------------
    void nlSolve( vec* inWaves,
                  vec* outWaves );

    //----------------------------------------------------------------------
    void evalNlModels(vec* inWaves, matData* myMatData, vec* x);

};


#endif  // RTWDF_NLSOLVERS_H_INCLUDED