MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu_TwoLevelMatlabFactory_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_TWOLEVELMATLABFACTORY_DECL_HPP
47#define MUELU_TWOLEVELMATLABFACTORY_DECL_HPP
48
49#include <string>
50
51#include <Xpetra_Matrix_fwd.hpp>
52#include <Xpetra_CrsMatrix_fwd.hpp>
53#include <Xpetra_MatrixFactory_fwd.hpp>
54#include <Xpetra_Vector_fwd.hpp>
55#include <Xpetra_VectorFactory_fwd.hpp>
56
57#include "MueLu_ConfigDefs.hpp"
59
61#include "MueLu_Level_fwd.hpp"
65
66#ifdef HAVE_MUELU_MATLAB
67#include "mex.h"
68
69
70namespace MueLu {
76 template <class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
78#undef MUELU_TWOLEVELMATLABFACTORY_SHORT
80
81 public:
83
84
86
88
90
92
93 RCP<const ParameterList> GetValidParameterList() const;
94
95 void DeclareInput(Level& fineLevel, Level& coarseLevel) const;
96
98
100
101 void Build(Level& fineLevel, Level& coarseLevel) const;
103
105
106 std::string description() const;
108 private:
110
111 mutable bool hasDeclaredInput_;
112
114
116
118 mutable std::vector<std::string> needsFine_;
119
121 mutable std::vector<std::string> needsCoarse_;
122
124
125 }; //class TwoLevelMatlabFactory
126
127} //namespace MueLu
128
129#define MUELU_TWOLEVELMATLABFACTORY_SHORT
130
131#endif // HAVE_MUELU_MATLAB
132#endif // MUELU TWOLEVELMATLABFACTORY_DECL_HPP
Class that holds all level-specific information.
Definition: MueLu_Level.hpp:99
Base class for factories that use two levels (fineLevel and coarseLevel).
Factory for interacting with Matlab.
std::string description() const
@ name Description
std::vector< std::string > needsCoarse_
List of arguments to the MATLAB function, in order. These args must correspond to MueLu "Needs" objec...
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 an object with this factory.
std::vector< std::string > needsFine_
List of arguments to the MATLAB function, in order. These args must correspond to MueLu "Needs" objec...
void DeclareInput(Level &fineLevel, Level &coarseLevel) const
Input.
Namespace for MueLu classes and methods.