Xyce  6.1
Xyce::Device::Vcvs::Instance Class Reference

#include <N_DEV_Vcvs.h>

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

Public Member Functions

 Instance (const Configuration &configuration, const InstanceBlock &IBref, 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 updateIntermediateVars ()
 
bool updatePrimaryState ()
 
bool loadDAEQVector ()
 
bool loadDAEFVector ()
 
bool loadDAEdQdx ()
 
bool loadDAEdFdx ()
 
void setupPointers ()
 
void varTypes (std::vector< char > &varTypeVec)
 
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 processParams ()
 
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 ()
 
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 Gain
 
double LeadCurrent
 
InstanceBlock IB
 
int li_Pos
 
int li_Neg
 
int li_Bra
 
int li_ContPos
 
int li_ContNeg
 
int ABraEquPosNodeOffset
 
int ABraEquNegNodeOffset
 
int ABraEquContPosNodeOffset
 
int ABraEquContNegNodeOffset
 
int APosEquBraVarOffset
 
int ANegEquBraVarOffset
 
double * f_BraEquPosNodePtr
 
double * f_BraEquNegNodePtr
 
double * f_BraEquContPosNodePtr
 
double * f_BraEquContNegNodePtr
 
double * f_PosEquBraVarPtr
 
double * f_NegEquBraVarPtr
 

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::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 84 of file N_DEV_Vcvs.h.

Constructor & Destructor Documentation

Xyce::Device::Vcvs::Instance::Instance ( const Configuration configuration,
const InstanceBlock IBref,
Model Viter,
const FactoryBlock factory_block 
)

Definition at line 90 of file N_DEV_Vcvs.C.

Xyce::Device::Vcvs::Instance::~Instance ( )

Definition at line 158 of file N_DEV_Vcvs.C.

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

Member Function Documentation

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

Definition at line 132 of file N_DEV_Vcvs.h.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 266 of file N_DEV_Vcvs.C.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 371 of file N_DEV_Vcvs.C.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 122 of file N_DEV_Vcvs.h.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 338 of file N_DEV_Vcvs.C.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 118 of file N_DEV_Vcvs.h.

void Xyce::Device::Vcvs::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 240 of file N_DEV_Vcvs.C.

Instance& Xyce::Device::Vcvs::Instance::operator= ( const Instance )
private
void Xyce::Device::Vcvs::Instance::registerJacLIDs ( const std::vector< std::vector< int > > &  jacLIDVec)
virtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 279 of file N_DEV_Vcvs.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 171 of file N_DEV_Vcvs.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 253 of file N_DEV_Vcvs.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 299 of file N_DEV_Vcvs.C.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 114 of file N_DEV_Vcvs.h.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 321 of file N_DEV_Vcvs.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 394 of file N_DEV_Vcvs.C.

Friends And Related Function Documentation

friend class Master
friend

Definition at line 88 of file N_DEV_Vcvs.h.

friend class Model
friend

Definition at line 87 of file N_DEV_Vcvs.h.

friend class ParametricData< Instance >
friend

Definition at line 86 of file N_DEV_Vcvs.h.

friend class Traits
friend

Definition at line 88 of file N_DEV_Vcvs.h.

Member Data Documentation

int Xyce::Device::Vcvs::Instance::ABraEquContNegNodeOffset
private

Definition at line 161 of file N_DEV_Vcvs.h.

int Xyce::Device::Vcvs::Instance::ABraEquContPosNodeOffset
private

Definition at line 160 of file N_DEV_Vcvs.h.

int Xyce::Device::Vcvs::Instance::ABraEquNegNodeOffset
private

Definition at line 159 of file N_DEV_Vcvs.h.

int Xyce::Device::Vcvs::Instance::ABraEquPosNodeOffset
private

Definition at line 158 of file N_DEV_Vcvs.h.

int Xyce::Device::Vcvs::Instance::ANegEquBraVarOffset
private

Definition at line 163 of file N_DEV_Vcvs.h.

int Xyce::Device::Vcvs::Instance::APosEquBraVarOffset
private

Definition at line 162 of file N_DEV_Vcvs.h.

double* Xyce::Device::Vcvs::Instance::f_BraEquContNegNodePtr
private

Definition at line 169 of file N_DEV_Vcvs.h.

double* Xyce::Device::Vcvs::Instance::f_BraEquContPosNodePtr
private

Definition at line 168 of file N_DEV_Vcvs.h.

double* Xyce::Device::Vcvs::Instance::f_BraEquNegNodePtr
private

Definition at line 167 of file N_DEV_Vcvs.h.

double* Xyce::Device::Vcvs::Instance::f_BraEquPosNodePtr
private

Definition at line 166 of file N_DEV_Vcvs.h.

double* Xyce::Device::Vcvs::Instance::f_NegEquBraVarPtr
private

Definition at line 171 of file N_DEV_Vcvs.h.

double* Xyce::Device::Vcvs::Instance::f_PosEquBraVarPtr
private

Definition at line 170 of file N_DEV_Vcvs.h.

double Xyce::Device::Vcvs::Instance::Gain
private

Definition at line 142 of file N_DEV_Vcvs.h.

InstanceBlock Xyce::Device::Vcvs::Instance::IB
private

Definition at line 145 of file N_DEV_Vcvs.h.

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

Definition at line 138 of file N_DEV_Vcvs.h.

double Xyce::Device::Vcvs::Instance::LeadCurrent
private

Definition at line 143 of file N_DEV_Vcvs.h.

int Xyce::Device::Vcvs::Instance::li_Bra
private

Definition at line 152 of file N_DEV_Vcvs.h.

int Xyce::Device::Vcvs::Instance::li_ContNeg
private

Definition at line 155 of file N_DEV_Vcvs.h.

int Xyce::Device::Vcvs::Instance::li_ContPos
private

Definition at line 154 of file N_DEV_Vcvs.h.

int Xyce::Device::Vcvs::Instance::li_Neg
private

Definition at line 151 of file N_DEV_Vcvs.h.

int Xyce::Device::Vcvs::Instance::li_Pos
private

Definition at line 150 of file N_DEV_Vcvs.h.

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

Definition at line 140 of file N_DEV_Vcvs.h.


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