Nektar++
FentonKarma.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File: FentonKarma.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: Fenton-Karma cell model
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKTAR_SOLVERS_ADRSOLVER_EQUATIONSYSTEMS_FENTONKARMA_H
37 #define NEKTAR_SOLVERS_ADRSOLVER_EQUATIONSYSTEMS_FENTONKARMA_H
38 
40 
41 namespace Nektar
42 {
43  class FentonKarma: public CellModel
44  {
45  public:
46  /// Creates an instance of this class
49  const MultiRegions::ExpListSharedPtr& pField)
50  {
52  ::AllocateSharedPtr(pSession, pField);
53  }
54 
55  /// Name of class
56  static std::string className;
57 
58  /// Constructor
61  const MultiRegions::ExpListSharedPtr& pField);
62 
63  /// Destructor
64  virtual ~FentonKarma();
65 
66  protected:
67  /// Computes the reaction terms $f(u,v)$ and $g(u,v)$.
68  virtual void v_Update(
69  const Array<OneD, const Array<OneD, NekDouble> >&inarray,
70  Array<OneD, Array<OneD, NekDouble> >&outarray,
71  const NekDouble time);
72 
73  /// Prints a summary of the model parameters.
74  virtual void v_GenerateSummary(SummaryList& s);
75 
76  virtual void v_SetInitialConditions();
77 
78  virtual std::string v_GetCellVarName(unsigned int idx);
79 
80  private:
102 
103  bool isCF3;
104 
105  enum Variants {
116  };
118 
119  static std::string lookupIds[];
120  static std::string def;
121  };
122 
123 }
124 
125 #endif
NekDouble tau_y_minus
Definition: FentonKarma.h:96
static std::string lookupIds[]
Definition: FentonKarma.h:119
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
virtual ~FentonKarma()
Destructor.
virtual void v_GenerateSummary(SummaryList &s)
Prints a summary of the model parameters.
Cell model base class.
Definition: CellModel.h:65
NekDouble tau_y_plus
Definition: FentonKarma.h:95
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
NekDouble tau_v1_minus
Definition: FentonKarma.h:89
FentonKarma(const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField)
Constructor.
Definition: FentonKarma.cpp:88
virtual void v_SetInitialConditions()
static CellModelSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const MultiRegions::ExpListSharedPtr &pField)
Creates an instance of this class.
Definition: FentonKarma.h:47
boost::shared_ptr< ExpList > ExpListSharedPtr
Shared pointer to an ExpList object.
Definition: ExpList.h:1340
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)$.
double NekDouble
NekDouble tau_w_plus
Definition: FentonKarma.h:101
NekDouble tau_v2_minus
Definition: FentonKarma.h:90
enum Variants model_variant
Definition: FentonKarma.h:117
NekDouble g_fi_max
Definition: FentonKarma.h:87
NekDouble tau_w_minus
Definition: FentonKarma.h:100
virtual std::string v_GetCellVarName(unsigned int idx)
NekDouble tau_v_plus
Definition: FentonKarma.h:91
static std::string className
Name of class.
Definition: FentonKarma.h:56
static std::string def
Definition: FentonKarma.h:120