Xyce  6.1
Xyce::Device::ThermalResistor::Instance Class Reference

#include <N_DEV_ThermalResistor.h>

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

Public Member Functions

 Instance (const Configuration &configuration, const InstanceBlock &IB, Model &Riter, 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)
 
virtual 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...
 
bool processParams ()
 
bool updateTemperature (const double &temp_tmp)
 
bool updateIntermediateVars ()
 
bool updatePrimaryState ()
 
const std::vector< std::vector< int > > & jacobianStamp () const
 
void registerJacLIDs (const std::vector< std::vector< int > > &jacLIDVec)
 
bool plotfileFlag ()
 
bool loadDAEQVector ()
 
bool loadDAEFVector ()
 
bool loadDAEdQdx ()
 
bool loadDAEdFdx ()
 
void setupPointers ()
 
bool outputPlotFiles (bool force_final_output)
 
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 bool isLinearDevice () const
 
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 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 updateSecondaryState ()
 
virtual bool setIC ()
 
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 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 analyticSensitivityAvailableDefaultParam ()
 
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 getAnalyticSensitivityDefaultParam (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 findParam (const std::string &param_name) const
 
bool getParamBreakpoints (std::vector< Util::BreakPoint > &)
 
bool updateDependentParameters (const 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 R
 
double length
 
double width
 
double area
 
double thermalLength
 
double thermalArea
 
double resistivity
 
double density
 
double heatCapacity
 
double thermalHeatCapacity
 
double temp
 
double G
 
double i0
 
int li_Pos
 
int li_Neg
 
bool tempModelEnabled
 
bool outputInternalVarsFlag
 
int li_TempState
 
int li_store_dev_i
 
int li_branch_data
 Index for Lead Current and junction voltage (for power calculations) More...
 
int APosEquPosNodeOffset
 
int APosEquNegNodeOffset
 
int ANegEquPosNodeOffset
 
int ANegEquNegNodeOffset
 
double * f_PosEquPosNodePtr
 
double * f_PosEquNegNodePtr
 
double * f_NegEquPosNodePtr
 
double * f_NegEquNegNodePtr
 

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 102 of file N_DEV_ThermalResistor.h.

Constructor & Destructor Documentation

Xyce::Device::ThermalResistor::Instance::Instance ( const Configuration configuration,
const InstanceBlock IB,
Model Riter,
const FactoryBlock factory_block 
)

Definition at line 224 of file N_DEV_ThermalResistor.C.

Xyce::Device::ThermalResistor::Instance::~Instance ( )

Definition at line 379 of file N_DEV_ThermalResistor.C.

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

Member Function Documentation

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

Definition at line 155 of file N_DEV_ThermalResistor.h.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 504 of file N_DEV_ThermalResistor.C.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 693 of file N_DEV_ThermalResistor.C.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 148 of file N_DEV_ThermalResistor.h.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 662 of file N_DEV_ThermalResistor.C.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 144 of file N_DEV_ThermalResistor.h.

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

Populates and returns the store name map.

Implements Xyce::Device::DeviceInstance.

Definition at line 554 of file N_DEV_ThermalResistor.C.

Instance& Xyce::Device::ThermalResistor::Instance::operator= ( const Instance )
private
bool Xyce::Device::ThermalResistor::Instance::outputPlotFiles ( bool  force_final_output)
virtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 632 of file N_DEV_ThermalResistor.C.

bool Xyce::Device::ThermalResistor::Instance::plotfileFlag ( )
inlinevirtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 141 of file N_DEV_ThermalResistor.h.

bool Xyce::Device::ThermalResistor::Instance::processParams ( )
virtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 207 of file N_DEV_ThermalResistor.C.

void Xyce::Device::ThermalResistor::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 it keeps the "lead current" that may be used on .PRINT lines as "I(R1)" for the current through resistor R1. and a junction voltage.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 486 of file N_DEV_ThermalResistor.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 517 of file N_DEV_ThermalResistor.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 390 of file N_DEV_ThermalResistor.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 430 of file N_DEV_ThermalResistor.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 450 of file N_DEV_ThermalResistor.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 535 of file N_DEV_ThermalResistor.C.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 570 of file N_DEV_ThermalResistor.C.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 605 of file N_DEV_ThermalResistor.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 713 of file N_DEV_ThermalResistor.C.

Friends And Related Function Documentation

friend class Master
friend

Definition at line 106 of file N_DEV_ThermalResistor.h.

friend class Model
friend

Definition at line 105 of file N_DEV_ThermalResistor.h.

friend class ParametricData< Instance >
friend

Definition at line 104 of file N_DEV_ThermalResistor.h.

friend class Traits
friend

Definition at line 106 of file N_DEV_ThermalResistor.h.

Member Data Documentation

int Xyce::Device::ThermalResistor::Instance::ANegEquNegNodeOffset
private

Definition at line 202 of file N_DEV_ThermalResistor.h.

int Xyce::Device::ThermalResistor::Instance::ANegEquPosNodeOffset
private

Definition at line 201 of file N_DEV_ThermalResistor.h.

int Xyce::Device::ThermalResistor::Instance::APosEquNegNodeOffset
private

Definition at line 200 of file N_DEV_ThermalResistor.h.

int Xyce::Device::ThermalResistor::Instance::APosEquPosNodeOffset
private

Definition at line 199 of file N_DEV_ThermalResistor.h.

double Xyce::Device::ThermalResistor::Instance::area
private

Definition at line 171 of file N_DEV_ThermalResistor.h.

double Xyce::Device::ThermalResistor::Instance::density
private

Definition at line 177 of file N_DEV_ThermalResistor.h.

double* Xyce::Device::ThermalResistor::Instance::f_NegEquNegNodePtr
private

Definition at line 208 of file N_DEV_ThermalResistor.h.

double* Xyce::Device::ThermalResistor::Instance::f_NegEquPosNodePtr
private

Definition at line 207 of file N_DEV_ThermalResistor.h.

double* Xyce::Device::ThermalResistor::Instance::f_PosEquNegNodePtr
private

Definition at line 206 of file N_DEV_ThermalResistor.h.

double* Xyce::Device::ThermalResistor::Instance::f_PosEquPosNodePtr
private

Definition at line 205 of file N_DEV_ThermalResistor.h.

double Xyce::Device::ThermalResistor::Instance::G
private

Definition at line 184 of file N_DEV_ThermalResistor.h.

double Xyce::Device::ThermalResistor::Instance::heatCapacity
private

Definition at line 178 of file N_DEV_ThermalResistor.h.

double Xyce::Device::ThermalResistor::Instance::i0
private

Definition at line 185 of file N_DEV_ThermalResistor.h.

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

Definition at line 161 of file N_DEV_ThermalResistor.h.

double Xyce::Device::ThermalResistor::Instance::length
private

Definition at line 168 of file N_DEV_ThermalResistor.h.

int Xyce::Device::ThermalResistor::Instance::li_branch_data
private

Index for Lead Current and junction voltage (for power calculations)

Definition at line 196 of file N_DEV_ThermalResistor.h.

int Xyce::Device::ThermalResistor::Instance::li_Neg
private

Definition at line 190 of file N_DEV_ThermalResistor.h.

int Xyce::Device::ThermalResistor::Instance::li_Pos
private

Definition at line 188 of file N_DEV_ThermalResistor.h.

int Xyce::Device::ThermalResistor::Instance::li_store_dev_i
private

Definition at line 195 of file N_DEV_ThermalResistor.h.

int Xyce::Device::ThermalResistor::Instance::li_TempState
private

Definition at line 194 of file N_DEV_ThermalResistor.h.

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

Definition at line 163 of file N_DEV_ThermalResistor.h.

bool Xyce::Device::ThermalResistor::Instance::outputInternalVarsFlag
private

Definition at line 193 of file N_DEV_ThermalResistor.h.

double Xyce::Device::ThermalResistor::Instance::R
private

Definition at line 166 of file N_DEV_ThermalResistor.h.

double Xyce::Device::ThermalResistor::Instance::resistivity
private

Definition at line 176 of file N_DEV_ThermalResistor.h.

double Xyce::Device::ThermalResistor::Instance::temp
private

Definition at line 181 of file N_DEV_ThermalResistor.h.

bool Xyce::Device::ThermalResistor::Instance::tempModelEnabled
private

Definition at line 192 of file N_DEV_ThermalResistor.h.

double Xyce::Device::ThermalResistor::Instance::thermalArea
private

Definition at line 173 of file N_DEV_ThermalResistor.h.

double Xyce::Device::ThermalResistor::Instance::thermalHeatCapacity
private

Definition at line 179 of file N_DEV_ThermalResistor.h.

double Xyce::Device::ThermalResistor::Instance::thermalLength
private

Definition at line 172 of file N_DEV_ThermalResistor.h.

double Xyce::Device::ThermalResistor::Instance::width
private

Definition at line 169 of file N_DEV_ThermalResistor.h.


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