Metric.h 3.05 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41
///////////////////////////////////////////////////////////////////////////////
//
// File: Metric.h
//
// For more information, please see: http://www.nektar.info
//
// The MIT License
//
// Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
// Department of Aeronautics, Imperial College London (UK), and Scientific
// Computing and Imaging Institute, University of Utah (USA).
//
// License for the specific language governing rights and limitations under
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
// Description: Definition of the metric base class.
//
///////////////////////////////////////////////////////////////////////////////

#ifndef NEKTAR_TESTS_METRIC_H
#define NEKTAR_TESTS_METRIC_H

#include <tinyxml/tinyxml.h>
#include <string>

42 43 44
#include <LibUtilities/BasicUtils/NekFactory.hpp>

namespace Nektar
45
{
46 47 48
    class Metric
    {
    public:
49
        Metric(TiXmlElement *metric, bool generate);
50
        
51
        /// Perform the test, given the standard output and error streams
52 53 54
        bool Test     (std::istream& pStdout, std::istream& pStderr);
        /// Perform the test, given the standard output and error streams
        void Generate (std::istream& pStdout, std::istream& pStderr);
55 56
        
    protected:
57
        /// Stores the ID of this metric.
58
        int m_id;
59 60
        /// Stores the type of this metric (uppercase).
        std::string m_type;
61 62 63
        /// 
        bool m_generate;
        TiXmlElement *m_metric;
64
        
65 66 67 68
        virtual bool v_Test     (std::istream& pStdout, 
                                 std::istream& pStderr) = 0;
        virtual void v_Generate (std::istream& pStdout, 
                                 std::istream& pSrderr) = 0;
69 70 71 72
    };

    /// A shared pointer to an EquationSystem object
    typedef boost::shared_ptr<Metric> MetricSharedPtr;
73
    
74 75
    /// Datatype of the NekFactory used to instantiate classes derived from the
    /// Advection class.
76 77
    typedef LibUtilities::NekFactory<std::string, Metric, TiXmlElement*, bool>
        MetricFactory;
78

79
    MetricFactory& GetMetricFactory();
80
}
81

82

83
#endif