CEPS: AbstractPacemakerProblem Class Reference

Detailed Description

Common elements of problems with a pacemaker.

Definition at line 38 of file AbstractPacemakerProblem.hpp.

#include <AbstractPacemakerProblem.hpp>

Inheritance diagram for AbstractPacemakerProblem:

Data Structures
class	PowerSupply
	Function supply(t) More...

Public Member Functions
	AbstractPacemakerProblem (Geometry g, InputParameters params=nullptr)
	Constructor with geometry and parameters. More...

virtual	~AbstractPacemakerProblem ()=default
	Destructor. More...

void	setStimulation (CepsReal amplitude, CepsReal duration)
	Set the parameters of the stimulation. More...

void	setStimulationAmplitude (CepsReal amplitude)
	Set the amplitude of the stimulation. More...

CepsReal	getStimulationAmplitude () const
	Get the stimulation amplitude. More...

void	setStimulationDuration (CepsReal duration)
	Set the duration of the stimulation. More...

CepsReal	getStimulationDuration () const
	Get the stimulation duration. More...

CepsReal	getStimulationPeriod () const
	Get the stimulation period. More...

CepsPacemakerPhase	getPhase (CepsReal t) const
	Get the phase id of pacemaker cycle. More...

CepsBool	isRechargingPhase (CepsReal t) const
	Tells if the phase is a rehcarging phase. More...

CepsReal	getRelativeTimeOnPhase (CepsReal t) const
	Get the relative time of this pacemaker cycle step. More...

CepsReal	getPacemakerDuration (CepsPacemakerPhase phase) const
	Get the duration of a phase. More...

CepsReal	getPacemakerCapacitance (CepsReal t) const
	Get the equivalent capacitance of the pacemaker. More...

CepsReal	getPacemakerCapacitanceCets (CepsReal t) const
	Get the capacitance associated to the main capacitor of the device. More...

CepsReal	getPacemakerCapacitanceCts (CepsReal t) const
	Get the capacitance associated to the second capacitor of the pacemaker. More...

CepsReal	getPacemakerResistance (CepsReal t) const
	Get the equivalent resistance of the pacemaker. More...

CepsReal	getPacemakerResistanceLittle (CepsReal t) const
	Get the resistance used in the recharge circuit of the Cets. More...

CepsReal	getWireResistanceAnodeLine (CepsReal t) const
	Get the resistance used in to model the wire in anode line. More...

CepsReal	getWireResistanceCathodeLine (CepsReal t) const
	Get the resistance used in to model the wire in cathode line. More...

void	setPulseOnlyMode (CepsBool value)
	Set pacemaker in pulse only mode. More...

CepsBool	isPulseOnlyMode () const
	Tells if the pacemaker is in pulse only mode. More...

void	setupWithParameters (InputParameters *params)
	Sets options from the parameters. More...

void	setupRunningProperties ()
	Sets running parameters like equivalent resistances and capacitances. More...

virtual Unknown *	getUAnodeUnknown () const =0
	Link to the Up unknown of the problem. More...

virtual Unknown *	getUCathodeUnknown () const =0
	Link to the Um unknown of the problem. More...

virtual Unknown *	getVCetsUnknown () const =0
	Link to the VCets unknown of the problem. More...

virtual Unknown *	getVCtsUnknown () const =0
	Link to the VCts unknown of the problem. More...

Public Member Functions inherited from HoldsAnodeCathode< ParallelRCElectrode >
	HoldsAnodeCathode ()
	Default constructor. More...

	HoldsAnodeCathode (InputParameters params, Geometry geom=nullptr)
	Constructor with parameters, pass geometry to compute measures. More...

	HoldsAnodeCathode (const CepsSet< CepsAttribute > &anodeAttrs, const CepsSet< CepsAttribute > &cathodeAttrs, Geometry *geom=nullptr)
	Constructor with sets of attributes, pass geometry to compute measures. More...

