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

#include <N_DEV_Neuron2.h>

Inheritance diagram for Xyce::Device::Neuron2::Model:
Collaboration diagram for Xyce::Device::Neuron2::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)
 
InstanceVectorgetInstanceVector ()
 
const InstanceVectorgetInstanceVector () const
 
- Public Member Functions inherited from Xyce::Device::DeviceModel
 DeviceModel (const ModelBlock &model_block, ParametricData< void > &parametric_data, const FactoryBlock &factory_block)
 
virtual ~DeviceModel ()
 
void setModParams (const std::vector< Param > &params)
 
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 (const char *const entity_type, const std::string &device_name, 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 ()
 
bool scaleParam (const std::string &paramName, double val, double val0)
 
bool scaleParam (const std::string &paramName, double val)
 
bool scaleDefaultParam (double val)
 
bool setParam (const std::string &paramName, double val)
 
bool getParam (const std::string &paramName, double &result)
 
bool getParamBreakpoints (std::vector< Util::BreakPoint > &)
 
bool updateDependentParameters (N_LAS_Vector &vars)
 
bool updateDependentParameters (double temp_tmp)
 
bool updateGlobalParameters (std::map< std::string, double > &)
 
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
 
const char * getEntityType () const
 
const std::string & getName () const
 
void setDefaultParamName (const std::string &default_param_name)
 
const std::vector< Depend > & getDependentParams ()
 
const DeviceOptionsgetDeviceOptions () const
 
const SolverStategetSolverState () const
 
const NetlistLocation & netlistLocation () const
 
const ParameterMapgetParameterMap () const
 
- Public Member Functions inherited from Xyce::Device::ParameterBase
 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
 
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< DependdependentParams
 
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 640 of file N_DEV_Neuron2.h.

Member Typedef Documentation

Definition at line 642 of file N_DEV_Neuron2.h.

Constructor & Destructor Documentation

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

Definition at line 1302 of file N_DEV_Neuron2.C.

Xyce::Device::Neuron2::Model::~Model ( )

Definition at line 1335 of file N_DEV_Neuron2.C.

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

Member Function Documentation

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

Definition at line 707 of file N_DEV_Neuron2.h.

void Xyce::Device::Neuron2::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 1395 of file N_DEV_Neuron2.C.

InstanceVector& Xyce::Device::Neuron2::Model::getInstanceVector ( )
inline

Definition at line 712 of file N_DEV_Neuron2.h.

const InstanceVector& Xyce::Device::Neuron2::Model::getInstanceVector ( ) const
inline

Definition at line 717 of file N_DEV_Neuron2.h.

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

Implements Xyce::Device::DeviceModel.

Definition at line 1358 of file N_DEV_Neuron2.C.

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

processInstanceParams

Returns
true if parameter processing was successful

Implements Xyce::Device::DeviceModel.

Definition at line 1279 of file N_DEV_Neuron2.C.

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

processParams

Returns
true if parameter processing was successful

Implements Xyce::Device::DeviceModel.

Definition at line 1266 of file N_DEV_Neuron2.C.

Friends And Related Function Documentation

friend class Instance
friend

Definition at line 645 of file N_DEV_Neuron2.h.

friend class ParametricData< Model >
friend

Definition at line 644 of file N_DEV_Neuron2.h.

friend class Traits
friend

Definition at line 646 of file N_DEV_Neuron2.h.

Member Data Documentation

double Xyce::Device::Neuron2::Model::CaGamma
private

Definition at line 685 of file N_DEV_Neuron2.h.

bool Xyce::Device::Neuron2::Model::CaGammaGiven
private

Definition at line 703 of file N_DEV_Neuron2.h.

double Xyce::Device::Neuron2::Model::CaInit
private

Definition at line 684 of file N_DEV_Neuron2.h.

bool Xyce::Device::Neuron2::Model::CaInitGiven
private

Definition at line 702 of file N_DEV_Neuron2.h.

double Xyce::Device::Neuron2::Model::CaTau
private

Definition at line 686 of file N_DEV_Neuron2.h.

bool Xyce::Device::Neuron2::Model::CaTauGiven
private

Definition at line 704 of file N_DEV_Neuron2.h.

double Xyce::Device::Neuron2::Model::cMem
private

Definition at line 671 of file N_DEV_Neuron2.h.

bool Xyce::Device::Neuron2::Model::cMemGiven
private

Definition at line 689 of file N_DEV_Neuron2.h.

double Xyce::Device::Neuron2::Model::eA
private

Definition at line 678 of file N_DEV_Neuron2.h.

bool Xyce::Device::Neuron2::Model::eAGiven
private

Definition at line 696 of file N_DEV_Neuron2.h.

double Xyce::Device::Neuron2::Model::eCa
private

Definition at line 680 of file N_DEV_Neuron2.h.

bool Xyce::Device::Neuron2::Model::eCaGiven
private

Definition at line 698 of file N_DEV_Neuron2.h.

double Xyce::Device::Neuron2::Model::eK
private

Definition at line 676 of file N_DEV_Neuron2.h.

double Xyce::Device::Neuron2::Model::eKCa
private

Definition at line 682 of file N_DEV_Neuron2.h.

bool Xyce::Device::Neuron2::Model::eKCaGiven
private

Definition at line 700 of file N_DEV_Neuron2.h.

bool Xyce::Device::Neuron2::Model::eKGiven
private

Definition at line 694 of file N_DEV_Neuron2.h.

double Xyce::Device::Neuron2::Model::eNa
private

Definition at line 674 of file N_DEV_Neuron2.h.

bool Xyce::Device::Neuron2::Model::eNaGiven
private

Definition at line 692 of file N_DEV_Neuron2.h.

double Xyce::Device::Neuron2::Model::gA
private

Definition at line 679 of file N_DEV_Neuron2.h.

bool Xyce::Device::Neuron2::Model::gAGiven
private

Definition at line 697 of file N_DEV_Neuron2.h.

double Xyce::Device::Neuron2::Model::gCa
private

Definition at line 681 of file N_DEV_Neuron2.h.

bool Xyce::Device::Neuron2::Model::gCaGiven
private

Definition at line 699 of file N_DEV_Neuron2.h.

double Xyce::Device::Neuron2::Model::gK
private

Definition at line 677 of file N_DEV_Neuron2.h.

double Xyce::Device::Neuron2::Model::gKCa
private

Definition at line 683 of file N_DEV_Neuron2.h.

bool Xyce::Device::Neuron2::Model::gKCaGiven
private

Definition at line 701 of file N_DEV_Neuron2.h.

bool Xyce::Device::Neuron2::Model::gKGiven
private

Definition at line 695 of file N_DEV_Neuron2.h.

double Xyce::Device::Neuron2::Model::gMem
private

Definition at line 672 of file N_DEV_Neuron2.h.

bool Xyce::Device::Neuron2::Model::gMemGiven
private

Definition at line 690 of file N_DEV_Neuron2.h.

double Xyce::Device::Neuron2::Model::gNa
private

Definition at line 675 of file N_DEV_Neuron2.h.

bool Xyce::Device::Neuron2::Model::gNaGiven
private

Definition at line 693 of file N_DEV_Neuron2.h.

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

Definition at line 723 of file N_DEV_Neuron2.h.

double Xyce::Device::Neuron2::Model::vRest
private

Definition at line 673 of file N_DEV_Neuron2.h.

bool Xyce::Device::Neuron2::Model::vRestGiven
private

Definition at line 691 of file N_DEV_Neuron2.h.


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