Xyce  6.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Xyce::Device::Neuron8::Instance Class Reference

#include <N_DEV_Neuron8.h>

Inheritance diagram for Xyce::Device::Neuron8::Instance:
Collaboration diagram for Xyce::Device::Neuron8::Instance:

Public Member Functions

 Instance (const Configuration &configuration, const InstanceBlock &IB, Model &Miter, const FactoryBlock &factory_block)
 
 ~Instance ()
 
void registerLIDs (const std::vector< int > &intLIDVecRef, const std::vector< int > &extLIDVecRef)
 
void registerStateLIDs (const std::vector< int > &staLIDVecRef)
 
std::map< int, std::string > & getIntNameMap ()
 
bool loadDeviceMask ()
 
const std::vector< std::vector
< int > > & 
jacobianStamp () const
 
void registerJacLIDs (const std::vector< std::vector< int > > &jacLIDVec)
 
bool processParams ()
 
bool updateTemperature (const double &temp_tmp)
 
bool updateIntermediateVars ()
 
bool updatePrimaryState ()
 
bool updateSecondaryState ()
 
bool setIC ()
 
void varTypes (std::vector< char > &varTypeVec)
 
bool loadDAEQVector ()
 
bool loadDAEFVector ()
 
void auxDAECalculations ()
 
bool loadDAEdQdx ()
 
bool loadDAEdFdx ()
 
ModelgetModel ()
 
- Public Member Functions inherited from Xyce::Device::DeviceInstance
 DeviceInstance (const InstanceBlock &instance_block, ParametricData< void > &parametric_data, const FactoryBlock &factory_block)
 
virtual ~DeviceInstance ()
 
virtual std::ostream & printName (std::ostream &os) const
 
virtual void enableLeadCurrentCalc ()
 
virtual void registerGIDs (const std::list< index_pair > &intGIDListRef, const std::list< index_pair > &extGIDListRef)
 
virtual void registerStateGIDs (const std::list< index_pair > &staGIDListRef)
 
virtual void registerStoreGIDs (const std::list< index_pair > &stoGIDListRef)
 
virtual void registerStoreLIDs (const std::vector< int > &stoLIDVecRef)
 
virtual const std::vector
< std::string > & 
getDepSolnVars ()
 
virtual void registerDepSolnGIDs (const std::vector< std::vector< int > > &varList)
 
virtual const std::vector
< std::string > & 
getDepStateVars ()
 
virtual void registerDepStateGIDs (const std::vector< std::vector< int > > &varList)
 
virtual const std::vector
< std::string > & 
getDepStoreVars ()
 
virtual void registerDepStoreGIDs (const std::vector< std::vector< int > > &varList)
 
virtual void registerDepSolnLIDs (const std::vector< std::vector< int > > &depSolnLIDVecRef)
 
virtual void registerDepStateLIDs (const std::vector< std::vector< int > > &depStaLIDVecRef)
 
virtual void registerDepStoreLIDs (const std::vector< std::vector< int > > &depStoLIDVecRef)
 
virtual void registerGIDData (const std::vector< int > &counts, const std::vector< int > &GIDs, const std::vector< std::vector< int > > &jacGIDs)
 
virtual void setupPointers ()
 
virtual void getDepSolnGIDVec (std::vector< int > &depGIDVec)
 
virtual bool getIndexPairList (std::list< index_pair > &iplRef)
 
virtual bool getInstanceBreakPoints (std::vector< Util::BreakPoint > &breakPointTimes)
 
virtual bool updateSource ()
 
virtual bool processInstanceParams ()
 
virtual bool isConverged ()
 
virtual bool testDAEMatrices (std::vector< std::string > &nameVec)
 
virtual bool loadTrivialDAE_FMatrixStamp ()
 
bool trivialStampLoader (N_LAS_Matrix *matPtr)
 
bool zeroMatrixDiagonal (N_LAS_Matrix *matPtr)
 
virtual bool plotfileFlag ()
 
virtual void acceptStep ()
 
virtual bool loadDAEBVector ()
 
const InstanceNamegetName () const
 
int getNumIntVars () const
 
int getNumExtVars () const
 
int getNumStateVars () const
 
int getNumStoreVars () const
 
void setNumStoreVars (int num_store_vars)
 
