Panzer_GatherSolution_BlockedEpetra_decl.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//           Panzer: A partial differential equation assembly
//       engine for strongly coupled complex multiphysics systems
//                 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 Roger P. Pawlowski (rppawlo@sandia.gov) and
// Eric C. Cyr (eccyr@sandia.gov)
// ***********************************************************************
// @HEADER

#ifndef   __Panzer_GatherSolution_BlockedEpetra_decl_hpp__
#define   __Panzer_GatherSolution_BlockedEpetra_decl_hpp__

//
//  Include Files
//

// Panzer
#include "Panzer_BlockedVector_ReadOnly_GlobalEvaluationData.hpp"
#include "Panzer_CloneableEvaluator.hpp"
#include "Panzer_Dimension.hpp"
#include "PanzerDiscFE_config.hpp"
#include "Panzer_Evaluator_WithBaseImpl.hpp"
#include "Panzer_Traits.hpp"

// Phalanx
#include "Phalanx_config.hpp"
#include "Phalanx_Evaluator_Macros.hpp"
#include "Phalanx_MDField.hpp"

// Teuchos
#include "Teuchos_ParameterList.hpp"

//
//  Forward Declarations
//

namespace panzer
{
  template<typename LocalOrdinalT, typename GlobalOrdinalT>
  class UniqueGlobalIndexer;
}
namespace Thyra
{
  template<typename> class ProductVectorBase;
}

namespace panzer
{
  template<typename EvalT, typename TRAITS, typename LO, typename GO>
  class GatherSolution_BlockedEpetra
    :
    public panzer::EvaluatorWithBaseImpl<TRAITS>,
    public PHX::EvaluatorDerived<panzer::Traits::Residual, TRAITS>,
    public panzer::CloneableEvaluator
  {
    public:

      typedef typename EvalT::ScalarT ScalarT;
  
      GatherSolution_BlockedEpetra(
        const Teuchos::ParameterList& p)
      {
      } // end of Constructor
  
      virtual Teuchos::RCP<CloneableEvaluator>
      clone(
        const Teuchos::ParameterList& pl) const
      {
        return Teuchos::rcp(new
          GatherSolution_BlockedEpetra<EvalT, TRAITS, LO, GO>(pl));
      } // end of clone()
  
      void
      postRegistrationSetup(
        typename TRAITS::SetupData d,
        PHX::FieldManager<TRAITS>& fm)
      {
      } // end of postRegistrationSetup()
  
      void
      evaluateFields(
        typename TRAITS::EvalData d)
      {
        using PHX::typeAsString;
        using std::cout;
        using std::endl;
        cout << "Unspecialized version of \"GatherSolution_BlockedEpetra::"   \
          "evaluateFields\" on " + typeAsString<EvalT>() + "\" should not "   \
          "be used!" << endl;
        TEUCHOS_ASSERT(false);
      } // end of evaluateFields()

  }; // end of class GatherSolution_BlockedEpetra

  template<typename TRAITS, typename LO, typename GO>
  class GatherSolution_BlockedEpetra<panzer::Traits::Residual, TRAITS, LO, GO>
    :
    public panzer::EvaluatorWithBaseImpl<TRAITS>,
    public PHX::EvaluatorDerived<panzer::Traits::Residual, TRAITS>,
    public panzer::CloneableEvaluator
  {
    public:

      GatherSolution_BlockedEpetra(
        const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO, int>>>&
          indexers)
        : 
        indexers_(indexers)
      {
      } // end of Constructor

      GatherSolution_BlockedEpetra(
        const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO, int>>>&
          indexers,
        const Teuchos::ParameterList& p);

      void
      postRegistrationSetup(
        typename TRAITS::SetupData d,
        PHX::FieldManager<TRAITS>& fm);
       
      void
      preEvaluate(
        typename TRAITS::PreEvalData d);
       
      void
      evaluateFields(
        typename TRAITS::EvalData d);
       
      virtual Teuchos::RCP<CloneableEvaluator>
      clone(
        const Teuchos::ParameterList& pl) const
      {
        using panzer::Traits;
        using Teuchos::rcp;
        return rcp(new
          GatherSolution_BlockedEpetra<Traits::Residual, TRAITS, LO, GO>
          (indexers_, pl));
      } // end of clone()
  
    private:

      typedef typename panzer::Traits::Residual EvalT;

      typedef typename panzer::Traits::Residual::ScalarT ScalarT;
       
      std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO, int>>> indexers_;
       
      std::vector<int> indexerIds_;
       
      std::vector<int> subFieldIds_;
       
      std::vector<PHX::MDField<ScalarT, Cell, NODE>> gatherFields_;
       
      std::vector<std::string> indexerNames_;
       
      bool useTimeDerivativeSolutionVector_;
       
      std::string globalDataKey_;
       
      Teuchos::RCP<Thyra::ProductVectorBase<double>> x_;
       
      Teuchos::RCP<panzer::BlockedVector_ReadOnly_GlobalEvaluationData>
      xBvRoGed_;
  
      bool hasTangentFields_;
       
      std::vector<std::vector<PHX::MDField<const ScalarT, Cell, NODE>>>
      tangentFields_;
       
      GatherSolution_BlockedEpetra();

  }; // end of class GatherSolution_BlockedEpetra (Residual Specialization)

