Nektar++
LuoRudy91.h
Go to the documentation of this file.
1///////////////////////////////////////////////////////////////////////////////
2//
3// File: LuoRudy91.h
4//
5// For more information, please see: http://www.nektar.info
6//
7// The MIT License
8//
9// Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
10// Department of Aeronautics, Imperial College London (UK), and Scientific
11// Computing and Imaging Institute, University of Utah (USA).
12//
13// Permission is hereby granted, free of charge, to any person obtaining a
14// copy of this software and associated documentation files (the "Software"),
15// to deal in the Software without restriction, including without limitation
16// the rights to use, copy, modify, merge, publish, distribute, sublicense,
17// and/or sell copies of the Software, and to permit persons to whom the
18// Software is furnished to do so, subject to the following conditions:
19//
20// The above copyright notice and this permission notice shall be included
21// in all copies or substantial portions of the Software.
22//
23// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
24// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
29// DEALINGS IN THE SOFTWARE.
30//
31// Description: Luo-Rudy 1991 cell model
32//
33///////////////////////////////////////////////////////////////////////////////
34
35#ifndef NEKTAR_SOLVERS_ADRSOLVER_EQUATIONSYSTEMS_LUO_RUDY_91_H
36#define NEKTAR_SOLVERS_ADRSOLVER_EQUATIONSYSTEMS_LUO_RUDY_91_H
37
39namespace Nektar
40{
41class LuoRudy91 : public CellModel
42{
43
44public:
45 /// Creates an instance of this class
49 {
50 return MemoryManager<LuoRudy91>::AllocateSharedPtr(pSession, pField);
51 }
52
53 /// Name of class
54 static std::string className;
55
56 /// Constructor
58 const MultiRegions::ExpListSharedPtr &pField);
59
60 /// Destructor
61 ~LuoRudy91() override
62 {
63 }
64
65protected:
66 /// Computes the reaction terms $f(u,v)$ and $g(u,v)$.
67 void v_Update(const Array<OneD, const Array<OneD, NekDouble>> &inarray,
69 const NekDouble time) override;
70
71 /// Prints a summary of the model parameters.
72 void v_GenerateSummary(SummaryList &s) override;
73
74 /// Set initial conditions for the cell model
75 void v_SetInitialConditions() override;
76};
77} // namespace Nektar
78
79#endif
Cell model base class.
Definition: CellModel.h:66
~LuoRudy91() override
Destructor.
Definition: LuoRudy91.h:61
static CellModelSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField)
Creates an instance of this class.
Definition: LuoRudy91.h:46
void v_SetInitialConditions() override
Set initial conditions for the cell model.
Definition: LuoRudy91.cpp:550
void v_Update(const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time) override
Computes the reaction terms $f(u,v)$ and $g(u,v)$.
Definition: LuoRudy91.cpp:77
LuoRudy91(const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField)
Constructor.
Definition: LuoRudy91.cpp:61
void v_GenerateSummary(SummaryList &s) override
Prints a summary of the model parameters.
Definition: LuoRudy91.cpp:542
static std::string className
Name of class.
Definition: LuoRudy91.h:54
static std::shared_ptr< DataType > AllocateSharedPtr(const Args &...args)
Allocate a shared pointer from the memory pool.
std::shared_ptr< SessionReader > SessionReaderSharedPtr
std::shared_ptr< ExpList > ExpListSharedPtr
Shared pointer to an ExpList object.
std::vector< std::pair< std::string, std::string > > SummaryList
Definition: Misc.h:46
std::shared_ptr< CellModel > CellModelSharedPtr
A shared pointer to an EquationSystem object.
Definition: CellModel.h:55
double NekDouble