Nektar++
Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
Nektar::CellModelAlievPanfilov Class Reference

Aliev Panfilov model. More...

#include <AlievPanfilov.h>

Inheritance diagram for Nektar::CellModelAlievPanfilov:
[legend]

Public Member Functions

 CellModelAlievPanfilov (const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField)
 
 ~CellModelAlievPanfilov () override
 
- Public Member Functions inherited from Nektar::CellModel
 CellModel (const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField)
 
virtual ~CellModel ()
 
void Initialise ()
 Initialise the cell model storage and set initial conditions. More...
 
void TimeIntegrate (const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time)
 Time integrate the cell model by one PDE timestep. More...
 
void Update (const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time)
 Compute the derivatives of cell model variables. More...
 
void GenerateSummary (SummaryList &s)
 Print a summary of the cell model. More...
 
size_t GetNumCellVariables ()
 
std::string GetCellVarName (size_t idx)
 
Array< OneD, NekDouble > GetCellSolutionCoeffs (size_t idx)
 
Array< OneD, NekDouble > GetCellSolution (size_t idx)
 

Static Public Member Functions

static CellModelSharedPtr create (const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField)
 Creates an instance of this class. More...
 

Static Public Attributes

static std::string className
 Name of class. More...
 

Protected Member Functions

void v_Update (const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time) override
 
void v_GenerateSummary (SummaryList &s) override
 
void v_SetInitialConditions () override
 
- Protected Member Functions inherited from Nektar::CellModel
virtual void v_Update (const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time)=0
 
virtual void v_GenerateSummary (SummaryList &s)=0
 
virtual std::string v_GetCellVarName (size_t idx)
 
virtual void v_SetInitialConditions ()=0
 
void LoadCellModel ()
 

Private Attributes

NekDouble m_a
 Trigger parameter a. More...
 
NekDouble m_k
 Scaling parameter k. More...
 
NekDouble m_mu1
 Restitution parameter \(\mu_1\). More...
 
NekDouble m_mu2
 Restitution parameter \(\mu_2\). More...
 
NekDouble m_eps
 Restitution parameter \(\epsilon\). More...
 
Array< OneD, NekDouble > m_uu
 Temporary space for storing \(u^2\) when computing reaction term. More...
 
Array< OneD, NekDouble > m_uuu
 Temporary space for storing \(u^3\) when computing reaction term. More...
 
Array< OneD, NekDouble > m_tmp1
 Workspace for computing reaction term. More...
 
Array< OneD, NekDouble > m_tmp2
 Workspace for computing reaction term. More...
 

Additional Inherited Members

- Protected Attributes inherited from Nektar::CellModel
LibUtilities::SessionReaderSharedPtr m_session
 Session. More...
 
MultiRegions::ExpListSharedPtr m_field
 Transmembrane potential field from PDE system. More...
 
size_t m_nq
 Number of physical points. More...
 
size_t m_nvar
 Number of variables in cell model (inc. transmembrane voltage) More...
 
NekDouble m_lastTime
 Timestep for pde model. More...
 
size_t m_substeps
 Number of substeps to take. More...
 
Array< OneD, Array< OneD, NekDouble > > m_cellSol
 Cell model solution variables. More...
 
Array< OneD, Array< OneD, NekDouble > > m_wsp
 Cell model integration workspace. More...
 
bool m_useNodal
 Flag indicating whether nodal projection in use. More...
 
StdRegions::StdNodalTriExpSharedPtr m_nodalTri
 StdNodalTri for cell model calculations. More...
 
StdRegions::StdNodalTetExpSharedPtr m_nodalTet
 
Array< OneD, Array< OneD, NekDouble > > m_nodalTmp
 Temporary array for nodal projection. More...
 
std::vector< int > m_concentrations
 Indices of cell model variables which are concentrations. More...
 
std::vector< int > m_gates
 Indices of cell model variables which are gates. More...
 
Array< OneD, Array< OneD, NekDouble > > m_gates_tau
 Storage for gate tau values. More...
 

Detailed Description

Aliev Panfilov model.

Definition at line 43 of file AlievPanfilov.h.

Constructor & Destructor Documentation

◆ CellModelAlievPanfilov()

Nektar::CellModelAlievPanfilov::CellModelAlievPanfilov ( const LibUtilities::SessionReaderSharedPtr &  pSession,
const MultiRegions::ExpListSharedPtr &  pField 
)

Definition at line 51 of file AlievPanfilov.cpp.

