BioDynaMo  v1.03.56-8762fa70
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
bdm::neuroscience::Param Struct Reference

#include <param.h>

Inheritance diagram for bdm::neuroscience::Param:
[legend]
Collaboration diagram for bdm::neuroscience::Param:
[legend]

Public Member Functions

 BDM_PARAM_GROUP_HEADER (Param, 1)
 
- Public Member Functions inherited from bdm::ParamGroup
virtual ~ParamGroup ()
 
virtual ParamGroupNewCopy () const =0
 
virtual ParamGroupUid GetUid () const =0
 

Public Attributes

double neurite_default_actual_length = 1.0
 
double neurite_default_density = 1.0
 
double neurite_default_diameter = 1.0
 
double neurite_default_spring_constant = 10
 
double neurite_default_adherence = 0.1
 
double neurite_default_tension = 0.0
 
double neurite_min_length = 2.0
 
double neurite_max_length = 15
 
double neurite_minimial_bifurcation_length = 0
 

Protected Member Functions

void AssignFromConfig (const std::shared_ptr< cpptoml::table > &) override
 Assign values from config file to variables. More...
 

Detailed Description

Definition at line 31 of file param.h.

Member Function Documentation

◆ AssignFromConfig()

void bdm::neuroscience::Param::AssignFromConfig ( const std::shared_ptr< cpptoml::table > &  config)
overrideprotectedvirtual

Assign values from config file to variables.

Reimplemented from bdm::ParamGroup.

Definition at line 23 of file param.cc.

◆ BDM_PARAM_GROUP_HEADER()

bdm::neuroscience::Param::BDM_PARAM_GROUP_HEADER ( Param  ,
 
)

Member Data Documentation

◆ neurite_default_actual_length

double bdm::neuroscience::Param::neurite_default_actual_length = 1.0

Default actual length value of a neurite.
Default value: 1.0
TOML config file:

[neuroscience]
neurite_default_actual_length = 1.0 

Definition at line 40 of file param.h.

◆ neurite_default_adherence

double bdm::neuroscience::Param::neurite_default_adherence = 0.1

Default adherence value of a neurite.
Default value: 0.1
TOML config file:

[neuroscience]
neurite_default_adherence = 0.1 

Definition at line 72 of file param.h.

◆ neurite_default_density

double bdm::neuroscience::Param::neurite_default_density = 1.0

Default density value of a neurite.
Default value: 1.0
TOML config file:

[neuroscience]
neurite_default_density = 1.0 

Definition at line 48 of file param.h.

◆ neurite_default_diameter

double bdm::neuroscience::Param::neurite_default_diameter = 1.0

Default diameter value of a neurite.
Default value: 1.0
TOML config file:

[neuroscience]
neurite_default_diameter = 1.0 

Definition at line 56 of file param.h.

◆ neurite_default_spring_constant

double bdm::neuroscience::Param::neurite_default_spring_constant = 10

Default spring constant value of a neurite.
Default value: 10
TOML config file:

[neuroscience]
neurite_default_spring_constant = 10 

Definition at line 64 of file param.h.

◆ neurite_default_tension

double bdm::neuroscience::Param::neurite_default_tension = 0.0

Default tension value of a neurite.
Default value: 0.0
TOML config file:

[neuroscience]
neurite_default_tension = 0.0 

Definition at line 80 of file param.h.

◆ neurite_max_length

double bdm::neuroscience::Param::neurite_max_length = 15

Maximum allowed length of a neurite element.
Default value: 15
TOML config file:

[neuroscience]
neurite_max_length = 15 

Definition at line 96 of file param.h.

◆ neurite_min_length

double bdm::neuroscience::Param::neurite_min_length = 2.0

Minimum allowed length of a neurite element.
Default value: 2.0
TOML config file:

[neuroscience]
neurite_min_length = 2.0 

Definition at line 88 of file param.h.

◆ neurite_minimial_bifurcation_length

double bdm::neuroscience::Param::neurite_minimial_bifurcation_length = 0

Minumum bifurcation length of a neurite element.
If the length is below this threshold, bifurcation is not permitted.
Default value: 0
TOML config file:

[neuroscience]
neurite_minimial_bifurcation_length = 0 

Definition at line 105 of file param.h.


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