Optika GUI Toolik Version of the Day
example/CustomFunctionExample/main.cpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 //         Optika: A Tool For Developing Parameter Obtaining GUIs
00005 //                Copyright (2009) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, with Sandia Corporation, the 
00008 // U.S. Government retains certain rights in this software.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Kurtis Nusbaum (klnusbaum@gmail.com) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 #include "Teuchos_ParameterList.hpp"
00042 #include "Teuchos_StandardParameterEntryValidators.hpp"
00043 #include "Teuchos_Array.hpp"  
00044 #include "Teuchos_Version.hpp"
00045 #include "Optika_GUI.hpp"
00046 #include "Teuchos_XMLParameterListHelpers.hpp"
00047 #include "Teuchos_FancyOStream.hpp"
00048 #include "Teuchos_VerboseObject.hpp"
00064 void customFunction(Teuchos::RCP<const Teuchos::ParameterList> currentParams);
00065 
00066 int main(int argc, char* argv[])
00067 {
00088   using Teuchos::RCP;
00089   using Teuchos::ParameterList;
00090   using Teuchos::StringValidator;
00091   using Teuchos::tuple;
00092   using Teuchos::Array;
00093   using Teuchos::rcp;
00094   RCP<ParameterList> My_List = rcp(new ParameterList);
00095 
00096   My_List->set(
00097     "Max Iters", 
00098     1550, 
00099     "Determines the maximum number of iterations in the solver");
00100   My_List->set(
00101     "Tolerance", 
00102     1e-10, 
00103     "The tolerance used for the convergence check");
00104   
00105   RCP<StringValidator> solverValidator = 
00106      rcp(new StringValidator(tuple<std::string>("GMRES", "CG", "TFQMR")));
00107   My_List->set( 
00108     "Solver", 
00109     "GMRES", 
00110     "The type of solver to use.", 
00111     solverValidator);
00112 
00113   Array<double> doubleArray( 10, 0.0 );
00114   My_List->set(
00115     "Initial Guess", 
00116     doubleArray, 
00117     "The initial guess as a RCP to an array object.");
00118 
00119   ParameterList& Prec_List = My_List->sublist(
00120     "Preconditioner",
00121     false,
00122     "Sublist that defines the preconditioner.");
00123 
00124   Prec_List.set("Type", "ILU", "The tpye of preconditioner to use");
00125   Prec_List.set(
00126     "Drop Tolerance",
00127     1e-3,
00128     "The tolerance below which entries from the "
00129     "factorization are left out of the factors.");
00130 
00137   Optika::getInput(My_List, Teuchos::null, &customFunction);
00138 
00139   RCP<Teuchos::FancyOStream> out = 
00140     Teuchos::VerboseObjectBase::getDefaultOStream();
00141   Teuchos::writeParameterListToXmlOStream(*My_List, *out);
00142   
00143   return 0;
00144 }
00145 
00157 void customFunction(Teuchos::RCP<const Teuchos::ParameterList> currentParams){
00158   std::cout << "The Solver Choosen was: " << 
00159     currentParams->get<std::string>("Solver") << std::endl;
00160 
00161   std::cout << "The Tolerence choosen was: " << 
00162     currentParams->get<double>("Tolerance") << std::endl; 
00163 
00164   std::cout << "The Preconditioner type was set to: " 
00165     << currentParams->sublist("Preconditioner").get<std::string>("Type") << 
00166     std::endl;
00167 }
00168 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Friends Defines