virtual	~HoldsAnodeCathode ()
	Destructor. More...

CepsSet< CepsAttribute > &	getAnodeAttributes () const
	Anode attributes. More...

CepsSet< CepsAttribute > &	getCathodeAttributes () const
	Cathode attributes. More...

void	setElectrodesAttributes (const CepsSet< CepsAttribute > &anodeAttrs, const CepsSet< CepsAttribute > &cathodeAttrs, Geometry *geom=nullptr)
	Sets the attributes. More...

ParallelRCElectrode *	getAnode () const
	Ptr to anode object. More...

ParallelRCElectrode *	getCathode () const
	Ptr to cathode object. More...

Protected Attributes
CepsReal	m_stimAmplitude
	Amplitude of the stim [mV]. More...

CepsReal	m_stimDuration
	Duration of the stim [ms]. More...

CepsBool	m_pmkPulseOnlyMode
	Pulse only mode. More...

CepsReal	m_pmkOffset
	Offset duration [ms]. More...

CepsReal	m_pmkPeriod
	Period duration [ms], default 90bpm. More...

CepsReal	m_pmkSwitch
	Switch duration [ms]. More...

CepsReal	m_pmkOcd
	OCD duration [ms]. More...

CepsUInt	m_pmkNSpikes
	Number of spikes to do. More...

CepsReal	m_pmkCets
	CETS capacitance [uF]. More...

CepsReal	m_pmkCts
	CTS capacitance [uF]. More...

CepsReal	m_pmkRgnd
	GROUND resistance [kOhm]. More...

CepsReal	m_pmkRpulse
	PULSE resistance [kOhm]. More...

CepsReal	m_pmkRwa
	ANODE WIRE resistance [kOhm]. More...

CepsReal	m_pmkRwc
	CATHODE WIRE resistance [kOhm]. More...

CepsReal	m_pmkRbig
	BIG resistance [kOhm] during the waiting phase. More...

CepsReal	m_pmkRlittle
	LITTLE resistance [kOhm] used to recharge the CETS. More...

CepsArray< CepsReal, CepsPacemakerPhaseSize >	m_pmkC
	All equivalent capacitances depending on phase [uF]. More...

CepsArray< CepsReal, CepsPacemakerPhaseSize >	m_pmkR
	All equivalent resistances depending on phase [kOhm]. More...

Protected Attributes inherited from HoldsAnodeCathode< ParallelRCElectrode >
ParallelRCElectrode *	m_anode
	Electrode object. More...

ParallelRCElectrode *	m_cathode
	Electrode object. More...

Additional Inherited Members
Protected Member Functions inherited from HoldsAnodeCathode< ParallelRCElectrode >
void	checkCommonAttributes ()
	Check that anode and cathode do not share attributes. More...

Constructor & Destructor Documentation

◆ AbstractPacemakerProblem()

AbstractPacemakerProblem::AbstractPacemakerProblem	(	Geometry *	g,
		InputParameters *	params = `nullptr`
	)

explicit

Constructor with geometry and parameters.

Parameters

g
params

Definition at line 61 of file AbstractPacemakerProblem.cpp.

◆ ~AbstractPacemakerProblem()

virtual AbstractPacemakerProblem::~AbstractPacemakerProblem ( )

virtualdefault

Destructor.

Member Function Documentation

◆ getPacemakerCapacitance()

CepsReal AbstractPacemakerProblem::getPacemakerCapacitance ( CepsReal t ) const

Get the equivalent capacitance of the pacemaker.

Definition at line 206 of file AbstractPacemakerProblem.cpp.

◆ getPacemakerCapacitanceCets()

CepsReal AbstractPacemakerProblem::getPacemakerCapacitanceCets ( CepsReal t ) const

Get the capacitance associated to the main capacitor of the device.

Definition at line 213 of file AbstractPacemakerProblem.cpp.

