Zoltan2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
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 
49 namespace Zoltan2{
50 
52 // Parameter-related namespace methods
53 
54 void createAllParameters(Teuchos::ParameterList &pList);
55 
57  const Teuchos::ParameterList &plIn, Teuchos::ParameterList &plOut);
58 
59 void 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 
87 };
88 
104 };
105 
118 enum TimerType {
125 };
126 
130 enum OSType {
135 };
136 
144 };
145 
146 } // end of namespace Zoltan2
147 
148 #endif
checks for logic errors
Time an algorithm (or other entity) as a whole.
fast typical checks for valid arguments
MessageOutputLevel
The amount of debugging or status output to print.
void createValidatorList(const Teuchos::ParameterList &plIn, Teuchos::ParameterList &plOut)
Create a list by adding validators to the users parameter list.
more involved, like validate a graph
TimerType
The type of timers which should be active.
/dev/null: do actions but don&#39;t output results
void createAllParameters(Teuchos::ParameterList &pList)
Create a list of all Zoltan2 parameters and validators.
void printListDocumentation(const Teuchos::ParameterList &pl, std::ostream &os, std::string listNames)
Time the substeps of an entity.
sub-steps, each method&#39;s entry and exit
Run both MACRO and MICRO timers.
AssertionLevel
Level of error checking or assertions desired.
no assertion checks will be done
OSType
Output stream types.
Timers added while testing, removed later.
don&#39;t display status/debug messages
the status at each high level step
Gathering definitions used in software development.
multiCriteriaNorm
Enumerator used in code for multicriteria norm choice.
include more detail about sub-steps
No timing data will be collected (the default).