Nektar++
DriverStandard.cpp
Go to the documentation of this file.
1///////////////////////////////////////////////////////////////////////////////
2//
3// File: DriverStandard.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: Driver class for the standard solver
32//
33///////////////////////////////////////////////////////////////////////////////
34
35#include <iomanip>
36
39
40using namespace std;
41
42namespace Nektar::SolverUtils
43{
45 "Standard", DriverStandard::create);
48
49/**
50 *
51 */
55 : Driver(pSession, pGraph)
56{
57}
58
59/**
60 *
61 */
63{
65}
66
67/**
68 *
69 */
70void DriverStandard::v_Execute(ostream &out)
71
72{
74 NekDouble CPUtime;
75
76 m_equ[0]->PrintSummary(out);
77
78 timer.Start();
79
80 m_equ[0]->DoInitialise();
81 m_equ[0]->DoSolve();
82
83 timer.Stop();
84
85 m_equ[0]->Output();
86
87 if (m_comm->GetRank() == 0)
88 {
89 CPUtime = timer.Elapsed().count();
90 cout << "-------------------------------------------" << endl;
91 cout << "Total Computation Time = " << CPUtime << "s" << endl;
92 cout << "-------------------------------------------" << endl;
93 }
94
95 // Evaluate and output computation time and solution accuracy.
96 // The specific format of the error output is essential for the
97 // regression tests to work.
98
99 // Evaluate L2 Error
100 for (int i = 0; i < m_equ[0]->GetNvariables(); ++i)
101 {
102 Array<OneD, NekDouble> exactsoln(m_equ[0]->GetTotPoints(), 0.0);
103
104 // Evaluate "ExactSolution" function, or zero array
105 m_equ[0]->EvaluateExactSolution(i, exactsoln, m_equ[0]->GetTime());
106
107 NekDouble vL2Error = m_equ[0]->L2Error(i, exactsoln);
108 NekDouble vLinfError = m_equ[0]->LinfError(i, exactsoln);
109
110 if (m_comm->GetRank() == 0)
111 {
112 out << "L 2 error (variable " << m_equ[0]->GetVariable(i)
113 << ") : " << vL2Error << endl;
114 out << "L inf error (variable " << m_equ[0]->GetVariable(i)
115 << ") : " << vLinfError << endl;
116 }
117 }
118}
119} // namespace Nektar::SolverUtils
tKey RegisterCreatorFunction(tKey idKey, CreatorFunction classCreator, std::string pDesc="")
Register a class with the factory.
static std::string RegisterEnumValue(std::string pEnum, std::string pString, int pEnumValue)
Registers an enumeration value.
Base class for the development of solvers.
Definition: Driver.h:65
virtual SOLVER_UTILS_EXPORT void v_InitObject(std::ostream &out=std::cout)
Virtual function for initialisation implementation.
Definition: Driver.cpp:84
LibUtilities::CommSharedPtr m_comm
Communication object.
Definition: Driver.h:80
Array< OneD, EquationSystemSharedPtr > m_equ
Equation system to solve.
Definition: Driver.h:92
static std::string className
Name of the class.
SOLVER_UTILS_EXPORT void v_InitObject(std::ostream &out=std::cout) override
Virtual function for initialisation implementation.
SOLVER_UTILS_EXPORT void v_Execute(std::ostream &out=std::cout) override
Virtual function for solve implementation.
SOLVER_UTILS_EXPORT DriverStandard(const LibUtilities::SessionReaderSharedPtr pSession, const SpatialDomains::MeshGraphSharedPtr pGraph)
Constructor.
static DriverSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession, const SpatialDomains::MeshGraphSharedPtr &pGraph)
Creates an instance of this class.
std::shared_ptr< SessionReader > SessionReaderSharedPtr
DriverFactory & GetDriverFactory()
Definition: Driver.cpp:66
std::shared_ptr< MeshGraph > MeshGraphSharedPtr
Definition: MeshGraph.h:174
double NekDouble
STL namespace.