virtual void getDevConMap (std::vector< int > &)
 
virtual DeviceStategetInternalState ()
 
virtual bool setInternalState (const DeviceState &state)
 
virtual bool loadDFDV (int iElectrode, N_LAS_Vector *dfdvPtr)
 
virtual bool calcConductance (int iElectrode, const N_LAS_Vector *dxdvPtr)
 
virtual std::map< int,
std::string > & 
getStateNameMap ()
 
virtual std::map< int,
std::string > & 
getStoreNameMap ()
 
virtual bool outputPlotFiles ()
 
virtual bool enablePDEContinuation ()
 
virtual bool disablePDEContinuation ()
 
virtual void setPDEContinuationAlpha (double alpha)
 
virtual void setPDEContinuationBeta (double beta)
 
virtual bool setInitialGuess ()
 
virtual double getMaxTimeStepSize ()
 
bool getOrigFlag () const
 
void setOrigFlag (bool origFlag_local)
 
const std::vector< int > & getDevLIDs () const
 
const std::vector< std::vector
< int > > & 
getDevJacLIDs () const
 
const std::vector< int > & getStaLIDVec () const
 
bool getMergeRowColChecked () const
 
void setMergeRowColChecked (bool mergeRowColChecked_local)
 
const MatrixLoadDatagetMatrixLoadData () const
 
MatrixLoadDatagetMatrixLoadData ()
 
const ExternDatagetExternData () const
 
- Public Member Functions inherited from Xyce::Device::DeviceEntity
 DeviceEntity (ParametricData< void > &parametric_data, const SolverState &solver_state, const DeviceOptions &device_options, const std::string &netlist_path, int netlist_line)
 
virtual ~DeviceEntity ()
 
virtual CompositeParamconstructComposite (const std::string &composite_name, const std::string &param_name)
 
bool setDefaultParam (double val)
 
double getDefaultParam () const
 
bool scaleParam (const std::string &paramName, double val, double val0)
 
bool scaleParam (const std::string &paramName, double val)
 
bool scaleDefaultParam (double val)
 
bool analyticSensitivityAvailable (const std::string &paramName)
 
bool getAnalyticSensitivity (const std::string &paramName, std::vector< double > &dfdpVec, std::vector< double > &dqdpVec, std::vector< double > &dbdpVec, std::vector< int > &FindicesVec, std::vector< int > &QindicesVec, std::vector< int > &BindicesVec)
 
bool setParam (const std::string &paramName, double val)
 
bool getParam (const std::string &paramName, double &result) const
 
bool getParamBreakpoints (std::vector< Util::BreakPoint > &)
 
bool updateDependentParameters (N_LAS_Vector &vars)
 
bool updateDependentParameters (double temp_tmp)
 
bool updateGlobalParameters (GlobalParameterMap &)
 
bool updateDependentParameters ()
 
double setDependentParameter (Util::Param &, double *, ParameterType::ExprAccess)
 
double setDependentParameter (Util::Param &, std::vector< double > *, int, ParameterType::ExprAccess)
 
void setDependentParameter (Util::Param &par, Depend &dependentParam, ParameterType::ExprAccess depend)
 
void setDefaultParams ()
 
void setParams (const std::vector< Param > &params)
 
bool given (const std::string &parameter_name) const
 
void setDefaultParamName (const std::string &default_param_name)
 
const std::vector< Depend > & getDependentParams ()
 
void addDependentParameter (const Depend &param)
 
const DeviceOptionsgetDeviceOptions () const
 
const SolverStategetSolverState () const
 
const NetlistLocation & netlistLocation () const
 
const ParameterMapgetParameterMap () const
 
- Public Member Functions inherited from Xyce::Device::ParameterBase
 ParameterBase ()
 
virtual ~ParameterBase ()
 
double getOriginalValue (int serial_number)
 
void setOriginalValue (int serial_number, double value)
 
bool wasValueGiven (int serial_number) const
 
void setValueGiven (int serial_number, bool value)
 

Static Public Attributes

static std::vector
< std::vector< int > > 
jacStamp
 

Private Member Functions

 Instance (const Instance &)
 
Instanceoperator= (const Instance &)
 

Private Attributes

Modelmodel_
 
double memCap
 
double Vt
 
double Vr
 
double Vpeak
 
double k
 
