Chaste Commit::ca8ccdedf819b6e02855bc0e8e6f50bdecbc5208
Public Member Functions | Public Attributes | Protected Attributes | List of all members
AbstractUntemplatedConvergenceTester Class Referenceabstract

#include <AbstractConvergenceTester.hpp>

+ Inheritance diagram for AbstractUntemplatedConvergenceTester:
+ Collaboration diagram for AbstractUntemplatedConvergenceTester:

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
 
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 145 of file AbstractConvergenceTester.hpp.

Constructor & Destructor Documentation

◆ AbstractUntemplatedConvergenceTester()

AbstractUntemplatedConvergenceTester::AbstractUntemplatedConvergenceTester ( )

Definition at line 40 of file AbstractConvergenceTester.cpp.

◆ ~AbstractUntemplatedConvergenceTester()

AbstractUntemplatedConvergenceTester::~AbstractUntemplatedConvergenceTester ( )
virtual

Definition at line 60 of file AbstractConvergenceTester.cpp.

Member Function Documentation

◆ Converge()

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
nameOfTestThe 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

◆ AbsoluteStimulus

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 178 of file AbstractConvergenceTester.hpp.

◆ Apd90FirstQn

double AbstractUntemplatedConvergenceTester::Apd90FirstQn

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

Definition at line 162 of file AbstractConvergenceTester.hpp.

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

◆ Apd90ThirdQn

double AbstractUntemplatedConvergenceTester::Apd90ThirdQn

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

Definition at line 163 of file AbstractConvergenceTester.hpp.

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

◆ ConductionVelocity

double AbstractUntemplatedConvergenceTester::ConductionVelocity

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

Definition at line 164 of file AbstractConvergenceTester.hpp.

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

◆ Converged

bool AbstractUntemplatedConvergenceTester::Converged

Set to true when convergence has been reached

Definition at line 180 of file AbstractConvergenceTester.hpp.

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

◆ FixedResult

bool AbstractUntemplatedConvergenceTester::FixedResult

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

Definition at line 172 of file AbstractConvergenceTester.hpp.

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

◆ LastDifference

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 161 of file AbstractConvergenceTester.hpp.

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

◆ MeshNum

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 159 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 >::GetMeshNum(), SpaceConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::GetSpaceStep(), SpaceConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::GiveUpConvergence(), SpaceConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::SetInitialConvergenceParameters(), and SpaceConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::UpdateConvergenceParameters().

◆ mMeshWidth

double AbstractUntemplatedConvergenceTester::mMeshWidth
protected

Mesh width (for cuboid mesh)

Definition at line 149 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().

◆ NeumannStimulus

double AbstractUntemplatedConvergenceTester::NeumannStimulus

Quantity of face stimulus to use in the Neumann case

Definition at line 182 of file AbstractConvergenceTester.hpp.

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

◆ OdeTimeStep

double AbstractUntemplatedConvergenceTester::OdeTimeStep

OdeTimeStep to be varied in OdeConvergenceTester etc

Definition at line 152 of file AbstractConvergenceTester.hpp.

Referenced by OdeConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::Abscissa(), OdePdeConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::Abscissa(), AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::Converge(), AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::DisplayRun(), OdeConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::GiveUpConvergence(), OdePdeConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::GiveUpConvergence(), PdeConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::GiveUpConvergence(), OdeConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::SetInitialConvergenceParameters(), OdePdeConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::SetInitialConvergenceParameters(), PdeConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::SetInitialConvergenceParameters(), OdeConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::UpdateConvergenceParameters(), and OdePdeConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::UpdateConvergenceParameters().

◆ PdeTimeStep

double AbstractUntemplatedConvergenceTester::PdeTimeStep

PdeTimeStep to be varied in PdeConvergenceTester etc

Definition at line 154 of file AbstractConvergenceTester.hpp.

Referenced by PdeConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::Abscissa(), AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::Converge(), AbstractConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::DisplayRun(), OdePdeConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::GiveUpConvergence(), OdeConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::SetInitialConvergenceParameters(), OdePdeConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::SetInitialConvergenceParameters(), PdeConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::SetInitialConvergenceParameters(), OdePdeConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::UpdateConvergenceParameters(), and PdeConvergenceTester< CELL, CARDIAC_PROBLEM, DIM, PROBLEM_DIM >::UpdateConvergenceParameters().

◆ PopulatedResult

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 168 of file AbstractConvergenceTester.hpp.

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

◆ RelativeConvergenceCriterion

double AbstractUntemplatedConvergenceTester::RelativeConvergenceCriterion

Main convergence test is LastDifference < RelativeConvergenceCriterion

Definition at line 160 of file AbstractConvergenceTester.hpp.

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

◆ SimulateFullActionPotential

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 179 of file AbstractConvergenceTester.hpp.

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

◆ Stimulus

StimulusType AbstractUntemplatedConvergenceTester::Stimulus

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

Definition at line 181 of file AbstractConvergenceTester.hpp.

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

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