openCARP
Doxygen code documentation for the open cardiac electrophysiology simulator openCARP
Public Member Functions | Public Attributes | List of all members
opencarp::Ionics Class Reference

#include <ionics.h>

Inheritance diagram for opencarp::Ionics:
Collaboration diagram for opencarp::Ionics:

Public Member Functions

 Ionics (mesh_t gid)
 
void initialize ()
 
void destroy ()
 
void compute_step ()
 
void output_step ()
 
 ~Ionics ()=default
 
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 Member Functions inherited from opencarp::Basic_physic
virtual void output_timings ()
 

Public Attributes

limpet::MULTI_IFmiif = NULL
 
mesh_t ion_domain
 
generic_timing_stats comp_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 63 of file ionics.h.

Constructor & Destructor Documentation

◆ Ionics()

opencarp::Ionics::Ionics ( mesh_t  gid)
inline

Definition at line 71 of file ionics.h.

◆ ~Ionics()

opencarp::Ionics::~Ionics ( )
default
Here is the caller graph for this function:

Member Function Documentation

◆ compute_step()

void opencarp::Ionics::compute_step ( )
virtual

Implements opencarp::Basic_physic.

Definition at line 35 of file ionics.cc.

Here is the caller graph for this function:

◆ destroy()

void opencarp::Ionics::destroy ( )
virtual

Implements opencarp::Basic_physic.

Definition at line 52 of file ionics.cc.

Here is the caller graph for this function:

◆ initialize()

void opencarp::Ionics::initialize ( )
virtual

Implements opencarp::Basic_physic.

Definition at line 60 of file ionics.cc.

Here is the caller graph for this function:

◆ output_step()

void opencarp::Ionics::output_step ( )
virtual

Implements opencarp::Basic_physic.

Definition at line 57 of file ionics.cc.

Here is the caller graph for this function:

◆ timer_unit()

std::string opencarp::Ionics::timer_unit ( const int  timer_id)
virtual

figure out units of a signal linked to a given timer

determine unit of a stimulus

Implements opencarp::Basic_physic.

Definition at line 452 of file ionics.cc.

Here is the caller graph for this function:

◆ timer_val()

double opencarp::Ionics::timer_val ( const int  timer_id)
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 444 of file ionics.cc.

Here is the caller graph for this function:

Member Data Documentation

◆ comp_stats

generic_timing_stats opencarp::Ionics::comp_stats

Definition at line 69 of file ionics.h.

◆ ion_domain

mesh_t opencarp::Ionics::ion_domain

Definition at line 67 of file ionics.h.

◆ miif

limpet::MULTI_IF* opencarp::Ionics::miif = NULL

Definition at line 66 of file ionics.h.


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