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

#include <N_DEV_MOSFET3.h>

Inheritance diagram for Xyce::Device::MOSFET3::Master:
Collaboration diagram for Xyce::Device::MOSFET3::Master:

Public Member Functions

 Master (const Configuration &configuration, const FactoryBlock &factory_block, const SolverState &ss1, const DeviceOptions &do1)
 
virtual bool updateState (double *solVec, double *staVec, double *stoVec)
 Updates the devices state information. More...
 
virtual bool loadDAEVectors (double *solVec, double *fVec, double *qVec, double *bVec, double *storeLeadF, double *storeLeadQ)
 Populates the device's ExternData object with these pointers. More...
 
virtual bool loadDAEMatrices (N_LAS_Matrix &dFdx, N_LAS_Matrix &dQdx)
 Populates the device's Jacobian object with these pointers. More...
 
- Public Member Functions inherited from Xyce::Device::DeviceMaster< Traits >
 DeviceMaster (const Configuration &configuration, const FactoryBlock &factory_block, const SolverState &solver_state, const DeviceOptions &device_options)
 Constructs a device. More...
 
virtual ~DeviceMaster ()
 Destroys the device. More...
 
virtual const std::string & getName () const
 Returns the name of this device. More...
 
virtual const std::string & getDefaultModelName () const
 Returns the default model name to use if the instance being created does not specify one. More...
 
virtual DeviceModelfindModel (const ModelName &model_name)
 Returns a pointer to the model or model model with the specified name. More...
 
virtual const DeviceModelfindModel (const ModelName &model_name) const
 Returns a pointer to the model or model model with the specified name. More...
 
virtual DeviceEntityfindInstance (const InstanceName &instance_name)
 Returns a pointer to the model or instance entity with the specified name. More...
 
virtual const DeviceEntityfindInstance (const InstanceName &instance_name) const
 Returns a pointer to the model or instance entity with the specified name. More...
 
virtual bool isLinearDevice () const
 Returns true if this device is a linear device. More...
 
virtual bool isPDEDevice () const
 Returns true if this device is a PDE device. More...
 
virtual void forEachModel (DeviceModelOp &op) const
 Executes operator op, passing its DeviceModel pointer, for each device model. More...
 
virtual void forEachInstance (DeviceInstanceOp &op) const
 Executes operator op, passing its DeviceInstance pointer, for each device instance. More...
 
virtual ModelTypeaddModel (const ModelBlock &MB, const FactoryBlock &factory_block)
 Creates a device model and adds it to the device's list of models. More...
 
virtual InstanceTypeaddInstance (const InstanceBlock &instance_block, const FactoryBlock &factory_block)
 Creates a device instance and adds to the device model's instance list. More...
 
virtual bool updateSources ()
 Updates the devices source information. More...
 
virtual bool updateSecondaryState (double *staDerivVec, double *stoVec)
 Updates the devices secondary state information. More...
 
- Public Member Functions inherited from Xyce::Device::Device
 Device ()
 
virtual ~Device ()
 

Friends

class Instance
 
class Model
 

Additional Inherited Members

- Public Types inherited from Xyce::Device::DeviceMaster< Traits >
typedef Traits::ModelType ModelType
 Make the model begin defined available. More...
 
typedef Traits::InstanceType InstanceType
 Make the instance being define available. More...
 
- Protected Types inherited from Xyce::Device::DeviceMaster< Traits >
typedef std::vector
< InstanceType * > 
InstanceVector
 
typedef std::map< std::string,
ModelType *, LessNoCase > 
ModelMap
 
typedef std::map< std::string,
InstanceType *, LessNoCase > 
InstanceMap
 
- Protected Member Functions inherited from Xyce::Device::DeviceMaster< Traits >
const SolverStategetSolverState () const
 Returns the solver state given during device construction. More...
 
const DeviceOptionsgetDeviceOptions () const
 Returns the device options given during device construction. More...
 
InstanceVector::const_iterator getInstanceBegin () const
 Returns an iterator to the beginning of the vector of all instances created for this device. More...
 
InstanceVector::const_iterator getInstanceEnd () const
 Returns an iterator to the ending of the vector of all instances created for this device. More...
 
bool isModelRequired () const
 Returns true if the model name must be specified for each instance. More...
 

Detailed Description

Definition at line 651 of file N_DEV_MOSFET3.h.

Constructor & Destructor Documentation

Xyce::Device::MOSFET3::Master::Master ( const Configuration configuration,
const FactoryBlock factory_block,
const SolverState ss1,
const DeviceOptions do1 
)
inline

Definition at line 654 of file N_DEV_MOSFET3.h.

Member Function Documentation

bool Xyce::Device::MOSFET3::Master::loadDAEMatrices ( N_LAS_Matrix &  dFdx,
N_LAS_Matrix &  dQdx 
)
virtual

Populates the device's Jacobian object with these pointers.

THIS FUNCTION MUST BE CALLED AFTER CALLING loadDAEVectors.

Parameters
dFdxpointer to the analysis dFdx matrix
dQdxpointer to the analysis dQdx matrix
Returns

Reimplemented from Xyce::Device::DeviceMaster< Traits >.

Definition at line 3518 of file N_DEV_MOSFET3.C.

bool Xyce::Device::MOSFET3::Master::loadDAEVectors ( double *  solVec,
double *  fVec,
double *  qVec,
double *  bVec,
double *  storeLeadF,
double *  storeLeadQ 
)
virtual

Populates the device's ExternData object with these pointers.

THIS FUNCTION MUST BE CALLED PRIOR TO CALLING loadDAEMatrices.

Parameters
solVecpointer to the analysis solution vector for this device
fVecpointer to the analysis f vector for this device
qVecpointer to the analysis q vector for this device
storeLeadFpointer to the analysis lead store f vector for this device
storeLeadQpoitner to the analysis load store q vector for this device
Returns
true if the update was successful

Reimplemented from Xyce::Device::DeviceMaster< Traits >.

Definition at line 3353 of file N_DEV_MOSFET3.C.

bool Xyce::Device::MOSFET3::Master::updateState ( double *  solVec,
double *  staVec,
double *  stoVec 
)
virtual

Updates the devices state information.

This function is called by the analysis subsystem when it is time to update the device state information.

Returns
true if the update was successful

Reimplemented from Xyce::Device::DeviceMaster< Traits >.

Definition at line 3264 of file N_DEV_MOSFET3.C.

Friends And Related Function Documentation

friend class Instance
friend

Definition at line 671 of file N_DEV_MOSFET3.h.

friend class Model
friend

Definition at line 672 of file N_DEV_MOSFET3.h.


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