Xyce  6.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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)
 
std::map< int, std::string > & getIntNameMap ()
 
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 std::list< index_pair > &intGIDListRef, const std::list< index_pair > &extGIDListRef)
 
virtual void registerStateGIDs (const std::list< index_pair > &staGIDListRef)
 
virtual void registerStoreGIDs (const std::list< index_pair > &stoGIDListRef)
 
virtual void registerStoreLIDs (const std::vector< int > &stoLIDVecRef)
 
virtual const std::vector
< std::string > & 
getDepSolnVars ()
 
virtual void registerDepSolnGIDs (const std::vector< std::vector< int > > &varList)
 
virtual const std::vector
< std::string > & 
getDepStateVars ()
 
virtual void registerDepStateGIDs (const std::vector< std::vector< int > > &varList)
 
virtual const std::vector
< std::string > & 
getDepStoreVars ()
 
virtual void registerDepStoreGIDs (const std::vector< std::vector< int > > &varList)
 
virtual void registerDepSolnLIDs (const std::vector< std::vector< int > > &depSolnLIDVecRef)
 
virtual void registerDepStateLIDs (const std::vector< std::vector< int > > &depStaLIDVecRef)
 
virtual void registerDepStoreLIDs (const std::vector< std::vector< int > > &depStoLIDVecRef)
 
virtual void registerGIDData (const std::vector< int > &counts, const std::vector< int > &GIDs, const std::vector< std::vector< int > > &jacGIDs)
 
virtual void getDepSolnGIDVec (std::vector< int > &depGIDVec)
 
virtual bool getIndexPairList (std::list< index_pair > &iplRef)
 
virtual bool getInstanceBreakPoints (std::vector< Util::BreakPoint > &breakPointTimes)
 
virtual bool updateSource ()
 
virtual bool processInstanceParams ()
 
virtual bool isConverged ()
 
virtual bool testDAEMatrices (std::vector< std::string > &nameVec)
 
virtual bool loadTrivialDAE_FMatrixStamp ()
 
bool trivialStampLoader (N_LAS_Matrix *matPtr)
 
bool zeroMatrixDiagonal (N_LAS_Matrix *matPtr)
 
virtual bool plotfileFlag ()
 
virtual bool loadDeviceMask ()
 
virtual void acceptStep ()
 
virtual bool loadDAEBVector ()
 
const InstanceNamegetName () const
 
int getNumIntVars () const
 
int getNumExtVars () const
 
int getNumStateVars () const
 
int getNumStoreVars () const
 
void setNumStoreVars (int num_store_vars)
 
virtual void getDevConMap (std::vector< int > &)
 
virtual DeviceStategetInternalState ()
 
virtual bool setInternalState (const DeviceState &state)
 
virtual bool loadDFDV (int iElectrode, N_LAS_Vector *dfdvPtr)
 
virtual bool calcConductance (int iElectrode, const N_LAS_Vector *dxdvPtr)
 
virtual std::map< int,
std::string > & 
getStateNameMap ()
 
virtual std::map< int,
std::string > & 
getStoreNameMap ()
 
virtual bool outputPlotFiles ()
 
virtual bool enablePDEContinuation ()
 
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 std::vector< int > & getDevLIDs () const
 
const std::vector< std::vector
< int > > & 
getDevJacLIDs () const
 
const std::vector< int > & getStaLIDVec () 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_path, int netlist_line)
 
virtual ~DeviceEntity ()
 
virtual CompositeParamconstructComposite (const std::string &composite_name, const std::string &param_name)
 
bool setDefaultParam (double val)
 
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 getParam (const std::string &paramName, double &result) const
 
bool getParamBreakpoints (std::vector< Util::BreakPoint > &)
 
