Modigliani  2.0
A stochastic simulator for axons, neurons, and networks
membrane_patch.h
1 
24 #ifndef MODIGLIANI_MODIGLIANI_CORE_MEMBRANE_PATCH_H_
25 #define MODIGLIANI_MODIGLIANI_CORE_MEMBRANE_PATCH_H_
26 
27 #include "modigliani_core/membrane_compartment.h"
28 
29 namespace modigliani_core {
34  public:
42  Membrane_patch(modigliani_base::Real area,
43  modigliani_base::Real newCM);
44 
45  Membrane_patch(const Membrane_patch & original) = delete;
46 
47  Membrane_patch & operator=(const Membrane_patch & right) = delete;
48 
49  virtual ~Membrane_patch();
50 
55  modigliani_base::ReturnEnum Step();
56 
62  modigliani_base::ReturnEnum InitialStep();
63 
68  modigliani_base::Real MembraneCurrent(modigliani_base::Size
69  currentIndex) const {
70  assert((currentIndex > 0) && (currentIndex - 1 < NumberCurrents()));
71  return (Current(currentIndex)->current());
72  }
73  };
74 } // namespace modigliani_core
75 #endif // MODIGLIANI_MODIGLIANI_CORE_MEMBRANE_PATCH_H_
modigliani_base::ReturnEnum InitialStep()
Runs an initial step, needed if time staggering of the differential equations solution is desired...
Definition: membrane_patch.cc:43
const Membrane_current * Current(modigliani_base::Size currentIndex) const
Returns the current object at the given index.
Definition: membrane_compartment.h:205
Membrane_compartment class acts as a &quot;container + glue&quot; for the various Membrane_current classes that...
Definition: membrane_compartment.h:45
Membrane_patch class.
Definition: membrane_patch.h:33
modigliani_base::Size NumberCurrents() const
Returns the number of currents attached to the compartment.
Definition: membrane_compartment.cc:207
modigliani_base::ReturnEnum Step()
Runs one step of simulation.
Definition: membrane_patch.cc:34
modigliani_base::Real MembraneCurrent(modigliani_base::Size currentIndex) const
Returns total memrane current.
Definition: membrane_patch.h:68
Membrane_patch(modigliani_base::Real area, modigliani_base::Real newCM)
Constructor.
Definition: membrane_patch.cc:28
modigliani_base::Real area() const
Returns the membrane surface area.
Definition: membrane_compartment.h:215