trilinos_preconditioner.h

浏览该文件的文档.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2023 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

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

// This library 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
// Lesser General Public License for more details.

// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA



#ifndef LIBMESH_TRILINOS_PRECONDITIONER_H
#define LIBMESH_TRILINOS_PRECONDITIONER_H

#include "libmesh/libmesh_config.h"

#ifdef LIBMESH_TRILINOS_HAVE_EPETRA

// Local includes
#include "libmesh/preconditioner.h"
#include "libmesh/libmesh_common.h"
#include "libmesh/reference_counted_object.h"
#include "libmesh/libmesh.h"

// Trilinos includes.  Ignore many unused parameter warnings coming
// from these headers.
#include "libmesh/ignore_warnings.h"
#include "Epetra_Operator.h"
#include "Epetra_FECrsMatrix.h"
#include "Teuchos_ParameterList.hpp"
#include "libmesh/restore_warnings.h"

// C++ includes
#include <cstddef>

namespace libMesh
{

// forward declarations
template <typename T> class SparseMatrix;
template <typename T> class NumericVector;
template <typename T> class ShellMatrix;
enum PreconditionerType : int;

template <typename T>
class TrilinosPreconditioner :
    public Preconditioner<T>,
    public Epetra_Operator
{
public:

  TrilinosPreconditioner (const libMesh::Parallel::Communicator & comm);

  virtual ~TrilinosPreconditioner ();

  virtual void apply(const NumericVector<T> & x, NumericVector<T> & y) override;

  virtual void clear () override {}

  virtual void init () override;

  void set_params(Teuchos::ParameterList & list);

  Epetra_FECrsMatrix * mat() { return _mat; }

  void set_preconditioner_type (const PreconditionerType & preconditioner_type);

  void compute();

protected:

  Epetra_Operator * _prec;

  Epetra_FECrsMatrix * _mat;

  Teuchos::ParameterList _param_list;

  // Epetra_Operator 接口

  // 设置是否使用转置操作
  virtual int SetUseTranspose(bool UseTranspose) override;

  // 应用操作将输入向量 X 映射到输出向量 Y
  virtual int Apply(const Epetra_MultiVector & X, Epetra_MultiVector & Y) const override;

  // 应用操作的逆操作，将输入向量 r 映射到输出向量 z
  virtual int ApplyInverse(const Epetra_MultiVector & r, Epetra_MultiVector & z) const override;

  // 计算操作的无穷范数
  virtual double NormInf() const override;

  // 返回操作的标签
  virtual const char * Label() const override;

  // 返回是否使用了转置操作
  virtual bool UseTranspose() const override;

  // 返回操作的无穷范数是否可用
  virtual bool HasNormInf() const override;

  // 返回操作的通信器
  virtual const Epetra_Comm & Comm() const override;

  // 返回操作的定义域映射
  virtual const Epetra_Map & OperatorDomainMap() const override;

  // 返回操作的值域映射
  virtual const Epetra_Map & OperatorRangeMap() const override;
};




/*----------------------- inline functions ----------------------------------*/
template <typename T>
inline
TrilinosPreconditioner<T>::TrilinosPreconditioner (const libMesh::Parallel::Communicator & comm) :
  Preconditioner<T>(comm),
  _prec(nullptr),
  _mat(nullptr)
{
}



template <typename T>
inline
TrilinosPreconditioner<T>::~TrilinosPreconditioner ()
{
  this->clear ();
}

} // namespace libMesh

#endif // LIBMESH_TRILINOS_HAVE_EPETRA
#endif // LIBMESH_TRILINOS_PRECONDITIONER_H