Nektar++
FitzhughNagumo.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File FitzhughNagumo.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 // License for the specific language governing rights and limitations under
14 // Permission is hereby granted, free of charge, to any person obtaining a
15 // copy of this software and associated documentation files (the "Software"),
16 // to deal in the Software without restriction, including without limitation
17 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
18 // and/or sell copies of the Software, and to permit persons to whom the
19 // Software is furnished to do so, subject to the following conditions:
20 //
21 // The above copyright notice and this permission notice shall be included
22 // in all copies or substantial portions of the Software.
23 //
24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
25 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
29 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
30 // DEALINGS IN THE SOFTWARE.
31 //
32 // Description: Fitzhugh-Nagumo phenomological cell model.
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKTAR_SOLVERS_ADRSOLVER_CELLMODELS_FITZHUGHNAGUMO
37 #define NEKTAR_SOLVERS_ADRSOLVER_CELLMODELS_FITZHUGHNAGUMO
38 
40 
41 namespace Nektar
42 {
43  /// FitzHugh-Nagumo model.
45  {
46  public:
47  /// Creates an instance of this class
50  const MultiRegions::ExpListSharedPtr& pField)
51  {
53  }
54 
55  /// Name of class
56  static std::string className;
57 
60  const MultiRegions::ExpListSharedPtr& pField);
61 
63 
64  protected:
65  virtual void v_Update(
66  const Array<OneD, const Array<OneD, NekDouble> >&inarray,
67  Array<OneD, Array<OneD, NekDouble> >&outarray,
68  const NekDouble time);
69 
70  virtual void v_GenerateSummary(SummaryList& s);
71 
72  virtual void v_SetInitialConditions();
73 
74  private:
77 
78  /// Temporary space for storing \f$u^3\f$ when computing reaction term.
80  };
81 }
82 #endif /* FITZHUGHNAGUMO_H_ */
Array< OneD, NekDouble > m_uuu
Temporary space for storing when computing reaction term.
virtual void v_Update(const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time)
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
Cell model base class.
Definition: CellModel.h:65
std::vector< std::pair< std::string, std::string > > SummaryList
Definition: CellModel.h:51
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:50
boost::shared_ptr< CellModel > CellModelSharedPtr
A shared pointer to an EquationSystem object.
Definition: CellModel.h:56
static CellModelSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField)
Creates an instance of this class.
boost::shared_ptr< ExpList > ExpListSharedPtr
Shared pointer to an ExpList object.
Definition: ExpList.h:1340
double NekDouble
static std::string className
Name of class.
virtual void v_GenerateSummary(SummaryList &s)
FitzHugh-Nagumo model.
CellModelFitzHughNagumo(const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField)