Xyce  6.1
Xyce::Device::Resistor3::Instance Class Reference

#include <N_DEV_Resistor3.h>

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

Public Member Functions

 Instance (const Configuration &configuration, const InstanceBlock &IB, Model &Viter, 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 loadNodeSymbols (Util::SymbolTable &symbol_table) const
 Populates and returns the store name map. More...
 
const std::vector< std::vector< int > > & jacobianStamp () const
 
void registerJacLIDs (const std::vector< std::vector< int > > &jacLIDVec)
 
bool processParams ()
 
bool updateIntermediateVars ()
 
bool updatePrimaryState ()
 
bool loadDAEQVector ()
 
bool loadDAEFVector ()
 
bool loadDAEdQdx ()
 
bool loadDAEdFdx ()
 
void setupPointers ()
 
double getMaxTimeStepSize ()
 
void varTypes (std::vector< char > &varTypeVec)
 
void getLIDs (int &lpos, int &lneg, int &lbra)
 
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 IndexPairVector &intGIDListRef, const IndexPairVector &extGIDListRef)
 
virtual void registerStateGIDs (const IndexPairVector &staGIDListRef)
 
virtual void registerStoreGIDs (const IndexPairVector &stoGIDListRef)
 
virtual void registerStoreLIDs (const LocalIdVector &stoLIDVecRef)
 
virtual void registerBranchDataLIDs (const LocalIdVector &branchDataLIDVecRef)
 
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 registerGIDData (const std::vector< int > &counts, const IdVector &GIDs, const JacobianStamp &jacGIDs)
 
virtual const IdVectorgetDepSolnGIDVec ()
 
virtual const IndexPairVector & getIndexPairList ()
 
virtual bool getInstanceBreakPoints (std::vector< Util::BreakPoint > &breakPointTimes)
 
virtual bool updateSource ()
 
virtual bool processInstanceParams ()
 
virtual bool updateTemperature (const double &temp_tmp)
 
virtual bool isConverged ()
 
virtual bool testDAEMatrices (const std::vector< const std::string * > &nameVec)
 
virtual bool loadTrivialDAE_FMatrixStamp ()
 
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 bool loadDAEBVector ()
 
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 ()
 
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_
 
double srcCurrent
 
double srcVoltage
 
double srcDrop
 
double srcBC
 
double scale
 
int nlstep
 
double R
 
double length
 
double width
 
double temp
 
double tempCoeff1
 
double tempCoeff2
 
double dtemp
 
bool tempCoeff1Given
 
bool tempCoeff2Given
 
bool dtempGiven
 
double source
 
double v_pos
 
double v_neg
 
double i_bra
 
int istate_I
 
int li_Pos
 
int li_Neg
 
int li_Bra
 
int ABraEquPosNodeOffset
 
int ABraEquNegNodeOffset
 
int APosEquBraVarOffset
 
int ANegEquBraVarOffset
 
int APosEquPosNodeOffset
 
int ANegEquNegNodeOffset
 
int ABraEquBraVarOffset
 
double * fBraEquPosNodePtr
 
double * fBraEquNegNodePtr
 
double * fPosEquBraVarPtr
 
double * fNegEquBraVarPtr
 
double * fPosEquPosNodePtr
 
double * fNegEquNegNodePtr
 
double * fBraEquBraVarPtr
 

Static Private Attributes

static std::vector< std::vector< int > > jacStamp
 
static std::vector< std::vector< int > > jacStampPDE
 
static ParametricData< InstanceparMap_
 

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::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 89 of file N_DEV_Resistor3.h.

Constructor & Destructor Documentation

Xyce::Device::Resistor3::Instance::Instance ( const Configuration configuration,
const InstanceBlock IB,
Model Viter,
const FactoryBlock factory_block 
)

Definition at line 134 of file N_DEV_Resistor3.C.

Xyce::Device::Resistor3::Instance::~Instance ( )

Definition at line 232 of file N_DEV_Resistor3.C.

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

Member Function Documentation

void Xyce::Device::Resistor3::Instance::getLIDs ( int &  lpos,
int &  lneg,
int &  lbra 
)
inline

Definition at line 138 of file N_DEV_Resistor3.h.

double Xyce::Device::Resistor3::Instance::getMaxTimeStepSize ( )
virtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 522 of file N_DEV_Resistor3.C.

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

Definition at line 144 of file N_DEV_Resistor3.h.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 343 of file N_DEV_Resistor3.C.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 500 of file N_DEV_Resistor3.C.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 129 of file N_DEV_Resistor3.h.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 473 of file N_DEV_Resistor3.C.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 125 of file N_DEV_Resistor3.h.

void Xyce::Device::Resistor3::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 317 of file N_DEV_Resistor3.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 244 of file N_DEV_Resistor3.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 359 of file N_DEV_Resistor3.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 257 of file N_DEV_Resistor3.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 330 of file N_DEV_Resistor3.C.

void Xyce::Device::Resistor3::Instance::setupPointers ( )
virtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 387 of file N_DEV_Resistor3.C.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 407 of file N_DEV_Resistor3.C.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 455 of file N_DEV_Resistor3.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 536 of file N_DEV_Resistor3.C.

Friends And Related Function Documentation

friend class Master
friend

Definition at line 94 of file N_DEV_Resistor3.h.

friend class Model
friend

Definition at line 92 of file N_DEV_Resistor3.h.

friend class ParametricData< Instance >
friend

Definition at line 91 of file N_DEV_Resistor3.h.

friend class Traits
friend

Definition at line 93 of file N_DEV_Resistor3.h.

Member Data Documentation

