Panzer_GatherTangent_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_GatherTangent_BlockedEpetra_decl_hpp__
#define   __Panzer_GatherTangent_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 panzer
{
  template<typename EvalT, typename TRAITS, typename LO, typename GO>
  class GatherTangent_BlockedEpetra
    :
    public panzer::EvaluatorWithBaseImpl<TRAITS>,
    public PHX::EvaluatorDerived<EvalT, TRAITS>,
    public panzer::CloneableEvaluator
  {
    public:

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

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

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

      void
      preEvaluate(
        typename TRAITS::PreEvalData d);

      void
      evaluateFields(
        typename TRAITS::EvalData d);

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

    private:

      typedef typename EvalT::ScalarT ScalarT;

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

      std::vector<int> indexerIds_;   // block index

      std::vector<int> subFieldIds_; // sub field numbers

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

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

      bool useTimeDerivativeSolutionVector_;

      std::string globalDataKey_;

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

      GatherTangent_BlockedEpetra();

  }; // end of class GatherTangent_BlockedEpetra

} // end of namespace panzer

#endif // __Panzer_GatherTangent_BlockedEpetra_decl_hpp__