◆ getPacemakerCapacitanceCts()

CepsReal AbstractPacemakerProblem::getPacemakerCapacitanceCts ( CepsReal t ) const

Get the capacitance associated to the second capacitor of the pacemaker.

Definition at line 219 of file AbstractPacemakerProblem.cpp.

◆ getPacemakerDuration()

CepsReal AbstractPacemakerProblem::getPacemakerDuration ( CepsPacemakerPhase phase ) const

Get the duration of a phase.

Definition at line 187 of file AbstractPacemakerProblem.cpp.

◆ getPacemakerResistance()

CepsReal AbstractPacemakerProblem::getPacemakerResistance ( CepsReal t ) const

Get the equivalent resistance of the pacemaker.

Definition at line 225 of file AbstractPacemakerProblem.cpp.

◆ getPacemakerResistanceLittle()

CepsReal AbstractPacemakerProblem::getPacemakerResistanceLittle ( CepsReal t ) const

Get the resistance used in the recharge circuit of the Cets.

Definition at line 232 of file AbstractPacemakerProblem.cpp.

◆ getPhase()

CepsPacemakerPhase AbstractPacemakerProblem::getPhase ( CepsReal t ) const

Get the phase id of pacemaker cycle.

Definition at line 126 of file AbstractPacemakerProblem.cpp.

◆ getRelativeTimeOnPhase()

CepsReal AbstractPacemakerProblem::getRelativeTimeOnPhase ( CepsReal t ) const

Get the relative time of this pacemaker cycle step.

Definition at line 165 of file AbstractPacemakerProblem.cpp.

◆ getStimulationAmplitude()

CepsReal AbstractPacemakerProblem::getStimulationAmplitude ( ) const

Get the stimulation amplitude.

Definition at line 108 of file AbstractPacemakerProblem.cpp.

◆ getStimulationDuration()

CepsReal AbstractPacemakerProblem::getStimulationDuration ( ) const

Get the stimulation duration.

Definition at line 114 of file AbstractPacemakerProblem.cpp.

◆ getStimulationPeriod()

CepsReal AbstractPacemakerProblem::getStimulationPeriod ( ) const

Get the stimulation period.

Definition at line 120 of file AbstractPacemakerProblem.cpp.

◆ getUAnodeUnknown()

virtual Unknown* AbstractPacemakerProblem::getUAnodeUnknown ( ) const

pure virtual

Link to the Up unknown of the problem.

Implemented in PacemakerPoissonProblem, and PacemakerBidomainProblem.

◆ getUCathodeUnknown()

virtual Unknown* AbstractPacemakerProblem::getUCathodeUnknown ( ) const

pure virtual

Link to the Um unknown of the problem.

Implemented in PacemakerPoissonProblem, and PacemakerBidomainProblem.

◆ getVCetsUnknown()

virtual Unknown* AbstractPacemakerProblem::getVCetsUnknown ( ) const

pure virtual

Link to the VCets unknown of the problem.

Implemented in PacemakerPoissonProblem, and PacemakerBidomainProblem.

◆ getVCtsUnknown()

virtual Unknown* AbstractPacemakerProblem::getVCtsUnknown ( ) const

pure virtual

Link to the VCts unknown of the problem.

Implemented in PacemakerPoissonProblem, and PacemakerBidomainProblem.

◆ getWireResistanceAnodeLine()

CepsReal AbstractPacemakerProblem::getWireResistanceAnodeLine ( CepsReal t ) const

Get the resistance used in to model the wire in anode line.

Definition at line 238 of file AbstractPacemakerProblem.cpp.

◆ getWireResistanceCathodeLine()

CepsReal AbstractPacemakerProblem::getWireResistanceCathodeLine ( CepsReal t ) const

Get the resistance used in to model the wire in cathode line.

Definition at line 244 of file AbstractPacemakerProblem.cpp.

◆ isPulseOnlyMode()

