Panzer_SGEpetraLinearObjFactory_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_SGEpetraLinearObjFactory_decl_hpp__
#define __Panzer_SGEpetraLinearObjFactory_decl_hpp__

#include "Panzer_config.hpp"
#ifdef HAVE_STOKHOS

#include <map>

// Epetra includes
#include "Epetra_Map.h"
#include "Epetra_CrsGraph.h"
#include "Epetra_Import.h"
#include "Epetra_Export.h"

#include "Panzer_config.hpp"
#include "Panzer_UniqueGlobalIndexer.hpp"
#include "Panzer_LinearObjFactory.hpp"
#include "Panzer_EpetraLinearObjFactory.hpp"
#include "Panzer_SGEpetraLinearObjContainer.hpp"

#include "Teuchos_RCP.hpp"
#include "Teuchos_DefaultMpiComm.hpp"

#include "Stokhos_OrthogPolyBasis.hpp"
#include "Stokhos_EpetraVectorOrthogPoly.hpp"

#include <vector>

namespace panzer {

template <typename Traits,typename LocalOrdinalT>
class SGEpetraLinearObjFactory : public LinearObjFactory<Traits> {
public:

   SGEpetraLinearObjFactory(const Teuchos::RCP<EpetraLinearObjFactory<Traits,LocalOrdinalT> > & epetraFact,
                            const Teuchos::RCP<Stokhos::OrthogPolyExpansion<int,double> > & expansion,
                            const Teuchos::RCP<const EpetraExt::MultiComm> & globalMultiComm);

   virtual ~SGEpetraLinearObjFactory();

/*************** Linear object factory methods *******************/

   virtual void readVector(const std::string & identifier,LinearObjContainer & loc,int id) const 
   { TEUCHOS_ASSERT(false); }

   virtual void writeVector(const std::string & identifier,const LinearObjContainer & loc,int id) const
   { TEUCHOS_ASSERT(false); }

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

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

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

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

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

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

   template <typename EvalT>
   Teuchos::RCP<panzer::CloneableEvaluator> buildScatter() const
   { return epetraFact_->template buildScatter<EvalT>(); }

   template <typename EvalT>
   Teuchos::RCP<panzer::CloneableEvaluator > buildGather() const
   { return epetraFact_->template buildGather<EvalT>(); }

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

   template <typename EvalT>
   Teuchos::RCP<panzer::CloneableEvaluator > buildGatherOrientation() const
   { return epetraFact_->template buildGatherOrientation<EvalT>(); }

   template <typename EvalT>
   Teuchos::RCP<panzer::CloneableEvaluator> buildScatterDirichlet() const
   { return epetraFact_->template buildScatterDirichlet<EvalT>(); }

/*************** Generic helper functions for container setup *******************/
   
   void initializeContainer(int mem,LinearObjContainer & loc) const;

   void initializeGhostedContainer(int mem,LinearObjContainer & loc) const;

   Teuchos::RCP<EpetraLinearObjFactory<Traits,LocalOrdinalT> > getEpetraFactory() const
   { return epetraFact_; }

   Teuchos::RCP<const Stokhos::OrthogPolyExpansion<int,double> > getExpansion() const
   { return expansion_; }

   Teuchos::RCP<Stokhos::OrthogPolyExpansion<int,double> > getExpansion()
   { return expansion_; }

   Teuchos::RCP<Stokhos::EpetraVectorOrthogPoly> getVectorOrthogPoly() const;

   Teuchos::RCP<const Epetra_Map> getMap();

   Teuchos::RCP<const Epetra_Map> getSGBlockMap() const;

   Teuchos::RCP<const panzer::UniqueGlobalIndexerBase> getUniqueGlobalIndexerBase() const
   { return epetraFact_->getUniqueGlobalIndexerBase(); }

protected:

   Teuchos::RCP<EpetraLinearObjFactory<Traits,LocalOrdinalT> > epetraFact_;
   Teuchos::RCP<Stokhos::OrthogPolyExpansion<int,double> > expansion_;
   Teuchos::RCP<const EpetraExt::MultiComm> globalMultiComm_;

   mutable Teuchos::RCP<const Epetra_Map> sgBlockMap_; // constructed via lazy evaluation
};

}

#endif
#endif