double a
 
double b
 
double c
 
double d
 
double uscale
 
double fallRate
 
bool memCapGiven
 
bool VtGiven
 
bool VrGiven
 
bool VpeakGiven
 
bool kGiven
 
bool aGiven
 
bool bGiven
 
bool cGiven
 
bool dGiven
 
bool uscaleGiven
 
bool fallRateGiven
 
double vEquFvalue
 
double vEquQvalue
 
double vEqudFdv
 
double vEqudFdu
 
double vEqudQdv
 
double uEquFvalue
 
double uEquQvalue
 
double uEqudFdv
 
double uEqudFdu
 
double uEqudQdu
 
bool resetting
 
double uPeak
 
int li_V
 
int li_U
 
int vEquVOffset
 
int vEquUOffset
 
int uEquVOffset
 
int uEquUOffset
 

Friends

class ParametricData< Instance >
 
class Model
 
class Traits
 

Additional Inherited Members

- Public Attributes inherited from Xyce::Device::DeviceInstance
std::vector< int > & cols
 
std::vector< double > & vals
 
NumericalJacobiannumJacPtr
 
bool psLoaded
 
bool ssLoaded
 
bool rhsLoaded
 
bool origFlag
 
int numIntVars
 
int numExtVars
 
int numStateVars
 
int numStoreVars
 
int numLeadCurrentStoreVars
 
bool loadLeadCurrent
 
std::vector< int > devConMap
 
bool mergeRowColChecked
 
- Protected Member Functions inherited from Xyce::Device::DeviceInstance
void jacStampMap (std::vector< std::vector< int > > &stamp_parent, std::vector< int > &map_parent, std::vector< std::vector< int > > &map2_parent, std::vector< std::vector< int > > &stamp, std::vector< int > &map, std::vector< std::vector< int > > &map2, int from, int to, int original_size)
 
void jacStampMap_fixOrder (std::vector< std::vector< int > > &stamp_parent, std::vector< std::vector< int > > &map2_parent, std::vector< std::vector< int > > &stamp, std::vector< std::vector< int > > &map2)
 
void outputJacStamp (const std::vector< std::vector< int > > &jac)
 
void outputJacMaps (const std::vector< int > &jacMap, const std::vector< std::vector< int > > &jacMap2)
 
- Protected Attributes inherited from Xyce::Device::DeviceInstance
const ExternDataextData
 
std::list< index_pair > intGIDList
 
std::list< index_pair > extGIDList
 
std::list< index_pair > indexPairList
 
std::list< index_pair > staGIDList
 
std::vector< int > intLIDVec
 
std::vector< int > extLIDVec
 
std::vector< int > staLIDVec
 
std::vector< int > stoLIDVec
 
std::vector< int > devLIDs
 
std::vector< std::vector< int > > devJacLIDs
 
std::map< int, std::string > intNameMap
 
std::map< int, std::string > stateNameMap
 
std::map< int, std::string > storeNameMap
 
DeviceSupport devSupport
 

Detailed Description

Definition at line 91 of file N_DEV_Neuron8.h.

Constructor & Destructor Documentation

Xyce::Device::Neuron8::Instance::Instance ( const Configuration configuration,
const InstanceBlock IB,
Model Miter,
const FactoryBlock factory_block 
)

Definition at line 207 of file N_DEV_Neuron8.C.

Xyce::Device::Neuron8::Instance::~Instance ( )

Definition at line 412 of file N_DEV_Neuron8.C.

Xyce::Device::Neuron8::Instance::Instance ( const Instance )
private

Member Function Documentation

void Xyce::Device::Neuron8::Instance::auxDAECalculations ( )
std::map< int, std::string > & Xyce::Device::Neuron8::Instance::getIntNameMap ( )
virtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 505 of file N_DEV_Neuron8.C.

Model& Xyce::Device::Neuron8::Instance::getModel ( )
inline

Definition at line 145 of file N_DEV_Neuron8.h.

const std::vector< std::vector< int > > & Xyce::Device::Neuron8::Instance::jacobianStamp ( ) const
virtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 561 of file N_DEV_Neuron8.C.

bool Xyce::Device::Neuron8::Instance::loadDAEdFdx ( )
virtual

Implements Xyce::Device::DeviceInstance.

