BioDynaMo  v1.03.58-27764645
Public Member Functions | Private Member Functions | Private Attributes | List of all members
bdm::Chemotaxis Class Reference

Move cells along the diffusion gradient (from low concentration to high) More...

#include <chemotaxis.h>

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

Public Member Functions

 Chemotaxis ()=default
 
 Chemotaxis (const std::string &substance, real_t speed)
 
 Chemotaxis (DiffusionGrid *dgrid, real_t speed)
 
virtual ~Chemotaxis ()=default
 
void Initialize (const NewAgentEvent &event) override
 
void Run (Agent *agent) override
 
- Public Member Functions inherited from bdm::Behavior
 Behavior ()
 
virtual ~Behavior ()=default
 
virtual BehaviorNew () const =0
 Create a new instance of this object using the default constructor. More...
 
virtual BehaviorNewCopy () const =0
 Create a new copy of this behavior. More...
 
virtual void Update (const NewAgentEvent &event)
 
void AlwaysCopyToNew ()
 Always copy this behavior to new agents. More...
 
void NeverCopyToNew ()
 Never copy this behavior to new agents. More...
 
void CopyToNewIf (const std::initializer_list< NewAgentEventUid > &uids)
 
void AlwaysRemoveFromExisting ()
 
void NeverRemoveFromExisting ()
 
void RemoveFromExistingIf (const std::initializer_list< NewAgentEventUid > &uids)
 
bool WillBeCopied (NewAgentEventUid event) const
 
bool WillBeRemoved (NewAgentEventUid event) const
 
void * operator new (size_t size)
 
void operator delete (void *p)
 

Private Member Functions

 BDM_BEHAVIOR_HEADER (Chemotaxis, Behavior, 1)
 

Private Attributes

std::string substance_
 
DiffusionGriddgrid_ = nullptr
 
real_t speed_
 

Detailed Description

Move cells along the diffusion gradient (from low concentration to high)

Definition at line 26 of file chemotaxis.h.

Constructor & Destructor Documentation

◆ Chemotaxis() [1/3]

bdm::Chemotaxis::Chemotaxis ( )
default

◆ Chemotaxis() [2/3]

bdm::Chemotaxis::Chemotaxis ( const std::string &  substance,
real_t  speed 
)
inline

Definition at line 31 of file chemotaxis.h.

◆ Chemotaxis() [3/3]

bdm::Chemotaxis::Chemotaxis ( DiffusionGrid dgrid,
real_t  speed 
)
inlineexplicit

Definition at line 37 of file chemotaxis.h.

◆ ~Chemotaxis()

virtual bdm::Chemotaxis::~Chemotaxis ( )
virtualdefault

Member Function Documentation

◆ BDM_BEHAVIOR_HEADER()

bdm::Chemotaxis::BDM_BEHAVIOR_HEADER ( Chemotaxis  ,
Behavior  ,
 
)
private

◆ Initialize()

void bdm::Chemotaxis::Initialize ( const NewAgentEvent event)
inlineoverridevirtual

This method is called to initialize new behaviors that are created during a NewAgentEvent. Override this method to initialize attributes of your own Behavior subclasses. NB: Don't forget to call the implementation of the base class first. Base::Initialize(event); Failing to do so will result in errors.

Reimplemented from bdm::Behavior.

Definition at line 44 of file chemotaxis.h.

◆ Run()

void bdm::Chemotaxis::Run ( Agent agent)
inlineoverridevirtual

Implements bdm::Behavior.

Definition at line 52 of file chemotaxis.h.

Member Data Documentation

◆ dgrid_

DiffusionGrid* bdm::Chemotaxis::dgrid_ = nullptr
private

Definition at line 62 of file chemotaxis.h.

◆ speed_

real_t bdm::Chemotaxis::speed_
private

Definition at line 63 of file chemotaxis.h.

◆ substance_

std::string bdm::Chemotaxis::substance_
private

Definition at line 61 of file chemotaxis.h.


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