bool updateDependentParameters (N_LAS_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
 
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 numLeadCurrentStoreVars
 
bool loadLeadCurrent
 
std::vector< int > devConMap
 
bool mergeRowColChecked
 
- Protected Member Functions inherited from Xyce::Device::DeviceInstance
void jacStampMap (std::vector< std::vector< int > > &stamp_parent, std::vector< int > &map_parent, std::vector< std::vector< int > > &map2_parent, std::vector< std::vector< int > > &stamp, std::vector< int > &map, std::vector< std::vector< int > > &map2, int from, int to, int original_size)
 
void jacStampMap_fixOrder (std::vector< std::vector< int > > &stamp_parent, std::vector< std::vector< int > > &map2_parent, std::vector< std::vector< int > > &stamp, std::vector< std::vector< int > > &map2)
 
void outputJacStamp (const std::vector< std::vector< int > > &jac)
 
void outputJacMaps (const std::vector< int > &jacMap, const std::vector< std::vector< int > > &jacMap2)
 
- Protected Attributes inherited from Xyce::Device::DeviceInstance
const ExternDataextData
 
std::list< index_pair > intGIDList
 
std::list< index_pair > extGIDList
 
std::list< index_pair > indexPairList
 
std::list< index_pair > staGIDList
 
std::vector< int > intLIDVec
 
std::vector< int > extLIDVec
 
std::vector< int > staLIDVec
 
std::vector< int > stoLIDVec
 
std::vector< int > devLIDs
 
std::vector< std::vector< int > > devJacLIDs
 
std::map< int, std::string > intNameMap
 
std::map< int, std::string > stateNameMap
 
std::map< int, std::string > storeNameMap
 
DeviceSupport devSupport
 

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 190 of file N_DEV_Inductor.C.

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

Definition at line 287 of file N_DEV_Inductor.C.

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

Member Function Documentation

void Xyce::Device::Inductor::Instance::auxDAECalculations ( )
std::map< int, std::string > & Xyce::Device::Inductor::Instance::getIntNameMap ( )
virtual

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 369 of file N_DEV_Inductor.C.

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

Definition at line 167 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 406 of file N_DEV_Inductor.C.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 563 of file N_DEV_Inductor.C.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 544 of file N_DEV_Inductor.C.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 501 of file N_DEV_Inductor.C.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 480 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 155 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 419 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 324 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 388 of file N_DEV_Inductor.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 597 of file N_DEV_Inductor.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 299 of file N_DEV_Inductor.C.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 144 of file N_DEV_Inductor.h.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 438 of file N_DEV_Inductor.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 460 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 173 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 628 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 222 of file N_DEV_Inductor.h.

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

Definition at line 211 of file N_DEV_Inductor.h.

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

Definition at line 219 of file N_DEV_Inductor.h.

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

Definition at line 216 of file N_DEV_Inductor.h.

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

Definition at line 237 of file N_DEV_Inductor.h.

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

Definition at line 235 of file N_DEV_Inductor.h.

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

Definition at line 239 of file N_DEV_Inductor.h.

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

Definition at line 233 of file N_DEV_Inductor.h.

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

Definition at line 231 of file N_DEV_Inductor.h.

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

Definition at line 228 of file N_DEV_Inductor.h.

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

Definition at line 225 of file N_DEV_Inductor.h.

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

Definition at line 182 of file N_DEV_Inductor.h.

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

Definition at line 197 of file N_DEV_Inductor.h.

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

Definition at line 247 of file N_DEV_Inductor.h.

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

Definition at line 246 of file N_DEV_Inductor.h.

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

Definition at line 245 of file N_DEV_Inductor.h.

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

Definition at line 244 of file N_DEV_Inductor.h.

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

Definition at line 243 of file N_DEV_Inductor.h.

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

Definition at line 180 of file N_DEV_Inductor.h.

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

Definition at line 181 of file N_DEV_Inductor.h.

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

Definition at line 173 of file N_DEV_Inductor.h.

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

Definition at line 179 of file N_DEV_Inductor.h.

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

Definition at line 205 of file N_DEV_Inductor.h.

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

Definition at line 200 of file N_DEV_Inductor.h.

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

Definition at line 209 of file N_DEV_Inductor.h.

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

Definition at line 204 of file N_DEV_Inductor.h.

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

Definition at line 203 of file N_DEV_Inductor.h.

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

Definition at line 176 of file N_DEV_Inductor.h.

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

Definition at line 248 of file N_DEV_Inductor.h.

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

Definition at line 183 of file N_DEV_Inductor.h.

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

Definition at line 188 of file N_DEV_Inductor.h.

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

Definition at line 193 of file N_DEV_Inductor.h.

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

Definition at line 189 of file N_DEV_Inductor.h.

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

Definition at line 194 of file N_DEV_Inductor.h.

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

Definition at line 184 of file N_DEV_Inductor.h.

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

Definition at line 208 of file N_DEV_Inductor.h.


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