FreeEquation.hh

Go to the documentation of this file.

#ifndef FREE_EQUATION_HH
#define FREE_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
//          Vikram Krishnamachary       

#include "tyvis/Component.hh"
#include "tyvis/VHDLType.hh"
#include "tyvis/adouble.h"
#include "tyvis/adutils.h"

class _savant_entity_ams_elab;

class freeEquation : public component {
public:
  
   freeEquation(_savant_entity_ams_elab *designPtr, component **&parent_equation, int caseValue, const char* name, 
                adouble (*functionPtr) (component *, adouble*), int noOfVariables, ...);

  freeEquation(const char* name, adouble (*functionPtr) (component *, adouble*),
               int noOfVariables, VHDLType **Qty);

  virtual eqnType getEquationType() {
    return equationType;
  }

  virtual ~freeEquation(void);

  virtual void init();

  virtual int pointerAllocation();

  virtual int findBranch(int posNode, int negNode);

  virtual int load();

  virtual char * getEquationKind(){
    return "FREE";   
  }

  Quantity **getQuantities();
   
  int getNumberOfQuantities();

  list<int*> *formNodeSet();

  virtual bool getConsCheck(){
    return conservativeCheck;
  }
  
  int findFreeQuantity(int toCheck);

  virtual component* getImplicitEquationList();

  virtual void add(component *comp);
  
  int loadImplicitEqns(Quantity* qty);

  int loadImplicitEqns();

  void initializeImplicitEqns();
  
  int pointerAllocationForImplicitEqns();

protected:

private:
  adouble (*functionPointer) (component *, adouble*);
   
  spREAL **dcMatrixPointers;

  spREAL **transientMatrixPointers;

  int branch;

  int numberOfQuantities;

  Quantity** freeQty;
    
  bool conservativeCheck;

  int* base;

  component *implicitEquationList;

};

#endif

---