IFPACK Development
Loading...
Searching...
No Matches
Ifpack_CrsIlut.cpp
1/*@HEADER
2// ***********************************************************************
3//
4// Ifpack: Object-Oriented Algebraic Preconditioner Package
5// Copyright (2002) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38//
39// ***********************************************************************
40//@HEADER
41*/
42
43#include "Ifpack_CrsIlut.h"
44#include "Epetra_Comm.h"
45#include "Epetra_Map.h"
46#include "Epetra_CrsGraph.h"
47#include "Epetra_CrsMatrix.h"
48#include "Epetra_VbrMatrix.h"
49#include "Epetra_RowMatrix.h"
50#include "Epetra_Vector.h"
51#include "Epetra_MultiVector.h"
52
53#include <Teuchos_ParameterList.hpp>
54#include <ifp_parameters.h>
55
56//==============================================================================
57Ifpack_CrsIlut::Ifpack_CrsIlut(const Ifpack_OverlapGraph * OverlapGraph, double DropTol,
58 double FillTol)
59 : Epetra_Object("Ifpack::CrsIlut"),
61 Ifpack_OverlapFactorObject(OverlapGraph),
62 Ifpack_OverlapSolveObject(Epetra_Object::Label(), OverlapGraph->OverlapGraph().Comm()),
63 DropTol_(DropTol),
64 FillTol_(FillTol)
65{
66}
67//==============================================================================
68Ifpack_CrsIlut::Ifpack_CrsIlut(const Epetra_RowMatrix * UserMatrix, double DropTol,
69 double FillTol)
70 : Epetra_Object("Ifpack::CrsIlut"),
73 Ifpack_OverlapSolveObject(Epetra_Object::Label(), UserMatrix->Comm()),
74 DropTol_(DropTol),
75 FillTol_(FillTol)
76{
77}
78//==============================================================================
80 : Epetra_Object(Source),
81 Epetra_CompObject(Source),
84 DropTol_(Source.DropTol_),
85 FillTol_(Source.FillTol_)
86{
87}
88
89//==========================================================================
90int Ifpack_CrsIlut::SetParameters(const Teuchos::ParameterList& parameterlist,
91 bool cerr_warning_if_unused)
92{
94 params.double_params[Ifpack::fill_tolerance] = FillTol_;
95 params.double_params[Ifpack::drop_tolerance] = DropTol_;
96
97 Ifpack::set_parameters(parameterlist, params, cerr_warning_if_unused);
98
99 FillTol_ = params.double_params[Ifpack::fill_tolerance];
100 Droptol_ = params.double_params[Ifpack::drop_tolerance];
101
102 return(0);
103}
104
105//==============================================================================
107{
108
109 return(0);
110}
111//==============================================================================
113{
114
115 return(0);
116}
Ifpack_CrsIlut: ILUT preconditioner of a given Epetra_RowMatrix.
int ProcessOverlapMatrix(const Epetra_RowMatrix &A)
Processes the overlapped user matrix for computing the ILUT preconditioner.
Ifpack_CrsIlut(const Ifpack_OverlapGraph *OverlapGraph, double DropTol=1.0E-4, double FillTol=1.0)
Constructor using Ifpack_OverlapGraph.
int SetParameters(const Teuchos::ParameterList &parameterlist, bool cerr_warning_if_unused=false)
Set parameters using a Teuchos::ParameterList object.
int DerivedFactor()
Compute ILUT factors L and U: WARNING: THIS ROUTINE IS NOT USER CALLABLE, CALL Factor().
Ifpack_OverlapFactorObject: Supports functionality common to Ifpack overlap factorization classes.
Ifpack_OverlapGraph: Constructs a graph for use with Ifpack preconditioners.
Ifpack_OverlapSolveObject: Provides Overlapped Forward/back solve services for Ifpack.