Xyce  6.1
Xyce::Device::Capacitor::Model Class Reference

Capacitor Model class. More...

#include <N_DEV_Capacitor.h>

Inheritance diagram for Xyce::Device::Capacitor::Model:
Collaboration diagram for Xyce::Device::Capacitor::Model:

Public Member Functions

 Model (const Configuration &configuration, const ModelBlock &model_block, const FactoryBlock &factory_block)
 Construct a capacitor model from a "model block" that was created by the netlist parser. More...
 
 ~Model ()
 
bool processParams ()
 Process model parameters. More...
 
bool processInstanceParams ()
 Process the instance parameters of instance owned by this model. More...
 
virtual void forEachInstance (DeviceInstanceOp &op) const
 Apply a device instance "op" to all instances associated with this model. More...
 
virtual std::ostream & printOutInstances (std::ostream &os) const
 
void addInstance (Instance *instance)
 
- Public Member Functions inherited from Xyce::Device::DeviceModel
 DeviceModel (const ModelBlock &model_block, ParametricData< void > &parametric_data, const FactoryBlock &factory_block)
 
virtual ~DeviceModel ()
 
const std::string & getName () const
 
void setModParams (const std::vector< Param > &params)
 
virtual std::ostream & printName (std::ostream &os) const
 
virtual bool clearTemperatureData ()
 
void saveParams ()
 
bool interpolateTNOM (double)
 
bool interpolateDOSE (double)
 
void restoreParams ()
 
virtual bool getBinPrefixFlag ()
 
int getLevel () const
 
void setLevel (int level)
 
const std::string & getType () 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 Types

typedef std::vector< Instance * > InstanceVector
 

Private Member Functions

 Model ()
 
 Model (const Model &)
 
Modeloperator= (const Model &)
 

Private Attributes

std::vector< Instance * > instanceContainer
 
double capacitanceMultiplier
 
double cj
 
double cjsw
 
double defWidth
 
double narrow
 
double tempCoeff1
 
double tempCoeff2
 
double baseCap
 
double tnom
 
bool tnomGiven
 

Friends

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

Additional Inherited Members

- Static Public Member Functions inherited from Xyce::Device::DeviceModel
template<class T >
static void initThermalModel (ParametricData< T > &parametric_data)
 Add the parameter "TEMPMODEL" to the parametric_data. More...
 
template<class T >
static void initDoseModel (ParametricData< T > &parametric_data)
 Add the parameter "DOSEMODEL" to the parametric_data. More...
 
- 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

Capacitor Model class.

Definition at line 274 of file N_DEV_Capacitor.h.

Member Typedef Documentation

Definition at line 276 of file N_DEV_Capacitor.h.

Constructor & Destructor Documentation

Xyce::Device::Capacitor::Model::Model ( const Configuration configuration,
const ModelBlock model_block,
const FactoryBlock factory_block 
)

Construct a capacitor model from a "model block" that was created by the netlist parser.

Parameters
configuration
model_block
factory_block
Author
Eric Keiter, SNL, Parallel Computational Sciences
Date
5/17/00

Definition at line 1682 of file N_DEV_Capacitor.C.

Xyce::Device::Capacitor::Model::~Model ( )

Definition at line 1726 of file N_DEV_Capacitor.C.

Xyce::Device::Capacitor::Model::Model ( )
private
Xyce::Device::Capacitor::Model::Model ( const Model )
private

Member Function Documentation

void Xyce::Device::Capacitor::Model::addInstance ( Instance instance)
inline

Definition at line 304 of file N_DEV_Capacitor.h.

void Xyce::Device::Capacitor::Model::forEachInstance ( DeviceInstanceOp op) const
virtual

Apply a device instance "op" to all instances associated with this model.

Parameters
[in]opOperator to apply to all instances.

Implements Xyce::Device::DeviceModel.

Definition at line 1789 of file N_DEV_Capacitor.C.

Model& Xyce::Device::Capacitor::Model::operator= ( const Model )
private
std::ostream & Xyce::Device::Capacitor::Model::printOutInstances ( std::ostream &  os) const
virtual

Implements Xyce::Device::DeviceModel.

Definition at line 1748 of file N_DEV_Capacitor.C.

bool Xyce::Device::Capacitor::Model::processInstanceParams ( )
virtual

Process the instance parameters of instance owned by this model.

This method simply loops over all instances associated with this model and calls their processParams method.

Returns
true
Author
Dave Shirely, PSSI
Date
03/23/06

Implements Xyce::Device::DeviceModel.

Definition at line 1649 of file N_DEV_Capacitor.C.

bool Xyce::Device::Capacitor::Model::processParams ( )
virtual

Process model parameters.

Returns
true on success
Author
Eric Keiter, SNL, Parallel Computational Sciences
Date
6/03/02

Implements Xyce::Device::DeviceModel.

Definition at line 1619 of file N_DEV_Capacitor.C.

Friends And Related Function Documentation

friend class capSensitivity
friend

Definition at line 282 of file N_DEV_Capacitor.h.

friend class Instance
friend

Definition at line 279 of file N_DEV_Capacitor.h.

friend class Master
friend

Definition at line 281 of file N_DEV_Capacitor.h.

friend class ParametricData< Model >
friend

Definition at line 278 of file N_DEV_Capacitor.h.

friend class Traits
friend

Definition at line 280 of file N_DEV_Capacitor.h.

Member Data Documentation

double Xyce::Device::Capacitor::Model::baseCap
private

Definition at line 323 of file N_DEV_Capacitor.h.

double Xyce::Device::Capacitor::Model::capacitanceMultiplier
private

Definition at line 316 of file N_DEV_Capacitor.h.

double Xyce::Device::Capacitor::Model::cj
private

Definition at line 317 of file N_DEV_Capacitor.h.

double Xyce::Device::Capacitor::Model::cjsw
private

Definition at line 318 of file N_DEV_Capacitor.h.

double Xyce::Device::Capacitor::Model::defWidth
private

Definition at line 319 of file N_DEV_Capacitor.h.

std::vector<Instance*> Xyce::Device::Capacitor::Model::instanceContainer
private

Definition at line 310 of file N_DEV_Capacitor.h.

double Xyce::Device::Capacitor::Model::narrow
private

Definition at line 320 of file N_DEV_Capacitor.h.

double Xyce::Device::Capacitor::Model::tempCoeff1
private

Definition at line 321 of file N_DEV_Capacitor.h.

double Xyce::Device::Capacitor::Model::tempCoeff2
private

Definition at line 322 of file N_DEV_Capacitor.h.

double Xyce::Device::Capacitor::Model::tnom
private

Definition at line 324 of file N_DEV_Capacitor.h.

bool Xyce::Device::Capacitor::Model::tnomGiven
private

Definition at line 326 of file N_DEV_Capacitor.h.


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