Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Fox02.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File FitzhughNagumo.cpp
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: FitzhughNagumo phenomological cell model.
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKTAR_SOLVERS_ADRSOLVER_EQUATIONSYSTEMS_FOX02_H
37 #define NEKTAR_SOLVERS_ADRSOLVER_EQUATIONSYSTEMS_FOX02_H
38 
40 namespace Nektar
41 {
42  class Fox02 : public CellModel
43  {
44 
45  public:
46  /// Creates an instance of this class
49  const MultiRegions::ExpListSharedPtr& pField)
50  {
51  return MemoryManager<Fox02>::AllocateSharedPtr(pSession, pField);
52  }
53 
54  /// Name of class
55  static std::string className;
56 
57  /// Constructor
59  const MultiRegions::ExpListSharedPtr& pField);
60 
61  /// Destructor
62  virtual ~Fox02() {}
63 
64  protected:
65  /// Computes the reaction terms $f(u,v)$ and $g(u,v)$.
66  virtual void v_Update(
67  const Array<OneD, const Array<OneD, NekDouble> >&inarray,
68  Array<OneD, Array<OneD, NekDouble> >&outarray,
69  const NekDouble time);
70  /// Prints a summary of the model parameters.
71  virtual void v_GenerateSummary(SummaryList& s);
72 
73  virtual void v_SetInitialConditions();
74 
75  private:
76  //
77  // Settable parameters and readable variables
78  //
81  };
82 
83 }
84 
85 #endif
static CellModelSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField)
Creates an instance of this class.
Definition: Fox02.h:47
virtual void v_Update(const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time)
Computes the reaction terms $f(u,v)$ and $g(u,v)$.
Definition: Fox02.cpp:81
NekDouble m_sigmai
Definition: Fox02.h:80
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
std::vector< std::pair< std::string, std::string > > SummaryList
Definition: Misc.h:47
Cell model base class.
Definition: CellModel.h:65
virtual void v_SetInitialConditions()
Definition: Fox02.cpp:423
virtual void v_GenerateSummary(SummaryList &s)
Prints a summary of the model parameters.
Definition: Fox02.cpp:414
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:51
boost::shared_ptr< CellModel > CellModelSharedPtr
A shared pointer to an EquationSystem object.
Definition: CellModel.h:56
Fox02(const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField)
Constructor.
Definition: Fox02.cpp:53
NekDouble m_chi
Definition: Fox02.h:79
boost::shared_ptr< ExpList > ExpListSharedPtr
Shared pointer to an ExpList object.
double NekDouble
static std::string className
Name of class.
Definition: Fox02.h:55
virtual ~Fox02()
Destructor.
Definition: Fox02.h:62