MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_ConstraintFactory_def.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_CONSTRAINTFACTORY_DEF_HPP
47#define MUELU_CONSTRAINTFACTORY_DEF_HPP
48
49#include <Xpetra_MultiVector_fwd.hpp>
50#include <Xpetra_CrsGraph_fwd.hpp>
51
54
55#include "MueLu_Constraint.hpp"
56#include "MueLu_Monitor.hpp"
57
58namespace MueLu {
59
60 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
62 RCP<ParameterList> validParamList = rcp(new ParameterList());
63
64 validParamList->set< RCP<const FactoryBase> >("FineNullspace", Teuchos::null, "Generating factory for the nullspace");
65 validParamList->set< RCP<const FactoryBase> >("CoarseNullspace", Teuchos::null, "Generating factory for the nullspace");
66 validParamList->set< RCP<const FactoryBase> >("Ppattern", Teuchos::null, "Generating factory for the nonzero pattern");
67
68 return validParamList;
69 }
70
71 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
73 Input(fineLevel, "Nullspace", "FineNullspace");
74 Input(coarseLevel, "Nullspace", "CoarseNullspace");
75 Input(coarseLevel, "Ppattern");
76 }
77
78 template <class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
80 FactoryMonitor m(*this, "Constraint", coarseLevel);
81
82 RCP<MultiVector> fineNullspace = Get< RCP<MultiVector> >(fineLevel, "Nullspace", "FineNullspace");
83 RCP<MultiVector> coarseNullspace = Get< RCP<MultiVector> >(coarseLevel, "Nullspace", "CoarseNullspace");
84
85 RCP<Constraint> constraint(new Constraint);
86 constraint->Setup(*fineNullspace, *coarseNullspace,
87 Get< RCP<const CrsGraph> >(coarseLevel, "Ppattern"));
88
89 Set(coarseLevel, "Constraint", constraint);
90 }
91
92
93} // namespace MueLu
94
95#endif // MUELU_CONSTRAINTFACTORY_DEF_HPP
RCP< const ParameterList > GetValidParameterList() const
Return a const parameter list of valid parameters that setParameterList() will accept.
void Build(Level &fineLevel, Level &coarseLevel) const
Build method.
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Input.
Constraint space information for the potential prolongator.
Timer to be used in factories. Similar to Monitor but with additional timers.
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
Namespace for MueLu classes and methods.