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

#include <mechanics.h>

Inheritance diagram for opencarp::Mechanics:
Collaboration diagram for opencarp::Mechanics:

Public Member Functions

 Mechanics ()
 Most of the initialization is done with initialize() More...
 
void initialize ()
 Initialize the Mechanics. More...
 
void destroy ()
 Currently we only need to close the file logger. More...
 
void compute_step ()
 Main function for every compute step. More...
 
void output_step ()
 
 ~Mechanics ()
 
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

MaterialType mtype
 
equilibrium_solver eq_solver
 
sf_mesh surfmesh
 
igb_output_manager output_manager
 class handling the igb output More...
 
- 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 145 of file mechanics.h.

Constructor & Destructor Documentation

◆ Mechanics()

opencarp::Mechanics::Mechanics ( )
inline

Most of the initialization is done with initialize()

Definition at line 158 of file mechanics.h.

◆ ~Mechanics()

opencarp::Mechanics::~Mechanics ( )

Member Function Documentation

◆ compute_step()

void opencarp::Mechanics::compute_step ( )
virtual

Main function for every compute step.

Implements opencarp::Basic_physic.

Definition at line 209 of file mechanics.cc.

◆ destroy()

void opencarp::Mechanics::destroy ( )
virtual

Currently we only need to close the file logger.

Implements opencarp::Basic_physic.

Definition at line 253 of file mechanics.cc.

◆ initialize()

void opencarp::Mechanics::initialize ( )
virtual

Initialize the Mechanics.

Initialization of mechanics physics.

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 145 of file mechanics.cc.

◆ output_step()

void opencarp::Mechanics::output_step ( )
virtual

Implements opencarp::Basic_physic.

Definition at line 242 of file mechanics.cc.

◆ timer_unit()

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

figure out units of a signal linked to a given timer

determine unit of a stimulus, check whether sth like that could be used for mechanics, currently just here to satisfy basic physics parent class

Implements opencarp::Basic_physic.

Definition at line 290 of file mechanics.cc.

◆ timer_val()

double opencarp::Mechanics::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, check whether sth like that could be used for mechanics

Implements opencarp::Basic_physic.

Definition at line 280 of file mechanics.cc.

Member Data Documentation

◆ eq_solver

equilibrium_solver opencarp::Mechanics::eq_solver

Definition at line 149 of file mechanics.h.

◆ mtype

MaterialType opencarp::Mechanics::mtype

Definition at line 148 of file mechanics.h.

◆ output_manager

igb_output_manager opencarp::Mechanics::output_manager

class handling the igb output

Definition at line 153 of file mechanics.h.

◆ surfmesh

sf_mesh opencarp::Mechanics::surfmesh

Definition at line 150 of file mechanics.h.


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