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

#include <stimulate.h>

Collaboration diagram for opencarp::stim_physics:

Public Member Functions

void setup (int idx)
 assign stimulus physics parameters More...
 

Public Attributes

stim_t type
 type of stimulus More...
 
stim_domain_t domain
 applied in intra- or extracellular space More...
 
std::string unit
 physical units of stimulus More...
 
double scale
 internal unit conversion scaling More...
 
bool total_current
 whether we apply total current scaling More...
 

Detailed Description

Definition at line 139 of file stimulate.h.

Member Function Documentation

◆ setup()

void opencarp::stim_physics::setup ( int  idx)

assign stimulus physics parameters

Definition at line 334 of file stimulate.cc.

Member Data Documentation

◆ domain

stim_domain_t opencarp::stim_physics::domain

applied in intra- or extracellular space

Definition at line 143 of file stimulate.h.

◆ scale

double opencarp::stim_physics::scale

internal unit conversion scaling

Definition at line 145 of file stimulate.h.

◆ total_current

bool opencarp::stim_physics::total_current

whether we apply total current scaling

Definition at line 146 of file stimulate.h.

◆ type

stim_t opencarp::stim_physics::type

type of stimulus

Definition at line 142 of file stimulate.h.

◆ unit

std::string opencarp::stim_physics::unit

physical units of stimulus

Definition at line 144 of file stimulate.h.


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