Nektar++
solvers
ADRSolver
EquationSystems
SteadyAdvectionDiffusionReaction.h
Go to the documentation of this file.
1
///////////////////////////////////////////////////////////////////////////////
2
//
3
// File SteadyAdvectionDiffusionReaction.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
// Permission is hereby granted, free of charge, to any person obtaining a
14
// copy of this software and associated documentation files (the "Software"),
15
// to deal in the Software without restriction, including without limitation
16
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
17
// and/or sell copies of the Software, and to permit persons to whom the
18
// Software is furnished to do so, subject to the following conditions:
19
//
20
// The above copyright notice and this permission notice shall be included
21
// in all copies or substantial portions of the Software.
22
//
23
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
24
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
29
// DEALINGS IN THE SOFTWARE.
30
//
31
// Description: Steady advection-diffusion-reaction solve routines
32
//
33
///////////////////////////////////////////////////////////////////////////////
34
#ifndef NEKTAR_SOLVERS_ADRSOLVER_EQUATIONSYSTEMS_ADVECTIONDIFFUSIONREACTION_H
35
#define NEKTAR_SOLVERS_ADRSOLVER_EQUATIONSYSTEMS_ADVECTIONDIFFUSIONREACTION_H
36
37
#include <
ADRSolver/EquationSystems/SteadyAdvectionDiffusion.h
>
38
39
namespace
Nektar
40
{
41
class
SteadyAdvectionDiffusionReaction
:
public
SteadyAdvectionDiffusion
42
{
43
public
:
44
friend
class
MemoryManager
<
SteadyAdvectionDiffusionReaction
>;
45
46
/// Creates an instance of this class
47
static
EquationSystemSharedPtr
create
(
48
const
LibUtilities::SessionReaderSharedPtr
& pSession,
49
const
SpatialDomains::MeshGraphSharedPtr
& pGraph)
50
{
51
EquationSystemSharedPtr
p
=
MemoryManager<SteadyAdvectionDiffusionReaction>
52
::AllocateSharedPtr
(pSession, pGraph);
53
p
->InitObject();
54
return
p
;
55
}
56
57
/// Name of class
58
static
std::string
className
;
59
60
virtual
~SteadyAdvectionDiffusionReaction
();
61
62
protected
:
63
SteadyAdvectionDiffusionReaction
(
64
const
LibUtilities::SessionReaderSharedPtr
& pSession,
65
const
SpatialDomains::MeshGraphSharedPtr
& pGraph);
66
67
virtual
void
v_InitObject
();
68
69
virtual
void
v_GenerateSummary
(
SolverUtils::SummaryList
& s);
70
};
71
}
72
73
#endif
SteadyAdvectionDiffusion.h
Nektar::MemoryManager
General purpose memory allocation routines with the ability to allocate from thread specific memory p...
Definition:
NekMemoryManager.hpp:84
Nektar::MemoryManager::AllocateSharedPtr
static std::shared_ptr< DataType > AllocateSharedPtr(const Args &...args)
Allocate a shared pointer from the memory pool.
Definition:
NekMemoryManager.hpp:171
Nektar::SteadyAdvectionDiffusion
Definition:
SteadyAdvectionDiffusion.h:44
Nektar::SteadyAdvectionDiffusionReaction
Definition:
SteadyAdvectionDiffusionReaction.h:42
Nektar::SteadyAdvectionDiffusionReaction::v_InitObject
virtual void v_InitObject()
Initialisation object for EquationSystem.
Definition:
SteadyAdvectionDiffusionReaction.cpp:51
Nektar::SteadyAdvectionDiffusionReaction::create
static EquationSystemSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)
Creates an instance of this class.
Definition:
SteadyAdvectionDiffusionReaction.h:47
Nektar::SteadyAdvectionDiffusionReaction::~SteadyAdvectionDiffusionReaction
virtual ~SteadyAdvectionDiffusionReaction()
Definition:
SteadyAdvectionDiffusionReaction.cpp:62
Nektar::SteadyAdvectionDiffusionReaction::SteadyAdvectionDiffusionReaction
SteadyAdvectionDiffusionReaction(const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)
Definition:
SteadyAdvectionDiffusionReaction.cpp:44
Nektar::SteadyAdvectionDiffusionReaction::className
static std::string className
Name of class.
Definition:
SteadyAdvectionDiffusionReaction.h:58
Nektar::SteadyAdvectionDiffusionReaction::v_GenerateSummary
virtual void v_GenerateSummary(SolverUtils::SummaryList &s)
Virtual function for generating summary information.
Definition:
SteadyAdvectionDiffusionReaction.cpp:67
CellMLToNektar.cellml_metadata.p
p
Definition:
cellml_metadata.py:350
Nektar::LibUtilities::SessionReaderSharedPtr
std::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition:
SessionReader.h:120
Nektar::SolverUtils::SummaryList
std::vector< std::pair< std::string, std::string > > SummaryList
Definition:
Misc.h:46
Nektar::SolverUtils::EquationSystemSharedPtr
std::shared_ptr< EquationSystem > EquationSystemSharedPtr
A shared pointer to an EquationSystem object.
Definition:
EquationSystem.h:61
Nektar::SpatialDomains::MeshGraphSharedPtr
std::shared_ptr< MeshGraph > MeshGraphSharedPtr
Definition:
MeshGraph.h:174
Nektar
The above copyright notice and this permission notice shall be included.
Definition:
CoupledSolver.h:1
Generated on Wed Nov 24 2021 10:33:29 for Nektar++ by
1.9.1