Xyce  6.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Xyce::Device::MutIndNonLin2::Model Class Reference

#include <N_DEV_MutIndNonLin2.h>

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

Public Member Functions

 Model (const Configuration &configuration, const ModelBlock &MB, const FactoryBlock &factory_block)
 
 ~Model ()
 
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
 
bool processParams ()
 processParams More...
 
bool processInstanceParams ()
 processInstanceParams More...
 
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_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 Types

typedef std::vector< Instance * > InstanceVector
 

Private Member Functions

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

Private Attributes

std::vector< Instance * > instanceContainer
 
double A
 
double Alpha
 
double Area
 
double BetaH
 
double BetaM
 
double C
 
double DeltaV
 
double Gap
 
double Kirr
 
double Ms
 
double LevelIgnored
 
double PackIgnored
 
double Path
 
double Vinf
 
double tempCoeff1
 
double tempCoeff2
 
double tnom
 
double pZeroTol
 
double mVarScaling
 
double rVarScaling
 
double mEqScaling
 
double rEqScaling
 
int outputStateVars
 
int factorMS
 
int includeDeltaM
 
int useRKIntegration
 
int useStateDeriv
 
int voltageLimiterFlag
 
double magLimitThres
 
double rLimitThres
 
bool tc1Given
 
bool tc2Given
 
bool tnomGiven
 
bool includeDeltaMGiven
 
bool useRKIntegrationGiven
 

Friends

class ParametricData< Model >
 
class Instance
 
class Traits
 

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

Definition at line 247 of file N_DEV_MutIndNonLin2.h.

Member Typedef Documentation

Definition at line 249 of file N_DEV_MutIndNonLin2.h.

Constructor & Destructor Documentation

Xyce::Device::MutIndNonLin2::Model::Model ( const Configuration configuration,
const ModelBlock MB,
const FactoryBlock factory_block 
)

Definition at line 1652 of file N_DEV_MutIndNonLin2.C.

Xyce::Device::MutIndNonLin2::Model::~Model ( )

Definition at line 1712 of file N_DEV_MutIndNonLin2.C.

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

Member Function Documentation

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

Definition at line 278 of file N_DEV_MutIndNonLin2.h.

void Xyce::Device::MutIndNonLin2::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 1772 of file N_DEV_MutIndNonLin2.C.

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

Implements Xyce::Device::DeviceModel.

Definition at line 1734 of file N_DEV_MutIndNonLin2.C.

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

processInstanceParams

Returns
true if parameter processing was successful

Implements Xyce::Device::DeviceModel.

Definition at line 1630 of file N_DEV_MutIndNonLin2.C.

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

processParams

Returns
true if parameter processing was successful

Implements Xyce::Device::DeviceModel.

Definition at line 1617 of file N_DEV_MutIndNonLin2.C.

Friends And Related Function Documentation

friend class Instance
friend

Definition at line 252 of file N_DEV_MutIndNonLin2.h.

friend class ParametricData< Model >
friend

Definition at line 251 of file N_DEV_MutIndNonLin2.h.

friend class Traits
friend

Definition at line 253 of file N_DEV_MutIndNonLin2.h.

Member Data Documentation

double Xyce::Device::MutIndNonLin2::Model::A
private

Definition at line 288 of file N_DEV_MutIndNonLin2.h.

double Xyce::Device::MutIndNonLin2::Model::Alpha
private

Definition at line 289 of file N_DEV_MutIndNonLin2.h.

double Xyce::Device::MutIndNonLin2::Model::Area
private

Definition at line 290 of file N_DEV_MutIndNonLin2.h.

double Xyce::Device::MutIndNonLin2::Model::BetaH
private

Definition at line 291 of file N_DEV_MutIndNonLin2.h.

double Xyce::Device::MutIndNonLin2::Model::BetaM
private

Definition at line 292 of file N_DEV_MutIndNonLin2.h.

double Xyce::Device::MutIndNonLin2::Model::C
private

Definition at line 293 of file N_DEV_MutIndNonLin2.h.

double Xyce::Device::MutIndNonLin2::Model::DeltaV
private

Definition at line 294 of file N_DEV_MutIndNonLin2.h.

int Xyce::Device::MutIndNonLin2::Model::factorMS
private

