IterationPack: General framework for building iterative algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IterationPack_AlgorithmSetOptions.cpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) 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 Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #include <assert.h>
43 
44 #include "IterationPack_AlgorithmSetOptions.hpp"
45 #include "Teuchos_Assert.hpp"
46 
47 // Define the options
48 namespace {
49 
50 const int local_num_options = 1;
51 
52 enum local_EOptions {
53  INTERRUPT_FILE_NAME
54 };
55 
56 const char* local_SOptions[local_num_options] = {
57  "interrupt_file_name"
58 };
59 
60 inline
61 std::string remove_quotes( const std::string &option_name, const std::string &str )
62 {
64  str[0]!='\"' || str[str.length()-1]!='\"', std::logic_error
65  ,"Error, the option \'" << option_name << "\' must have a single set of quotes around it!"
66  );
67  if(str.length()==2)
68  return std::string("");
69  return str.substr(1,str.length()-2);
70 }
71 
72 } // namespace
73 
74 namespace IterationPack {
75 
77  Algorithm* target
78  , const char opt_grp_name[] )
79  : OptionsFromStreamPack::SetOptionsFromStreamNode(
80  opt_grp_name, local_num_options, local_SOptions )
81  , OptionsFromStreamPack::SetOptionsToTargetBase<
82  Algorithm >( target )
83 {}
84 
86  int option_num, const std::string& option_value )
87 {
88  typedef Algorithm target_t;
89  switch( (local_EOptions)option_num ) {
90  case INTERRUPT_FILE_NAME :
91  target().interrupt_file_name(remove_quotes("interrupt_file_name",option_value));
92  break;
93  default:
94  TEUCHOS_TEST_FOR_EXCEPT(true); // Local error only?
95  }
96 }
97 
98 } // end namespace IterationPack
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
AlgorithmSetOptions(Algorithm *target=0, const char opt_grp_name[]="IterationPack_Algorithm")
Acts as the central hub for an iterative algorithm.
void setOption(int option_num, const std::string &option_value)
Overridden from SetOptionsFromStreamNode.
#define TEUCHOS_TEST_FOR_EXCEPT(throw_exception_test)