AbstractUntemplatedConvergenceTester Class Reference

#include <AbstractConvergenceTester.hpp>

Inheritance diagram for AbstractUntemplatedConvergenceTester:

Collaboration diagram for AbstractUntemplatedConvergenceTester:

List of all members.

Public Member Functions

virtual void Converge (std::string nameOfTest)=0

Public Attributes

double OdeTimeStep

double PdeTimeStep

unsigned MeshNum

double RelativeConvergenceCriterion

double LastDifference

double Apd90FirstQn

double Apd90ThirdQn

double ConductionVelocity

bool PopulatedResult

bool FixedResult

bool UseAbsoluteStimulus

double AbsoluteStimulus

bool SimulateFullActionPotential

bool Converged

StimulusType Stimulus

double NeumannStimulus

Protected Attributes

double mMeshWidth

Detailed Description

AbstractUntemplatedConvergenceTester contains core functionality used in more convergence testers

Definition at line 136 of file AbstractConvergenceTester.hpp.

Member Function Documentation

virtual void AbstractUntemplatedConvergenceTester::Converge ( std::string nameOfTest ) [pure virtual]

Run the same test at different levels of refinement until some convergence criterion is met.

Parameters:

nameOfTest

The name of the convergence test (typically the name in the suite) for use in naming files.

Implemented in AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >.

Member Data Documentation

double AbstractUntemplatedConvergenceTester::mMeshWidth [protected]

Mesh width (for cuboid mesh)

Definition at line 140 of file AbstractConvergenceTester.hpp.

Referenced by SpaceConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::Abscissa(), AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::Converge(), AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::DisplayRun(), SpaceConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::GetSpaceStep(), and AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::SetMeshWidth().

double AbstractUntemplatedConvergenceTester::OdeTimeStep

OdeTimeStep to be varied in OdeConvergenceTester etc

Definition at line 143 of file AbstractConvergenceTester.hpp.

double AbstractUntemplatedConvergenceTester::PdeTimeStep

PdeTimeStep to be varied in PdeConvergenceTester etc

Definition at line 145 of file AbstractConvergenceTester.hpp.

unsigned AbstractUntemplatedConvergenceTester::MeshNum

Mesh number - mesh 0 has 4 elements in each space dimension 0.05cm on a 0.2cm mesh

mesh 1 has 8 (0.025cm)
mesh 2 has 16 (0.0125cm)

Definition at line 150 of file AbstractConvergenceTester.hpp.

double AbstractUntemplatedConvergenceTester::RelativeConvergenceCriterion

Main convergence test is LastDifference < RelativeConvergenceCriterion

Definition at line 151 of file AbstractConvergenceTester.hpp.

Referenced by AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::Converge().

double AbstractUntemplatedConvergenceTester::LastDifference

Used to store and retrieve the difference between success runs (relative 2-norm of Vm at 3rd quarter node).

Definition at line 152 of file AbstractConvergenceTester.hpp.

Referenced by AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::Converge().

double AbstractUntemplatedConvergenceTester::Apd90FirstQn

Used to store and retrieve the APD90 of a node in the first quarter x-value

Definition at line 153 of file AbstractConvergenceTester.hpp.

Referenced by AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::Converge().

double AbstractUntemplatedConvergenceTester::Apd90ThirdQn

Used to store and retrieve the APD90 of a node in the third quarter x-value

Definition at line 154 of file AbstractConvergenceTester.hpp.

Referenced by AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::Converge().

double AbstractUntemplatedConvergenceTester::ConductionVelocity

Used to store and retrieve the conduction velocity between the first & third quarter nodes

Definition at line 155 of file AbstractConvergenceTester.hpp.

Referenced by AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::Converge().

bool AbstractUntemplatedConvergenceTester::PopulatedResult

Set to true once the result of a test is known (either read from file or produced by the coarsest run of the tester).

Definition at line 159 of file AbstractConvergenceTester.hpp.

Referenced by AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::Converge(), and AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::PopulateStandardResult().

bool AbstractUntemplatedConvergenceTester::FixedResult

true if converging to a known standard result used in StimulusConverger in projects/jmpf

Definition at line 163 of file AbstractConvergenceTester.hpp.

Referenced by AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::Converge().

bool AbstractUntemplatedConvergenceTester::UseAbsoluteStimulus

true if the plane stimulus should applied with an exact value (not scaled by space-step) used in StimulusConverger in projects/jmpf

Definition at line 167 of file AbstractConvergenceTester.hpp.

Referenced by AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::Converge(), and AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::DisplayRun().

double AbstractUntemplatedConvergenceTester::AbsoluteStimulus

A value to be used with a plane stimulus (not scaled by space-step) used in StimulusConverger in projects/jmpf

Definition at line 172 of file AbstractConvergenceTester.hpp.

Referenced by AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::Converge(), and AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::DisplayRun().

bool AbstractUntemplatedConvergenceTester::SimulateFullActionPotential

Set it true in order to run simulations for long enough to get a whole AP (and thus get convergence history for APD90). Note that this slackens the relative L2 norm criterion, since we are in plateau phase for longer

Definition at line 173 of file AbstractConvergenceTester.hpp.

Referenced by AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::Converge().

bool AbstractUntemplatedConvergenceTester::Converged

Set to true when convergence has been reached

Definition at line 174 of file AbstractConvergenceTester.hpp.

Referenced by AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::Converge(), and AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::IsConverged().

StimulusType AbstractUntemplatedConvergenceTester::Stimulus

The type of stimulus: PLANE (x=0), REGION (first quarter in x) or NEUMANN (monodomain only)

Definition at line 175 of file AbstractConvergenceTester.hpp.

Referenced by AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::Converge(), and AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::DisplayRun().

double AbstractUntemplatedConvergenceTester::NeumannStimulus

Quantity of face stimulus to use in the Neumann case

Definition at line 176 of file AbstractConvergenceTester.hpp.

Referenced by AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::Converge().

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

heart/src/convergence/AbstractConvergenceTester.hpp
heart/src/convergence/AbstractConvergenceTester.cpp


Public Member Functions
virtual void	Converge (std::string nameOfTest)=0
Public Attributes
double	OdeTimeStep
double	PdeTimeStep
unsigned	MeshNum
double	RelativeConvergenceCriterion
double	LastDifference
double	Apd90FirstQn
double	Apd90ThirdQn
double	ConductionVelocity
bool	PopulatedResult
bool	FixedResult
bool	UseAbsoluteStimulus
double	AbsoluteStimulus
bool	SimulateFullActionPotential
bool	Converged
StimulusType	Stimulus
double	NeumannStimulus
Protected Attributes
double	mMeshWidth