Definition at line 855 of file N_DEV_Neuron8.C.

bool Xyce::Device::Neuron8::Instance::loadDAEdQdx ( )
virtual

Implements Xyce::Device::DeviceInstance.

Definition at line 829 of file N_DEV_Neuron8.C.

bool Xyce::Device::Neuron8::Instance::loadDAEFVector ( )
virtual

Implements Xyce::Device::DeviceInstance.

Definition at line 808 of file N_DEV_Neuron8.C.

bool Xyce::Device::Neuron8::Instance::loadDAEQVector ( )
virtual

Implements Xyce::Device::DeviceInstance.

Definition at line 785 of file N_DEV_Neuron8.C.

bool Xyce::Device::Neuron8::Instance::loadDeviceMask ( )
virtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 542 of file N_DEV_Neuron8.C.

Instance& Xyce::Device::Neuron8::Instance::operator= ( const Instance )
private
bool Xyce::Device::Neuron8::Instance::processParams ( )
virtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 424 of file N_DEV_Neuron8.C.

void Xyce::Device::Neuron8::Instance::registerJacLIDs ( const std::vector< std::vector< int > > &  jacLIDVec)
virtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 574 of file N_DEV_Neuron8.C.

void Xyce::Device::Neuron8::Instance::registerLIDs ( const std::vector< int > &  intLIDVecRef,
const std::vector< int > &  extLIDVecRef 
)
virtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 457 of file N_DEV_Neuron8.C.

void Xyce::Device::Neuron8::Instance::registerStateLIDs ( const std::vector< int > &  staLIDVecRef)
virtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 524 of file N_DEV_Neuron8.C.

bool Xyce::Device::Neuron8::Instance::setIC ( )
virtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 878 of file N_DEV_Neuron8.C.

bool Xyce::Device::Neuron8::Instance::updateIntermediateVars ( )
virtual

Implements Xyce::Device::DeviceInstance.

Definition at line 593 of file N_DEV_Neuron8.C.

bool Xyce::Device::Neuron8::Instance::updatePrimaryState ( )
virtual

Implements Xyce::Device::DeviceInstance.

Definition at line 746 of file N_DEV_Neuron8.C.

bool Xyce::Device::Neuron8::Instance::updateSecondaryState ( )
virtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 763 of file N_DEV_Neuron8.C.

bool Xyce::Device::Neuron8::Instance::updateTemperature ( const double &  temp_tmp)
virtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 443 of file N_DEV_Neuron8.C.

void Xyce::Device::Neuron8::Instance::varTypes ( std::vector< char > &  varTypeVec)
virtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 893 of file N_DEV_Neuron8.C.

Friends And Related Function Documentation

friend class Model
friend

Definition at line 94 of file N_DEV_Neuron8.h.

friend class ParametricData< Instance >
friend

Definition at line 93 of file N_DEV_Neuron8.h.

friend class Traits
friend

Definition at line 95 of file N_DEV_Neuron8.h.

Member Data Documentation

double Xyce::Device::Neuron8::Instance::a
private

Definition at line 160 of file N_DEV_Neuron8.h.

bool Xyce::Device::Neuron8::Instance::aGiven
private

Definition at line 172 of file N_DEV_Neuron8.h.

double Xyce::Device::Neuron8::Instance::b
private

Definition at line 161 of file N_DEV_Neuron8.h.

bool Xyce::Device::Neuron8::Instance::bGiven
private

Definition at line 173 of file N_DEV_Neuron8.h.

double Xyce::Device::Neuron8::Instance::c
private

Definition at line 162 of file N_DEV_Neuron8.h.

bool Xyce::Device::Neuron8::Instance::cGiven
private

Definition at line 174 of file N_DEV_Neuron8.h.

double Xyce::Device::Neuron8::Instance::d
private

Definition at line 163 of file N_DEV_Neuron8.h.

bool Xyce::Device::Neuron8::Instance::dGiven
private

Definition at line 175 of file N_DEV_Neuron8.h.

double Xyce::Device::Neuron8::Instance::fallRate
private

Definition at line 165 of file N_DEV_Neuron8.h.

bool Xyce::Device::Neuron8::Instance::fallRateGiven
private

Definition at line 177 of file N_DEV_Neuron8.h.

