Nektar++
AdvectionSystem.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File AdvectionSystem.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: Advection system
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKTAR_SOLVERUTILS_ADVECTIONSYSTEM_H
37 #define NEKTAR_SOLVERUTILS_ADVECTIONSYSTEM_H
38 
41 
42 namespace Nektar {
43 namespace SolverUtils {
44 
45 /// A base class for PDEs which include an advection component
46 class AdvectionSystem: virtual public UnsteadySystem
47 {
48 public:
50  const LibUtilities::SessionReaderSharedPtr &pSession);
51 
53 
54  SOLVER_UTILS_EXPORT virtual void v_InitObject();
55 
56  /// Returns the advection object held by this instance.
58  {
59  return m_advObject;
60  }
61 
62 protected:
63  /// Advection term
65 };
66 
67 /// Shared pointer to an AdvectionSystem class
68 typedef boost::shared_ptr<AdvectionSystem> AdvectionSystemSharedPtr;
69 
70 }
71 }
72 
73 #endif
SolverUtils::AdvectionSharedPtr m_advObject
Advection term.
boost::shared_ptr< AdvectionSystem > AdvectionSystemSharedPtr
Shared pointer to an AdvectionSystem class.
boost::shared_ptr< Advection > AdvectionSharedPtr
A shared pointer to an Advection object.
Definition: Advection.h:158
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:50
Base class for unsteady solvers.
SOLVER_UTILS_EXPORT AdvectionSystem(const LibUtilities::SessionReaderSharedPtr &pSession)
#define SOLVER_UTILS_EXPORT
virtual SOLVER_UTILS_EXPORT void v_InitObject()
Init object for UnsteadySystem class.
A base class for PDEs which include an advection component.
virtual SOLVER_UTILS_EXPORT ~AdvectionSystem()
AdvectionSharedPtr GetAdvObject()
Returns the advection object held by this instance.