54 : CellModel(pSession, pField)
55{
56 pSession->LoadParameter("k", m_k, 0.0);
57 pSession->LoadParameter("a", m_a, 0.0);
58 pSession->LoadParameter("mu1", m_mu1, 0.0);
59 pSession->LoadParameter("mu2", m_mu2, 0.0);
60 pSession->LoadParameter("eps", m_eps, 0.0);
61
62 m_uu = Array<OneD, NekDouble>(m_nq, 0.0);
63 m_uuu = Array<OneD, NekDouble>(m_nq, 0.0);
64 m_tmp1 = Array<OneD, NekDouble>(m_nq, 0.0);
65 m_tmp2 = Array<OneD, NekDouble>(m_nq, 0.0);
66
67 m_nvar = 2;
68 m_concentrations.push_back(1);
69}
Nektar::CellModelAlievPanfilov::m_tmp1
Array< OneD, NekDouble > m_tmp1
Workspace for computing reaction term.
Definition: AlievPanfilov.h:91
Nektar::CellModelAlievPanfilov::m_uuu
Array< OneD, NekDouble > m_uuu
Temporary space for storing when computing reaction term.
Definition: AlievPanfilov.h:89
Nektar::CellModelAlievPanfilov::m_uu
Array< OneD, NekDouble > m_uu
Temporary space for storing when computing reaction term.
Definition: AlievPanfilov.h:87
Nektar::CellModelAlievPanfilov::m_a
NekDouble m_a
Trigger parameter a.
Definition: AlievPanfilov.h:76
Nektar::CellModelAlievPanfilov::m_k
NekDouble m_k
Scaling parameter k.
Definition: AlievPanfilov.h:78
Nektar::CellModelAlievPanfilov::m_mu1
NekDouble m_mu1
Restitution parameter .
Definition: AlievPanfilov.h:80
Nektar::CellModelAlievPanfilov::m_tmp2
Array< OneD, NekDouble > m_tmp2
Workspace for computing reaction term.
Definition: AlievPanfilov.h:93
Nektar::CellModelAlievPanfilov::m_eps
NekDouble m_eps
Restitution parameter .
Definition: AlievPanfilov.h:84
Nektar::CellModelAlievPanfilov::m_mu2
NekDouble m_mu2
Restitution parameter .
Definition: AlievPanfilov.h:82
Nektar::CellModel::m_concentrations
std::vector< int > m_concentrations
Indices of cell model variables which are concentrations.
Definition: CellModel.h:139
Nektar::CellModel::m_nq
size_t m_nq
Number of physical points.
Definition: CellModel.h:117
Nektar::CellModel::m_nvar
size_t m_nvar
Number of variables in cell model (inc. transmembrane voltage)
Definition: CellModel.h:119
Nektar::CellModel::CellModel
CellModel(const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField)
Definition: CellModel.cpp:66

References m_a, Nektar::CellModel::m_concentrations, m_eps, m_k, m_mu1, m_mu2, Nektar::CellModel::m_nq, Nektar::CellModel::m_nvar, m_tmp1, m_tmp2, m_uu, and m_uuu.

◆ ~CellModelAlievPanfilov()

Nektar::CellModelAlievPanfilov::~CellModelAlievPanfilov ( )
inlineoverride

Definition at line 61 of file AlievPanfilov.h.

62 {
63 }

Member Function Documentation

◆ create()

static CellModelSharedPtr Nektar::CellModelAlievPanfilov::create ( const LibUtilities::SessionReaderSharedPtr &  pSession,
const MultiRegions::ExpListSharedPtr &  pField 
)
inlinestatic

Creates an instance of this class.

Definition at line 47 of file AlievPanfilov.h.

50 {
51 return MemoryManager<CellModelAlievPanfilov>::AllocateSharedPtr(
52 pSession, pField);
53 }
Nektar::MemoryManager::AllocateSharedPtr
static std::shared_ptr< DataType > AllocateSharedPtr(const Args &...args)
Allocate a shared pointer from the memory pool.
Definition: NekMemoryManager.hpp:166

References Nektar::MemoryManager< DataType >::AllocateSharedPtr().

◆ v_GenerateSummary()

void Nektar::CellModelAlievPanfilov::v_GenerateSummary ( SummaryList &  s)
overrideprotectedvirtual

Implements Nektar::CellModel.

Definition at line 186 of file AlievPanfilov.cpp.

