Nektar++
Laplace.cpp
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File: Laplace.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: Laplace solve routines
32 //
33 ///////////////////////////////////////////////////////////////////////////////
34 
36 
37 using namespace std;
38 
39 namespace Nektar
40 {
41 string Laplace::className = GetEquationSystemFactory().RegisterCreatorFunction(
42  "Laplace", Laplace::create);
43 
44 Laplace::Laplace(const LibUtilities::SessionReaderSharedPtr &pSession,
46  : EquationSystem(pSession, pGraph), m_factors()
47 {
50 }
51 
52 void Laplace::v_InitObject(bool DeclareFields)
53 {
54  EquationSystem::v_InitObject(DeclareFields);
55 }
56 
58 {
59 }
60 
62 {
64  SolverUtils::AddSummaryItem(s, "Lambda",
66 }
67 
69 {
70  for (int i = 0; i < m_fields.size(); ++i)
71  {
72  // Zero field so initial conditions are zero
73  Vmath::Zero(m_fields[i]->GetNcoeffs(), m_fields[i]->UpdateCoeffs(), 1);
74  m_fields[i]->HelmSolve(m_fields[i]->GetPhys(),
75  m_fields[i]->UpdateCoeffs(), m_factors);
76  m_fields[i]->SetPhysState(false);
77  }
78 }
79 
81 {
82  return Array<OneD, bool>(m_session->GetVariables().size(), true);
83 }
84 } // namespace Nektar
virtual ~Laplace()
Definition: Laplace.cpp:57
virtual void v_DoSolve() override
Virtual function for solve implementation.
Definition: Laplace.cpp:68
virtual void v_GenerateSummary(SolverUtils::SummaryList &s) override
Virtual function for generating summary information.
Definition: Laplace.cpp:61
virtual Array< OneD, bool > v_GetSystemSingularChecks() override
Definition: Laplace.cpp:80
virtual void v_InitObject(bool DeclareFields=true) override
Initialisation object for EquationSystem.
Definition: Laplace.cpp:52
StdRegions::ConstFactorMap m_factors
Definition: Laplace.h:65
tKey RegisterCreatorFunction(tKey idKey, CreatorFunction classCreator, std::string pDesc="")
Register a class with the factory.
Definition: NekFactory.hpp:198
A base class for describing how to solve specific equations.
SOLVER_UTILS_EXPORT void SessionSummary(SummaryList &vSummary)
Write out a session summary.
Array< OneD, MultiRegions::ExpListSharedPtr > m_fields
Array holding all dependent variables.
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 GetNcoeffs()
std::shared_ptr< SessionReader > SessionReaderSharedPtr
std::vector< std::pair< std::string, std::string > > SummaryList
Definition: Misc.h:48
EquationSystemFactory & GetEquationSystemFactory()
void AddSummaryItem(SummaryList &l, const std::string &name, const std::string &value)
Adds a summary item to the summary info list.
Definition: Misc.cpp:49
std::shared_ptr< MeshGraph > MeshGraphSharedPtr
Definition: MeshGraph.h:172
The above copyright notice and this permission notice shall be included.
Definition: CoupledSolver.h:2
void Zero(int n, T *x, const int incx)
Zero vector.
Definition: Vmath.cpp:492