BioDynaMo  v1.03.58-27764645
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
bdm::CellDivisionEvent Struct Reference

Contains the parameters to perform a cell division. More...

#include <cell_division_event.h>

Inheritance diagram for bdm::CellDivisionEvent:
[legend]
Collaboration diagram for bdm::CellDivisionEvent:
[legend]

Public Member Functions

 CellDivisionEvent (real_t volume_ratio, real_t phi, real_t theta)
 
virtual ~CellDivisionEvent ()=default
 
NewAgentEventUid GetUid () const override
 
- Public Member Functions inherited from bdm::NewAgentEvent
virtual ~NewAgentEvent ()=default
 

Public Attributes

real_t volume_ratio
 
real_t phi
 phi azimuthal angle (spherical coordinates) More...
 
real_t theta
 theta polar angle (spherical coordinates) More...
 
- Public Attributes inherited from bdm::NewAgentEvent
Agentexisting_agent
 
InlineVector< Agent *, 3 > new_agents
 
Behaviorexisting_behavior
 
InlineVector< Behavior *, 3 > new_behaviors
 

Static Public Attributes

static const NewAgentEventUid kUid
 

Detailed Description

Contains the parameters to perform a cell division.

A cell division divides a mother cell in two daughter cells.
When the mother cell divides, by definition:
1) the mother cell becomes the 1st daughter cell
2) the new cell becomes the 2nd daughter cell

The cell that triggers the event is the mother.

Definition at line 31 of file cell_division_event.h.

Constructor & Destructor Documentation

◆ CellDivisionEvent()

bdm::CellDivisionEvent::CellDivisionEvent ( real_t  volume_ratio,
real_t  phi,
real_t  theta 
)
inline

Definition at line 34 of file cell_division_event.h.

◆ ~CellDivisionEvent()

virtual bdm::CellDivisionEvent::~CellDivisionEvent ( )
virtualdefault

Member Function Documentation

◆ GetUid()

NewAgentEventUid bdm::CellDivisionEvent::GetUid ( ) const
inlineoverridevirtual

Implements bdm::NewAgentEvent.

Definition at line 39 of file cell_division_event.h.

Member Data Documentation

◆ kUid

const NewAgentEventUid bdm::CellDivisionEvent::kUid
static
Initial value:

Definition at line 32 of file cell_division_event.h.

◆ phi

real_t bdm::CellDivisionEvent::phi

phi azimuthal angle (spherical coordinates)

Definition at line 45 of file cell_division_event.h.

◆ theta

real_t bdm::CellDivisionEvent::theta

theta polar angle (spherical coordinates)

Definition at line 47 of file cell_division_event.h.

◆ volume_ratio

real_t bdm::CellDivisionEvent::volume_ratio

volume_ratio the ratio (Volume daughter 1)/(Volume daughter 2). 1.0 gives equal cells.

Definition at line 43 of file cell_division_event.h.


The documentation for this struct was generated from the following files:
bdm::NewAgentEventUidGenerator::GenerateUid
NewAgentEventUid GenerateUid()
Definition: new_agent_event.h:44
bdm::NewAgentEventUidGenerator::GetInstance
static NewAgentEventUidGenerator * GetInstance()
Definition: new_agent_event.cc:23