#include <HeartIonicData.hpp>

Inheritance diagram for HeartIonicData:

Collaboration diagram for HeartIonicData:

Private Attributes
std::string	M_meshFile

std::string	M_meshDirectory

UInt	M_verbose

Real	M_RMCParameterA
	RogersMcCulloch (RMC) 1994 Ionic Model parameters. More...

Real	M_RMCParameterB

Real	M_RMCParameterC1

Real	M_RMCParameterC2

Real	M_RMCParameterD

Real	M_RMCTimeUnit

Real	M_RMCPotentialAmplitude

Real	M_RMCRestPotential

Real	M_RMCInitialRepolarization

Real	M_MSTauIn
	Mitchell & Schaeffer (MS) More...

Real	M_MSTauOut

Real	M_MSTauOpen

Real	M_MSTauClose

Real	M_MSCriticalPotential

Real	M_MSPotentialMinimum

Real	M_MSPotentialMaximum

Real	M_MSReactionAmplitude

Real	M_MSInitialTime

Real	M_MSTend

Real	M_MSBDForder

bool	M_MSHasHeterogeneousTauClose

Constructor & Destructor
	HeartIonicData ()
	Constructors. More...

	HeartIonicData (const GetPot &dataFile)
	Constructors. More...

	HeartIonicData (const HeartIonicData &dataIonic)

virtual	~HeartIonicData ()

Operators
HeartIonicData &	operator= (const HeartIonicData &dataIonic)

Methods
void	showMe (std::ostream &output=std::cout)
	output: show the data used for the simulation More...

Set Methods
void	setup (const GetPot &dataFile)
	external setup: set all the data for the simulation More...

const Real &	RMCParameterA () const

const Real &	RMCParameterB () const

const Real &	RMCParameterC1 () const

const Real &	RMCParameterC2 () const

const Real &	RMCParameterD () const

const Real &	RMCTimeUnit () const

const Real &	RMCPotentialAmplitude () const

const Real &	RMCRestPotential () const

const Real &	RMCInitialRepolarization () const

const Real &	MSTauIn () const

const Real &	MSTauOut () const

const Real &	MSTauOpen () const

const Real &	MSTauClose () const

const Real &	MSCriticalPotential () const

const Real &	MSPotentialMinimum () const

const Real &	MSPotentialMaximum () const

const Real &	MSReactionAmplitude () const

const Real &	MSInitialTime () const

const Real &	MSTend () const

const Real &	MSBDForder () const

const bool &	MSHasHeterogeneousTauClose () const

Additional Inherited Members
Public Member Functions inherited from MeshData
	MeshData ()
	Empty Constructor. More...

	MeshData (const GetPot &dataFile, const std::string &section="space_discretization")
	Constructor. More...

	MeshData (const MeshData &meshData)
	Copy constructor. More...

virtual	~MeshData ()
	Virtual destructor. More...

void	setup (const GetPot &dataFile, const std::string &section)
	Read the dataFile and set all the members. More...

void	setup (const Teuchos::ParameterList &meshParameters)
	Set all members using a Teuchos ParameterList. More...

virtual void	showMe (std::ostream &output=std::cout) const
	Display the values. More...

void	setMeshDir (const std::string &dir)

void	setMeshFile (const std::string &file)

void	setMeshType (const std::string &type)

void	setMOrder (const std::string &order)

void	setVerbose (const bool &isVerbose)

const std::string &	meshDir () const

const std::string &	meshFile () const

const std::string &	meshType () const

const std::string &	mOrder () const

const bool &	verbose () const

Public Member Functions inherited from TimeData
	TimeData ()
	Empty Constructor. More...

	TimeData (const GetPot &dataFile, const std::string &section="time_discretization")
	Constructor. More...

	TimeData (const TimeData &TimeData)
	Copy constructor. More...

virtual	~TimeData ()
	Virtual destructor. More...

void	setup (const GetPot &dfile, const std::string &section="time_discretization")
	Read the dataFile and set all the internal quantities. More...

void	updateTime ()
	Update the time by a timestep. More...

bool	canAdvance ()
	Return if we can make a new timestep. More...

bool	isFirstTimeStep ()
	Return if it is the initial time step. More...

bool	isLastTimeStep ()
	Return if it is the last time step. More...

void	showMe (std::ostream &output=std::cout) const
	Display general information about the content of the class. More...

Real	round (const Real &n, const Int &decimal=10) const

void	setInitialTime (const Real &initialTime)
	Set the initial time step. More...

void	setEndTime (const Real &endTime)
	Set the final time step. More...

void	setTime (const Real &time)
	Set the present time of the simulation. More...

void	setTimeStep (const Real &timeStep)
	Set the initial time step. More...

void	setTimeStepNumber (const UInt &timeStepNumber)
	Set the time step number. More...

const Real &	initialTime () const
	Get the initial time step. More...

const Real &	endTime () const
	Get the final time step. More...

const Real &	periodTime () const
	Get the period. More...

