openCARP
Doxygen code documentation for the open cardiac electrophysiology simulator openCARP
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Public Attributes | List of all members
opencarp::Basic_physic Class Referenceabstract

The abstract physics interface we can use to trigger all physics. More...

#include <physics_types.h>

Inheritance diagram for opencarp::Basic_physic:
Collaboration diagram for opencarp::Basic_physic:

Public Member Functions

virtual void initialize ()=0
 
virtual void destroy ()=0
 
virtual void compute_step ()=0
 
virtual void output_step ()=0
 
virtual void output_timings ()
 
virtual std::string timer_unit (const int timer_id)=0
 
virtual double timer_val (const int timer_id)=0
 

Public Attributes

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

The abstract physics interface we can use to trigger all physics.

Definition at line 59 of file physics_types.h.

Member Function Documentation

◆ compute_step()

virtual void opencarp::Basic_physic::compute_step ( )
pure virtual

Implemented in opencarp::Laplace, opencarp::Electrics, and opencarp::Ionics.

Here is the caller graph for this function:

◆ destroy()

virtual void opencarp::Basic_physic::destroy ( )
pure virtual

Implemented in opencarp::Laplace, opencarp::Electrics, and opencarp::Ionics.

Here is the caller graph for this function:

◆ initialize()

virtual void opencarp::Basic_physic::initialize ( )
pure virtual

Implemented in opencarp::Laplace, opencarp::Electrics, and opencarp::Ionics.

Here is the caller graph for this function:

◆ output_step()

virtual void opencarp::Basic_physic::output_step ( )
pure virtual

◆ output_timings()

virtual void opencarp::Basic_physic::output_timings ( )
inlinevirtual

Reimplemented in opencarp::Electrics.

Definition at line 76 of file physics_types.h.

Here is the caller graph for this function:

◆ timer_unit()

virtual std::string opencarp::Basic_physic::timer_unit ( const int  timer_id)
pure virtual

◆ timer_val()

virtual double opencarp::Basic_physic::timer_val ( const int  timer_id)
pure virtual

Member Data Documentation

◆ compute_time

double opencarp::Basic_physic::compute_time = 0.0

Definition at line 88 of file physics_types.h.

◆ initialize_time

double opencarp::Basic_physic::initialize_time = 0.0

Definition at line 87 of file physics_types.h.

◆ logger

FILE_SPEC opencarp::Basic_physic::logger = NULL

The logger of the physic, each physic should have one.

Definition at line 64 of file physics_types.h.

◆ name

const char* opencarp::Basic_physic::name = NULL

The name of the physic, each physic should have one.

Definition at line 62 of file physics_types.h.

◆ output_time

double opencarp::Basic_physic::output_time = 0.0

Definition at line 89 of file physics_types.h.

◆ timer_idx

int opencarp::Basic_physic::timer_idx = -1

the timer index received from the timer manager

Definition at line 66 of file physics_types.h.


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