Definition at line 312 of file N_DEV_MutIndNonLin2.h.

double Xyce::Device::MutIndNonLin2::Model::Gap
private

Definition at line 295 of file N_DEV_MutIndNonLin2.h.

int Xyce::Device::MutIndNonLin2::Model::includeDeltaM
private

Definition at line 313 of file N_DEV_MutIndNonLin2.h.

bool Xyce::Device::MutIndNonLin2::Model::includeDeltaMGiven
private

Definition at line 324 of file N_DEV_MutIndNonLin2.h.

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

Definition at line 284 of file N_DEV_MutIndNonLin2.h.

double Xyce::Device::MutIndNonLin2::Model::Kirr
private

Definition at line 296 of file N_DEV_MutIndNonLin2.h.

double Xyce::Device::MutIndNonLin2::Model::LevelIgnored
private

Definition at line 298 of file N_DEV_MutIndNonLin2.h.

double Xyce::Device::MutIndNonLin2::Model::magLimitThres
private

Definition at line 317 of file N_DEV_MutIndNonLin2.h.

double Xyce::Device::MutIndNonLin2::Model::mEqScaling
private

Definition at line 308 of file N_DEV_MutIndNonLin2.h.

double Xyce::Device::MutIndNonLin2::Model::Ms
private

Definition at line 297 of file N_DEV_MutIndNonLin2.h.

double Xyce::Device::MutIndNonLin2::Model::mVarScaling
private

Definition at line 306 of file N_DEV_MutIndNonLin2.h.

int Xyce::Device::MutIndNonLin2::Model::outputStateVars
private

Definition at line 310 of file N_DEV_MutIndNonLin2.h.

double Xyce::Device::MutIndNonLin2::Model::PackIgnored
private

Definition at line 299 of file N_DEV_MutIndNonLin2.h.

double Xyce::Device::MutIndNonLin2::Model::Path
private

Definition at line 300 of file N_DEV_MutIndNonLin2.h.

double Xyce::Device::MutIndNonLin2::Model::pZeroTol
private

Definition at line 305 of file N_DEV_MutIndNonLin2.h.

double Xyce::Device::MutIndNonLin2::Model::rEqScaling
private

Definition at line 309 of file N_DEV_MutIndNonLin2.h.

double Xyce::Device::MutIndNonLin2::Model::rLimitThres
private

Definition at line 318 of file N_DEV_MutIndNonLin2.h.

double Xyce::Device::MutIndNonLin2::Model::rVarScaling
private

Definition at line 307 of file N_DEV_MutIndNonLin2.h.

bool Xyce::Device::MutIndNonLin2::Model::tc1Given
private

Definition at line 321 of file N_DEV_MutIndNonLin2.h.

bool Xyce::Device::MutIndNonLin2::Model::tc2Given
private

Definition at line 322 of file N_DEV_MutIndNonLin2.h.

double Xyce::Device::MutIndNonLin2::Model::tempCoeff1
private

Definition at line 302 of file N_DEV_MutIndNonLin2.h.

double Xyce::Device::MutIndNonLin2::Model::tempCoeff2
private

Definition at line 303 of file N_DEV_MutIndNonLin2.h.

double Xyce::Device::MutIndNonLin2::Model::tnom
private

Definition at line 304 of file N_DEV_MutIndNonLin2.h.

bool Xyce::Device::MutIndNonLin2::Model::tnomGiven
private

Definition at line 323 of file N_DEV_MutIndNonLin2.h.

int Xyce::Device::MutIndNonLin2::Model::useRKIntegration
private

Definition at line 314 of file N_DEV_MutIndNonLin2.h.

bool Xyce::Device::MutIndNonLin2::Model::useRKIntegrationGiven
private

Definition at line 325 of file N_DEV_MutIndNonLin2.h.

int Xyce::Device::MutIndNonLin2::Model::useStateDeriv
private

Definition at line 315 of file N_DEV_MutIndNonLin2.h.

double Xyce::Device::MutIndNonLin2::Model::Vinf
private

Definition at line 301 of file N_DEV_MutIndNonLin2.h.

int Xyce::Device::MutIndNonLin2::Model::voltageLimiterFlag
private

Definition at line 316 of file N_DEV_MutIndNonLin2.h.


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