Xyce  6.1
Xyce::Device::DeviceOptions Class Reference

#include <N_DEV_DeviceOptions.h>

Public Member Functions

 DeviceOptions ()
 
 ~DeviceOptions ()
 
bool setOptions (const Util::OptionBlock &option_block)
 

Static Public Member Functions

static void populateMetadata (IO::PkgOptionsMgr &options_manager)
 

Public Attributes

double defad
 MOS drain diffusion area. More...
 
double defas
 MOS source diffusion area. More...
 
double defl
 MOS channel length. More...
 
double defw
 MOS channel width. More...
 
double abstol
 absolute current error tolerance. More...
 
double reltol
 relative current error tolerance. More...
 
double chgtol
 absolute charge error tolerance. More...
 
double gmin
 minimum allowed conductance. More...
 
double gmin_orig
 this is needed for gmin-homotopy. More...
 
double gmin_init
 this is needed for gmin-homotopy. More...
 
double gmin_scalar
 this is needed for gmin-homotopy. More...
 
double gmax
 maximum allowed conductance. More...
 
double testJac_relTol
 reltol for num. jacobian diagnostic More...
 
double testJac_absTol
 abstol for num. jacobian diagnostic. More...
 
double testJac_SqrtEta
 dx = numJacSqrtEta * (1.0 + std::fabs(soln[i])); More...
 
double deviceSens_dp
 similar to eta, but for numerical device sensitivities More...
 
double tnom
 nominal temperature for device params. More...
 
Util::Param temp
 operating temperature of ckt. More...
 
double scale_src
 scaling for source loads More...
 
bool numericalJacobianFlag
 
bool testJacobianFlag
 
int testJacStartStep
 
int testJacStopStep
 
bool testJacWarn
 
bool testJacDeviceNameGiven
 
std::string testJacDeviceName
 
bool voltageLimiterFlag
 
int lambertWFlag
 
bool newMeyerFlag
 
double icMultiplier
 
double defaultMaxTimeStep
 mosfet homotopy: More...
 
double vdsScaleMin
 
double vgstConst
 
int numGainScaleBlocks
 
bool staggerGainScale
 
bool randomizeVgstConst
 
double length0
 
double width0
 
double tox0
 
double minRes
 
double minCap
 
double exp_order
 tolerance on resistance below which it will be treated as zero More...
 
double zeroResistanceTol
 
bool checkForZeroResistance
 
int debugMinTimestep
 
int debugMaxTimestep
 
double debugMinTime
 
double debugMaxTime
 
int verboseLevel
 
bool newExcessPhase
 
bool defaultNewExcessPhase
 default is true for MPDE, false for non-MPDE. More...
 
double excessPhaseScalar1
 
double excessPhaseScalar2
 
unsigned int randomSeed
 seed for random number generator used by some devices. More...
 
bool tryToCompact
 Try to compact past history for LTRA device(s). More...
 
bool calculateAllLeadCurrents
 configure all devices to load lead currents More...
 
int digInitState
 used to initialize all of the digital gates in a circuit More...
 

Private Member Functions

 DeviceOptions (DeviceOptions const &)
 No copying. More...
 
DeviceOptionsoperator= (DeviceOptions const &)
 No assignment. More...
 

Friends

std::ostream & operator<< (std::ostream &os, const DeviceOptions &devOp)
 

Detailed Description

Definition at line 67 of file N_DEV_DeviceOptions.h.

Constructor & Destructor Documentation

Xyce::Device::DeviceOptions::DeviceOptions ( )

Definition at line 90 of file N_DEV_DeviceOptions.C.

Xyce::Device::DeviceOptions::~DeviceOptions ( )

Definition at line 161 of file N_DEV_DeviceOptions.C.

Xyce::Device::DeviceOptions::DeviceOptions ( DeviceOptions const &  )
private

No copying.

Member Function Documentation

DeviceOptions& Xyce::Device::DeviceOptions::operator= ( DeviceOptions const &  )
private

No assignment.

void Xyce::Device::DeviceOptions::populateMetadata ( IO::PkgOptionsMgr &  options_manager)
static

Definition at line 349 of file N_DEV_DeviceOptions.C.

bool Xyce::Device::DeviceOptions::setOptions ( const Util::OptionBlock &  option_block)

Definition at line 173 of file N_DEV_DeviceOptions.C.

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os,
const DeviceOptions devOp 
)
friend

Definition at line 417 of file N_DEV_DeviceOptions.C.

Member Data Documentation

double Xyce::Device::DeviceOptions::abstol

absolute current error tolerance.

Definition at line 90 of file N_DEV_DeviceOptions.h.

bool Xyce::Device::DeviceOptions::calculateAllLeadCurrents

configure all devices to load lead currents

Definition at line 164 of file N_DEV_DeviceOptions.h.

bool Xyce::Device::DeviceOptions::checkForZeroResistance

Definition at line 142 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::chgtol

absolute charge error tolerance.

Definition at line 92 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::debugMaxTime

Definition at line 147 of file N_DEV_DeviceOptions.h.

int Xyce::Device::DeviceOptions::debugMaxTimestep

Definition at line 145 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::debugMinTime

Definition at line 146 of file N_DEV_DeviceOptions.h.

int Xyce::Device::DeviceOptions::debugMinTimestep

Definition at line 144 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::defad

MOS drain diffusion area.

Definition at line 85 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::defas

MOS source diffusion area.

Definition at line 86 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::defaultMaxTimeStep

mosfet homotopy:

Definition at line 125 of file N_DEV_DeviceOptions.h.

bool Xyce::Device::DeviceOptions::defaultNewExcessPhase

default is true for MPDE, false for non-MPDE.

Definition at line 152 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::defl

MOS channel length.

Definition at line 87 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::defw

MOS channel width.

Definition at line 88 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::deviceSens_dp

similar to eta, but for numerical device sensitivities

Definition at line 104 of file N_DEV_DeviceOptions.h.

int Xyce::Device::DeviceOptions::digInitState

used to initialize all of the digital gates in a circuit

Definition at line 166 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::excessPhaseScalar1

Definition at line 154 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::excessPhaseScalar2

Definition at line 155 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::exp_order

tolerance on resistance below which it will be treated as zero

Definition at line 138 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::gmax

maximum allowed conductance.

Definition at line 99 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::gmin

minimum allowed conductance.

Definition at line 94 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::gmin_init

this is needed for gmin-homotopy.

Definition at line 96 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::gmin_orig

this is needed for gmin-homotopy.

Definition at line 95 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::gmin_scalar

this is needed for gmin-homotopy.

Definition at line 97 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::icMultiplier

Definition at line 123 of file N_DEV_DeviceOptions.h.

int Xyce::Device::DeviceOptions::lambertWFlag

Definition at line 119 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::length0

Definition at line 133 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::minCap

Definition at line 137 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::minRes

Definition at line 136 of file N_DEV_DeviceOptions.h.

bool Xyce::Device::DeviceOptions::newExcessPhase

Definition at line 151 of file N_DEV_DeviceOptions.h.

bool Xyce::Device::DeviceOptions::newMeyerFlag

Definition at line 121 of file N_DEV_DeviceOptions.h.

bool Xyce::Device::DeviceOptions::numericalJacobianFlag

Definition at line 111 of file N_DEV_DeviceOptions.h.

int Xyce::Device::DeviceOptions::numGainScaleBlocks

Definition at line 130 of file N_DEV_DeviceOptions.h.

bool Xyce::Device::DeviceOptions::randomizeVgstConst

Definition at line 132 of file N_DEV_DeviceOptions.h.

unsigned int Xyce::Device::DeviceOptions::randomSeed

seed for random number generator used by some devices.

note: each device gets its own random number generator so it must initialize thing correctly. (See N_DEV_Synapse3 for an example)

Definition at line 157 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::reltol

relative current error tolerance.

Definition at line 91 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::scale_src

scaling for source loads

Definition at line 109 of file N_DEV_DeviceOptions.h.

bool Xyce::Device::DeviceOptions::staggerGainScale

Definition at line 131 of file N_DEV_DeviceOptions.h.

Util::Param Xyce::Device::DeviceOptions::temp

operating temperature of ckt.

Definition at line 107 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::testJac_absTol

abstol for num. jacobian diagnostic.

Definition at line 102 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::testJac_relTol

reltol for num. jacobian diagnostic

Definition at line 101 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::testJac_SqrtEta

dx = numJacSqrtEta * (1.0 + std::fabs(soln[i]));

Definition at line 103 of file N_DEV_DeviceOptions.h.

std::string Xyce::Device::DeviceOptions::testJacDeviceName

Definition at line 117 of file N_DEV_DeviceOptions.h.

bool Xyce::Device::DeviceOptions::testJacDeviceNameGiven

Definition at line 116 of file N_DEV_DeviceOptions.h.

bool Xyce::Device::DeviceOptions::testJacobianFlag

Definition at line 112 of file N_DEV_DeviceOptions.h.

int Xyce::Device::DeviceOptions::testJacStartStep

Definition at line 113 of file N_DEV_DeviceOptions.h.

int Xyce::Device::DeviceOptions::testJacStopStep

Definition at line 114 of file N_DEV_DeviceOptions.h.

bool Xyce::Device::DeviceOptions::testJacWarn

Definition at line 115 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::tnom

nominal temperature for device params.

Definition at line 106 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::tox0

Definition at line 135 of file N_DEV_DeviceOptions.h.

bool Xyce::Device::DeviceOptions::tryToCompact

Try to compact past history for LTRA device(s).

Definition at line 162 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::vdsScaleMin

Definition at line 128 of file N_DEV_DeviceOptions.h.

int Xyce::Device::DeviceOptions::verboseLevel

Definition at line 149 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::vgstConst

Definition at line 129 of file N_DEV_DeviceOptions.h.

bool Xyce::Device::DeviceOptions::voltageLimiterFlag

Definition at line 118 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::width0

Definition at line 134 of file N_DEV_DeviceOptions.h.

double Xyce::Device::DeviceOptions::zeroResistanceTol

Definition at line 141 of file N_DEV_DeviceOptions.h.


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