SundanceComputationType.hpp

Go to the documentation of this file.

/* @HEADER@ */
// ************************************************************************
// 
//                              Sundance
//                 Copyright (2005) Sandia Corporation
// 
// Copyright (year first published) Sandia Corporation.  Under the terms 
// of Contract DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government 
// retains certain rights in this software.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//                                                                                 
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA                                                                                
// Questions? Contact Kevin Long (krlong@sandia.gov), 
// Sandia National Laboratories, Livermore, California, USA
// 
// ************************************************************************
/* @HEADER@ */

#ifndef SUNDANCE_COMPUTATIONTYPE_H
#define SUNDANCE_COMPUTATIONTYPE_H

#include "SundanceDefs.hpp"

namespace Sundance
{
/** 
 * \relates EquationSet
 *
 * Specifier of what sort of calculation is to be done with an
 * equation set
 */
enum ComputationType {MatrixAndVector, VectorOnly, 
                      FunctionalOnly, FunctionalAndGradient,
                      Sensitivities};

/** */
inline std::ostream& operator<<(std::ostream& os, const ComputationType& ct)
{
  switch(ct)
  {
    case MatrixAndVector:
      os << "MatrixAndVector";
      break;
    case VectorOnly:
      os << "VectorOnly";
      break;
    case FunctionalOnly:
      os << "FunctionalOnly";
      break;
    case FunctionalAndGradient:
      os << "FunctionalAndGradient";
      break;
    case Sensitivities:
      os << "Sensitivities";
      break;
    default:
      TEUCHOS_TEST_FOR_EXCEPT(1);
  }
  return os;
}

}

#endif