Session file configuration

8.3 Session file configuration

8.3.1 Solver Info

Eqtype Specifies the PDE system to solve. The following values are supported:
- Monodomain: solve the monodomain equation.
- BidomainRoth: solve the bidomain equations using the Roth formulation.

CellModel Specifies the cell model to use. Available cell models are

Value	Description	No. of Var.	Ref.
`AlievPanfilov`	Phenomological	1	[2]
`CourtemancheRamirezNattel98`	Human atrial	20	[22]
`FitzHughNagumo`
`Fox02`
`LuoRudy91`	Mammalian ventricular	7	[21]
`PanditGilesDemir03`
`TenTusscher06`	Human ventricular	18	[35]
`Winslow99`

Projection Specifies the Galerkin projection type to use. Only Continuous has been extensively tested.
TimeIntegrationMethod Specifies the time integration scheme to use for advancing the PDE system. This must be an IMEX scheme. Suitable choices are: IMEXOrder1, IMEXOrder2, IMEXOrder3, IMEXdirk_3_4_3. The cell model state variables are time advanced using Forward Euler for the ion concentrations, and Rush-Larsen for the cell model gating variables.
DiffusionAdvancement Specifies whether the diffusion is handled implicitly or explicitly in the time integration scheme. The current code only supports Implicit integration of the diffusion term. The cell model is always integrated explicitly.

8.3.2 Parameters

The following parameters can be specified in the PARAMETERS section of the session file. Example values are taken from [13].

Chi sets the surface-to-volume ratio (Units: mm⁻¹).
Example: χ = 140mm⁻¹
Cm sets the specific membrane capacitance (Units: μFmm⁻²).
Example: C_m = 0.01μFmm⁻²
Substeps sets the number of substeps taken in time integrating the cell model for each PDE timestep.
Example: 4
d_min, d_max, o_min, o_max specifies a bijective map to assign conductivity values σ to intensity values μ when using the IsotropicConductivity function. The intensity map is first thresholded to the range [d_min,d_max] and then the conductivity is calculated as

σ = (1 − μ) + o_min

8.3.3 Functions

The following functions can be specified inside the CONDITIONS section of the session file. If both are specified, the effect is multiplicative. Example values are taken from [13].

IsotropicConductivity specifies the conductivity σ of the tissue.
Example: σ = 0.13341 mSmm⁻¹, based on σ = , σ_i = 0.17,σ_e = 0.62mSmm⁻¹
The variable name to use is intensity since the conductivity may be derived from late-Gadolinium enhanced MRA imaging. Example specifications are

1<E VAR="intensity" VALUE="0.13341" />
2<F VAR="intensity" FILE="scarmap.con" />

where scarmap.con is a Nektar++ field file containing a variable intensity describing the conductivity across the domain.
AnisotropicConductivity specifies the conductivity σ of the tissue.

8.3.4 Filters

CellHistoryPoints writes all cell model states over time at fixed points. Can be used along with the HistoryPoints filter to record all variables at specific points during a simulation.
1<FILTER TYPE="CellHistoryPoints">
2    <PARAM NAME="OutputFile">crn.his</PARAM>
3    <PARAM NAME="OutputFrequency">1</PARAM>
4    <PARAM NAME="Points">
5        0.00 0.0 0.0
6    </PARAM>
7</FILTER>
- OutputFile specifies the filename to write history data to.
- OutputFrequency specifies the number of steps between successive outputs.
- Points lists coordinates at which history data is to be recorded.
CheckpointCellModel checkpoints the cell model. Can be used along with the Checkpoint filter to record complete simulation state and regular intervals.
1<FILTER TYPE="CheckpointCellModel">
2 <PARAM NAME="OutputFile"> session </PARAM>
3 <PARAM NAME="OutputFrequency"> 1 </PARAM>
4</FILTER>
- OutputFile (optional) specifies the base filename to use. If not specified, the session name is used. Checkpoint files are suffixed with the process ID and the extension ‘.chk‘.
- OutputFrequency specifies the number of timesteps between checkpoints.
Electrogram Computes virtual unipolar electrograms at a prescribed set of points.
1<FILTER TYPE="Electrogram">
2  <PARAM NAME="OutputFile"> session </PARAM>
3  <PARAM NAME="OutputFrequency"> 1 </PARAM>
4  <PARAM NAME="Points">
5      0.0  0.5  0.7
6      1.0  0.5  0.7
7      2.0  0.5  0.7
8  </PARAM>
9</FILTER>
- OutputFile (optional) specifies the base filename to use. If not specified, the session name is used. The extension ‘.ecg‘ is appended if not already specified.
- OutputFrequency specifies the number of resolution of the electrogram data.
- Points specifies a list of coordinates at which electrograms are desired. They must not lie within the domain.
Benchmark Records spatially distributed event times for activation and repolarisation (recovert) during a simulation, for undertaking benchmark test problems.
1<FILTER TYPE="Benchmark">
2  <PARAM NAME="ThresholdValue"> -40.0 </PARAM>
3  <PARAM NAME="InitialValue">     0.0 </PARAM>
4  <PARAM NAME="OutputFile"> benchmark </PARAM>
5  <PARAM NAME="StartTime">        0.0 </PARAM>
6</FILTER>
- ThresholdValue specifies the value above which tissue is considered to be depolarised and below which is considered repolarised.
- InitialValue specifies the initial value of the activation or repolarisation time map.
- OutputFile specifies the base filename of activation and repolarisation maps output from the filter. This name is appended with the index of the event and the suffix ‘.fld‘.
- StartTime (optional) specifies the simulation time at which to start detecting events.