187{
188 SolverUtils::AddSummaryItem(s, "Cell model", "Aliev-Panfilov");
189 SolverUtils::AddSummaryItem(s, "k", m_k);
190 SolverUtils::AddSummaryItem(s, "a", m_a);
191 SolverUtils::AddSummaryItem(s, "eps", m_eps);
192 SolverUtils::AddSummaryItem(s, "mu1", m_mu1);
193 SolverUtils::AddSummaryItem(s, "mu2", m_mu2);
194}
Nektar::SolverUtils::AddSummaryItem
void AddSummaryItem(SummaryList &l, const std::string &name, const std::string &value)
Adds a summary item to the summary info list.
Definition: Misc.cpp:47

References Nektar::SolverUtils::AddSummaryItem(), m_a, m_eps, m_k, m_mu1, and m_mu2.

◆ v_SetInitialConditions()

void Nektar::CellModelAlievPanfilov::v_SetInitialConditions ( )
overrideprotectedvirtual

Implements Nektar::CellModel.

Definition at line 199 of file AlievPanfilov.cpp.

200{
201 Vmath::Fill(m_nq, 0.0, m_cellSol[0], 1);
202 Vmath::Fill(m_nq, 0.0, m_cellSol[1], 1);
203}
Nektar::CellModel::m_cellSol
Array< OneD, Array< OneD, NekDouble > > m_cellSol
Cell model solution variables.
Definition: CellModel.h:126
Vmath::Fill
void Fill(int n, const T alpha, T *x, const int incx)
Fill a vector with a constant value.
Definition: Vmath.hpp:54

References Vmath::Fill(), Nektar::CellModel::m_cellSol, and Nektar::CellModel::m_nq.

◆ v_Update()

void Nektar::CellModelAlievPanfilov::v_Update ( const Array< OneD, const Array< OneD, NekDouble > > &  inarray,
Array< OneD, Array< OneD, NekDouble > > &  outarray,
const NekDouble  time 
)
overrideprotectedvirtual

Implements Nektar::CellModel.

Definition at line 71 of file AlievPanfilov.cpp.

