Panzer_LinearObjFactory.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_LinearObjFactory_hpp__
#define   __Panzer_LinearObjFactory_hpp__

// Panzer
#include "Panzer_CloneableEvaluator.hpp"
#include "Panzer_LinearObjContainer.hpp"
#include "Panzer_ReadOnlyVector_GlobalEvaluationData.hpp"
#include "Panzer_WriteVector_GlobalEvaluationData.hpp"

// Phalanx
#include "Phalanx_Evaluator.hpp"
#include "Phalanx_Evaluator_Derived.hpp"
#include "Phalanx_TemplateManager.hpp"

// Teuchos
#include "Teuchos_DefaultMpiComm.hpp"

// #include "Sacado_mpl_placeholders.hpp"
// using namespace Sacado::mpl::placeholders;

namespace panzer {

class UniqueGlobalIndexerBase; // forward declaration

template <typename Traits>
class LinearObjFactory {
public:
    virtual ~LinearObjFactory() {}

    template <typename BuilderT>
    void buildGatherScatterEvaluators(const BuilderT & builder);

    virtual void readVector(const std::string & identifier,LinearObjContainer & loc,int id) const = 0;

    virtual void writeVector(const std::string & identifier,const LinearObjContainer & loc,int id) const = 0;

   virtual Teuchos::RCP<LinearObjContainer> buildLinearObjContainer() const = 0;

   virtual Teuchos::RCP<LinearObjContainer> buildPrimitiveLinearObjContainer() const = 0;

   virtual Teuchos::RCP<LinearObjContainer> buildGhostedLinearObjContainer() const = 0;

   virtual Teuchos::RCP<LinearObjContainer> buildPrimitiveGhostedLinearObjContainer() const = 0;

   virtual Teuchos::RCP<ReadOnlyVector_GlobalEvaluationData> buildReadOnlyDomainContainer() const = 0;

   virtual Teuchos::RCP<WriteVector_GlobalEvaluationData> buildWriteDomainContainer() const = 0;

   virtual void globalToGhostContainer(const LinearObjContainer & container,
                                       LinearObjContainer & ghostContainer,int) const = 0;
   virtual void ghostToGlobalContainer(const LinearObjContainer & ghostContainer,
                                       LinearObjContainer & container,int) const = 0;

   virtual void initializeContainer(int,LinearObjContainer & loc) const = 0;

   virtual void initializeGhostedContainer(int,LinearObjContainer & loc) const = 0;

   virtual void adjustForDirichletConditions(const LinearObjContainer & localBCRows,
                                             const LinearObjContainer & globalBCRows,
                                             LinearObjContainer & ghostedObjs,
                                             bool zeroVectorRows=false, bool adjustX=false) const = 0;

   virtual void applyDirichletBCs(const LinearObjContainer & counter,
                                  LinearObjContainer & result) const = 0;

   virtual Teuchos::MpiComm<int> getComm() const = 0;

   template <typename EvalT>
   Teuchos::RCP<PHX::Evaluator<Traits> > buildScatter(const Teuchos::ParameterList & pl) const
   { return Teuchos::rcp_dynamic_cast<PHX::Evaluator<Traits> >(scatterManager_->template getAsBase<EvalT>()->clone(pl)); }

   template <typename EvalT>
   Teuchos::RCP<PHX::Evaluator<Traits> > buildGather(const Teuchos::ParameterList & pl) const
   { return Teuchos::rcp_dynamic_cast<PHX::Evaluator<Traits> >(gatherManager_->template getAsBase<EvalT>()->clone(pl)); }

   template <typename EvalT>
   Teuchos::RCP<PHX::Evaluator<Traits> > buildGatherTangent(const Teuchos::ParameterList & pl) const
   { return Teuchos::rcp_dynamic_cast<PHX::Evaluator<Traits> >(gatherTangentManager_->template getAsBase<EvalT>()->clone(pl)); }

   template <typename EvalT>
   Teuchos::RCP<PHX::Evaluator<Traits> > buildGatherDomain(const Teuchos::ParameterList & pl) const
   { return Teuchos::rcp_dynamic_cast<PHX::Evaluator<Traits> >(gatherDomainManager_->template getAsBase<EvalT>()->clone(pl)); }

   template <typename EvalT>
   Teuchos::RCP<PHX::Evaluator<Traits> > buildGatherOrientation(const Teuchos::ParameterList & pl) const
   { return Teuchos::rcp_dynamic_cast<PHX::Evaluator<Traits> >(gatherOrientManager_->template getAsBase<EvalT>()->clone(pl)); }

   template <typename EvalT>
   Teuchos::RCP<PHX::Evaluator<Traits> > buildScatterDirichlet(const Teuchos::ParameterList & pl) const
   { return Teuchos::rcp_dynamic_cast<PHX::Evaluator<Traits> >(scatterDirichletManager_->template getAsBase<EvalT>()->clone(pl)); }

   PANZER_DEPRECATED Teuchos::RCP<const panzer::UniqueGlobalIndexerBase> getUniqueGlobalIndexerBase() const
   { return getRangeGlobalIndexer(); }
  
   virtual Teuchos::RCP<const panzer::UniqueGlobalIndexerBase> getDomainGlobalIndexer() const = 0;

