Xyce  6.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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)
 
std::map< int, std::string > & getIntNameMap ()
 
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 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 processParams ()
 
virtual bool processInstanceParams ()
 
virtual bool updateTemperature (const double &temp_tmp)
 
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 updateSecondaryState ()
 
virtual bool setIC ()
 
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 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 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 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 97 of file N_DEV_Vcvs.C.

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

Definition at line 165 of file N_DEV_Vcvs.C.

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

Member Function Documentation

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 255 of file N_DEV_Vcvs.C.

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 287 of file N_DEV_Vcvs.C.

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

Implements Xyce::Device::DeviceInstance.

Definition at line 392 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 359 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.

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 300 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 178 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 274 of file N_DEV_Vcvs.C.

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

Reimplemented from Xyce::Device::DeviceInstance.

Definition at line 320 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 342 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 415 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: