NOX_TSF_Group.H

Go to the documentation of this file.

// $Id$ 
// $Source$ 

//@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.
// 
// 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 Tammy Kolda (tgkolda@sandia.gov) or Roger Pawlowski
// (rppawlo@sandia.gov), Sandia National Laboratories.
// 
// ************************************************************************
//@HEADER

#ifndef NOX_TSF_GROUP_H
#define NOX_TSF_GROUP_H

#include "NOX_Abstract_Group.H" // base class
#include "Teuchos_ParameterList.hpp"  // base class

#include "NOX_Common.H"             // class data element (string)
#include "NOX_TSF_Vector.H"     // class data element
#include "TSFVectorType.hpp"
#include "TSFVectorSpaceDecl.hpp"
#include "TSFLinearSolverDecl.hpp"
#include "TSFLinearOperatorDecl.hpp"
#include "SundanceObjectWithVerbosity.hpp"
#include "TSFNonlinearOperator.hpp" // nonlinear operator

// Forward declares
namespace Teuchos 
{
  namespace Parameter 
  {
    class List;
  }
}

namespace NOX {
  namespace TSF {

    class Group : public virtual NOX::Abstract::Group,
    public TSFExtended::DefaultObjectWithVerbosity
    {

    public:

      /*! \brief Constructor.
       *
       * Construct a group given an initial condition, the nonlinear operator that 
       * describes the problem to be solved, and the linear solver
       */
      Group(const TSFExtended::Vector<double>& initcond, 
            const TSFExtended::NonlinearOperator<double>& nonlinOp,
            const TSFExtended::LinearSolver<double>& solver);

      /*! \brief Constructor.
       *
       * Construct a group given an initial condition and the nonlinear operator that 
       * describes the problem to be solved.
       */
      Group(const TSFExtended::NonlinearOperator<double>& nonlinOp,
            const TSFExtended::LinearSolver<double>& solver);

      /*! \brief Constructor.
       *
       * Construct a group given an initial condition, the nonlinear operator that 
       * describes the problem to be solved, the linear solver, and user-specified precision.
       */
      Group(const TSFExtended::Vector<double>& initcond, 
            const TSFExtended::NonlinearOperator<double>& nonlinOp,
            const TSFExtended::LinearSolver<double>& solver,
            int numdigits);

      /*! \brief Constructor.
       *
       * Construct a group given an initial condition, the nonlinear operator that 
       * describes the problem to be solved, and user-specified precision.
       */
      Group(const TSFExtended::NonlinearOperator<double>& nonlinOp,
            const TSFExtended::LinearSolver<double>& solver,
            int numdigits);




      /*! \brief Copy constructor
       *
       * Construct a new group given an existing group to copy from.
       */
      Group(const NOX::TSF::Group& source, NOX::CopyType type = DeepCopy);

      //! Destructor.
      ~Group();


      NOX::Abstract::Group& operator=(const NOX::Abstract::Group& source);
      //! See above.
      NOX::Abstract::Group& operator=(const NOX::TSF::Group& source);

      /** @name "Compute" functions. */
      //@{

      void setX(const NOX::Abstract::Vector& y);
      //! See above
      void setX(const NOX::TSF::Vector& y);

      void computeX(const NOX::Abstract::Group& grp, 
                    const NOX::Abstract::Vector& d, 
                    double step);
      //! See above.
      void computeX(const NOX::TSF::Group& grp, 
                    const NOX::TSF::Vector& d, 
                    double step);

      NOX::Abstract::Group::ReturnType computeF();

      NOX::Abstract::Group::ReturnType computeJacobian();

      NOX::Abstract::Group::ReturnType computeGradient();

      NOX::Abstract::Group::ReturnType computeNewton(Teuchos::ParameterList& params);

      //@}

      /** @name Jacobian operations.
       *
       * Operations using the Jacobian matrix. These may not be defined in
       * matrix-free scenarios. */

      //@{
  
      NOX::Abstract::Group::ReturnType 
      applyJacobian(const NOX::TSF::Vector& input, 
                    NOX::TSF::Vector& result) const;

      //! See above
      NOX::Abstract::Group::ReturnType 
      applyJacobian(const NOX::Abstract::Vector& input, 
                    NOX::Abstract::Vector& result) const;

      NOX::Abstract::Group::ReturnType 
      applyJacobianTranspose(const NOX::TSF::Vector& input, 
                             NOX::TSF::Vector& result) const;

      //! See above
      NOX::Abstract::Group::ReturnType 
      applyJacobianTranspose(const NOX::Abstract::Vector& input, 
                             NOX::Abstract::Vector& result) const;

      NOX::Abstract::Group::ReturnType 
      applyJacobianInverse(Teuchos::ParameterList& params, 
                           const NOX::TSF::Vector& input, 
                           NOX::TSF::Vector& result) const;

      NOX::Abstract::Group::ReturnType 
      applyJacobianInverse(Teuchos::ParameterList& params, 
                           const NOX::Abstract::Vector& input, 
                           NOX::Abstract::Vector& result) const;
  
      //@}

      /** @name "Is" functions
       *
       * Checks to see if various objects have been computed. Returns true
       * if the corresponding "compute" function has been called since the
       * last update to the solution vector (via instantiation or
       * computeX). */
      //@{

      bool isF() const;
      bool isJacobian() const;
      bool isGradient() const;
      bool isNewton() const;

      //@}

      /** @name "Get" functions 
       *
       * Note that these function do not check whether or not the vectors
       * are valid. Must use the "Is" functions for that purpose. */
      //@{

      const NOX::Abstract::Vector& getX() const;

      const NOX::Abstract::Vector& getF() const;
  
      double getNormF() const;

      const NOX::Abstract::Vector& getGradient() const;

      const NOX::Abstract::Vector& getNewton() const;

      //@}

#ifdef TRILINOS_6
      virtual NOX::Abstract::Group* clone(NOX::CopyType type = NOX::DeepCopy) const;
#else
      virtual RCP<NOX::Abstract::Group> clone(NOX::CopyType type = NOX::DeepCopy) const;
#endif

      //! Print out the group
      void print() const;

    protected:

      //! resets all isValid flags to false
      void resetIsValid();

    protected:

      //! user-specified precision
      int precision; 
      
      /** @name Vectors */
      //@{
      //! Solution vector.
      NOX::TSF::Vector xVector;
      //! Right-hand-side vector (function evaluation).
      NOX::TSF::Vector fVector;
      //! Newton direction vector.
      NOX::TSF::Vector newtonVector;
      //! Gradient vector (steepest descent vector).
      NOX::TSF::Vector gradientVector;
      //@}

      //! Linear solver that will be used to solve J*step = resid
      mutable TSFExtended::LinearSolver<double> solver;

      //! Linear solver that will be used to solve J*step = resid
      TSFExtended::LinearOperator<double> jacobian;


      //! Problem interface: reference to nonlinear operator passed to group
      TSFExtended::NonlinearOperator<double> nonlinearOp;

      /** @name IsValid flags 
       *  
       * True if the current solution is up-to-date with respect to the
       * currect xVector. */
      //@{
      bool isValidF;
      bool isValidJacobian;
      bool isValidGradient;
      bool isValidNewton;
      //@}
  
      //! Norm of F
      double normF;

    };

  } // namespace TSF
} // namespace NOX


#endif