Nektar++
SteadyAdvectionDiffusion.cpp
Go to the documentation of this file.
1/////////////////////////////////////////////////////////////////////////////////
2//
3// File: SteadyAdvectionDiffusion.cpp
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 solve routines
32//
33///////////////////////////////////////////////////////////////////////////////
34
36
37namespace Nektar
38{
39
42 "SteadyAdvectionDiffusion", SteadyAdvectionDiffusion::create);
43
44/**
45 * @class SteadyAdvectionDiffusion
46 * This is a solver class for solving the problems.
47 * - SteadyAdvectionDiffusion:
48 * \f$ c \cdot \nabla u -\nabla \cdot (\nabla u) = f(x)\f$
49 */
50
54 : EquationSystem(pSession, pGraph), m_lambda(0.0)
55{
56}
57
59{
60 EquationSystem::v_InitObject(DeclareFields);
61
62 m_session->LoadParameter("epsilon", m_epsilon, 1.0);
63
64 std::vector<std::string> vel;
65 vel.push_back("Vx");
66 vel.push_back("Vy");
67 vel.push_back("Vz");
68
69 // Resize the advection velocities vector to dimension of the problem
70 vel.resize(m_spacedim);
71
72 // Store in the global variable m_velocity the advection velocities
74 GetFunction("BaseFlow")->Evaluate(vel, m_velocity);
75}
76
78 [[maybe_unused]] SolverUtils::SummaryList &s)
79{
80}
81
83 [[maybe_unused]] bool dumpInitialConditions)
84{
85 // Set initial forcing from session file
86 GetFunction("Forcing")->Evaluate(m_session->GetVariables(), m_fields);
87}
88
90{
93
95
96 // Set advection velocities
100 for (int i = 0; i < m_spacedim; i++)
101 {
102 // Scale advection velocities by diffusion coefficient
103 Vmath::Smul(m_velocity[i].size(), 1.0 / m_epsilon, m_velocity[i], 1,
104 m_velocity[i], 1);
105 varcoeffs[varcoefftypes[i]] = m_velocity[i];
106 }
107
108 // Solve for velocity
109 for (int i = 0; i < m_fields.size(); ++i)
110 {
111 // Zero initial guess
112 Vmath::Zero(m_fields[i]->GetNcoeffs(), m_fields[i]->UpdateCoeffs(), 1);
113 // Scale forcing term by diffusion coefficient
115 m_fields[i]->GetPhys(), 1, m_fields[i]->UpdatePhys(), 1);
116 // Solve system
117 m_fields[i]->LinearAdvectionDiffusionReactionSolve(
118 m_fields[i]->GetPhys(), m_fields[i]->UpdateCoeffs(), factors,
119 varcoeffs);
120 m_fields[i]->SetPhysState(false);
121 }
122}
123
124} // namespace Nektar
tKey RegisterCreatorFunction(tKey idKey, CreatorFunction classCreator, std::string pDesc="")
Register a class with the factory.
A base class for describing how to solve specific equations.
int m_spacedim
Spatial dimension (>= expansion dim).
Array< OneD, MultiRegions::ExpListSharedPtr > m_fields
Array holding all dependent variables.
SOLVER_UTILS_EXPORT int GetNcoeffs()
virtual SOLVER_UTILS_EXPORT void v_InitObject(bool DeclareFeld=true)
Initialisation object for EquationSystem.
LibUtilities::SessionReaderSharedPtr m_session
The session reader.
SOLVER_UTILS_EXPORT int GetTotPoints()
SOLVER_UTILS_EXPORT SessionFunctionSharedPtr GetFunction(std::string name, const MultiRegions::ExpListSharedPtr &field=MultiRegions::NullExpListSharedPtr, bool cache=false)
Get a SessionFunction by name.
static std::string className
Name of class.
SteadyAdvectionDiffusion(const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)
void v_GenerateSummary(SolverUtils::SummaryList &s) override
Virtual function for generating summary information.
void v_InitObject(bool DeclareFields=true) override
Initialisation object for EquationSystem.
static EquationSystemSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)
Creates an instance of this class.
void v_DoInitialise(bool dumpInitialConditions=false) override
Virtual function for initialisation implementation.
Array< OneD, Array< OneD, NekDouble > > m_velocity
void v_DoSolve() override
Virtual function for solve implementation.
std::shared_ptr< SessionReader > SessionReaderSharedPtr
std::vector< std::pair< std::string, std::string > > SummaryList
Definition: Misc.h:46
EquationSystemFactory & GetEquationSystemFactory()
std::shared_ptr< MeshGraph > MeshGraphSharedPtr
Definition: MeshGraph.h:174
std::map< ConstFactorType, NekDouble > ConstFactorMap
Definition: StdRegions.hpp:430
std::map< StdRegions::VarCoeffType, VarCoeffEntry > VarCoeffMap
Definition: StdRegions.hpp:375
StdRegions::ConstFactorMap factors
void Smul(int n, const T alpha, const T *x, const int incx, T *y, const int incy)
Scalar multiply y = alpha*x.
Definition: Vmath.hpp:100
void Zero(int n, T *x, const int incx)
Zero vector.
Definition: Vmath.hpp:273