CepsBool AbstractPacemakerProblem::isPulseOnlyMode ( ) const

Tells if the pacemaker is in pulse only mode.

Definition at line 256 of file AbstractPacemakerProblem.cpp.

◆ isRechargingPhase()

CepsBool AbstractPacemakerProblem::isRechargingPhase ( CepsReal t ) const

Tells if the phase is a rehcarging phase.

Definition at line 153 of file AbstractPacemakerProblem.cpp.

◆ setPulseOnlyMode()

void AbstractPacemakerProblem::setPulseOnlyMode ( CepsBool value )

Set pacemaker in pulse only mode.

Definition at line 250 of file AbstractPacemakerProblem.cpp.

◆ setStimulation()

void AbstractPacemakerProblem::setStimulation	(	CepsReal	amplitude,
		CepsReal	duration
	)

Set the parameters of the stimulation.

Definition at line 85 of file AbstractPacemakerProblem.cpp.

◆ setStimulationAmplitude()

void AbstractPacemakerProblem::setStimulationAmplitude ( CepsReal amplitude )

Set the amplitude of the stimulation.

Definition at line 92 of file AbstractPacemakerProblem.cpp.

◆ setStimulationDuration()

void AbstractPacemakerProblem::setStimulationDuration ( CepsReal duration )

Set the duration of the stimulation.

Definition at line 98 of file AbstractPacemakerProblem.cpp.

◆ setupRunningProperties()

void AbstractPacemakerProblem::setupRunningProperties ( )

Sets running parameters like equivalent resistances and capacitances.

Definition at line 292 of file AbstractPacemakerProblem.cpp.

◆ setupWithParameters()

void AbstractPacemakerProblem::setupWithParameters ( InputParameters * params )

Sets options from the parameters.

Definition at line 262 of file AbstractPacemakerProblem.cpp.

Field Documentation

◆ m_pmkC

CepsArray<CepsReal, CepsPacemakerPhaseSize> AbstractPacemakerProblem::m_pmkC

protected

All equivalent capacitances depending on phase [uF].

Definition at line 217 of file AbstractPacemakerProblem.hpp.

◆ m_pmkCets

CepsReal AbstractPacemakerProblem::m_pmkCets

protected

CETS capacitance [uF].

Definition at line 205 of file AbstractPacemakerProblem.hpp.

◆ m_pmkCts

CepsReal AbstractPacemakerProblem::m_pmkCts

protected

CTS capacitance [uF].

Definition at line 206 of file AbstractPacemakerProblem.hpp.

◆ m_pmkNSpikes

CepsUInt AbstractPacemakerProblem::m_pmkNSpikes

protected

Number of spikes to do.

Definition at line 201 of file AbstractPacemakerProblem.hpp.

◆ m_pmkOcd

CepsReal AbstractPacemakerProblem::m_pmkOcd

protected

OCD duration [ms].

Definition at line 200 of file AbstractPacemakerProblem.hpp.

◆ m_pmkOffset

CepsReal AbstractPacemakerProblem::m_pmkOffset

protected

Offset duration [ms].

Definition at line 197 of file AbstractPacemakerProblem.hpp.

◆ m_pmkPeriod

CepsReal AbstractPacemakerProblem::m_pmkPeriod

protected

Period duration [ms], default 90bpm.

Definition at line 198 of file AbstractPacemakerProblem.hpp.

◆ m_pmkPulseOnlyMode

CepsBool AbstractPacemakerProblem::m_pmkPulseOnlyMode

protected

Pulse only mode.

Definition at line 196 of file AbstractPacemakerProblem.hpp.

◆ m_pmkR

CepsArray<CepsReal, CepsPacemakerPhaseSize> AbstractPacemakerProblem::m_pmkR

protected

All equivalent resistances depending on phase [kOhm].

Definition at line 219 of file AbstractPacemakerProblem.hpp.

◆ m_pmkRbig

