CV

CV#

class braincell.CV(id, branch_id, branch_type, prox, dist, parent_cv, children_cv, length, area, cm, ra, v, temp, r_axial, r_axial_prox, r_axial_dist, radius_prox, radius_mid, diam_arc_mean, radius_dist, density_mech, point_mech, point_mech_roles=())[source]#

Immutable per-control-volume record exposed to users.

Geometry, cable properties, and attached mechanisms are frozen into this dataclass by build_discretization(). CV is the physical truth layer of the declaration-time discretization; node-space structures are thin views built from these records.

Variables:

  • id (int) – Stable CV index within the discretization.

  • branch_id (int) – Index of the morphology branch that owns this CV.

  • branch_type (str) – Morphology branch type, for example "soma" or "basal_dendrite".

  • prox (float) – Proximal CV boundary in normalized branch coordinates.

  • dist (float) – Distal CV boundary in normalized branch coordinates.

  • parent_cv (int or None) – Parent CV id in the CV tree. None marks the root CV.

  • children_cv (tuple of int) – Child CV ids in the CV tree.

  • length (brainunit.Quantity) – CV cable length.

  • area (brainunit.Quantity) – CV membrane lateral area.

  • cm (brainunit.Quantity) – Membrane capacitance density active on this CV.

  • ra (brainunit.Quantity) – Axial resistivity active on this CV.

  • v (brainunit.Quantity) – Resting potential declaration carried by this CV.

  • temp (brainunit.Quantity) – Temperature declaration carried by this CV.

  • r_axial (brainunit.Quantity) – End-to-end axial resistance of this CV.

  • r_axial_prox (brainunit.Quantity) – Axial resistance from the CV midpoint to the proximal side.

  • r_axial_dist (brainunit.Quantity) – Axial resistance from the CV midpoint to the distal side.

  • radius_prox (brainunit.Quantity) – Radius at the proximal CV boundary.

  • radius_mid (brainunit.Quantity) – Radius at the CV midpoint.

  • diam_arc_mean (brainunit.Quantity) – Arc-length-weighted mean diameter across the CV.

  • radius_dist (brainunit.Quantity) – Radius at the distal CV boundary.

  • density_mech (tuple of Density) – Density-like mechanism declarations active on this CV.

  • point_mech (tuple of Point) – Point-mechanism declarations that resolve to this CV, without preserving local-role provenance.

  • point_mech_roles (tuple of CVPointMechanism) – Point-mechanism declarations together with the CV-local role that owns each one.

Notes

CV is intentionally static. It stores declaration-time geometry and mechanism specifications only; runtime ion/channel instances and state buffers live later in braincell._compute.

property diam_mid: Quantity#

Return the diameter at the CV midpoint.

Returns:

Midpoint diameter, equal to 2 * radius_mid.

Return type:

brainunit.Quantity

property region: RegionMask#

Return a one-interval region covering this CV.

Returns:

Region spanning (branch_id, prox, dist).

Return type:

RegionMask