Xyce  6.1
Xyce::Device::Neuron4::Model Class Reference

#include <N_DEV_Neuron4.h>

Inheritance diagram for Xyce::Device::Neuron4::Model:
Collaboration diagram for Xyce::Device::Neuron4::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 eA
 
double gA
 
double eCa
 
double gCa
 
double eKCa
 
double gKCa
 
double CaInit
 
double CaGamma
 
double CaTau
 
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 rIntGiven
 
bool radiusGiven
 
bool lengthGiven
 
bool nSegGiven
 
bool cMemGiven
 
bool gMemGiven
 
bool vRestGiven
 
bool eNaGiven
 
bool gNaGiven
 
bool eKGiven
 
bool gKGiven
 
bool eAGiven
 
bool gAGiven
 
bool eCaGiven
 
bool gCaGiven
 
bool eKCaGiven
 
bool gKCaGiven
 
bool CaInitGiven
 
bool CaGammaGiven
 
bool CaTauGiven
 
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 660 of file N_DEV_Neuron4.h.

Member Typedef Documentation

Definition at line 662 of file N_DEV_Neuron4.h.

Constructor & Destructor Documentation

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

Definition at line 1967 of file N_DEV_Neuron4.C.

Xyce::Device::Neuron4::Model::~Model ( )

Definition at line 1999 of file N_DEV_Neuron4.C.

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

Member Function Documentation

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

Definition at line 754 of file N_DEV_Neuron4.h.

void Xyce::Device::Neuron4::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 2059 of file N_DEV_Neuron4.C.

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

Implements Xyce::Device::DeviceModel.

Definition at line 2022 of file N_DEV_Neuron4.C.

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

processInstanceParams

Returns
true if parameter processing was successful

Implements Xyce::Device::DeviceModel.

Definition at line 1944 of file N_DEV_Neuron4.C.

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

processParams

Returns
true if parameter processing was successful

Implements Xyce::Device::DeviceModel.

Definition at line 1931 of file N_DEV_Neuron4.C.

Friends And Related Function Documentation

friend class Instance
friend

Definition at line 665 of file N_DEV_Neuron4.h.

friend class ParametricData< Model >
friend

Definition at line 664 of file N_DEV_Neuron4.h.

friend class Traits
friend

Definition at line 666 of file N_DEV_Neuron4.h.

Member Data Documentation

double Xyce::Device::Neuron4::Model::CaGamma
private

Definition at line 705 of file N_DEV_Neuron4.h.

bool Xyce::Device::Neuron4::Model::CaGammaGiven
private

Definition at line 749 of file N_DEV_Neuron4.h.

double Xyce::Device::Neuron4::Model::CaInit
private

Definition at line 704 of file N_DEV_Neuron4.h.

bool Xyce::Device::Neuron4::Model::CaInitGiven
private

Definition at line 748 of file N_DEV_Neuron4.h.

double Xyce::Device::Neuron4::Model::CaTau
private

Definition at line 706 of file N_DEV_Neuron4.h.

bool Xyce::Device::Neuron4::Model::CaTauGiven
private

Definition at line 750 of file N_DEV_Neuron4.h.

double Xyce::Device::Neuron4::Model::cMem
private

Definition at line 691 of file N_DEV_Neuron4.h.

bool Xyce::Device::Neuron4::Model::cMemGiven
private

Definition at line 735 of file N_DEV_Neuron4.h.

double Xyce::Device::Neuron4::Model::eA
private

Definition at line 698 of file N_DEV_Neuron4.h.

bool Xyce::Device::Neuron4::Model::eAGiven
private

Definition at line 742 of file N_DEV_Neuron4.h.

double Xyce::Device::Neuron4::Model::eCa
private

Definition at line 700 of file N_DEV_Neuron4.h.

bool Xyce::Device::Neuron4::Model::eCaGiven
private

Definition at line 744 of file N_DEV_Neuron4.h.

double Xyce::Device::Neuron4::Model::eK
private

Definition at line 696 of file N_DEV_Neuron4.h.

double Xyce::Device::Neuron4::Model::eKCa
private

Definition at line 702 of file N_DEV_Neuron4.h.

bool Xyce::Device::Neuron4::Model::eKCaGiven
private

Definition at line 746 of file N_DEV_Neuron4.h.

bool Xyce::Device::Neuron4::Model::eKGiven
private

Definition at line 740 of file N_DEV_Neuron4.h.

double Xyce::Device::Neuron4::Model::eNa
private

Definition at line 694 of file N_DEV_Neuron4.h.

bool Xyce::Device::Neuron4::Model::eNaGiven
private