CepsReal AbstractPacemakerProblem::m_pmkRbig

protected

BIG resistance [kOhm] during the waiting phase.

Definition at line 211 of file AbstractPacemakerProblem.hpp.

◆ m_pmkRgnd

CepsReal AbstractPacemakerProblem::m_pmkRgnd

protected

GROUND resistance [kOhm].

Definition at line 207 of file AbstractPacemakerProblem.hpp.

◆ m_pmkRlittle

CepsReal AbstractPacemakerProblem::m_pmkRlittle

protected

LITTLE resistance [kOhm] used to recharge the CETS.

Definition at line 212 of file AbstractPacemakerProblem.hpp.

◆ m_pmkRpulse

CepsReal AbstractPacemakerProblem::m_pmkRpulse

protected

PULSE resistance [kOhm].

Definition at line 208 of file AbstractPacemakerProblem.hpp.

◆ m_pmkRwa

CepsReal AbstractPacemakerProblem::m_pmkRwa

protected

ANODE WIRE resistance [kOhm].

Definition at line 209 of file AbstractPacemakerProblem.hpp.

◆ m_pmkRwc

CepsReal AbstractPacemakerProblem::m_pmkRwc

protected

CATHODE WIRE resistance [kOhm].

Definition at line 210 of file AbstractPacemakerProblem.hpp.

◆ m_pmkSwitch

CepsReal AbstractPacemakerProblem::m_pmkSwitch

protected

Switch duration [ms].

Definition at line 199 of file AbstractPacemakerProblem.hpp.

◆ m_stimAmplitude

CepsReal AbstractPacemakerProblem::m_stimAmplitude

protected

Amplitude of the stim [mV].

Definition at line 191 of file AbstractPacemakerProblem.hpp.

◆ m_stimDuration

CepsReal AbstractPacemakerProblem::m_stimDuration

protected

Duration of the stim [ms].

Definition at line 192 of file AbstractPacemakerProblem.hpp.

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

/builds/xxjFYZX3/0/carmen/ceps/src/cardiac/pacemaker/problem/AbstractPacemakerProblem.hpp
/builds/xxjFYZX3/0/carmen/ceps/src/cardiac/pacemaker/problem/AbstractPacemakerProblem.cpp

Detailed Description

Data Structures

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ AbstractPacemakerProblem()

◆ ~AbstractPacemakerProblem()

Member Function Documentation

◆ getPacemakerCapacitance()

◆ getPacemakerCapacitanceCets()

◆ getPacemakerCapacitanceCts()

◆ getPacemakerDuration()

◆ getPacemakerResistance()

◆ getPacemakerResistanceLittle()

◆ getPhase()

◆ getRelativeTimeOnPhase()

◆ getStimulationAmplitude()

◆ getStimulationDuration()

◆ getStimulationPeriod()

◆ getUAnodeUnknown()

◆ getUCathodeUnknown()

◆ getVCetsUnknown()

◆ getVCtsUnknown()

◆ getWireResistanceAnodeLine()

◆ getWireResistanceCathodeLine()

◆ isPulseOnlyMode()

◆ isRechargingPhase()

◆ setPulseOnlyMode()

◆ setStimulation()

◆ setStimulationAmplitude()

◆ setStimulationDuration()

◆ setupRunningProperties()

◆ setupWithParameters()

Field Documentation

◆ m_pmkC

◆ m_pmkCets

◆ m_pmkCts

◆ m_pmkNSpikes

◆ m_pmkOcd

◆ m_pmkOffset

◆ m_pmkPeriod

◆ m_pmkPulseOnlyMode

◆ m_pmkR

◆ m_pmkRbig

◆ m_pmkRgnd

◆ m_pmkRlittle

◆ m_pmkRpulse

◆ m_pmkRwa

◆ m_pmkRwc

◆ m_pmkSwitch

◆ m_stimAmplitude

◆ m_stimDuration