opm-simulators/opm/simulators/linalg/linalgproperties.hh

// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
/*
  This file is part of the Open Porous Media project (OPM).

  OPM is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 2 of the License, or
  (at your option) any later version.

  OPM is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with OPM.  If not, see <http://www.gnu.org/licenses/>.

  Consult the COPYING file in the top-level source directory of this
  module for the precise wording of the license and the list of
  copyright holders.
*/
/*!
 * \file
 * \ingroup BlackOilModel
 *
 * \brief Declares the properties required by the black oil model.
 */
#ifndef EWOMS_LINALG_PROPERTIES_HH
#define EWOMS_LINALG_PROPERTIES_HH

#include <opm/models/utils/basicproperties.hh>

namespace Opm::Properties {

//! The type of the linear solver to be used
template<class TypeTag, class MyTypeTag>
struct LinearSolverBackend { using type = UndefinedProperty; };

//! the preconditioner used by the linear solver
template<class TypeTag, class MyTypeTag>
struct PreconditionerWrapper { using type = UndefinedProperty; };


//! The floating point type used internally by the linear solver
template<class TypeTag, class MyTypeTag>
struct LinearSolverScalar { using type = UndefinedProperty; };

/*!
 * \brief The size of the algebraic overlap of the linear solver.
 *
 * Algebraic overlaps can be thought as being the same as the overlap
 * of a grid, but it is only existant for the linear system of
 * equations.
 */
template<class TypeTag, class MyTypeTag>
struct LinearSolverOverlapSize { using type = UndefinedProperty; };

/*!
 * \brief Maximum accepted error of the solution of the linear solver.
 */
template<class TypeTag, class MyTypeTag>
struct LinearSolverTolerance { using type = UndefinedProperty; };

/*!
 * \brief Maximum accepted error of the norm of the residual.
 */
template<class TypeTag, class MyTypeTag>
struct LinearSolverAbsTolerance { using type = UndefinedProperty; };

/*!
 * \brief Specifies the verbosity of the linear solver
 *
 * By default it is 0, i.e. it doesn't print anything. Setting this
 * property to 1 prints aggregated convergence rates, 2 prints the
 * convergence rate of every iteration of the scheme.
 */
template<class TypeTag, class MyTypeTag>
struct LinearSolverVerbosity { using type = UndefinedProperty; };

//! Maximum number of iterations eyecuted by the linear solver
template<class TypeTag, class MyTypeTag>
struct LinearSolverMaxIterations { using type = UndefinedProperty; };

//! The order of the sequential preconditioner
template<class TypeTag, class MyTypeTag>
struct PreconditionerOrder { using type = UndefinedProperty; };

//! The relaxation factor of the preconditioner
template<class TypeTag, class MyTypeTag>
struct PreconditionerRelaxation { using type = UndefinedProperty; };

//! number of iterations between solver restarts for the GMRES solver
template<class TypeTag, class MyTypeTag>
struct GMResRestart { using type = UndefinedProperty; };

//! The class that allows to manipulate sparse matrices
template<class TypeTag, class MyTypeTag>
struct SparseMatrixAdapter { using type = UndefinedProperty; };

//! Vector containing a quantity of for equation for each DOF of the whole grid
template<class TypeTag, class MyTypeTag>
struct GlobalEqVector { using type = UndefinedProperty; };

template<class TypeTag, class MyTypeTag>
struct AmgCoarsenTarget { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct LinearSolverMaxError { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct LinearSolverWrapper { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct Overlap { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct OverlappingLinearOperator { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct OverlappingMatrix { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct OverlappingScalarProduct { using type = UndefinedProperty; };
template<class TypeTag, class MyTypeTag>
struct OverlappingVector { using type = UndefinedProperty; };

} // namespace Opm::Properties

#endif