transient.h

Go to the documentation of this file.

/*
 * transient.h - transient helper class definitions
 *
 * Copyright (C) 2004, 2006 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: transient.h 1825 2011-03-11 20:42:14Z ela $
 *
 */

#ifndef __TRANSIENT_H__
#define __TRANSIENT_H__

enum integrator_type {
  INTEGRATOR_UNKNOWN       = -1,
  INTEGRATOR_EULER         =  0,
  INTEGRATOR_TRAPEZOIDAL   =  1,
  INTEGRATOR_GEAR          =  2,
  INTEGRATOR_ADAMSMOULTON  =  3,
  INTEGRATOR_ADAMSBASHFORD =  4
};

class circuit;
class integrator;

namespace transient {

  void calcCorrectorCoeff (int, int, nr_double_t *, nr_double_t *);
  void calcPredictorCoeff (int, int, nr_double_t *, nr_double_t *);
  void getConductance (integrator *, nr_double_t, nr_double_t&);
  void integrateEuler (integrator *, int, nr_double_t, nr_double_t&,
               nr_double_t&);
  void integrateBilinear (integrator *, int, nr_double_t, nr_double_t&,
              nr_double_t&);
  void integrateGear (integrator *, int, nr_double_t, nr_double_t&,
              nr_double_t&);
  void integrateMoulton (integrator *, int, nr_double_t, nr_double_t&,
             nr_double_t&);
  void setIntegrationMethod (circuit *, int);
  int  correctorType (char *, int&);
  int  correctorType (int, int);
  int  predictorType (int, int, int&);
  nr_double_t getCorrectorError (int, int);
  nr_double_t getPredictorError (int, int);

} // namespace

#endif /* __TRANSIENT_H__ */