Xyce  6.1
Xyce::Device::ISRC::Instance Class Reference

#include <N_DEV_ISRC.h>

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

Public Member Functions

 Instance (const Configuration &configuration, const InstanceBlock &instance_block, Model &model, const FactoryBlock &factory_block)
 
 ~Instance ()
 
void registerLIDs (const std::vector< int > &intLIDVecRef, const std::vector< int > &extLIDVecRef)
 
void registerStateLIDs (const std::vector< int > &staLIDVecRef)
 
void registerStoreLIDs (const std::vector< int > &stoLIDVecRef)
 
void registerBranchDataLIDs (const std::vector< int > &branchLIDVecRef)
 Register the local store IDs. More...
 
virtual void loadNodeSymbols (Util::SymbolTable &symbol_table) const
 Populates and returns the store name map. More...
 
const std::vector< std::vector< int > > & jacobianStamp () const
 
bool processParams ()
 
bool updateIntermediateVars ()
 
bool updatePrimaryState ()
 
bool loadTrivialMatrixStamp ()
 
bool loadTrivialDAE_FMatrixStamp ()
 
bool loadDAEQVector ()
 
bool loadDAEFVector ()
 
bool loadDAEBVector ()
 
bool loadDAEdQdx ()
 
bool loadDAEdFdx ()
 
bool loadBVectorsforAC (double *bVecReal, double *bVecImag)
 
ModelgetModel ()
 
- Public Member Functions inherited from Xyce::Device::SourceInstance
 SourceInstance (const InstanceBlock &IB, ParametricData< void > &parametric_data, const FactoryBlock &factory_block)
 
 ~SourceInstance ()
 
void setFastSourceFlag (bool value)
 
bool getFastSourceFlag () const
 
bool getResetFlag () const
 
double period () const
 
virtual bool getInstanceBreakPoints (std::vector< Util::BreakPoint > &breakPointTimes)
 
virtual bool updateSource ()
 
- 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 IndexPairVector &intGIDListRef, const IndexPairVector &extGIDListRef)
 
virtual void registerStateGIDs (const IndexPairVector &staGIDListRef)
 
virtual void registerStoreGIDs (const IndexPairVector &stoGIDListRef)
 
virtual const std::vector< std::string > & getDepSolnVars ()
 
virtual void registerDepSolnGIDs (const std::vector< IdVector > &varList)
 
virtual const std::vector< std::string > & getDepStateVars ()
 
virtual void registerDepStateGIDs (const std::vector< IdVector > &varList)
 
virtual const std::vector< std::string > & getDepStoreVars ()
 
virtual void registerDepStoreGIDs (const std::vector< IdVector > &varList)
 
virtual const std::vector< std::string > & getDepLeadCurrentVars ()
 
virtual void registerDepLeadCurrentGIDs (const std::vector< IdVector > &varList)
 
virtual void registerDepSolnLIDs (const std::vector< IdVector > &depSolnLIDVecRef)
 
virtual void registerDepStateLIDs (const std::vector< IdVector > &depStaLIDVecRef)
 
virtual void registerDepStoreLIDs (const std::vector< IdVector > &depStoLIDVecRef)
 
virtual void registerJacLIDs (const JacobianStamp &jacLIDVec)
 
virtual void registerGIDData (const std::vector< int > &counts, const IdVector &GIDs, const JacobianStamp &jacGIDs)
 
virtual void setupPointers ()
 
virtual const IdVectorgetDepSolnGIDVec ()
 
virtual const IndexPairVector & getIndexPairList ()
 
virtual bool processInstanceParams ()
 
virtual bool updateTemperature (const double &temp_tmp)
 
virtual bool isConverged ()
 
virtual bool testDAEMatrices (const std::vector< const std::string * > &nameVec)
 
bool trivialStampLoader (Linear::Matrix *matPtr)
 
bool zeroMatrixDiagonal (Linear::Matrix *matPtr)
 
virtual bool updateSecondaryState ()
 
virtual bool setIC ()
 
virtual bool plotfileFlag ()
 
virtual void loadErrorWeightMask ()
 
virtual void acceptStep ()
 
virtual int getNumNoiseSources () const
 
virtual void setupNoiseSources (Xyce::Analysis::NoiseData &noiseDataVec)
 
