SymCompartment Class Reference

#include <SymCompartment.h>

Inheritance diagram for SymCompartment:

[legend]

Collaboration diagram for SymCompartment:

[legend]

List of all members.

Public Member Functions
	SymCompartment ()
	~SymCompartment ()
void	raxialSphere (double Ra, double Vm)
void	raxialCylinder (double Ra, double Vm)
void	raxialSym (double Ra, double Vm)
void	sumRaxial (double Ra)
void	vReinit (const Eref &e, ProcPtr p)
void	vInitProc (const Eref &e, ProcPtr p)
void	vInitReinit (const Eref &e, ProcPtr p)
Static Public Member Functions
static const Cinfo *	initCinfo ()

---

Detailed Description

The SymCompartment class sets up a symmetric compartment for branched nerve calculations. Handles electronic structure and also channels. This version splits the Ra between either end of the compartment and is hence slightly cleaner than the asymmetric compartment. The default EE method is not a particularly efficient way of doing the calculations, so we should use a solver for any substantial calculations.

---

Constructor & Destructor Documentation

SymCompartment::SymCompartment

(

)

SymCompartment::~SymCompartment

(

)

[inline]

---

Member Function Documentation

const Cinfo * SymCompartment::initCinfo

(

)

[static]

Initializes the class info.

The initCinfo() function sets up the Compartment class. This function uses the common trick of having an internal static value which is created the first time the function is called. There are several static arrays set up here. The ones which use SharedFinfos are for shared messages where multiple kinds of information go along the same connection.

Reimplemented from moose::Compartment.

References moose::Compartment::initCinfo(), raxialCylinder(), raxialSphere(), raxialSym(), and sumRaxial().

Here is the call graph for this function:

void SymCompartment::raxialCylinder	(	double	Ra,
		double	Vm
	)

References moose::Compartment::A_, moose::Compartment::B_, moose::Compartment::Im_, and moose::Compartment::Vm_.

Referenced by initCinfo().

void SymCompartment::raxialSphere	(	double	Ra,
		double	Vm
	)

References moose::Compartment::A_, moose::Compartment::B_, moose::Compartment::Im_, moose::Compartment::Ra_, and moose::Compartment::Vm_.

Referenced by initCinfo().

void SymCompartment::raxialSym	(	double	Ra,
		double	Vm
	)

References moose::Compartment::A_, moose::Compartment::B_, moose::Compartment::Im_, and moose::Compartment::Vm_.

Referenced by initCinfo().

void SymCompartment::sumRaxial

(

double

Ra

)

References moose::Compartment::Ra_.

Referenced by initCinfo().

void SymCompartment::vInitProc	(	const Eref &	e,
		ProcPtr	p
	)			[virtual]

The initProc function is for a second phase of 'process' operations. It sends the axial and raxial messages to other compartments. It has to be executed out of phase with the main process so that all compartments are equivalent and there is no calling order dependence in the results.

Reimplemented from moose::Compartment.

References moose::Compartment::Ra_, and moose::Compartment::Vm_.

void SymCompartment::vInitReinit	(	const Eref &	e,
		ProcPtr	p
	)			[virtual]

Empty function to do another reinit step out of phase with the main one. Nothing needs doing there.

Reimplemented from moose::Compartment.

void SymCompartment::vReinit	(	const Eref &	e,
		ProcPtr	p
	)			[virtual]

The reinit function reinitializes all fields.

Reimplemented from moose::Compartment.

References moose::Compartment::Ra_.

---

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

• biophysics/SymCompartment.h
• biophysics/SymCompartment.cpp