std::vector< std::vector< int > > Xyce::Device::Neuron8::Instance::jacStamp
static

Definition at line 98 of file N_DEV_Neuron8.h.

double Xyce::Device::Neuron8::Instance::k
private

Definition at line 159 of file N_DEV_Neuron8.h.

bool Xyce::Device::Neuron8::Instance::kGiven
private

Definition at line 171 of file N_DEV_Neuron8.h.

int Xyce::Device::Neuron8::Instance::li_U
private

Definition at line 205 of file N_DEV_Neuron8.h.

int Xyce::Device::Neuron8::Instance::li_V
private

Definition at line 204 of file N_DEV_Neuron8.h.

double Xyce::Device::Neuron8::Instance::memCap
private

Definition at line 155 of file N_DEV_Neuron8.h.

bool Xyce::Device::Neuron8::Instance::memCapGiven
private

Definition at line 167 of file N_DEV_Neuron8.h.

Model& Xyce::Device::Neuron8::Instance::model_
private

Definition at line 152 of file N_DEV_Neuron8.h.

bool Xyce::Device::Neuron8::Instance::resetting
private

Definition at line 200 of file N_DEV_Neuron8.h.

double Xyce::Device::Neuron8::Instance::uEqudFdu
private

Definition at line 195 of file N_DEV_Neuron8.h.

double Xyce::Device::Neuron8::Instance::uEqudFdv
private

Definition at line 194 of file N_DEV_Neuron8.h.

double Xyce::Device::Neuron8::Instance::uEqudQdu
private

Definition at line 196 of file N_DEV_Neuron8.h.

double Xyce::Device::Neuron8::Instance::uEquFvalue
private

Definition at line 192 of file N_DEV_Neuron8.h.

double Xyce::Device::Neuron8::Instance::uEquQvalue
private

Definition at line 193 of file N_DEV_Neuron8.h.

int Xyce::Device::Neuron8::Instance::uEquUOffset
private

Definition at line 211 of file N_DEV_Neuron8.h.

int Xyce::Device::Neuron8::Instance::uEquVOffset
private

Definition at line 210 of file N_DEV_Neuron8.h.

double Xyce::Device::Neuron8::Instance::uPeak
private

Definition at line 201 of file N_DEV_Neuron8.h.

double Xyce::Device::Neuron8::Instance::uscale
private

Definition at line 164 of file N_DEV_Neuron8.h.

bool Xyce::Device::Neuron8::Instance::uscaleGiven
private

Definition at line 176 of file N_DEV_Neuron8.h.

double Xyce::Device::Neuron8::Instance::vEqudFdu
private

Definition at line 190 of file N_DEV_Neuron8.h.

double Xyce::Device::Neuron8::Instance::vEqudFdv
private

Definition at line 189 of file N_DEV_Neuron8.h.

double Xyce::Device::Neuron8::Instance::vEqudQdv
private

Definition at line 191 of file N_DEV_Neuron8.h.

double Xyce::Device::Neuron8::Instance::vEquFvalue
private

Definition at line 187 of file N_DEV_Neuron8.h.

double Xyce::Device::Neuron8::Instance::vEquQvalue
private

Definition at line 188 of file N_DEV_Neuron8.h.

int Xyce::Device::Neuron8::Instance::vEquUOffset
private

Definition at line 209 of file N_DEV_Neuron8.h.

int Xyce::Device::Neuron8::Instance::vEquVOffset
private

Definition at line 208 of file N_DEV_Neuron8.h.

double Xyce::Device::Neuron8::Instance::Vpeak
private

Definition at line 158 of file N_DEV_Neuron8.h.

bool Xyce::Device::Neuron8::Instance::VpeakGiven
private

Definition at line 170 of file N_DEV_Neuron8.h.

double Xyce::Device::Neuron8::Instance::Vr
private

Definition at line 157 of file N_DEV_Neuron8.h.

bool Xyce::Device::Neuron8::Instance::VrGiven
private

Definition at line 169 of file N_DEV_Neuron8.h.

double Xyce::Device::Neuron8::Instance::Vt
private

Definition at line 156 of file N_DEV_Neuron8.h.

bool Xyce::Device::Neuron8::Instance::VtGiven
private

Definition at line 168 of file N_DEV_Neuron8.h.


The documentation for this class was generated from the following files: