Xyce  6.1
Xyce::Device::Neuron3::Model Class Reference

#include <N_DEV_Neuron3.h>

Inheritance diagram for Xyce::Device::Neuron3::Model:
Collaboration diagram for Xyce::Device::Neuron3::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_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 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 overrideOriginal=false)
 
bool getParam (const std::string &paramName, double &result) const
 
bool getParamBreakpoints (std::vector< Util::BreakPoint > &)
 
bool updateDependentParameters (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

double cMem
 
double gMem
 
double vRest
 
double eNa
 
double gNa
 
double eK
 
double gK
 
double rInt
 
double radius
 
double length
 
int nSeg
 
double rIntPrevious
 
double radiusPrevious
 
double lengthPrevious
 
double rIntNext
 
double radiusNext
 
double lengthNext
 
bool rIntPreviousGiven
 
bool radiusPreviousGiven
 
bool lengthPreviousGiven
 
bool rIntNextGiven
 
bool radiusNextGiven
 
bool lengthNextGiven
 
bool cMemGiven
 
bool gMemGiven
 
bool vRestGiven
 
bool eNaGiven
 
bool gNaGiven
 
bool eKGiven
 
bool gKGiven
 
bool rIntGiven
 
bool radiusGiven
 
bool lengthGiven
 
bool nSegGiven
 
std::vector< Instance * > instanceContainer
 

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 438 of file N_DEV_Neuron3.h.

Member Typedef Documentation

Definition at line 440 of file N_DEV_Neuron3.h.

Constructor & Destructor Documentation

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

Definition at line 1213 of file N_DEV_Neuron3.C.

Xyce::Device::Neuron3::Model::~Model ( )

Definition at line 1252 of file N_DEV_Neuron3.C.

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

Member Function Documentation

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

Definition at line 512 of file N_DEV_Neuron3.h.

void Xyce::Device::Neuron3::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 1312 of file N_DEV_Neuron3.C.

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

Implements Xyce::Device::DeviceModel.

Definition at line 1275 of file N_DEV_Neuron3.C.

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

processInstanceParams

Returns
true if parameter processing was successful

Implements Xyce::Device::DeviceModel.

Definition at line 1191 of file N_DEV_Neuron3.C.

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

processParams

Returns
true if parameter processing was successful

Implements Xyce::Device::DeviceModel.

Definition at line 1178 of file N_DEV_Neuron3.C.

Friends And Related Function Documentation

friend class Instance
friend

Definition at line 443 of file N_DEV_Neuron3.h.

friend class ParametricData< Model >
friend

Definition at line 442 of file N_DEV_Neuron3.h.

friend class Traits
friend

Definition at line 444 of file N_DEV_Neuron3.h.

Member Data Documentation

double Xyce::Device::Neuron3::Model::cMem
private

Definition at line 469 of file N_DEV_Neuron3.h.

bool Xyce::Device::Neuron3::Model::cMemGiven
private

Definition at line 498 of file N_DEV_Neuron3.h.

double Xyce::Device::Neuron3::Model::eK
private

Definition at line 474 of file N_DEV_Neuron3.h.

bool Xyce::Device::Neuron3::Model::eKGiven
private

Definition at line 503 of file N_DEV_Neuron3.h.

double Xyce::Device::Neuron3::Model::eNa
private

Definition at line 472 of file N_DEV_Neuron3.h.

bool Xyce::Device::Neuron3::Model::eNaGiven
private

Definition at line 501 of file N_DEV_Neuron3.h.

double Xyce::Device::Neuron3::Model::gK
private

Definition at line 475 of file N_DEV_Neuron3.h.

bool Xyce::Device::Neuron3::Model::gKGiven
private

Definition at line 504 of file N_DEV_Neuron3.h.

double Xyce::Device::Neuron3::Model::gMem
private

Definition at line 470 of file N_DEV_Neuron3.h.

bool Xyce::Device::Neuron3::Model::gMemGiven
private

Definition at line 499 of file N_DEV_Neuron3.h.

double Xyce::Device::Neuron3::Model::gNa
private

Definition at line 473 of file N_DEV_Neuron3.h.

bool Xyce::Device::Neuron3::Model::gNaGiven
private

Definition at line 502 of file N_DEV_Neuron3.h.

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

Definition at line 518 of file N_DEV_Neuron3.h.

double Xyce::Device::Neuron3::Model::length
private

Definition at line 478 of file N_DEV_Neuron3.h.

bool Xyce::Device::Neuron3::Model::lengthGiven
private

Definition at line 507 of file N_DEV_Neuron3.h.

double Xyce::Device::Neuron3::Model::lengthNext
private

Definition at line 489 of file N_DEV_Neuron3.h.

bool Xyce::Device::Neuron3::Model::lengthNextGiven
private

Definition at line 495 of file N_DEV_Neuron3.h.

double Xyce::Device::Neuron3::Model::lengthPrevious
private

Definition at line 486 of file N_DEV_Neuron3.h.

bool Xyce::Device::Neuron3::Model::lengthPreviousGiven
private

Definition at line 492 of file N_DEV_Neuron3.h.

int Xyce::Device::Neuron3::Model::nSeg
private

Definition at line 479 of file N_DEV_Neuron3.h.

bool Xyce::Device::Neuron3::Model::nSegGiven
private

Definition at line 508 of file N_DEV_Neuron3.h.

double Xyce::Device::Neuron3::Model::radius
private

Definition at line 477 of file N_DEV_Neuron3.h.

bool Xyce::Device::Neuron3::Model::radiusGiven
private

Definition at line 506 of file N_DEV_Neuron3.h.

double Xyce::Device::Neuron3::Model::radiusNext
private

Definition at line 488 of file N_DEV_Neuron3.h.

bool Xyce::Device::Neuron3::Model::radiusNextGiven
private

Definition at line 494 of file N_DEV_Neuron3.h.

double Xyce::Device::Neuron3::Model::radiusPrevious
private

Definition at line 485 of file N_DEV_Neuron3.h.

bool Xyce::Device::Neuron3::Model::radiusPreviousGiven
private

Definition at line 491 of file N_DEV_Neuron3.h.

double Xyce::Device::Neuron3::Model::rInt
private

Definition at line 476 of file N_DEV_Neuron3.h.

bool Xyce::Device::Neuron3::Model::rIntGiven
private

Definition at line 505 of file N_DEV_Neuron3.h.

double Xyce::Device::Neuron3::Model::rIntNext
private

Definition at line 487 of file N_DEV_Neuron3.h.

bool Xyce::Device::Neuron3::Model::rIntNextGiven
private

Definition at line 493 of file N_DEV_Neuron3.h.

double Xyce::Device::Neuron3::Model::rIntPrevious
private

Definition at line 484 of file N_DEV_Neuron3.h.

bool Xyce::Device::Neuron3::Model::rIntPreviousGiven
private

Definition at line 490 of file N_DEV_Neuron3.h.

double Xyce::Device::Neuron3::Model::vRest
private

Definition at line 471 of file N_DEV_Neuron3.h.

bool Xyce::Device::Neuron3::Model::vRestGiven
private

Definition at line 500 of file N_DEV_Neuron3.h.


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