Modigliani  2.0
A stochastic simulator for axons, neurons, and networks
Public Member Functions | List of all members
modigliani_core::Leak_current Class Reference

Simulates a leak current. More...

+ Inheritance diagram for modigliani_core::Leak_current:

Public Member Functions

 Leak_current (modigliani_base::Real newArea, modigliani_base::Real newLeakConductance, modigliani_base::Real newReversalPotential)
 Constructs a leak current instance. More...
 
modigliani_base::ReturnEnum StepCurrent ()
 Runs one step of the simulation. More...
 
void UpdateConductance ()
 Compute and return conductance. More...
 
modigliani_base::Real ComputeConductance () override
 Return leak conductance. More...
 
modigliani_base::Real MaxConductivity () const
 Return leak conductance. More...
 
- Public Member Functions inherited from modigliani_core::Membrane_current
 Membrane_current (modigliani_base::Real reversalPotential)
 Constructs a current. More...
 
modigliani_base::Real conductance () const
 Returns momentary conductance. More...
 
void set_reversal_potential (modigliani_base::Real eRev)
 Sets the reversal potential. More...
 
modigliani_base::Real reversal_potential () const
 Returns the reversal potential. More...
 
modigliani_base::Real temperature () const
 Returns the temperature. More...
 
modigliani_base::ReturnEnum set_temperature (modigliani_base::Real newTemp)
 Sets the temperature. More...
 
modigliani_base::Real q10 () const
 Returns the Q10 factor. More...
 
virtual modigliani_base::ReturnEnum set_q10 (modigliani_base::Real newQ10)
 Sets the Q10 factor. More...
 
enum StochasticType simulation_mode () const
 Returns the simulation mode. More...
 
virtual void set_simulation_mode (enum StochasticType newMode)
 Sets simulation mode. More...
 
void set_voltage (modigliani_base::Real newVoltage)
 Sets the membrane potential. More...
 
modigliani_base::ReturnEnum Step (modigliani_base::Real newVm)
 Runs one step of the simulation, updates the conductance and the current flowing through. More...
 
modigliani_base::Real ComputeCurrent (modigliani_base::Real vM)
 Computes, sets and returns the current going through. More...
 
virtual modigliani_base::Real ComputeTimeConstant ()
 Computes and returns the rate constants. More...
 
modigliani_base::Real current () const
 Returns the current. More...
 
- Public Member Functions inherited from modigliani_core::Object
modigliani_base::Real timestep () const
 Returns simulation timestep. More...
 
void set_timestep (modigliani_base::Real newTimeStep)
 Sets simulation timestep. More...
 

Additional Inherited Members

- Protected Member Functions inherited from modigliani_core::Membrane_current
modigliani_base::Real set_current (modigliani_base::Real newVal)
 Sets the current. More...
 
modigliani_base::Real set_conductance (modigliani_base::Real newVal)
 Sets the conductance. More...
 
- Protected Attributes inherited from modigliani_core::Membrane_current
modigliani_base::Real voltage_
 Membrane potential in [ $\si{\milli\volt}$].
 
modigliani_base::Real temperature_
 Temperature in [ $\si{\celsius}$].
 

Detailed Description

Simulates a leak current.

Constructor & Destructor Documentation

modigliani_core::Leak_current::Leak_current ( modigliani_base::Real  newArea,
modigliani_base::Real  newLeakConductance,
modigliani_base::Real  newReversalPotential 
)

Constructs a leak current instance.

Parameters
newAreaMembrane surface area in [ $\si{\micro\meter\squared}$]
newLeakConductanceLeak conductance in [ $\si{\milli\siemens\per\centi\meter\squared}$]
newReversalPotentialReversal potential in [ $\si{\milli\volt}$]

Member Function Documentation

modigliani_base::Real modigliani_core::Leak_current::ComputeConductance ( )
inlineoverridevirtual

Return leak conductance.

Returns
Leak conductance in [ $\si{\milli\siemens}$]
Warning
function return constant value (leak!) set in constructor)

Implements modigliani_core::Membrane_current.

modigliani_base::Real modigliani_core::Leak_current::MaxConductivity ( ) const
inlinevirtual

Return leak conductance.

Returns
Leak conductivity in [ $\si{\milli\siemens\per\centi\meter\squared}$]

Implements modigliani_core::Membrane_current.

modigliani_base::ReturnEnum modigliani_core::Leak_current::StepCurrent ( )
inlinevirtual

Runs one step of the simulation.

This function simply returns SUCCESS

Returns
SUCCESS

Implements modigliani_core::Membrane_current.

void modigliani_core::Leak_current::UpdateConductance ( )
inline

Compute and return conductance.

Returns
Conductance in [ $\si{\milli\siemens}$]

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