virtual void getNoiseSources (Xyce::Analysis::NoiseData &noiseDataVec)
 
const InstanceNamegetName () const
 
int getNumIntVars () const
 
int getNumExtVars () const
 
int getNumStateVars () const
 
int getNumStoreVars () const
 
int getNumBranchDataVars () const
 
void setNumStoreVars (int num_store_vars)
 
void setNumBranchDataVars (int num_branch_data_vars)
 
virtual const std::vector< int > & getDevConMap ()
 
virtual DeviceStategetInternalState ()
 
virtual bool setInternalState (const DeviceState &state)
 
virtual bool loadDFDV (int iElectrode, Linear::Vector *dfdvPtr)
 
virtual bool calcConductance (int iElectrode, const Linear::Vector *dxdvPtr)
 
virtual bool outputPlotFiles ()
 
virtual bool enablePDEContinuation (int &max_PDE_continuation_steps)
 
virtual bool disablePDEContinuation ()
 
virtual void setPDEContinuationAlpha (double alpha)
 
virtual void setPDEContinuationBeta (double beta)
 
virtual bool setInitialGuess ()
 
virtual double getMaxTimeStepSize ()
 
virtual void varTypes (std::vector< char > &varTypeVec)
 
bool getOrigFlag () const
 
void setOrigFlag (bool origFlag_local)
 
const IdVectorgetDevLIDs () const
 
const std::vector< IdVector > & getDevJacLIDs () const
 
const IdVectorgetStaLIDVec () 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_filename, int netlist_line)
 
virtual ~DeviceEntity ()
 
virtual CompositeParamconstructComposite (const std::string &composite_name, const std::string &param_name)
 
bool setDefaultParam (double val, bool overrideOriginal=false)
 
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 overrideOriginal=false)
 
bool getParam (const std::string &paramName, double &result) const
 
bool getParamBreakpoints (std::vector< Util::BreakPoint > &)
 
bool updateDependentParameters (Linear::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)
 

Private Member Functions

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

Private Attributes

Modelmodel_
 
int li_Pos
 
int li_Neg
 
int li_store_dev_i
 
int li_branch_data
 Index for lead current and junction voltage (for power calculations) More...
 
double DCV0
 
double par0
 
double par1
 
double par2
 
double par3
 
double par4
 
double par5
 
double par6
 
double par7
 
double REPEATTIME
 
double T
 
double V
 
int NUM
 
bool REPEAT
 
int TRANSIENTSOURCETYPE
 
bool TRANSIENTSOURCETYPEgiven
 
int ACSOURCETYPE
 
bool ACSOURCETYPEgiven
 
int DCSOURCETYPE
 
bool DCSOURCETYPEgiven
 
bool gotParams
 
double ACMAG
 
double ACPHASE
 

Static Private Attributes

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

Friends

class ParametricData< Instance >
 
class Model
 
class Traits
 
class Master
 

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 numLeadCurrentVars
 
int numLeadCurrentStoreVars
 
bool loadLeadCurrent
 
int numBranchDataVars
 
int numBranchDataVarsIfAllocated
 
std::vector< int > devConMap
 
bool mergeRowColChecked
 
- Protected Member Functions inherited from Xyce::Device::DeviceInstance
void jacStampMap (const JacobianStamp &stamp_parent, IdVector &map_parent, JacobianStamp &map2_parent, JacobianStamp &stamp, IdVector &map, JacobianStamp &map2, int from, int to, int original_size)
 
void jacStampMap_fixOrder (const JacobianStamp &stamp_parent, JacobianStamp &map2_parent, JacobianStamp &stamp, JacobianStamp &map2)
 
void outputJacStamp (const JacobianStamp &jac)
 
void outputJacMaps (const std::vector< int > &jacMap, const JacobianStamp &jacMap2)
 
- Protected Attributes inherited from Xyce::Device::SourceInstance
int sourceType
 type of source data More...
 
SourceDatatranSourceData_
 
SourceDataacSourceData_
 
SourceDatadcSourceData_
 
- Protected Attributes inherited from Xyce::Device::DeviceInstance
const ExternDataextData
 
IndexPairVector indexPairList
 
IndexPairVector intGIDList
 
IndexPairVector extGIDList
 
IndexPairVector staGIDList
 
IdVector intLIDVec
 
IdVector extLIDVec
 
