Nektar++
CourtemancheRamirezNattel98.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File CourtemancheRamirezNattel.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: Courtemanche-Ramirez-Nattel cell model
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKTAR_SOLVERS_ADRSOLVER_EQUATIONSYSTEMS_COURTEMANCHE_H
37 #define NEKTAR_SOLVERS_ADRSOLVER_EQUATIONSYSTEMS_COURTEMANCHE_H
38 
40 
41 namespace Nektar
42 {
44  {
45 
46  public:
47  /// Creates an instance of this class
50  const MultiRegions::ExpListSharedPtr& pField)
51  {
53  ::AllocateSharedPtr(pSession, pField);
54  }
55 
56  /// Name of class
57  static std::string className;
58 
59  /// Constructor
62  const MultiRegions::ExpListSharedPtr& pField);
63 
64  /// Destructor
66 
67  protected:
68  /// Computes the reaction terms $f(u,v)$ and $g(u,v)$.
69  virtual void v_Update(
70  const Array<OneD, const Array<OneD, NekDouble> >&inarray,
71  Array<OneD, Array<OneD, NekDouble> >&outarray,
72  const NekDouble time);
73 
74  /// Prints a summary of the model parameters.
75  virtual void v_GenerateSummary(SummaryList& s);
76 
77  virtual void v_SetInitialConditions();
78 
79  virtual std::string v_GetCellVarName(unsigned int idx);
80 
81  private:
124 
125  enum Variants {
128  };
130 
131  static std::string lookupIds[];
132  static std::string def;
133  };
134 
135 }
136 
137 #endif
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.
virtual std::string v_GetCellVarName(unsigned int idx)
boost::shared_ptr< ExpList > ExpListSharedPtr
Shared pointer to an ExpList object.
Definition: ExpList.h:1340
static std::string className
Name of class.
double NekDouble
virtual void v_GenerateSummary(SummaryList &s)
Prints a summary of the model parameters.
CourtemancheRamirezNattel98(const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField)
Constructor.
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)$.