Xyce  6.1
Xyce::Device::Inductor::Instance Class Reference

#include <N_DEV_Inductor.h>

Inheritance diagram for Xyce::Device::Inductor::Instance:
Collaboration diagram for Xyce::Device::Inductor::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 registerBranchDataLIDs (const std::vector< int > &branchLIDVecRef)
 Register the local store IDs. More...
 
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 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 ()
 
void setupPointers ()
 
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 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 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 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 ()
 
virtual double getMaxTimeStepSize ()
 
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 L
 
double IC
 
bool ICGiven
 
double baseL
 
double temp
 
bool tempGiven
 
double tempCoeff1
 
double tempCoeff2
 
bool tempCoeff1Given
 
bool tempCoeff2Given
 
double f0
 
int li_fstate
 
int li_Pos
 
int li_Neg
 
int li_Bra
 
int li_branch_data
 Index for lead current and junction voltage (for power calculations) More...
 
std::vector< int > xLBraVar_J
 
std::vector< int > li_LBra
 
int ABraEquLBraVar_I
 
int ABraEquPosNodeOffset
 
int ABraEquNegNodeOffset
 
int ABraEquBraVarOffset
 
int APosEquBraVarOffset
 
int ANegEquBraVarOffset
 
int AEPosEquEBraVarOffset
 
int AENegEquEBraVarOffset
 
int AEBraEquEPosNodeOffset
 
int AEBraEquENegNodeOffset
 
int AEBraEquLNegNodeOffset
 
double * fPosEquBraVarPtr
 
double * fNegEquBraVarPtr
 
double * fBraEquPosNodePtr
 
double * fBraEquNegNodePtr
 
double * fBraEquBraVarPtr
 
double * qBraEquBraVarPtr
 

Static Private Attributes

static std::vector< std::vector< int > > jacStamp_BASE
 

Friends

class ParametricData< Instance >
 
class Model
 
class Traits
 
class Master
 
class indSensitivity
 

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 111 of file N_DEV_Inductor.h.

Constructor & Destructor Documentation

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

Definition at line 184 of file N_DEV_Inductor.C.

Xyce::Device::Inductor::Instance::~Instance ( )

Definition at line 284 of file N_DEV_Inductor.C.

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

Member Function Documentation

void Xyce::Device::Inductor::Instance::auxDAECalculations ( )
Model& Xyce::Device::Inductor::Instance::getModel ( )
inline

Definition at line 168 of file N_DEV_Inductor.h.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 433 of file N_DEV_Inductor.C.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 590 of file N_DEV_Inductor.C.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 571 of file N_DEV_Inductor.C.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 528 of file N_DEV_Inductor.C.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 507 of file N_DEV_Inductor.C.

void Xyce::Device::Inductor::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 398 of file N_DEV_Inductor.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 149 of file N_DEV_Inductor.C.

void Xyce::Device::Inductor::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 380 of file N_DEV_Inductor.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 446 of file N_DEV_Inductor.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 321 of file N_DEV_Inductor.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 415 of file N_DEV_Inductor.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 624 of file N_DEV_Inductor.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 296 of file N_DEV_Inductor.C.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 145 of file N_DEV_Inductor.h.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 465 of file N_DEV_Inductor.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 487 of file N_DEV_Inductor.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 167 of file N_DEV_Inductor.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 655 of file N_DEV_Inductor.C.

Friends And Related Function Documentation

friend class indSensitivity
friend

Definition at line 116 of file N_DEV_Inductor.h.

friend class Master
friend

Definition at line 115 of file N_DEV_Inductor.h.

friend class Model
friend

Definition at line 114 of file N_DEV_Inductor.h.

friend class ParametricData< Instance >
friend

Definition at line 113 of file N_DEV_Inductor.h.

friend class Traits
friend

Definition at line 115 of file N_DEV_Inductor.h.

Member Data Documentation

int Xyce::Device::Inductor::Instance::ABraEquBraVarOffset
private

Definition at line 225 of file N_DEV_Inductor.h.

int Xyce::Device::Inductor::Instance::ABraEquLBraVar_I
private

Definition at line 214 of file N_DEV_Inductor.h.

int Xyce::Device::Inductor::Instance::ABraEquNegNodeOffset
private

