Kokkos Node API and Local Linear Algebra Kernels Version of the Day
Kokkos_OpenMPNode.cpp
00001 //@HEADER
00002 // ************************************************************************
00003 //
00004 //          Kokkos: Node API and Parallel Node Kernels
00005 //              Copyright (2008) Sandia Corporation
00006 //
00007 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00008 // the 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 Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ************************************************************************
00040 //@HEADER
00041 
00042 #include <Teuchos_ParameterList.hpp>
00043 #include "Kokkos_OpenMPNode.hpp"
00044 
00045 namespace Kokkos {
00046 
00047   OpenMPNode::OpenMPNode () :
00048     curNumThreads_ (-1), // Default: Let OpenMP pick the number of threads
00049     verbose_ (false) // Default: No verbose status output
00050   {
00051     init (curNumThreads_);
00052   }
00053 
00054 
00055   OpenMPNode::OpenMPNode (Teuchos::ParameterList &pl) :
00056     curNumThreads_ (-1), // Default: Let OpenMP pick the number of threads
00057     verbose_ (false) // Default: No verbose status output
00058   {
00059     // Don't set state (in this case, curNumThreads_) until we've read
00060     // in all the parameters.
00061     //
00062     // -1 or 0 mean let OpenMP pick the number of threads.  A positive
00063     // value means that we should tell OpenMP how many threads to use.
00064     const int curNumThreads = pl.get<int>("Num Threads", -1);
00065     //
00066     // We allow the "Verbose" parameter to be either bool or int.
00067     // It's really a Boolean value (verbose or not), but the original
00068     // author used int and this has been around for a while, so we
00069     // keep this option for backwards compatibility.
00070     //
00071     bool verbose = false; // Default value of the "Verbose" parameter.
00072     try {
00073       verbose = pl.get<bool> ("Verbose"); // Is it a bool?
00074     }
00075     catch (Teuchos::Exceptions::InvalidParameterName&) {
00076       // "Verbose" isn't a parameter in the input list; use the
00077       // default value.  We catch InvalidParameterName first so that
00078       // we don't bother trying for the int value of the "Verbose"
00079       // parameter if there's no "Verbose" parameter at all.
00080     }
00081     catch (Teuchos::Exceptions::InvalidParameterType&) {
00082       try {
00083         int verboseInt = pl.get<int> ("Verbose"); // Is it an int?
00084         verbose = (verboseInt != 0);
00085       }
00086       catch (Teuchos::Exceptions::InvalidParameterName&) {
00087         // This should be impossible.
00088         TEUCHOS_TEST_FOR_EXCEPTION(true, std::logic_error, "Kokkos::OpenMPNode "
00089           "constructor: should never get here!  \"Verbose\" is both a parameter "
00090           "and not a parameter in the input ParameterList.  Please report this "
00091           "bug to the Kokkos developers.");
00092       }
00093       catch (Teuchos::Exceptions::InvalidParameterType&) {
00094         // "Verbose" parameter exists, but is neither a bool nor an int.
00095         TEUCHOS_TEST_FOR_EXCEPTION(true, std::invalid_argument, "Kokkos::"
00096           "OpenMPNode constructor: If you provide a \"Verbose\" parameter, it "
00097           "must be either of type bool or of type int.");
00098       }
00099     }
00100 
00101     if (verbose) {
00102       std::cout << "OpenMPNode initializing with \"Num Threads\" = "
00103                 << curNumThreads << std::endl;
00104     }
00105     init (curNumThreads);
00106     curNumThreads_ = curNumThreads; // Now it's safe to set state.
00107     verbose_ = verbose;
00108   }
00109 
00110   OpenMPNode::~OpenMPNode() {}
00111 
00112   void OpenMPNode::init (int numThreads) {
00113     // mfh 10 Jul 2012: Don't set the number of threads if it's
00114     // negative (the default value of the "Num Threads" parameter is
00115     // -1) or 0.
00116     if (numThreads > 0) {
00117       omp_set_num_threads (numThreads);
00118     }
00119   }
00120 
00121 }
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends