MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_SteepestDescentSolver_decl.hpp
Go to the documentation of this file.
1// @HEADER
2//
3// ***********************************************************************
4//
5// MueLu: A package for multigrid based preconditioning
6// Copyright 2012 Sandia Corporation
7//
8// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9// the U.S. Government retains certain rights in this software.
10//
11// Redistribution and use in source and binary forms, with or without
12// modification, are permitted provided that the following conditions are
13// met:
14//
15// 1. Redistributions of source code must retain the above copyright
16// notice, this list of conditions and the following disclaimer.
17//
18// 2. Redistributions in binary form must reproduce the above copyright
19// notice, this list of conditions and the following disclaimer in the
20// documentation and/or other materials provided with the distribution.
21//
22// 3. Neither the name of the Corporation nor the names of the
23// contributors may be used to endorse or promote products derived from
24// this software without specific prior written permission.
25//
26// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37//
38// Questions? Contact
39// Jonathan Hu (jhu@sandia.gov)
40// Andrey Prokopenko (aprokop@sandia.gov)
41// Ray Tuminaro (rstumin@sandia.gov)
42//
43// ***********************************************************************
44//
45// @HEADER
46#ifndef MUELU_STEEPESTDESCENTSOLVER_DECL_HPP
47#define MUELU_STEEPESTDESCENTSOLVER_DECL_HPP
48
49#include <Xpetra_Matrix_fwd.hpp>
50#include <Xpetra_MultiVector_fwd.hpp>
51#include <Xpetra_CrsMatrixWrap_fwd.hpp>
52#include <Xpetra_CrsMatrixFactory_fwd.hpp>
53
54
55#include "MueLu_ConfigDefs.hpp"
57#include "MueLu_SolverBase.hpp"
59
60
61namespace MueLu {
62
68 template <class Scalar = DefaultScalar,
71 class Node = DefaultNode>
72 class SteepestDescentSolver : public SolverBase<Scalar, LocalOrdinal, GlobalOrdinal, Node> {
73#undef MUELU_STEEPESTDESCENTSOLVER_SHORT
75
76 public:
78
79
84 SteepestDescentSolver(size_t Its, SC StepLength = Teuchos::ScalarTraits<Scalar>::one());
85
87
89
90
92 void Iterate(const Matrix& A, const Constraint& C, const Matrix& P0, RCP<Matrix>& P) const;
93
95
96 private:
97 size_t nIts_;
99 };
100
101} // namespace MueLu
102
103#define MUELU_STEEPESTDESCENTSOLVER_SHORT
104#endif // MUELU_STEEPESTDESCENTSOLVER_DECL_HPP
MueLu::DefaultLocalOrdinal LocalOrdinal
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
MueLu::DefaultNode Node
Constraint space information for the potential prolongator.
Base class for energy-minimization iterative solvers.
Implements steepest descent algorithm for energy-minimization.
size_t nIts_
Number of performed iterations.
void Iterate(const Matrix &A, const Constraint &C, const Matrix &P0, RCP< Matrix > &P) const
Iterate.
SC stepLength_
Modifier of the step length.
Namespace for MueLu classes and methods.
KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
Tpetra::Details::DefaultTypes::scalar_type DefaultScalar