Nektar++
MetricPrecon.h
Go to the documentation of this file.
1///////////////////////////////////////////////////////////////////////////////
2//
3// File: MetricPrecon.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: Definition of the preconditioner metric.
32//
33///////////////////////////////////////////////////////////////////////////////
34
35#ifndef NEKTAR_TESTS_METRICPRECON_H
36#define NEKTAR_TESTS_METRICPRECON_H
37
38#include <MetricRegex.h>
39#include <map>
40
41namespace Nektar
42{
44{
45public:
46 static MetricSharedPtr create(TiXmlElement *metric, bool generate)
47 {
48 return MetricSharedPtr(new MetricPrecon(metric, generate));
49 }
50
51 static std::string type;
52 static std::string defaultTolerance;
53
54protected:
55 MetricPrecon(TiXmlElement *metric, bool generate);
56
57 std::string m_varTolerance;
58
59 void v_Generate(std::istream &pStdout, std::istream &pStderr) override;
60};
61} // namespace Nektar
62
63#endif
void v_Generate(std::istream &pStdout, std::istream &pStderr) override
Virtual function to generate the metric. Should be redefined in derived classes.
std::string m_varTolerance
Definition: MetricPrecon.h:57
static std::string defaultTolerance
Definition: MetricPrecon.h:52
MetricPrecon(TiXmlElement *metric, bool generate)
static MetricSharedPtr create(TiXmlElement *metric, bool generate)
Definition: MetricPrecon.h:46
static std::string type
Definition: MetricPrecon.h:51
std::shared_ptr< Metric > MetricSharedPtr
A shared pointer to an EquationSystem object.
Definition: Metric.h:124