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

#include <N_DEV_Neuron5.h>

Inheritance diagram for Xyce::Device::Neuron5::Model:
Collaboration diagram for Xyce::Device::Neuron5::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 267 of file N_DEV_Neuron5.h.

Member Typedef Documentation

Definition at line 269 of file N_DEV_Neuron5.h.

Constructor & Destructor Documentation

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

Definition at line 1317 of file N_DEV_Neuron5.C.

Xyce::Device::Neuron5::Model::~Model ( )

Definition at line 1349 of file N_DEV_Neuron5.C.

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

Member Function Documentation

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

Definition at line 335 of file N_DEV_Neuron5.h.

void Xyce::Device::Neuron5::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 1409 of file N_DEV_Neuron5.C.

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

Definition at line 340 of file N_DEV_Neuron5.h.

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

Definition at line 345 of file N_DEV_Neuron5.h.

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

Implements Xyce::Device::DeviceModel.

Definition at line 1372 of file N_DEV_Neuron5.C.

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

processInstanceParams

Returns
true if parameter processing was successful

Implements Xyce::Device::DeviceModel.

Definition at line 1294 of file N_DEV_Neuron5.C.

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

processParams

Returns
true if parameter processing was successful

Implements Xyce::Device::DeviceModel.

Definition at line 1281 of file N_DEV_Neuron5.C.

Friends And Related Function Documentation

friend class Instance
friend

Definition at line 272 of file N_DEV_Neuron5.h.

friend class ParametricData< Model >
friend

Definition at line 271 of file N_DEV_Neuron5.h.

friend class Traits
friend

Definition at line 273 of file N_DEV_Neuron5.h.

Member Data Documentation

double Xyce::Device::Neuron5::Model::CaGamma
private

Definition at line 312 of file N_DEV_Neuron5.h.

bool Xyce::Device::Neuron5::Model::CaGammaGiven
private

Definition at line 330 of file N_DEV_Neuron5.h.

double Xyce::Device::Neuron5::Model::CaInit
private

Definition at line 311 of file N_DEV_Neuron5.h.

bool Xyce::Device::Neuron5::Model::CaInitGiven
private

Definition at line 329 of file N_DEV_Neuron5.h.

double Xyce::Device::Neuron5::Model::CaTau
private

Definition at line 313 of file N_DEV_Neuron5.h.

bool Xyce::Device::Neuron5::Model::CaTauGiven
private

Definition at line 331 of file N_DEV_Neuron5.h.

double Xyce::Device::Neuron5::Model::cMem
private

Definition at line 298 of file N_DEV_Neuron5.h.

bool Xyce::Device::Neuron5::Model::cMemGiven
private

Definition at line 316 of file N_DEV_Neuron5.h.

double Xyce::Device::Neuron5::Model::eA
private

Definition at line 305 of file N_DEV_Neuron5.h.

bool Xyce::Device::Neuron5::Model::eAGiven
private

Definition at line 323 of file N_DEV_Neuron5.h.

double Xyce::Device::Neuron5::Model::eCa
private

Definition at line 307 of file N_DEV_Neuron5.h.

bool Xyce::Device::Neuron5::Model::eCaGiven
private

Definition at line 325 of file N_DEV_Neuron5.h.

double Xyce::Device::Neuron5::Model::eK
private

Definition at line 303 of file N_DEV_Neuron5.h.

double Xyce::Device::Neuron5::Model::eKCa
private

Definition at line 309 of file N_DEV_Neuron5.h.

bool Xyce::Device::Neuron5::Model::eKCaGiven
private

Definition at line 327 of file N_DEV_Neuron5.h.

bool Xyce::Device::Neuron5::Model::eKGiven
private

Definition at line 321 of file N_DEV_Neuron5.h.

double Xyce::Device::Neuron5::Model::eNa
private

Definition at line 301 of file N_DEV_Neuron5.h.

bool Xyce::Device::Neuron5::Model::eNaGiven
private

Definition at line 319 of file N_DEV_Neuron5.h.

double Xyce::Device::Neuron5::Model::gA
private

Definition at line 306 of file N_DEV_Neuron5.h.

bool Xyce::Device::Neuron5::Model::gAGiven
private

Definition at line 324 of file N_DEV_Neuron5.h.

double Xyce::Device::Neuron5::Model::gCa
private

Definition at line 308 of file N_DEV_Neuron5.h.

bool Xyce::Device::Neuron5::Model::gCaGiven
private

Definition at line 326 of file N_DEV_Neuron5.h.

double Xyce::Device::Neuron5::Model::gK
private

Definition at line 304 of file N_DEV_Neuron5.h.

double Xyce::Device::Neuron5::Model::gKCa
private

Definition at line 310 of file N_DEV_Neuron5.h.

bool Xyce::Device::Neuron5::Model::gKCaGiven
private

Definition at line 328 of file N_DEV_Neuron5.h.

bool Xyce::Device::Neuron5::Model::gKGiven
private

Definition at line 322 of file N_DEV_Neuron5.h.

double Xyce::Device::Neuron5::Model::gMem
private

Definition at line 299 of file N_DEV_Neuron5.h.

bool Xyce::Device::Neuron5::Model::gMemGiven
private

Definition at line 317 of file N_DEV_Neuron5.h.

double Xyce::Device::Neuron5::Model::gNa
private

Definition at line 302 of file N_DEV_Neuron5.h.

bool Xyce::Device::Neuron5::Model::gNaGiven
private

Definition at line 320 of file N_DEV_Neuron5.h.

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

Definition at line 351 of file N_DEV_Neuron5.h.

double Xyce::Device::Neuron5::Model::vRest
private

Definition at line 300 of file N_DEV_Neuron5.h.

bool Xyce::Device::Neuron5::Model::vRestGiven
private

Definition at line 318 of file N_DEV_Neuron5.h.


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