//@HEADER
// ************************************************************************
//
//            NOX: An Object-Oriented Nonlinear Solver Package
//                 Copyright (2002) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roger Pawlowski (rppawlo@sandia.gov) or
// Eric Phipps (etphipp@sandia.gov), Sandia National Laboratories.
// ************************************************************************
//  CVS Information
//  $Source$
//  $Author$
//  $Date$
//  $Revision$
// ************************************************************************
//@HEADER

#ifndef NOX_SOLVER_SOLVERUTILS_H
#define NOX_SOLVER_SOLVERUTILS_H

#include "Teuchos_RCP.hpp"
#include "NOX_StatusTest_Generic.H"

namespace Teuchos {
  class ParameterList;
}

namespace NOX {

  class Observer;

  namespace Solver{

    /*! \brief Nonmember method that returns the status test check type.

        This object parses the "Solver Options" parameter list for a
        key "Status Test Check Type" of type <std::string> with
        possible values:

    - "Complete"
    - "Minimal" (default)
    - "None"

    These options correspond to the NOX::StatusTest::CheckType.
    Please follow the link for this object for more information.
    */
    NOX::StatusTest::CheckType
    parseStatusTestCheckType(Teuchos::ParameterList& solver_options_list);

    /** \brief Parses the "Solver Options" sublist for a user defined observer. */
    Teuchos::RCP<NOX::Observer> parseObserver(Teuchos::ParameterList& solver_options_list);

    /*! \brief Nonmember method that validates and sets the defaults for the "Solver Options" sublist. */
    void
    validateSolverOptionsSublist(Teuchos::ParameterList& solver_options_list);

  }  // namespace Solver
}  // namespace NOX
#endif
