Nektar++
AlievPanfilov.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File AlievPanfilov.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: Aliev-Panfilov phenomological cell model.
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKTAR_SOLVERS_ADRSOLVER_CELLMODELS_ALIEVPANFILOV
37 #define NEKTAR_SOLVERS_ADRSOLVER_CELLMODELS_ALIEVPANFILOV
38 
40 
41 namespace Nektar
42 {
43  /// Aliev Panfilov model.
45  {
46  public:
47  /// Creates an instance of this class
49  const MultiRegions::ExpListSharedPtr& pField)
50  {
52  }
53 
54  /// Name of class
55  static std::string className;
56 
59  const MultiRegions::ExpListSharedPtr& pField);
60 
62 
63  protected:
64  virtual void v_Update(
65  const Array<OneD, const Array<OneD, NekDouble> >&inarray,
66  Array<OneD, Array<OneD, NekDouble> >&outarray,
67  const NekDouble time);
68 
69  virtual void v_GenerateSummary(SummaryList& s);
70 
71  virtual void v_SetInitialConditions();
72 
73  private:
74  /// Trigger parameter a.
76  /// Scaling parameter k.
78  /// Restitution parameter \f$\mu_1\f$.
80  /// Restitution parameter \f$\mu_2\f$.
82  /// Restitution parameter \f$\epsilon\f$.
84 
85  /// Temporary space for storing \f$u^2\f$ when computing reaction term.
87  /// Temporary space for storing \f$u^3\f$ when computing reaction term.
89  /// Workspace for computing reaction term.
91  /// Workspace for computing reaction term.
93  };
94 }
95 #endif /* ALIEVPANFILOV_H_ */
NekDouble m_a
Trigger parameter a.
Definition: AlievPanfilov.h:75
Array< OneD, NekDouble > m_uu
Temporary space for storing when computing reaction term.
Definition: AlievPanfilov.h:86
Array< OneD, NekDouble > m_tmp2
Workspace for computing reaction term.
Definition: AlievPanfilov.h:92
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
CellModelAlievPanfilov(const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField)
Aliev Panfilov model.
Definition: AlievPanfilov.h:44
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.
Definition: AlievPanfilov.h:48
boost::shared_ptr< ExpList > ExpListSharedPtr
Shared pointer to an ExpList object.
Definition: ExpList.h:1340
virtual void v_GenerateSummary(SummaryList &s)
double NekDouble
NekDouble m_eps
Restitution parameter .
Definition: AlievPanfilov.h:83
static std::string className
Name of class.
Definition: AlievPanfilov.h:55
NekDouble m_k
Scaling parameter k.
Definition: AlievPanfilov.h:77
NekDouble m_mu1
Restitution parameter .
Definition: AlievPanfilov.h:79
Array< OneD, NekDouble > m_tmp1
Workspace for computing reaction term.
Definition: AlievPanfilov.h:90
Array< OneD, NekDouble > m_uuu
Temporary space for storing when computing reaction term.
Definition: AlievPanfilov.h:88
NekDouble m_mu2
Restitution parameter .
Definition: AlievPanfilov.h:81
virtual void v_Update(const Array< OneD, const Array< OneD, NekDouble > > &inarray, Array< OneD, Array< OneD, NekDouble > > &outarray, const NekDouble time)