   virtual Teuchos::RCP<const panzer::UniqueGlobalIndexerBase> getRangeGlobalIndexer() const = 0;

   virtual void beginFill(LinearObjContainer & /* loc */) const {}
   virtual void endFill(LinearObjContainer & /* loc */) const {}

private:
   typedef PHX::TemplateManager<typename Traits::EvalTypes,
                                panzer::CloneableEvaluator,
                                PHX::EvaluatorDerived<_,Traits> > 
           Evaluator_TemplateManager;

   // managers to build the scatter/gather evaluators
   Teuchos::RCP<Evaluator_TemplateManager> scatterManager_;
   Teuchos::RCP<Evaluator_TemplateManager> scatterDirichletManager_;
   Teuchos::RCP<Evaluator_TemplateManager> gatherManager_;
   Teuchos::RCP<Evaluator_TemplateManager> gatherTangentManager_;
   Teuchos::RCP<Evaluator_TemplateManager> gatherDomainManager_;
   Teuchos::RCP<Evaluator_TemplateManager> gatherOrientManager_;

   template <typename BuilderT>
   struct Scatter_Builder {
      Teuchos::RCP<const BuilderT> builder_;

      Scatter_Builder(const Teuchos::RCP<const BuilderT> & builder) 
         : builder_(builder) {}
      
      template <typename EvalT> Teuchos::RCP<panzer::CloneableEvaluator> build() const 
      { return builder_->template buildScatter<EvalT>(); }
   };

   template <typename BuilderT>
   struct ScatterDirichlet_Builder {
      Teuchos::RCP<const BuilderT> builder_;

      ScatterDirichlet_Builder(const Teuchos::RCP<const BuilderT> & builder) 
         : builder_(builder) {}
     
      template <typename EvalT> Teuchos::RCP<panzer::CloneableEvaluator> build() const 
      { return builder_->template buildScatterDirichlet<EvalT>(); }
   };

   template <typename BuilderT>
   struct Gather_Builder {
      Teuchos::RCP<const BuilderT> builder_;

      Gather_Builder(const Teuchos::RCP<const BuilderT> & builder) 
         : builder_(builder) {}
     
      template <typename EvalT> Teuchos::RCP<panzer::CloneableEvaluator> build() const 
      { return builder_->template buildGather<EvalT>(); }
   };

   template <typename BuilderT>
   struct GatherTangent_Builder {
      Teuchos::RCP<const BuilderT> builder_;

      GatherTangent_Builder(const Teuchos::RCP<const BuilderT> & builder)
         : builder_(builder) {}

      template <typename EvalT> Teuchos::RCP<panzer::CloneableEvaluator> build() const
      { return builder_->template buildGatherTangent<EvalT>(); }
   };

   template <typename BuilderT>
   struct GatherDomain_Builder {
      Teuchos::RCP<const BuilderT> builder_;

      GatherDomain_Builder(const Teuchos::RCP<const BuilderT> & builder) 
         : builder_(builder) {}
     
      template <typename EvalT> Teuchos::RCP<panzer::CloneableEvaluator> build() const 
      { return builder_->template buildGatherDomain<EvalT>(); }
   };

   template <typename BuilderT>
   struct GatherOrientation_Builder {
      Teuchos::RCP<const BuilderT> builder_;

      GatherOrientation_Builder(const Teuchos::RCP<const BuilderT> & builder) 
         : builder_(builder) {}
     
      template <typename EvalT> Teuchos::RCP<panzer::CloneableEvaluator> build() const 
      { return builder_->template buildGatherOrientation<EvalT>(); }
   };
};

template<typename Traits>
template <typename BuilderT>
inline void LinearObjFactory<Traits>::
buildGatherScatterEvaluators(const BuilderT & builder) 
{
   using Teuchos::rcp;
   using Teuchos::rcpFromRef;

   scatterManager_ = rcp(new Evaluator_TemplateManager);
   scatterManager_->buildObjects(Scatter_Builder<BuilderT>(rcpFromRef(builder)));

   scatterDirichletManager_ = Teuchos::rcp(new Evaluator_TemplateManager);
   scatterDirichletManager_->buildObjects(ScatterDirichlet_Builder<BuilderT>(rcpFromRef(builder)));

   gatherManager_ = Teuchos::rcp(new Evaluator_TemplateManager);
   gatherManager_->buildObjects(Gather_Builder<BuilderT>(rcpFromRef(builder)));

   gatherTangentManager_ = Teuchos::rcp(new Evaluator_TemplateManager);
   gatherTangentManager_->buildObjects(GatherTangent_Builder<BuilderT>(rcpFromRef(builder)));

   gatherDomainManager_ = Teuchos::rcp(new Evaluator_TemplateManager);
   gatherDomainManager_->buildObjects(GatherDomain_Builder<BuilderT>(rcpFromRef(builder)));

   gatherOrientManager_ = Teuchos::rcp(new Evaluator_TemplateManager);
   gatherOrientManager_->buildObjects(GatherOrientation_Builder<BuilderT>(rcpFromRef(builder)));
}

}

#endif // __Panzer_LinearObjFactory_hpp__