Definition at line 738 of file N_DEV_Neuron4.h.

double Xyce::Device::Neuron4::Model::gA
private

Definition at line 699 of file N_DEV_Neuron4.h.

bool Xyce::Device::Neuron4::Model::gAGiven
private

Definition at line 743 of file N_DEV_Neuron4.h.

double Xyce::Device::Neuron4::Model::gCa
private

Definition at line 701 of file N_DEV_Neuron4.h.

bool Xyce::Device::Neuron4::Model::gCaGiven
private

Definition at line 745 of file N_DEV_Neuron4.h.

double Xyce::Device::Neuron4::Model::gK
private

Definition at line 697 of file N_DEV_Neuron4.h.

double Xyce::Device::Neuron4::Model::gKCa
private

Definition at line 703 of file N_DEV_Neuron4.h.

bool Xyce::Device::Neuron4::Model::gKCaGiven
private

Definition at line 747 of file N_DEV_Neuron4.h.

bool Xyce::Device::Neuron4::Model::gKGiven
private

Definition at line 741 of file N_DEV_Neuron4.h.

double Xyce::Device::Neuron4::Model::gMem
private

Definition at line 692 of file N_DEV_Neuron4.h.

bool Xyce::Device::Neuron4::Model::gMemGiven
private

Definition at line 736 of file N_DEV_Neuron4.h.

double Xyce::Device::Neuron4::Model::gNa
private

Definition at line 695 of file N_DEV_Neuron4.h.

bool Xyce::Device::Neuron4::Model::gNaGiven
private

Definition at line 739 of file N_DEV_Neuron4.h.

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

Definition at line 760 of file N_DEV_Neuron4.h.

double Xyce::Device::Neuron4::Model::length
private

Definition at line 709 of file N_DEV_Neuron4.h.

bool Xyce::Device::Neuron4::Model::lengthGiven
private

Definition at line 731 of file N_DEV_Neuron4.h.

double Xyce::Device::Neuron4::Model::lengthNext
private

Definition at line 720 of file N_DEV_Neuron4.h.

bool Xyce::Device::Neuron4::Model::lengthNextGiven
private

Definition at line 726 of file N_DEV_Neuron4.h.

double Xyce::Device::Neuron4::Model::lengthPrevious
private

Definition at line 717 of file N_DEV_Neuron4.h.

bool Xyce::Device::Neuron4::Model::lengthPreviousGiven
private

Definition at line 723 of file N_DEV_Neuron4.h.

int Xyce::Device::Neuron4::Model::nSeg
private

Definition at line 710 of file N_DEV_Neuron4.h.

bool Xyce::Device::Neuron4::Model::nSegGiven
private

Definition at line 732 of file N_DEV_Neuron4.h.

double Xyce::Device::Neuron4::Model::radius
private

Definition at line 708 of file N_DEV_Neuron4.h.

bool Xyce::Device::Neuron4::Model::radiusGiven
private

Definition at line 730 of file N_DEV_Neuron4.h.

double Xyce::Device::Neuron4::Model::radiusNext
private

Definition at line 719 of file N_DEV_Neuron4.h.

bool Xyce::Device::Neuron4::Model::radiusNextGiven
private

Definition at line 725 of file N_DEV_Neuron4.h.

double Xyce::Device::Neuron4::Model::radiusPrevious
private

Definition at line 716 of file N_DEV_Neuron4.h.

bool Xyce::Device::Neuron4::Model::radiusPreviousGiven
private

Definition at line 722 of file N_DEV_Neuron4.h.

double Xyce::Device::Neuron4::Model::rInt
private

Definition at line 707 of file N_DEV_Neuron4.h.

bool Xyce::Device::Neuron4::Model::rIntGiven
private

Definition at line 729 of file N_DEV_Neuron4.h.

double Xyce::Device::Neuron4::Model::rIntNext
private

Definition at line 718 of file N_DEV_Neuron4.h.

bool Xyce::Device::Neuron4::Model::rIntNextGiven
private

Definition at line 724 of file N_DEV_Neuron4.h.

double Xyce::Device::Neuron4::Model::rIntPrevious
private

Definition at line 715 of file N_DEV_Neuron4.h.

bool Xyce::Device::Neuron4::Model::rIntPreviousGiven
private

Definition at line 721 of file N_DEV_Neuron4.h.

double Xyce::Device::Neuron4::Model::vRest
private

Definition at line 693 of file N_DEV_Neuron4.h.

bool Xyce::Device::Neuron4::Model::vRestGiven
private

Definition at line 737 of file N_DEV_Neuron4.h.


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