e_trsolver.h

Go to the documentation of this file.

/*
 * e_trsolver.h - transient solver external interface class definitions
 *
 * Copyright (C) 2004, 2005, 2006, 2007, 2008 Stefan Jahn <stefan@lkcc.org>
 *
 * This is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * This software 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this package; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street - Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 * $Id$
 *
 */

#ifndef __E_TRSOLVER_H__
#define __E_TRSOLVER_H__

#include "qucs_interface.h"
#include "trsolver.h"
#include <vector>

namespace qucs {

class e_trsolver : public trsolver
{
public:
    ACREATOR (e_trsolver);
    //e_trsolver ();
    e_trsolver (char *);
    e_trsolver (e_trsolver &);
    ~e_trsolver ();

    int init (nr_double_t, nr_double_t, int);
//    int finish ();
    bool isExternal() { return true; };

public:

    int stepsolve_sync (nr_double_t synctime);
    void acceptstep_sync (void);
    int stepsolve_async (nr_double_t steptime);
    void acceptstep_async (void);
    void rejectstep_async (void);
    void getsolution (double *);

    int setECVSVoltage(char * ecvsname, nr_double_t V);

    int getJacRows ();

    int getJacCols ();

    void getJacData (int r, int c, nr_double_t& data);

    int getNodeV (char * label, nr_double_t& nodeV);

    int getVProbeV (char * probename, nr_double_t& probeV);

    int getIProbeI (char * probename, nr_double_t& probeI);

    // debugging functions
    void debug (void);
    void printx (void);

    void (*messagefcn)(int level, const char * format, ...);

private:

    int MaxIterations;
    nr_double_t reltol;
    nr_double_t abstol;
    nr_double_t vntol;
    nr_double_t time;
    nr_double_t saveCurrent;
    nr_double_t lastsynctime;
    int running;
    int rejected;
    int convError;

    void initETR (nr_double_t start, nr_double_t, int);
    void truncateHistory (nr_double_t);
    void updateExternalInterpTime(nr_double_t);
    void storeHistoryAges (void);
    void updateHistoryAges(nr_double_t);

//    int solve_nonlinear_step (void);
    void adjustDelta_sync (nr_double_t);

    // Asynchronous specific items

    // For going back in history of a solution after multiple
    // solution steps
    std::vector<nr_double_t> initialhistages;
    tvector<nr_double_t> * lastsolution[8];
    nr_double_t lastasynctime;
    nr_double_t lastdeltas[8];
    nr_double_t lastdelta;
    // restores the solver to an earlier stored state, used
    // when an asynchronous major step is rejected by the
    // parent process
    void restoreSolution (void);
    void copySolution (tvector<nr_double_t> * [8], tvector<nr_double_t> * [8]);
    void fillLastSolution (tvector<nr_double_t> * );
};

} // namespace qucs

#endif /* __e_trsolver_H__ */