const Real &	time () const
	Get the present time. More...

Real	leftTime () const
	Get the time left. More...

Real	elapsedTime () const
	Get the elapsed time. More...

Real	inCycleTime () const
	Get the present time shifted inside the first cycle (i.e. More...

Real	previousTime () const
	Get the previous time. More...

Real	nextTime () const
	Get the next time. More...

const Real &	timeStep () const
	Get the time step used for advancing. More...

const UInt &	timeStepNumber () const
	Get the number of time step performed. More...

Detailed Description

Definition at line 52 of file HeartIonicData.hpp.

Constructor & Destructor Documentation

◆ HeartIonicData() [1/3]

HeartIonicData ( )

Constructors.

Definition at line 57 of file HeartIonicData.cpp.

◆ HeartIonicData() [2/3]

HeartIonicData ( const GetPot & dataFile )

Constructors.

Definition at line 50 of file HeartIonicData.cpp.

Here is the caller graph for this function:

◆ HeartIonicData() [3/3]

HeartIonicData ( const HeartIonicData & dataIonic )

Definition at line 86 of file HeartIonicData.cpp.

Here is the caller graph for this function:

◆ ~HeartIonicData()

virtual ~HeartIonicData ( )

inlinevirtual

Definition at line 69 of file HeartIonicData.hpp.

Member Function Documentation

◆ operator=()

HeartIonicData & operator= ( const HeartIonicData & dataIonic )

Definition at line 120 of file HeartIonicData.cpp.

◆ showMe()

void showMe ( std::ostream & output = std::cout )

output: show the data used for the simulation

Definition at line 180 of file HeartIonicData.cpp.

◆ setup()

void setup ( const GetPot & dataFile )

external setup: set all the data for the simulation

Definition at line 152 of file HeartIonicData.cpp.

Here is the caller graph for this function:

◆ RMCParameterA()

const Real& RMCParameterA ( ) const

inline

Definition at line 97 of file HeartIonicData.hpp.

◆ RMCParameterB()

const Real& RMCParameterB ( ) const

inline

Definition at line 102 of file HeartIonicData.hpp.

◆ RMCParameterC1()

const Real& RMCParameterC1 ( ) const

inline

Definition at line 107 of file HeartIonicData.hpp.

◆ RMCParameterC2()

const Real& RMCParameterC2 ( ) const

inline

Definition at line 112 of file HeartIonicData.hpp.

◆ RMCParameterD()

const Real& RMCParameterD ( ) const

inline

Definition at line 117 of file HeartIonicData.hpp.

◆ RMCTimeUnit()

const Real& RMCTimeUnit ( ) const

inline

Definition at line 122 of file HeartIonicData.hpp.

◆ RMCPotentialAmplitude()

const Real& RMCPotentialAmplitude ( ) const

inline

Definition at line 127 of file HeartIonicData.hpp.

◆ RMCRestPotential()

const Real& RMCRestPotential ( ) const

inline

Definition at line 132 of file HeartIonicData.hpp.

◆ RMCInitialRepolarization()

const Real& RMCInitialRepolarization ( ) const

inline

Definition at line 137 of file HeartIonicData.hpp.

◆ MSTauIn()

const Real& MSTauIn ( ) const

inline

Definition at line 142 of file HeartIonicData.hpp.

◆ MSTauOut()

const Real& MSTauOut ( ) const

inline

Definition at line 147 of file HeartIonicData.hpp.

◆ MSTauOpen()

const Real& MSTauOpen ( ) const

inline

Definition at line 152 of file HeartIonicData.hpp.

◆ MSTauClose()

const Real& MSTauClose ( ) const

inline

Definition at line 157 of file HeartIonicData.hpp.

◆ MSCriticalPotential()

const Real& MSCriticalPotential ( ) const

inline

Definition at line 162 of file HeartIonicData.hpp.

◆ MSPotentialMinimum()

const Real& MSPotentialMinimum ( ) const

inline

Definition at line 167 of file HeartIonicData.hpp.

◆ MSPotentialMaximum()

const Real& MSPotentialMaximum ( ) const

inline

Definition at line 172 of file HeartIonicData.hpp.

◆ MSReactionAmplitude()

const Real& MSReactionAmplitude ( ) const

inline

Definition at line 177 of file HeartIonicData.hpp.

◆ MSInitialTime()

const Real& MSInitialTime ( ) const

inline

Definition at line 182 of file HeartIonicData.hpp.

◆ MSTend()

const Real& MSTend ( ) const

inline

Definition at line 187 of file HeartIonicData.hpp.

◆ MSBDForder()

const Real& MSBDForder ( ) const

inline

Definition at line 192 of file HeartIonicData.hpp.

◆ MSHasHeterogeneousTauClose()

const bool& MSHasHeterogeneousTauClose ( ) const

inline

Definition at line 197 of file HeartIonicData.hpp.

Field Documentation

◆ M_meshFile

std::string M_meshFile

private

Definition at line 215 of file HeartIonicData.hpp.

◆ M_meshDirectory

std::string M_meshDirectory

private

Definition at line 216 of file HeartIonicData.hpp.

◆ M_verbose

UInt M_verbose

private

Definition at line 218 of file HeartIonicData.hpp.

◆ M_RMCParameterA

Real M_RMCParameterA

private

RogersMcCulloch (RMC) 1994 Ionic Model parameters.

Definition at line 220 of file HeartIonicData.hpp.

◆ M_RMCParameterB

Real M_RMCParameterB

private

Definition at line 221 of file HeartIonicData.hpp.

◆ M_RMCParameterC1

Real M_RMCParameterC1

private

Definition at line 222 of file HeartIonicData.hpp.

◆ M_RMCParameterC2

Real M_RMCParameterC2

private

Definition at line 223 of file HeartIonicData.hpp.

◆ M_RMCParameterD

Real M_RMCParameterD

private

Definition at line 224 of file HeartIonicData.hpp.

◆ M_RMCTimeUnit

Real M_RMCTimeUnit

private

Definition at line 225 of file HeartIonicData.hpp.

◆ M_RMCPotentialAmplitude

Real M_RMCPotentialAmplitude

private

Definition at line 226 of file HeartIonicData.hpp.

◆ M_RMCRestPotential

Real M_RMCRestPotential

private

Definition at line 227 of file HeartIonicData.hpp.

◆ M_RMCInitialRepolarization

Real M_RMCInitialRepolarization

private

Definition at line 228 of file HeartIonicData.hpp.

◆ M_MSTauIn

Real M_MSTauIn

private

Mitchell & Schaeffer (MS)

Definition at line 231 of file HeartIonicData.hpp.

◆ M_MSTauOut

Real M_MSTauOut

private

Definition at line 232 of file HeartIonicData.hpp.

◆ M_MSTauOpen

Real M_MSTauOpen

private

Definition at line 233 of file HeartIonicData.hpp.

◆ M_MSTauClose

Real M_MSTauClose

private

Definition at line 234 of file HeartIonicData.hpp.

◆ M_MSCriticalPotential

Real M_MSCriticalPotential

private

Definition at line 235 of file HeartIonicData.hpp.

◆ M_MSPotentialMinimum

Real M_MSPotentialMinimum

private

Definition at line 236 of file HeartIonicData.hpp.

◆ M_MSPotentialMaximum

Real M_MSPotentialMaximum

private

Definition at line 237 of file HeartIonicData.hpp.

◆ M_MSReactionAmplitude

Real M_MSReactionAmplitude

private

Definition at line 238 of file HeartIonicData.hpp.

◆ M_MSInitialTime

Real M_MSInitialTime

private

Definition at line 239 of file HeartIonicData.hpp.

◆ M_MSTend

Real M_MSTend

private

Definition at line 240 of file HeartIonicData.hpp.

◆ M_MSBDForder

Real M_MSBDForder

private

Definition at line 241 of file HeartIonicData.hpp.

◆ M_MSHasHeterogeneousTauClose

bool M_MSHasHeterogeneousTauClose

private

Definition at line 243 of file HeartIonicData.hpp.

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

Private Attributes

Constructor & Destructor

Operators

Methods

Set Methods

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HeartIonicData() [1/3]

◆ HeartIonicData() [2/3]

◆ HeartIonicData() [3/3]

◆ ~HeartIonicData()

Member Function Documentation

◆ operator=()

◆ showMe()

◆ setup()

◆ RMCParameterA()

◆ RMCParameterB()

◆ RMCParameterC1()

◆ RMCParameterC2()

◆ RMCParameterD()

◆ RMCTimeUnit()

◆ RMCPotentialAmplitude()

◆ RMCRestPotential()

◆ RMCInitialRepolarization()

◆ MSTauIn()

◆ MSTauOut()

◆ MSTauOpen()

◆ MSTauClose()

◆ MSCriticalPotential()

◆ MSPotentialMinimum()

◆ MSPotentialMaximum()

◆ MSReactionAmplitude()

◆ MSInitialTime()

◆ MSTend()

◆ MSBDForder()

◆ MSHasHeterogeneousTauClose()

Field Documentation

◆ M_meshFile

◆ M_meshDirectory

◆ M_verbose

◆ M_RMCParameterA

◆ M_RMCParameterB

◆ M_RMCParameterC1

◆ M_RMCParameterC2

◆ M_RMCParameterD

◆ M_RMCTimeUnit

◆ M_RMCPotentialAmplitude

◆ M_RMCRestPotential

◆ M_RMCInitialRepolarization

◆ M_MSTauIn

◆ M_MSTauOut

◆ M_MSTauOpen

◆ M_MSTauClose

◆ M_MSCriticalPotential

◆ M_MSPotentialMinimum

◆ M_MSPotentialMaximum

◆ M_MSReactionAmplitude

◆ M_MSInitialTime

◆ M_MSTend

◆ M_MSBDForder

◆ M_MSHasHeterogeneousTauClose