GLpApp_AdvDiffReactOptModel.hpp

Go to the documentation of this file.

/*
//@HEADER
// ***********************************************************************
//
//     EpetraExt: Epetra Extended - Linear Algebra Services Package
//                 Copyright (2011) Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// 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 Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
//@HEADER
*/

#ifndef GLP_APP_ADV_DIFF_REACT_OPT_MODEL_HPP
#define GLP_APP_ADV_DIFF_REACT_OPT_MODEL_HPP

#include "EpetraExt_ModelEvaluator.h"
#include "GLpApp_GLpYUEpetraDataPool.hpp"
#include "Epetra_Map.h"
#include "Epetra_Vector.h"
#include "Epetra_Comm.h"
#include "Epetra_CrsGraph.h"
#include "Teuchos_VerboseObject.hpp"
#include "Teuchos_Array.hpp"

namespace GLpApp {

class AdvDiffReactOptModel
  : public EpetraExt::ModelEvaluator
  , public Teuchos::VerboseObject<AdvDiffReactOptModel>
{
public:

  AdvDiffReactOptModel(
    const Teuchos::RCP<const Epetra_Comm>  &comm
    ,const double                                  beta
    ,const double                                  len_x     // Ignored if meshFile is *not* empty
    ,const double                                  len_y     // Ignored if meshFile is *not* empty
    ,const int                                     local_nx  // Ignored if meshFile is *not* empty
    ,const int                                     local_ny  // Ignored if meshFile is *not* empty
    ,const char                                    meshFile[]
    ,const int                                     np
    ,const double                                  x0
    ,const double                                  p0
    ,const double                                  reactionRate
    ,const bool                                    normalizeBasis
    ,const bool                                    supportDerivatives
    );

  void set_q( Teuchos::RCP<const Epetra_Vector> const& q );

  Teuchos::RCP<GLpApp::GLpYUEpetraDataPool> getDataPool();

  Teuchos::RCP<const Epetra_MultiVector> get_B_bar() const;


  Teuchos::RCP<const Epetra_Map> get_x_map() const;
  Teuchos::RCP<const Epetra_Map> get_f_map() const;
  Teuchos::RCP<const Epetra_Map> get_p_map(int l) const;
  Teuchos::RCP<const Epetra_Map> get_g_map(int j) const;
  Teuchos::RCP<const Epetra_Vector> get_x_init() const;
  Teuchos::RCP<const Epetra_Vector> get_p_init(int l) const;
  Teuchos::RCP<const Epetra_Vector> get_x_lower_bounds() const;
  Teuchos::RCP<const Epetra_Vector> get_x_upper_bounds() const;
  Teuchos::RCP<const Epetra_Vector> get_p_lower_bounds(int l) const;
  Teuchos::RCP<const Epetra_Vector> get_p_upper_bounds(int l) const;
  Teuchos::RCP<Epetra_Operator> create_W() const;
  Teuchos::RCP<Epetra_Operator> create_DfDp_op(int l) const;
  InArgs createInArgs() const;
  OutArgs createOutArgs() const;
  void evalModel( const InArgs& inArgs, const OutArgs& outArgs ) const;


private:

  // /////////////////////////////////////
  // Private types

  typedef Teuchos::Array<Teuchos::RCP<const Epetra_Map> >  RCP_Eptra_Map_Array_t;
  typedef Teuchos::Array<Teuchos::RCP<Epetra_Vector> >     RCP_Eptra_Vector_Array_t;

  // /////////////////////////////////////
  // Private member data

  static const int Np_         = 2; // Number of axiliary parameters
  static const int p_bndy_idx  = 0; // index for boundary flux parameters
  static const int p_rx_idx    = 1; // index for reaction rate parameter

  bool      supportDerivatives_;

  bool      isInitialized_;

  Teuchos::RCP<GLpApp::GLpYUEpetraDataPool>   dat_;
  int                                                 np_;
  Teuchos::RCP<const Epetra_Vector>           q_;

  Teuchos::RCP<const Epetra_Map>              map_p_bar_;
  Teuchos::RCP<Epetra_MultiVector>            B_bar_;

  Teuchos::RCP<const Epetra_Comm>  epetra_comm_;
  Teuchos::RCP<const Epetra_Map>   map_x_;
  RCP_Eptra_Map_Array_t                    map_p_;
  Teuchos::RCP<const Epetra_Map>   map_f_;
  Teuchos::RCP<const Epetra_Map>   map_g_;

  Teuchos::RCP<Epetra_Vector> x0_;
  Teuchos::RCP<Epetra_Vector> xL_;
  Teuchos::RCP<Epetra_Vector> xU_;
  RCP_Eptra_Vector_Array_t            p0_;
  RCP_Eptra_Vector_Array_t            pL_;
  RCP_Eptra_Vector_Array_t            pU_;
  Teuchos::RCP<Epetra_Vector> gL_;
  Teuchos::RCP<Epetra_Vector> gU_;

  Teuchos::RCP<Epetra_CrsGraph>  W_graph_;

};

} // namespace GLpApp

#endif // GLP_APP_ADV_DIFF_REACT_OPT_MODEL_HPP