BranchEquation.hh

Go to the documentation of this file.

#ifndef BRANCH_EQUATION_HH
#define BRANCH_EQUATION_HH

// Copyright (c) 2002-2005 The University of Cincinnati.
// All rights reserved.

// You may modify, distribute, and use the software contained in this
// package under the terms of the "GNU LIBRARY GENERAL PUBLIC LICENSE"
// version 2, June 1991. A copy of this license agreement can be found in
// the file "LGPL", distributed with this archive.

// Authors: Vinod Chamarty                    chamarv@ececs.uc.edu
//          Sameer Kher                       kherss@ececs.uc.edu
//          Shriram Subramanian               subramsi@ececs.uc.edu

#include <stdarg.h>
#include "tyvis/Component.hh"
#include "tyvis/vhdl_ams.hh"
#include "tyvis/Quantity.hh"
#include "tyvis/VHDLType.hh"
#include "tyvis/AMSType.hh"
#include "tyvis/adouble.h"
#include "tyvis/adutils.h"

class _savant_entity_ams_elab;
class component;
class AMSType;

class branchEquation : public component {

public:
  branchEquation();   
  
  virtual ~branchEquation();
  
  branchEquation(const char* name, adouble (*functionPtr) (component *, adouble*),
                 int noOfVariables, VHDLType **Qty);

  branchEquation(_savant_entity_ams_elab *designPtr, component **&parent_equation, int caseValue, const char* name,
                 adouble (*functionPtr) (component *, adouble*),int noOfVariables, ...);

  virtual void init();
  
  virtual bool getConsCheck(); 

  virtual void setBranch();
  
  virtual void definePointers();
  
  virtual int findBranch(int posNode, int negNode);

  virtual eqnType getEquationType();

  virtual Quantity** getQuantities();

  virtual int getNumberOfQuantities();

  virtual int checkCurrent(int posNode, int negNode, int index);

  virtual int load();
 
  virtual int pointerAllocation();

  virtual void add(component *comp);

  int loadImplicitEqns(Quantity* qty); 

  int loadImplicitEqns();

  virtual component* getImplicitEquationList(void);  

  void initializeImplicitEqns();

  int pointerAllocationForImplicitEqns();


protected:

private:
  int numberOfQuantities;

  component *implicitEquationList;

  bool conservativeCheck;

  adouble (*functionPointer) (component *, adouble*);

  spREAL **dcMatrixPointers;

  spREAL **transientMatrixPointers;

  int matrixCount;

  int* base;

  int* correctValue;

  Quantity** branchQty;

  int branch;

  int sourceCurrent;

};

#endif

---