Xyce  6.1
Xyce::Device::Neuron::Model Class Reference

#include <N_DEV_Neuron.h>

Inheritance diagram for Xyce::Device::Neuron::Model:
Collaboration diagram for Xyce::Device::Neuron::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 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

double cMem
 
double gMem
 
double eLeak
 
double eNa
 
double gNa
 
double eK
 
double gK
 
double vRest
 
bool cMemGiven
 
bool gMemGiven
 
bool eLeakGiven
 
bool eNaGiven
 
bool gNaGiven
 
bool eKGiven
 
bool gKGiven
 
bool vRestGiven
 
std::vector< Instance * > instanceContainer
 

Friends

class ParametricData< Model >
 
class Instance
 
class Traits
 
class Master
 

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 391 of file N_DEV_Neuron.h.

Member Typedef Documentation

typedef std::vector<Instance *> Xyce::Device::Neuron::Model::InstanceVector
private

Definition at line 393 of file N_DEV_Neuron.h.

Constructor & Destructor Documentation

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

Definition at line 886 of file N_DEV_Neuron.C.

Xyce::Device::Neuron::Model::~Model ( )

Definition at line 919 of file N_DEV_Neuron.C.

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

Member Function Documentation

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

Definition at line 443 of file N_DEV_Neuron.h.

void Xyce::Device::Neuron::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 978 of file N_DEV_Neuron.C.

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

Implements Xyce::Device::DeviceModel.

Definition at line 941 of file N_DEV_Neuron.C.

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

processInstanceParams

Returns
true if parameter processing was successful

Implements Xyce::Device::DeviceModel.

Definition at line 863 of file N_DEV_Neuron.C.

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

processParams

Returns
true if parameter processing was successful

Implements Xyce::Device::DeviceModel.

Definition at line 850 of file N_DEV_Neuron.C.

Friends And Related Function Documentation

friend class Instance
friend

Definition at line 396 of file N_DEV_Neuron.h.

friend class Master
friend

Definition at line 397 of file N_DEV_Neuron.h.

friend class ParametricData< Model >
friend

Definition at line 395 of file N_DEV_Neuron.h.

friend class Traits
friend

Definition at line 397 of file N_DEV_Neuron.h.

Member Data Documentation

double Xyce::Device::Neuron::Model::cMem
private

Definition at line 422 of file N_DEV_Neuron.h.

bool Xyce::Device::Neuron::Model::cMemGiven
private

Definition at line 432 of file N_DEV_Neuron.h.

double Xyce::Device::Neuron::Model::eK
private

Definition at line 427 of file N_DEV_Neuron.h.

bool Xyce::Device::Neuron::Model::eKGiven
private

Definition at line 437 of file N_DEV_Neuron.h.

double Xyce::Device::Neuron::Model::eLeak
private

Definition at line 424 of file N_DEV_Neuron.h.

bool Xyce::Device::Neuron::Model::eLeakGiven
private

Definition at line 434 of file N_DEV_Neuron.h.

double Xyce::Device::Neuron::Model::eNa
private

Definition at line 425 of file N_DEV_Neuron.h.

bool Xyce::Device::Neuron::Model::eNaGiven
private

Definition at line 435 of file N_DEV_Neuron.h.

double Xyce::Device::Neuron::Model::gK
private

Definition at line 428 of file N_DEV_Neuron.h.

bool Xyce::Device::Neuron::Model::gKGiven
private

Definition at line 438 of file N_DEV_Neuron.h.

double Xyce::Device::Neuron::Model::gMem
private

Definition at line 423 of file N_DEV_Neuron.h.

bool Xyce::Device::Neuron::Model::gMemGiven
private

Definition at line 433 of file N_DEV_Neuron.h.

double Xyce::Device::Neuron::Model::gNa
private

Definition at line 426 of file N_DEV_Neuron.h.

bool Xyce::Device::Neuron::Model::gNaGiven
private

Definition at line 436 of file N_DEV_Neuron.h.

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

Definition at line 449 of file N_DEV_Neuron.h.

double Xyce::Device::Neuron::Model::vRest
private

Definition at line 429 of file N_DEV_Neuron.h.

bool Xyce::Device::Neuron::Model::vRestGiven
private

Definition at line 439 of file N_DEV_Neuron.h.


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