75{
76 // inarray[0] holds initial physical u values throughout
77 // inarray[1] holds initial physical v values throughout
78
79 // compute u^2: m_u = u*u
80 Vmath::Vmul(m_nq, &inarray[0][0], 1, &inarray[0][0], 1, &m_uu[0], 1);
81
82 // compute u^3: m_u = u*u*u
83 Vmath::Vmul(m_nq, &inarray[0][0], 1, &m_uu[0], 1, &m_uuu[0], 1);
84
85 // --------------------------------------
86 // Compute reaction term f(u,v)
87 // --------------------------------------
88 // if (m_spatialParameters->Exists("a"))
89 // {
90 // Vmath::Vmul(m_nq,
91 // &m_spatialParameters->GetData("a")->GetPhys()[0], 1,
92 // &inarray[0][0], 1, &m_tmp1[0], 1);
93 //
94 // Vmath::Vvtvm(m_nq,
95 // &m_spatialParameters->GetData("a")->GetPhys()[0], 1,
96 // &m_uu[0], 1, &m_tmp1[0], 1, &m_tmp1[0], 1);
97 //
98 // Vmath::Svtvm(m_nq, -1.0, &m_uu[0], 1, &m_tmp1[0], 1, &m_tmp1[0],
99 // 1);
100 // }
101 // else
102 // {
103 // Ru = au
104 Vmath::Smul(m_nq, m_a, &inarray[0][0], 1, &m_tmp1[0], 1);
105 // Ru = (-1-a)u*u + au
106 Vmath::Svtvp(m_nq, (-1.0 - m_a), &m_uu[0], 1, &m_tmp1[0], 1, &m_tmp1[0], 1);
107 // }
108 // Ru = u*u*u - (1+a)u*u + au
109 Vmath::Vadd(m_nq, &m_uuu[0], 1, &m_tmp1[0], 1, &m_tmp1[0], 1);
110 // Ru = k(u*u*u - (1+a)u*u + au)
111 // if (m_spatialParameters->Exists("k"))
112 // {
113 // Vmath::Vmul(m_nq,
114 // &m_spatialParameters->GetData("k")->GetPhys()[0], 1,
115 // &m_tmp1[0], 1, &m_tmp1[0], 1);
116 // }
117 // else
118 // {
119 Vmath::Smul(m_nq, m_k, &m_tmp1[0], 1, &m_tmp1[0], 1);
120 // }
121
122 // Ru = k(u*u*u - (1+a)u*u + au) + I_stim
123 Vmath::Vadd(m_nq, &outarray[0][0], 1, &m_tmp1[0], 1, &outarray[0][0], 1);
124
125 // Ru = k(u*u*u - (1+a)u*u + au) + uv + I_stim
126 Vmath::Vvtvp(m_nq, &inarray[0][0], 1, &inarray[1][0], 1, &m_tmp1[0], 1,
127 &outarray[0][0], 1);
128 // Ru = -k(u*u*u - (1+a)u*u + au) - uv - I_stim
129 Vmath::Neg(m_nq, &outarray[0][0], 1);
130
131 // --------------------------------------
132 // Compute reaction term g(u,v)
133 // --------------------------------------
134 // tmp2 = mu2 + u
135 Vmath::Sadd(m_nq, m_mu2, &inarray[0][0], 1, &m_tmp2[0], 1);
136
137 // tmp2 = v/(mu2 + u)
138 Vmath::Vdiv(m_nq, &inarray[1][0], 1, &m_tmp2[0], 1, &m_tmp2[0], 1);
139
140 // tmp2 = mu1*v/(mu2 + u)
141 Vmath::Smul(m_nq, m_mu1, &m_tmp2[0], 1, &m_tmp2[0], 1);
142
143 // tmp1 = Eps + mu1*v/(mu2+u)
144 Vmath::Sadd(m_nq, m_eps, &m_tmp2[0], 1, &m_tmp2[0], 1);
145
146 // tmp1 = (-a-1) + u
147 // if (m_spatialParameters->Exists("a"))
148 // {
149 // Vmath::Vsub(m_nq, &inarray[0][0], 1,
150 // &m_spatialParameters->GetData("a")->GetPhys()[0],
151 // 1, &m_tmp1[0], 1);
152 //
153 // Vmath::Sadd(m_nq, -1.0, &inarray[0][0], 1, &m_tmp1[0], 1);
154 // }
155 // else
156 // {
157 Vmath::Sadd(m_nq, (-m_a - 1), &inarray[0][0], 1, &m_tmp1[0], 1);
158 // }
159
160 // tmp1 = k(u-a-1)
161 // if (m_spatialParameters->Exists("k"))
162 // {
163 // Vmath::Vmul(m_nq,
164 // &m_spatialParameters->GetData("k")->GetPhys()[0], 1,
165 // &m_tmp1[0], 1, &m_tmp1[0], 1);
166 // }
167 // else
168 // {
169 Vmath::Smul(m_nq, m_k, &m_tmp1[0], 1, &m_tmp1[0], 1);
170 // }
171
172 // tmp1 = ku(u-a-1) + v
173 Vmath::Vvtvp(m_nq, &inarray[0][0], 1, &m_tmp1[0], 1, &inarray[1][0], 1,
174 &m_tmp1[0], 1);
175
176 // tmp1 = -ku(u-a-1)-v
177 Vmath::Neg(m_nq, &m_tmp1[0], 1);
178
179 // outarray = [Eps + mu1*v/(mu2+u)] * [-ku(u-a-1)-v]
180 Vmath::Vmul(m_nq, &m_tmp1[0], 1, &m_tmp2[0], 1, &outarray[1][0], 1);
181}
Vmath::Vmul
void Vmul(int n, const T *x, const int incx, const T *y, const int incy, T *z, const int incz)
Multiply vector z = x*y.
Definition: Vmath.hpp:72
Vmath::Svtvp
void Svtvp(int n, const T alpha, const T *x, const int incx, const T *y, const int incy, T *z, const int incz)
Svtvp (scalar times vector plus vector): z = alpha*x + y.
Definition: Vmath.hpp:396
Vmath::Neg
void Neg(int n, T *x, const int incx)
Negate x = -x.
Definition: Vmath.hpp:292
Vmath::Vvtvp
void Vvtvp(int n, const T *w, const int incw, const T *x, const int incx, const T *y, const int incy, T *z, const int incz)
vvtvp (vector times vector plus vector): z = w*x + y
Definition: Vmath.hpp:366
Vmath::Vadd
void Vadd(int n, const T *x, const int incx, const T *y, const int incy, T *z, const int incz)
Add vector z = x+y.
Definition: Vmath.hpp:180
Vmath::Smul
void Smul(int n, const T alpha, const T *x, const int incx, T *y, const int incy)
Scalar multiply y = alpha*x.
Definition: Vmath.hpp:100
Vmath::Vdiv
void Vdiv(int n, const T *x, const int incx, const T *y, const int incy, T *z, const int incz)
Multiply vector z = x/y.
Definition: Vmath.hpp:126
Vmath::Sadd
void Sadd(int n, const T alpha, const T *x, const int incx, T *y, const int incy)
Add vector y = alpha + x.
Definition: Vmath.hpp:194

