solution_base.hpp

// Copyright (C) 2011-2012 by the BEM++ Authors
//
// 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.

#ifndef bempp_solution_base_hpp
#define bempp_solution_base_hpp

#include "bempp/common/config_trilinos.hpp"
#include "../common/common.hpp"

#include "../common/scalar_traits.hpp"

// TODO: support lack of trilinos
#ifdef WITH_TRILINOS
#include <Thyra_SolveSupportTypes.hpp>
#endif // WITH_TRILINOS

#include <string>

namespace Bempp
{

struct SolutionStatus {
    enum Status {
        CONVERGED,
        UNCONVERGED,
        UNKNOWN};
};

template <typename BasisFunctionType, typename ResultType>
class SolutionBase
{
public:
    typedef typename ScalarTraits<ResultType>::RealType MagnitudeType;

#ifdef WITH_TRILINOS

    explicit SolutionBase(const Thyra::SolveStatus<MagnitudeType> status);
#endif // WITH_TRILINOS

    explicit SolutionBase(SolutionStatus::Status status,
                          MagnitudeType achievedTolerance = unknownTolerance(),
                          std::string message = "");

    static MagnitudeType unknownTolerance() { return MagnitudeType(-1.); }

    SolutionStatus::Status status() const;

    MagnitudeType achievedTolerance() const;

    int iterationCount() const;

    std::string solverMessage() const;

#ifdef WITH_TRILINOS

    Teuchos::RCP<Teuchos::ParameterList> extraParameters() const;
#endif // WITH_TRILINOS

private:
    SolutionStatus::Status m_status;
    MagnitudeType m_achievedTolerance;
    std::string m_message;
    int m_iterationCount;
#ifdef WITH_TRILINOS
    Teuchos::RCP<Teuchos::ParameterList> m_extraParameters;
#endif // WITH_TRILINOS
};

} // namespace Bempp

#endif