Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Stokhos_MLPreconditionerFactory.cpp
Go to the documentation of this file.
1// @HEADER
2// ***********************************************************************
3//
4// Stokhos Package
5// Copyright (2009) 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 Eric T. Phipps (etphipp@sandia.gov).
38//
39// ***********************************************************************
40// @HEADER
41
42#include "Stokhos_ConfigDefs.h"
44#include "Epetra_RowMatrix.h"
45#include "Epetra_CrsMatrix.h"
46#include "Teuchos_Assert.hpp"
47#ifdef HAVE_STOKHOS_ML
48#include "ml_include.h"
49#include "ml_MultiLevelPreconditioner.h"
50#endif
51
53MLPreconditionerFactory(const Teuchos::RCP<Teuchos::ParameterList>& p) :
54 precParams(p)
55{
56#ifdef HAVE_STOKHOS_ML
57 // Set default parameters
58 if (precParams->isType<std::string>("default values")) {
59 Teuchos::ParameterList ml_defaults;
60 ML_Epetra::SetDefaults(precParams->get<std::string>("default values"),
61 ml_defaults);
62 precParams->setParametersNotAlreadySet(ml_defaults);
63 }
64#endif
65}
66
67Teuchos::RCP<Epetra_Operator>
69compute(const Teuchos::RCP<Epetra_Operator>& op, bool compute_prec) {
70#ifdef HAVE_STOKHOS_ML
71 Teuchos::RCP<Epetra_RowMatrix> mat =
72 Teuchos::rcp_dynamic_cast<Epetra_RowMatrix>(op, true);
73 Teuchos::RCP<ML_Epetra::MultiLevelPreconditioner> ml_prec =
74 Teuchos::rcp(new ML_Epetra::MultiLevelPreconditioner(*mat, *precParams,
75 compute_prec));
76 //ml_prec->PrintUnused(0);
77 return ml_prec;
78#else
79 TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
80 "Stokhos::MLPreconditionerFactory is available " <<
81 "only with configured with ML support!");
82 return Teuchos::null;
83#endif // HAVE_STOKHOS_ML
84}
85
86void
88recompute(const Teuchos::RCP<Epetra_Operator>& op,
89 const Teuchos::RCP<Epetra_Operator>& prec_op) {
90#ifdef HAVE_STOKHOS_ML
91 // Copy matrix represented by "op" into underlying matrix in ML
92 Teuchos::RCP<Epetra_CrsMatrix> mat =
93 Teuchos::rcp_dynamic_cast<Epetra_CrsMatrix>(op, true);
94 Teuchos::RCP<ML_Epetra::MultiLevelPreconditioner> ml_prec =
95 Teuchos::rcp_dynamic_cast<ML_Epetra::MultiLevelPreconditioner>(prec_op);
96 const Epetra_RowMatrix& prec_mat = ml_prec->RowMatrix();
97 const Epetra_CrsMatrix& prec_crs_mat =
98 dynamic_cast<const Epetra_CrsMatrix&>(prec_mat);
99 Epetra_CrsMatrix& non_const_prec_crs_mat =
100 const_cast<Epetra_CrsMatrix&>(prec_crs_mat);
101 non_const_prec_crs_mat = *mat;
102
103 // Compute preconditioner
104 ml_prec->ComputePreconditioner();
105#else
106 TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error,
107 "Stokhos::MLPreconditionerFactory is available " <<
108 "only with configured with ML support!");
109#endif // HAVE_STOKHOS_ML
110}
MLPreconditionerFactory(const Teuchos::RCP< Teuchos::ParameterList > &p)
Constructor.
Teuchos::RCP< Teuchos::ParameterList > precParams
Preconditioner parameters.
virtual Teuchos::RCP< Epetra_Operator > compute(const Teuchos::RCP< Epetra_Operator > &op, bool compute_prec=true)
Compute preconditioner.
virtual void recompute(const Teuchos::RCP< Epetra_Operator > &op, const Teuchos::RCP< Epetra_Operator > &prec)
Recompute preconditioner operator for a new matrix.