References m_a, m_eps, m_k, m_mu1, m_mu2, Nektar::CellModel::m_nq, m_tmp1, m_tmp2, m_uu, m_uuu, Vmath::Neg(), Vmath::Sadd(), Vmath::Smul(), Vmath::Svtvp(), Vmath::Vadd(), Vmath::Vdiv(), Vmath::Vmul(), and Vmath::Vvtvp().

Member Data Documentation

◆ className

std::string Nektar::CellModelAlievPanfilov::className
static
Initial value:
=
GetCellModelFactory().RegisterCreatorFunction(
"AlievPanfilov", CellModelAlievPanfilov::create,
"Phenomological model of canine cardiac electrophysiology.")
Nektar::CellModelAlievPanfilov::create
static CellModelSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField)
Creates an instance of this class.
Definition: AlievPanfilov.h:47
Nektar::LibUtilities::NekFactory::RegisterCreatorFunction
tKey RegisterCreatorFunction(tKey idKey, CreatorFunction classCreator, std::string pDesc="")
Register a class with the factory.
Definition: NekFactory.hpp:197
Nektar::GetCellModelFactory
CellModelFactory & GetCellModelFactory()
Definition: CellModel.cpp:46

Name of class.

Registers the class with the Factory.

Definition at line 56 of file AlievPanfilov.h.

◆ m_a

NekDouble Nektar::CellModelAlievPanfilov::m_a
private

Trigger parameter a.

Definition at line 76 of file AlievPanfilov.h.

Referenced by CellModelAlievPanfilov(), v_GenerateSummary(), and v_Update().

◆ m_eps

NekDouble Nektar::CellModelAlievPanfilov::m_eps
private

Restitution parameter \(\epsilon\).

Definition at line 84 of file AlievPanfilov.h.

Referenced by CellModelAlievPanfilov(), v_GenerateSummary(), and v_Update().

◆ m_k

NekDouble Nektar::CellModelAlievPanfilov::m_k
private

Scaling parameter k.

Definition at line 78 of file AlievPanfilov.h.

Referenced by CellModelAlievPanfilov(), v_GenerateSummary(), and v_Update().

◆ m_mu1

NekDouble Nektar::CellModelAlievPanfilov::m_mu1
private

Restitution parameter \(\mu_1\).

Definition at line 80 of file AlievPanfilov.h.

Referenced by CellModelAlievPanfilov(), v_GenerateSummary(), and v_Update().

◆ m_mu2

NekDouble Nektar::CellModelAlievPanfilov::m_mu2
private

Restitution parameter \(\mu_2\).

Definition at line 82 of file AlievPanfilov.h.

Referenced by CellModelAlievPanfilov(), v_GenerateSummary(), and v_Update().

◆ m_tmp1

Array<OneD, NekDouble> Nektar::CellModelAlievPanfilov::m_tmp1
private

Workspace for computing reaction term.

Definition at line 91 of file AlievPanfilov.h.

Referenced by CellModelAlievPanfilov(), and v_Update().

◆ m_tmp2

Array<OneD, NekDouble> Nektar::CellModelAlievPanfilov::m_tmp2
private

Workspace for computing reaction term.

Definition at line 93 of file AlievPanfilov.h.

Referenced by CellModelAlievPanfilov(), and v_Update().

◆ m_uu

Array<OneD, NekDouble> Nektar::CellModelAlievPanfilov::m_uu
private

Temporary space for storing \(u^2\) when computing reaction term.

Definition at line 87 of file AlievPanfilov.h.

Referenced by CellModelAlievPanfilov(), and v_Update().

◆ m_uuu

Array<OneD, NekDouble> Nektar::CellModelAlievPanfilov::m_uuu
private

Temporary space for storing \(u^3\) when computing reaction term.

Definition at line 89 of file AlievPanfilov.h.

Referenced by CellModelAlievPanfilov(), and v_Update().

Generated on Wed Jan 31 2024 09:35:59 for Nektar++ by doxygen 1.9.4