8.3.5 Stimuli

Electrophysiological propagaion is initiated through the stimulus current I_ion. The STIMULI section describes one or more regions of stimulus and the time-dependent protocol with which they are applied.

1<STIMULI>
2 ...
3</STIMULI>

A number of stimulus types are available

8.3.5.1 Stimulus types

StimulusRect stimulates a cuboid-shaped region of the domain, specified by two coordinates (x₁,y₁,z₁) and (x₂,y₂,z₂). An additional parameter specifies the "smoothness" of the boundaries of the region; higher values produce a sharper boundary. Finally, the maximum strength of the stimulus current is specified in μA∕mm³
1<STIMULUS TYPE="StimulusRect" ID="0">
2  <p_x1> -15.24 </p_x1>
3  <p_y1>  14.02 </p_y1>
4  <p_z1>   6.87 </p_z1>
5  <p_x2>  12.23 </p_x2>
6  <p_y2>  16.56 </p_y2>
7  <p_z2>   8.88 </p_z2>
8  <p_is> 100.00 </p_is>
9  <p_strength> 50.0 </p_strength>
10</STIMULUS>
StimulusCirc stimulates a spherical region of the domain, as specified by a centre and radius. The smoothness and strength parameters are also specified as for ‘StimulusRect‘.
1<STIMULUS TYPE="StimulusCirc" ID="0">
2  <p_x1> -15.24 </p_x1>
3  <p_y1>  14.02 </p_y1>
4  <p_z1>   6.87 </p_z1>
5  <p_r1>  12.23 </p_r1>
6  <p_is> 100.00 </p_is>
7  <p_strength> 50.0 </p_strength>
8</STIMULUS>

8.3.5.2 Protocols

A protocol specifies the time-dependent function indicating the strength of the stimulus and one such PROTOCOL section should be included within each STIMULUS. This can be expressed as one of:

ProtocolSingle a single stimulus is applied at a given start time and for a given duration
1<PROTOCOL TYPE="ProtocolSingle">
2 <START> 0.0 </START>
3 <DURATION> 2.0 </DURATION>
4</PROTOCOL>
ProtocolS1 a train of pulses of fixed duration applied at a given start time and with a given cycle length.
1<PROTOCOL TYPE="ProtocolS1">
2  <START>    0.0   </START>
3  <DURATION> 2.0   </DURATION>
4  <S1CYCLELENGTH> 300.0 </S1CYCLELENGTH>
5  <NUM_S1>   5     </NUM_S1>
6</PROTOCOL>
ProtocolS1S2 same as ‘ProtocolS1‘ except with an additional single pulse applied at a different cycle length at the end of the train of S1 pulses.
1<PROTOCOL TYPE="ProtocolS1S2">
2  <START>    0.0   </START>
3  <DURATION> 2.0   </DURATION>
4  <S1CYCLELENGTH> 300.0 </S1CYCLELENGTH>
5  <NUM_S1>   5     </NUM_S1>
6  <S2CYCLELENGTH> 100.0 </S2CYCLELENGTH>
7</PROTOCOL>

[next] [prev] [prev-tail] [front] [up]