Definition at line 222 of file N_DEV_Inductor.h.

int Xyce::Device::Inductor::Instance::ABraEquPosNodeOffset
private

Definition at line 219 of file N_DEV_Inductor.h.

int Xyce::Device::Inductor::Instance::AEBraEquENegNodeOffset
private

Definition at line 240 of file N_DEV_Inductor.h.

int Xyce::Device::Inductor::Instance::AEBraEquEPosNodeOffset
private

Definition at line 238 of file N_DEV_Inductor.h.

int Xyce::Device::Inductor::Instance::AEBraEquLNegNodeOffset
private

Definition at line 242 of file N_DEV_Inductor.h.

int Xyce::Device::Inductor::Instance::AENegEquEBraVarOffset
private

Definition at line 236 of file N_DEV_Inductor.h.

int Xyce::Device::Inductor::Instance::AEPosEquEBraVarOffset
private

Definition at line 234 of file N_DEV_Inductor.h.

int Xyce::Device::Inductor::Instance::ANegEquBraVarOffset
private

Definition at line 231 of file N_DEV_Inductor.h.

int Xyce::Device::Inductor::Instance::APosEquBraVarOffset
private

Definition at line 228 of file N_DEV_Inductor.h.

double Xyce::Device::Inductor::Instance::baseL
private

Definition at line 183 of file N_DEV_Inductor.h.

double Xyce::Device::Inductor::Instance::f0
private

Definition at line 198 of file N_DEV_Inductor.h.

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

Definition at line 250 of file N_DEV_Inductor.h.

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

Definition at line 249 of file N_DEV_Inductor.h.

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

Definition at line 248 of file N_DEV_Inductor.h.

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

Definition at line 247 of file N_DEV_Inductor.h.

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

Definition at line 246 of file N_DEV_Inductor.h.

double Xyce::Device::Inductor::Instance::IC
private

Definition at line 181 of file N_DEV_Inductor.h.

bool Xyce::Device::Inductor::Instance::ICGiven
private

Definition at line 182 of file N_DEV_Inductor.h.

std::vector< std::vector< int > > Xyce::Device::Inductor::Instance::jacStamp_BASE
staticprivate

Definition at line 174 of file N_DEV_Inductor.h.

double Xyce::Device::Inductor::Instance::L
private

Definition at line 180 of file N_DEV_Inductor.h.

int Xyce::Device::Inductor::Instance::li_Bra
private

Definition at line 206 of file N_DEV_Inductor.h.

int Xyce::Device::Inductor::Instance::li_branch_data
private

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

Definition at line 208 of file N_DEV_Inductor.h.

int Xyce::Device::Inductor::Instance::li_fstate
private

Definition at line 201 of file N_DEV_Inductor.h.

std::vector<int> Xyce::Device::Inductor::Instance::li_LBra
private

Definition at line 212 of file N_DEV_Inductor.h.

int Xyce::Device::Inductor::Instance::li_Neg
private

Definition at line 205 of file N_DEV_Inductor.h.

int Xyce::Device::Inductor::Instance::li_Pos
private

Definition at line 204 of file N_DEV_Inductor.h.

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

Definition at line 177 of file N_DEV_Inductor.h.

double* Xyce::Device::Inductor::Instance::qBraEquBraVarPtr
private

Definition at line 251 of file N_DEV_Inductor.h.

double Xyce::Device::Inductor::Instance::temp
private

Definition at line 184 of file N_DEV_Inductor.h.

double Xyce::Device::Inductor::Instance::tempCoeff1
private

Definition at line 189 of file N_DEV_Inductor.h.

bool Xyce::Device::Inductor::Instance::tempCoeff1Given
private

Definition at line 194 of file N_DEV_Inductor.h.

double Xyce::Device::Inductor::Instance::tempCoeff2
private

Definition at line 190 of file N_DEV_Inductor.h.

bool Xyce::Device::Inductor::Instance::tempCoeff2Given
private

Definition at line 195 of file N_DEV_Inductor.h.

bool Xyce::Device::Inductor::Instance::tempGiven
private

Definition at line 185 of file N_DEV_Inductor.h.

std::vector<int> Xyce::Device::Inductor::Instance::xLBraVar_J
private

Definition at line 211 of file N_DEV_Inductor.h.


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