IdVector staLIDVec
 
IdVector stoLIDVec
 
IdVector devLIDs
 devLIDs is a combined LID vector, containing int, ext, and expVar ID's. More...
 
JacobianStamp devJacLIDs
 
DeviceSupport devSupport
 
- Protected Attributes inherited from Xyce::Device::DeviceEntity
std::vector< int > expVarGIDs
 
std::vector< int > expVarLIDs
 
std::vector< std::string > expVarNames
 
std::vector< double > expVarVals
 
std::vector< double > eVarVals
 

Detailed Description

Definition at line 86 of file N_DEV_ISRC.h.

Constructor & Destructor Documentation

Xyce::Device::ISRC::Instance::Instance ( const Configuration configuration,
const InstanceBlock instance_block,
Model model,
const FactoryBlock factory_block 
)

Definition at line 206 of file N_DEV_ISRC.C.

Xyce::Device::ISRC::Instance::~Instance ( )

Definition at line 372 of file N_DEV_ISRC.C.

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

Member Function Documentation

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

Definition at line 142 of file N_DEV_ISRC.h.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 511 of file N_DEV_ISRC.C.

bool Xyce::Device::ISRC::Instance::loadBVectorsforAC ( double *  bVecReal,
double *  bVecImag 
)
virtual

Reimplemented from Xyce::Device::SourceInstance.

Definition at line 528 of file N_DEV_ISRC.C.

bool Xyce::Device::ISRC::Instance::loadDAEBVector ( )
virtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 591 of file N_DEV_ISRC.C.

bool Xyce::Device::ISRC::Instance::loadDAEdFdx ( )
inlinevirtual

Implements Xyce::Device::DeviceInstance.

Definition at line 132 of file N_DEV_ISRC.h.

bool Xyce::Device::ISRC::Instance::loadDAEdQdx ( )
inlinevirtual

Implements Xyce::Device::DeviceInstance.

Definition at line 131 of file N_DEV_ISRC.h.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 576 of file N_DEV_ISRC.C.

bool Xyce::Device::ISRC::Instance::loadDAEQVector ( )
inlinevirtual

Implements Xyce::Device::DeviceInstance.

Definition at line 126 of file N_DEV_ISRC.h.

void Xyce::Device::ISRC::Instance::loadNodeSymbols ( Util::SymbolTable &  symbol_table) const
virtual

Populates and returns the store name map.

If the DeviceInstance::storeNameMap is empty, populate it.

For the purpose of lead currents, store vector elements must be given names that can be used to locate lead currents at print time. When a netlist attempts to print, say, "I(R1)" the output code looks for an entry in the store vector named R1:DEV_I.

This method does the assignment of names to various vector elements.

Author
David G. Baur
Date
12/18/2014

Implements Xyce::Device::DeviceInstance.

Definition at line 493 of file N_DEV_ISRC.C.

bool Xyce::Device::ISRC::Instance::loadTrivialDAE_FMatrixStamp ( )
inlinevirtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 255 of file N_DEV_ISRC.h.

bool Xyce::Device::ISRC::Instance::loadTrivialMatrixStamp ( )
inline

Definition at line 242 of file N_DEV_ISRC.h.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 327 of file N_DEV_ISRC.C.

void Xyce::Device::ISRC::Instance::registerBranchDataLIDs ( const std::vector< int > &  branchLIDVecRef)
virtual

Register the local store IDs.

In addition to state vector, Xyce maintains a separate datastructure called a "branch data" vector. As with other such vectors, the device declares at construction time how many branch vector entries it needs, and later Topology assigns locations for devices, returning LIDs.

These LIDs are stored in this method for later use.

The Resistor device uses exactly one "branch data vector" element, where

Parameters
stoLIDVecRefStore variable local IDs
Author
Richard Schiek, Electrical Systems Modeling
Date
12/18/2012

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 475 of file N_DEV_ISRC.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 388 of file N_DEV_ISRC.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 428 of file N_DEV_ISRC.C.

void Xyce::Device::ISRC::Instance::registerStoreLIDs ( const std::vector< int > &  stoLIDVecRef)
virtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 441 of file N_DEV_ISRC.C.

bool Xyce::Device::ISRC::Instance::updateIntermediateVars ( )
inlinevirtual

Implements Xyce::Device::DeviceInstance.

