Zoltan2
Loading...
Searching...
No Matches
Zoltan2_Parameters.hpp
Go to the documentation of this file.
1//
2// Zoltan2: A package of combinatorial algorithms for scientific computing
3// Copyright 2012 Sandia Corporation
4//
5// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
6// the U.S. Government retains certain rights in this software.
7//
8// Redistribution and use in source and binary forms, with or without
9// modification, are permitted provided that the following conditions are
10// met:
11//
12// 1. Redistributions of source code must retain the above copyright
13// notice, this list of conditions and the following disclaimer.
14//
15// 2. Redistributions in binary form must reproduce the above copyright
16// notice, this list of conditions and the following disclaimer in the
17// documentation and/or other materials provided with the distribution.
18//
19// 3. Neither the name of the Corporation nor the names of the
20// contributors may be used to endorse or promote products derived from
21// this software without specific prior written permission.
22//
23// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
24// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
26// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
27// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
28// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
29// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
30// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
31// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34//
35// Questions? Contact Karen Devine (kddevin@sandia.gov)
36// Erik Boman (egboman@sandia.gov)
37// Siva Rajamanickam (srajama@sandia.gov)
38//
39
44#ifndef _ZOLTAN2_PARAMETERS_HPP_
45#define _ZOLTAN2_PARAMETERS_HPP_
46
47#include <Zoltan2_Standards.hpp>
48
49namespace Zoltan2{
50
52// Parameter-related namespace methods
53
54void createAllParameters(Teuchos::ParameterList &pList);
55
57 const Teuchos::ParameterList &plIn, Teuchos::ParameterList &plOut);
58
59void printListDocumentation( const Teuchos::ParameterList &pl, std::ostream &os,
60 std::string listNames=std::string(""));
61
63// Parameter-related enumerated types.
64//
65// If you change these enumerators, change their documentation
66// in data/parameters.xml.
67//
68
88
105
126
136
145
146} // end of namespace Zoltan2
147
148#endif
Gathering definitions used in software development.
Created by mbenlioglu on Aug 31, 2020.
TimerType
The type of timers which should be active.
@ NO_TIMERS
No timing data will be collected (the default).
@ MACRO_TIMERS
Time an algorithm (or other entity) as a whole.
@ TEST_TIMERS
Timers added while testing, removed later.
@ MICRO_TIMERS
Time the substeps of an entity.
@ BOTH_TIMERS
Run both MACRO and MICRO timers.
MessageOutputLevel
The amount of debugging or status output to print.
@ BASIC_STATUS
the status at each high level step
@ DETAILED_STATUS
sub-steps, each method's entry and exit
@ NO_STATUS
don't display status/debug messages
@ VERBOSE_DETAILED_STATUS
include more detail about sub-steps
OSType
Output stream types.
@ CERR_STREAM
std::cerr
@ NULL_STREAM
/dev/null: do actions but don't output results
@ COUT_STREAM
std::cout
void printListDocumentation(const Teuchos::ParameterList &pl, std::ostream &os, std::string listNames)
AssertionLevel
Level of error checking or assertions desired.
@ BASIC_ASSERTION
fast typical checks for valid arguments
@ NO_ASSERTIONS
no assertion checks will be done
@ DEBUG_MODE_ASSERTION
checks for logic errors
@ COMPLEX_ASSERTION
more involved, like validate a graph
void createAllParameters(Teuchos::ParameterList &pList)
Create a list of all Zoltan2 parameters and validators.
multiCriteriaNorm
Enumerator used in code for multicriteria norm choice.
void createValidatorList(const Teuchos::ParameterList &plIn, Teuchos::ParameterList &plOut)
Create a list by adding validators to the users parameter list.