Modigliani  2.0
A stochastic simulator for axons, neurons, and networks
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
modigliani_core::Membrane_current Class Referenceabstract

Membrane_current class. More...

+ Inheritance diagram for modigliani_core::Membrane_current:

Public Member Functions

 Membrane_current (modigliani_base::Real reversalPotential)
 Constructs a current. More...
 
virtual modigliani_base::Real MaxConductivity () const =0
 Returns maximum conductivity. 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::ReturnEnum StepCurrent ()=0
 Runs one step of the simulation. More...
 
virtual modigliani_base::Real ComputeConductance ()=0
 Computes and returns conductance. 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...
 

Protected Member Functions

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

modigliani_base::Real voltage_
 Membrane potential in [ $\si{\milli\volt}$].
 
modigliani_base::Real temperature_
 Temperature in [ $\si{\celsius}$].
 

Detailed Description

Membrane_current class.

Represents the current accross a membrane, with its generalisable properties. It computes the actual currents based on the Nernst-Equation accross the membrane neglecting diffusion/concentration effects and the conductivity values provided by the hh_current or channel_current classes.

Constructor & Destructor Documentation

modigliani_core::Membrane_current::Membrane_current ( modigliani_base::Real  reversalPotential)
explicit

Constructs a current.

Parameters
reversalPotentialReversal potential in [ $\si{\milli\volt}$]

Member Function Documentation

virtual modigliani_base::Real modigliani_core::Membrane_current::ComputeConductance ( )
pure virtual
modigliani_base::Real modigliani_core::Membrane_current::ComputeCurrent ( modigliani_base::Real  vM)
inline

Computes, sets and returns the current going through.

Parameters
vMMembrane potential in [ $\si{\milli\volt}$]
virtual modigliani_base::Real modigliani_core::Membrane_current::ComputeTimeConstant ( )
inlinevirtual

Computes and returns the rate constants.

If not overriden, returns 0.

Returns
Time Constant in [ $\si{\per\milli\second}$}]
modigliani_base::Real modigliani_core::Membrane_current::conductance ( ) const
inline

Returns momentary conductance.

Returns
Conductance in [ $\si{\milli\siemens}$]
modigliani_base::Real modigliani_core::Membrane_current::current ( ) const
inline

Returns the current.

Returns
Current in [ $\si{\nano\ampere}$}]
virtual modigliani_base::Real modigliani_core::Membrane_current::MaxConductivity ( ) const
pure virtual

Returns maximum conductivity.

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

Implemented in modigliani_core::Network_synapse, modigliani_core::Voltage_gated_ion_channel_current, and modigliani_core::Leak_current.

modigliani_base::Real modigliani_core::Membrane_current::q10 ( ) const
inline

Returns the Q10 factor.

Returns
Q10
modigliani_base::Real modigliani_core::Membrane_current::reversal_potential ( ) const
inline

Returns the reversal potential.

Returns
Reversal potential in [ $\si{\milli\volt}$]
modigliani_base::Real modigliani_core::Membrane_current::set_conductance ( modigliani_base::Real  newVal)
inlineprotected

Sets the conductance.

Parameters
newValCurrent in [ $\si{\milli\siemens}$]
modigliani_base::Real modigliani_core::Membrane_current::set_current ( modigliani_base::Real  newVal)
inlineprotected

Sets the current.

Parameters
newValCurrent in [ $\si{\nano\ampere}$}]
virtual modigliani_base::ReturnEnum modigliani_core::Membrane_current::set_q10 ( modigliani_base::Real  newQ10)
inlinevirtual

Sets the Q10 factor.

Parameters
newQ10Q10
void modigliani_core::Membrane_current::set_reversal_potential ( modigliani_base::Real  eRev)
inline

Sets the reversal potential.

Parameters
eRevReversal potential in [ $\si{\milli\volt}$]
virtual void modigliani_core::Membrane_current::set_simulation_mode ( enum StochasticType  newMode)
inlinevirtual

Sets simulation mode.

Parameters
newModeSimulation mode
modigliani_base::ReturnEnum modigliani_core::Membrane_current::set_temperature ( modigliani_base::Real  newTemp)
inline

Sets the temperature.

Parameters
newTempTemperature in [ $\si{\celsius}$]
void modigliani_core::Membrane_current::set_voltage ( modigliani_base::Real  newVoltage)
inline

Sets the membrane potential.

Parameters
newVoltageMembrane potential in [ $\si{\milli\volt}$]
enum StochasticType modigliani_core::Membrane_current::simulation_mode ( ) const
inline

Returns the simulation mode.

Returns
Simulation mode
modigliani_base::ReturnEnum modigliani_core::Membrane_current::Step ( modigliani_base::Real  newVm)
inline

Runs one step of the simulation, updates the conductance and the current flowing through.

Parameters
newVmMembrane potential [ $\si{\milli\volt}$]
Returns
Success or Failure
virtual modigliani_base::ReturnEnum modigliani_core::Membrane_current::StepCurrent ( )
pure virtual
modigliani_base::Real modigliani_core::Membrane_current::temperature ( ) const
inline

Returns the temperature.

Returns
Temperature in [ $\si{\celsius}$]

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