Definition at line 119 of file N_DEV_ISRC.h.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 562 of file N_DEV_ISRC.C.

Friends And Related Function Documentation

friend class Master
friend

Definition at line 91 of file N_DEV_ISRC.h.

friend class Model
friend

Definition at line 89 of file N_DEV_ISRC.h.

friend class ParametricData< Instance >
friend

Definition at line 88 of file N_DEV_ISRC.h.

friend class Traits
friend

Definition at line 90 of file N_DEV_ISRC.h.

Member Data Documentation

double Xyce::Device::ISRC::Instance::ACMAG
private

Definition at line 184 of file N_DEV_ISRC.h.

double Xyce::Device::ISRC::Instance::ACPHASE
private

Definition at line 185 of file N_DEV_ISRC.h.

int Xyce::Device::ISRC::Instance::ACSOURCETYPE
private

Definition at line 177 of file N_DEV_ISRC.h.

bool Xyce::Device::ISRC::Instance::ACSOURCETYPEgiven
private

Definition at line 178 of file N_DEV_ISRC.h.

int Xyce::Device::ISRC::Instance::DCSOURCETYPE
private

Definition at line 179 of file N_DEV_ISRC.h.

bool Xyce::Device::ISRC::Instance::DCSOURCETYPEgiven
private

Definition at line 180 of file N_DEV_ISRC.h.

double Xyce::Device::ISRC::Instance::DCV0
private

Definition at line 161 of file N_DEV_ISRC.h.

bool Xyce::Device::ISRC::Instance::gotParams
private

Definition at line 181 of file N_DEV_ISRC.h.

std::vector< std::vector< int > > Xyce::Device::ISRC::Instance::jacStamp
staticprivate

Definition at line 148 of file N_DEV_ISRC.h.

int Xyce::Device::ISRC::Instance::li_branch_data
private

Index for lead current and junction voltage (for power calculations)

Definition at line 158 of file N_DEV_ISRC.h.

int Xyce::Device::ISRC::Instance::li_Neg
private

Definition at line 154 of file N_DEV_ISRC.h.

int Xyce::Device::ISRC::Instance::li_Pos
private

Definition at line 153 of file N_DEV_ISRC.h.

int Xyce::Device::ISRC::Instance::li_store_dev_i
private

Definition at line 157 of file N_DEV_ISRC.h.

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

Definition at line 150 of file N_DEV_ISRC.h.

int Xyce::Device::ISRC::Instance::NUM
private

Definition at line 173 of file N_DEV_ISRC.h.

double Xyce::Device::ISRC::Instance::par0
private

Definition at line 162 of file N_DEV_ISRC.h.

double Xyce::Device::ISRC::Instance::par1
private

Definition at line 163 of file N_DEV_ISRC.h.

double Xyce::Device::ISRC::Instance::par2
private

Definition at line 164 of file N_DEV_ISRC.h.

double Xyce::Device::ISRC::Instance::par3
private

Definition at line 165 of file N_DEV_ISRC.h.

double Xyce::Device::ISRC::Instance::par4
private

Definition at line 166 of file N_DEV_ISRC.h.

double Xyce::Device::ISRC::Instance::par5
private

Definition at line 167 of file N_DEV_ISRC.h.

double Xyce::Device::ISRC::Instance::par6
private

Definition at line 168 of file N_DEV_ISRC.h.

double Xyce::Device::ISRC::Instance::par7
private

Definition at line 169 of file N_DEV_ISRC.h.

bool Xyce::Device::ISRC::Instance::REPEAT
private

Definition at line 174 of file N_DEV_ISRC.h.

double Xyce::Device::ISRC::Instance::REPEATTIME
private

Definition at line 170 of file N_DEV_ISRC.h.

double Xyce::Device::ISRC::Instance::T
private

Definition at line 171 of file N_DEV_ISRC.h.

int Xyce::Device::ISRC::Instance::TRANSIENTSOURCETYPE
private

Definition at line 175 of file N_DEV_ISRC.h.

bool Xyce::Device::ISRC::Instance::TRANSIENTSOURCETYPEgiven
private

Definition at line 176 of file N_DEV_ISRC.h.

double Xyce::Device::ISRC::Instance::V
private

Definition at line 172 of file N_DEV_ISRC.h.


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