#include <electrics.h>
Public Types | |
| enum | grid_t { intra_grid = 0, extra_grid } |
| An electrics grid identifier to distinguish between intra and extra grids. More... | |
| enum | linsys_t { elliptic_sys, parabolic_sys } |
Public Member Functions | |
| Electrics () | |
| Most of the initialization is done with initialize() More... | |
| void | initialize () |
| Initialize the Electrics. More... | |
| void | destroy () |
| Currently we only need to close the file logger. More... | |
| void | compute_step () |
| void | output_step () |
| void | output_timings () |
| ~Electrics () | |
| double | timer_val (const int timer_id) |
| figure out current value of a signal linked to a given timer More... | |
| std::string | timer_unit (const int timer_id) |
| figure out units of a signal linked to a given timer More... | |
Public Attributes | |
| MaterialType | mtype [2] |
| the material types of intra_grid and extra_grid grids. More... | |
| SF::vector< stimulus > | stimuli |
| the electrical stimuli More... | |
| Ionics | ion |
| elliptic_solver | ellip_solver |
| Solver for the elliptic bidomain equation. More... | |
| parabolic_solver | parab_solver |
| Solver for the parabolic bidomain equation. More... | |
| LAT_detector | lat |
| the activation time detector More... | |
| gvec_data | gvec |
| datastruct holding global IMP state variable output More... | |
| igb_output_manager | output_manager |
| class handling the igb output More... | |
| phie_recovery_data | phie_rcv |
| struct holding helper data for phie recovery More... | |
| generic_timing_stats | IO_stats |
 Public Attributes inherited from opencarp::Basic_physic | |
| const char * | name = NULL |
| The name of the physic, each physic should have one. More... | |
| FILE_SPEC | logger = NULL |
| The logger of the physic, each physic should have one. More... | |
| int | timer_idx = -1 |
| the timer index received from the timer manager More... | |
| double | initialize_time = 0.0 |
| double | compute_time = 0.0 |
| double | output_time = 0.0 |
Detailed Description
Definition at line 237 of file electrics.h.
Member Enumeration Documentation
◆ grid_t
An electrics grid identifier to distinguish between intra and extra grids.
The indexing of the enum is used to access the MaterialType array.
| Enumerator | |
|---|---|
| intra_grid | |
| extra_grid | |
Definition at line 246 of file electrics.h.
◆ linsys_t
| Enumerator | |
|---|---|
| elliptic_sys | |
| parabolic_sys | |
Definition at line 247 of file electrics.h.
Constructor & Destructor Documentation
◆ Electrics()
|
inline |
Most of the initialization is done with initialize()
Definition at line 280 of file electrics.h.
◆ ~Electrics()
| opencarp::Electrics::~Electrics | ( | ) |
Member Function Documentation
◆ compute_step()
|
virtual |
Implements opencarp::Basic_physic.
Definition at line 269 of file electrics.cc.
◆ destroy()
|
virtual |
Currently we only need to close the file logger.
Implements opencarp::Basic_physic.
Definition at line 351 of file electrics.cc.
◆ initialize()
|
virtual |
Initialize the Electrics.
This could also be a constructor. But it might be better to expicitely call the initialization. This way we can instanciate electrics structs without calling the full setup as well.
Implements opencarp::Basic_physic.
Definition at line 36 of file electrics.cc.
◆ output_step()
|
virtual |
Implements opencarp::Basic_physic.
Definition at line 319 of file electrics.cc.
◆ output_timings()
|
inlinevirtual |
Reimplemented from opencarp::Basic_physic.
Definition at line 301 of file electrics.h.
◆ timer_unit()
|
virtual |
figure out units of a signal linked to a given timer
determine unit of a stimulus
Implements opencarp::Basic_physic.
Definition at line 737 of file electrics.cc.
◆ timer_val()
|
virtual |
figure out current value of a signal linked to a given timer
determine current value of a stimulus signal
Implements opencarp::Basic_physic.
Definition at line 721 of file electrics.cc.
Member Data Documentation
◆ ellip_solver
| elliptic_solver opencarp::Electrics::ellip_solver |
Solver for the elliptic bidomain equation.
Definition at line 259 of file electrics.h.
◆ gvec
| gvec_data opencarp::Electrics::gvec |
datastruct holding global IMP state variable output
Definition at line 267 of file electrics.h.
◆ IO_stats
| generic_timing_stats opencarp::Electrics::IO_stats |
Definition at line 275 of file electrics.h.
◆ ion
| Ionics opencarp::Electrics::ion |
The ionics physics is managed as a member of the Electrics. This allows for thighter coupling in the Electrics compute step.
Definition at line 256 of file electrics.h.
◆ lat
| LAT_detector opencarp::Electrics::lat |
the activation time detector
Definition at line 264 of file electrics.h.
◆ mtype
| MaterialType opencarp::Electrics::mtype[2] |
the material types of intra_grid and extra_grid grids.
Definition at line 250 of file electrics.h.
◆ output_manager
| igb_output_manager opencarp::Electrics::output_manager |
class handling the igb output
Definition at line 270 of file electrics.h.
◆ parab_solver
| parabolic_solver opencarp::Electrics::parab_solver |
Solver for the parabolic bidomain equation.
Definition at line 261 of file electrics.h.
◆ phie_rcv
| phie_recovery_data opencarp::Electrics::phie_rcv |
struct holding helper data for phie recovery
Definition at line 273 of file electrics.h.
◆ stimuli
| SF::vector<stimulus> opencarp::Electrics::stimuli |
the electrical stimuli
Definition at line 252 of file electrics.h.
The documentation for this class was generated from the following files:
- physics/electrics.h
- physics/electrics.cc