  template<typename TRAITS, typename LO, typename GO>
  class GatherSolution_BlockedEpetra<panzer::Traits::Tangent, TRAITS, LO, GO>
    :
    public panzer::EvaluatorWithBaseImpl<TRAITS>,
    public PHX::EvaluatorDerived<panzer::Traits::Tangent, TRAITS>,
    public panzer::CloneableEvaluator
  {
    public:
  
      GatherSolution_BlockedEpetra(
        const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO, int>>>&
          indexers)
        :
        indexers_(indexers)
      {
      } // end of Constructor
  
      GatherSolution_BlockedEpetra(
        const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO, int>>>&
          indexers,
        const Teuchos::ParameterList& p);
  
      void
      postRegistrationSetup(
        typename TRAITS::SetupData d,
        PHX::FieldManager<TRAITS>& fm);
  
      void
      preEvaluate(
        typename TRAITS::PreEvalData d);
  
      void
      evaluateFields(
        typename TRAITS::EvalData d);
  
      virtual Teuchos::RCP<CloneableEvaluator>
      clone(
        const Teuchos::ParameterList& pl) const
      {
        using panzer::Traits;
        using Teuchos::rcp;
        return rcp(new
          GatherSolution_BlockedEpetra<Traits::Tangent, TRAITS, LO, GO>
          (indexers_, pl));
      } // end of clone()
  
    private:

      typedef typename panzer::Traits::Tangent EvalT;

      typedef typename panzer::Traits::Tangent::ScalarT ScalarT;
  
      std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO, int>>> indexers_;
  
      std::vector<int> indexerIds_;
  
      std::vector<int> subFieldIds_;
  
      std::vector<PHX::MDField<ScalarT, Cell, NODE>> gatherFields_;
  
      std::vector<std::string> indexerNames_;
  
      bool useTimeDerivativeSolutionVector_;
  
      std::string globalDataKey_;
  
      Teuchos::RCP<Thyra::ProductVectorBase<double>> x_;
  
      Teuchos::RCP<panzer::BlockedVector_ReadOnly_GlobalEvaluationData>
      xBvRoGed_;

      bool hasTangentFields_;

      std::vector<std::vector<PHX::MDField<const ScalarT, Cell, NODE>>>
      tangentFields_;

      GatherSolution_BlockedEpetra();

  }; // end of class GatherSolution_BlockedEpetra (Tangent Specialization)

  template<typename TRAITS, typename LO, typename GO>
  class GatherSolution_BlockedEpetra<panzer::Traits::Jacobian, TRAITS, LO, GO>
    :
    public panzer::EvaluatorWithBaseImpl<TRAITS>,
    public PHX::EvaluatorDerived<panzer::Traits::Jacobian, TRAITS>,
    public panzer::CloneableEvaluator
  {
    public:

      GatherSolution_BlockedEpetra(
        const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO, int>>>&
          indexers)
        :
        indexers_(indexers)
      {
      } // end of Constructor

      GatherSolution_BlockedEpetra(
        const std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO, int>>>&
          indexers,
        const Teuchos::ParameterList& p);

      void
      postRegistrationSetup(
        typename TRAITS::SetupData d,
        PHX::FieldManager<TRAITS>& fm);

      void
      preEvaluate(
        typename TRAITS::PreEvalData d);

      void
      evaluateFields(
        typename TRAITS::EvalData d);

      virtual Teuchos::RCP<CloneableEvaluator>
      clone(
        const Teuchos::ParameterList& pl) const
      {
        using panzer::Traits;
        using Teuchos::rcp;
        return rcp(new
          GatherSolution_BlockedEpetra<Traits::Jacobian, TRAITS, LO, GO>
          (indexers_, pl));
      } // end of clone()
  
    private:

      typedef typename panzer::Traits::Jacobian EvalT;

      typedef typename panzer::Traits::Jacobian::ScalarT ScalarT;

      std::vector<Teuchos::RCP<const UniqueGlobalIndexer<LO, int>>> indexers_;

      std::vector<int> indexerIds_;

      std::vector<int> subFieldIds_;

      std::vector<PHX::MDField<ScalarT, Cell, NODE>> gatherFields_;

      std::vector<std::string> indexerNames_;

      bool useTimeDerivativeSolutionVector_;

      bool disableSensitivities_;

      std::string sensitivitiesName_;

      bool applySensitivities_;

      std::string globalDataKey_;

      int gatherSeedIndex_;

      Teuchos::RCP<Thyra::ProductVectorBase<double>> x_;

      Teuchos::RCP<panzer::BlockedVector_ReadOnly_GlobalEvaluationData>
      xBvRoGed_;

      GatherSolution_BlockedEpetra();

  }; // end of class GatherSolution_BlockedEpetra (Jacobian Specialization)

} // end of namespace panzer

#ifdef    Panzer_BUILD_HESSIAN_SUPPORT
#include "Panzer_GatherSolution_BlockedEpetra_Hessian.hpp"
#endif // Panzer_BUILD_HESSIAN_SUPPORT

#endif // __Panzer_GatherSolution_BlockedEpetra_decl_hpp__