int Xyce::Device::Resistor3::Instance::ABraEquBraVarOffset
private

Definition at line 221 of file N_DEV_Resistor3.h.

int Xyce::Device::Resistor3::Instance::ABraEquNegNodeOffset
private

Definition at line 204 of file N_DEV_Resistor3.h.

int Xyce::Device::Resistor3::Instance::ABraEquPosNodeOffset
private

Definition at line 201 of file N_DEV_Resistor3.h.

int Xyce::Device::Resistor3::Instance::ANegEquBraVarOffset
private

Definition at line 210 of file N_DEV_Resistor3.h.

int Xyce::Device::Resistor3::Instance::ANegEquNegNodeOffset
private

Definition at line 218 of file N_DEV_Resistor3.h.

int Xyce::Device::Resistor3::Instance::APosEquBraVarOffset
private

Definition at line 207 of file N_DEV_Resistor3.h.

int Xyce::Device::Resistor3::Instance::APosEquPosNodeOffset
private

Definition at line 215 of file N_DEV_Resistor3.h.

double Xyce::Device::Resistor3::Instance::dtemp
private

Definition at line 177 of file N_DEV_Resistor3.h.

bool Xyce::Device::Resistor3::Instance::dtempGiven
private

Definition at line 184 of file N_DEV_Resistor3.h.

double* Xyce::Device::Resistor3::Instance::fBraEquBraVarPtr
private

Definition at line 234 of file N_DEV_Resistor3.h.

double* Xyce::Device::Resistor3::Instance::fBraEquNegNodePtr
private

Definition at line 227 of file N_DEV_Resistor3.h.

double* Xyce::Device::Resistor3::Instance::fBraEquPosNodePtr
private

Definition at line 226 of file N_DEV_Resistor3.h.

double* Xyce::Device::Resistor3::Instance::fNegEquBraVarPtr
private

Definition at line 229 of file N_DEV_Resistor3.h.

double* Xyce::Device::Resistor3::Instance::fNegEquNegNodePtr
private

Definition at line 233 of file N_DEV_Resistor3.h.

double* Xyce::Device::Resistor3::Instance::fPosEquBraVarPtr
private

Definition at line 228 of file N_DEV_Resistor3.h.

double* Xyce::Device::Resistor3::Instance::fPosEquPosNodePtr
private

Definition at line 232 of file N_DEV_Resistor3.h.

double Xyce::Device::Resistor3::Instance::i_bra
private

Definition at line 187 of file N_DEV_Resistor3.h.

int Xyce::Device::Resistor3::Instance::istate_I
private

Definition at line 190 of file N_DEV_Resistor3.h.

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

Definition at line 150 of file N_DEV_Resistor3.h.

std::vector< std::vector< int > > Xyce::Device::Resistor3::Instance::jacStampPDE
staticprivate

Definition at line 151 of file N_DEV_Resistor3.h.

double Xyce::Device::Resistor3::Instance::length
private

Definition at line 170 of file N_DEV_Resistor3.h.

int Xyce::Device::Resistor3::Instance::li_Bra
private

Definition at line 197 of file N_DEV_Resistor3.h.

int Xyce::Device::Resistor3::Instance::li_Neg
private

Definition at line 196 of file N_DEV_Resistor3.h.

int Xyce::Device::Resistor3::Instance::li_Pos
private

Definition at line 195 of file N_DEV_Resistor3.h.

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

Definition at line 154 of file N_DEV_Resistor3.h.

int Xyce::Device::Resistor3::Instance::nlstep
private

Definition at line 164 of file N_DEV_Resistor3.h.

ParametricData<Instance> Xyce::Device::Resistor3::Instance::parMap_
staticprivate

Definition at line 152 of file N_DEV_Resistor3.h.

double Xyce::Device::Resistor3::Instance::R
private

Definition at line 168 of file N_DEV_Resistor3.h.

double Xyce::Device::Resistor3::Instance::scale
private

Definition at line 163 of file N_DEV_Resistor3.h.

double Xyce::Device::Resistor3::Instance::source
private

Definition at line 187 of file N_DEV_Resistor3.h.

double Xyce::Device::Resistor3::Instance::srcBC
private

Definition at line 160 of file N_DEV_Resistor3.h.

double Xyce::Device::Resistor3::Instance::srcCurrent
private

Definition at line 157 of file N_DEV_Resistor3.h.

double Xyce::Device::Resistor3::Instance::srcDrop
private

Definition at line 159 of file N_DEV_Resistor3.h.

double Xyce::Device::Resistor3::Instance::srcVoltage
private

Definition at line 158 of file N_DEV_Resistor3.h.

double Xyce::Device::Resistor3::Instance::temp
private

Definition at line 172 of file N_DEV_Resistor3.h.

double Xyce::Device::Resistor3::Instance::tempCoeff1
private

Definition at line 175 of file N_DEV_Resistor3.h.

bool Xyce::Device::Resistor3::Instance::tempCoeff1Given
private

Definition at line 182 of file N_DEV_Resistor3.h.

double Xyce::Device::Resistor3::Instance::tempCoeff2
private

Definition at line 176 of file N_DEV_Resistor3.h.

bool Xyce::Device::Resistor3::Instance::tempCoeff2Given
private

Definition at line 183 of file N_DEV_Resistor3.h.

double Xyce::Device::Resistor3::Instance::v_neg
private

Definition at line 187 of file N_DEV_Resistor3.h.

double Xyce::Device::Resistor3::Instance::v_pos
private

Definition at line 187 of file N_DEV_Resistor3.h.

double Xyce::Device::Resistor3::Instance::width
private

Definition at line 171 of file N_DEV_Resistor3.h.


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