Ifpack Package Browser (Single Doxygen Collection) Development
Loading...
Searching...
No Matches
ifp_parameters.h
Go to the documentation of this file.
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#ifndef _ifp_parameters_h_
44#define _ifp_parameters_h_
45
46#include "Ifpack_config.h"
47
48#include <Ifpack_ConfigDefs.h>
49
50#include <Teuchos_map.hpp>
51#include <Teuchos_ParameterList.hpp>
52#include <Epetra_CombineMode.h>
53
54namespace Ifpack {
55
56//define enum values to which parameter names will be mapped.
58 //parameters of type double
64
65 //parameters of type int
66 //(if you add or remove int parameters, be sure to
67 //update FIRST_INT_PARAM and LAST_INT_PARAM macros below, as
68 //they are used below and in ifp_parameters.cpp)
72
73 //mixed type parameters
76};
77
78#define FIRST_INT_PARAM Ifpack::level_fill
79#define LAST_INT_PARAM Ifpack::num_steps
80
81//define struct with union of all Ifpack parameters
87};
88
89Teuchos::map<std::string,parameter>& key_map();
90
91// This was marked as IFPACK_DEPRECATED for a very long time,
92// but the function never went away and was still used in Ifpack.
93// Please consider it still marked as deprecated.
95
96std::string upper_case(const std::string& s);
97
98// This was marked as IFPACK_DEPRECATED for a very long time,
99// but the function never went away and was still used in Ifpack.
100// Please consider it still marked as deprecated.
101void set_parameters(const Teuchos::ParameterList& parameterlist,
102 param_struct& params,
103 bool cerr_warning_if_unused=false);
104
105}//namespace Ifpack
106
107#endif //_ifp_parameters_h_
108
Epetra_CombineMode
@ overlap_mode
@ absolute_threshold
@ level_overlap
@ relative_threshold
@ drop_tolerance
@ fill_tolerance
@ use_reciprocal
#define FIRST_INT_PARAM
#define LAST_INT_PARAM
void initialize_string_map()
std::string upper_case(const std::string &s)
Teuchos::map< std::string, parameter > & key_map()
void set_parameters(const Teuchos::ParameterList &parameterlist, param_struct &params, bool cerr_warning_if_unused)
Epetra_CombineMode overlap_mode
double double_params[FIRST_INT_PARAM]
int int_params[LAST_INT_PARAM-FIRST_INT_PARAM+1]