Panzer_DOFManagerFEI_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_DOFManagerFEI_decl_hpp__
#define __Panzer_DOFManagerFEI_decl_hpp__

#include "PanzerDofMgr_config.hpp"

#ifdef PANZER_HAVE_FEI

#include <map>

// FEI includes
#include "fei_base.hpp"
#include "fei_Factory.hpp"

#ifdef HAVE_MPI
   #include "mpi.h"
#endif

#include "Panzer_FieldPattern.hpp"
#include "Panzer_FieldAggPattern.hpp"
#include "Panzer_ConnManager.hpp"
#include "Panzer_UniqueGlobalIndexer.hpp"
#include "Panzer_HashUtils.hpp"

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

#include <unordered_set>

namespace panzer {

template <typename LocalOrdinalT,typename GlobalOrdinalT>
class DOFManagerFEI : public UniqueGlobalIndexer<LocalOrdinalT,GlobalOrdinalT> {
public:
   typedef GlobalOrdinalT GlobalOrdinal;
   typedef LocalOrdinalT LocalOrdinal;
   typedef std::map<int,std::string>::const_iterator const_field_iterator;

   virtual ~DOFManagerFEI() {}

   DOFManagerFEI();

   DOFManagerFEI(const Teuchos::RCP<ConnManager<LocalOrdinalT,GlobalOrdinalT> > & connMngr,MPI_Comm mpiComm);

   void setConnManager(const Teuchos::RCP<ConnManager<LocalOrdinalT,GlobalOrdinalT> > & connMngr,MPI_Comm mpiComm);

   virtual Teuchos::RCP<Teuchos::Comm<int> > getComm() const
   { return communicator_; }

   Teuchos::RCP<const FieldPattern> getGeometricFieldPattern() const
   { return geomPattern_; }
   

   Teuchos::RCP<ConnManager<LocalOrdinalT,GlobalOrdinalT> > resetIndices();

   void addField(const std::string & str,const Teuchos::RCP<const FieldPattern> & pattern);

   void addField(const std::string & blockId,const std::string & str,const Teuchos::RCP<const FieldPattern> & pattern);

   void setFieldOrder(const std::vector<int> & fieldOrder);

   void setFieldOrder(const std::vector<std::string> & fieldOrder);

   void getFieldOrder(std::vector<int> & fieldOrder) const;

   void getFieldOrder(std::vector<std::string> & fieldOrder) const;

   Teuchos::RCP<const FieldPattern> getFieldPattern(const std::string & blockId, int fieldNum) const;

   Teuchos::RCP<const FieldPattern> getFieldPattern(const std::string & blockId, const std::string & fieldName) const;
   
   int getFieldNum(const std::string & str) const;

   const std::string & getFieldString(int num) const
   { return intToFieldStr_.find(num)->second; }
 
   int getNumFields() const;
   
   Teuchos::RCP<const ConnManager<LocalOrdinalT,GlobalOrdinalT> > getConnManager() const
   { return connMngr_; } 

   virtual Teuchos::RCP<const ConnManagerBase<LocalOrdinalT> > getConnManagerBase() const
   { return getConnManager(); }

   virtual void buildGlobalUnknowns();

   virtual void buildGlobalUnknowns(const Teuchos::RCP<const FieldPattern> & geomPattern);

   virtual void buildUnknownsOrientation();

   void printFieldInformation(std::ostream & os) const;

   //{@

   virtual void getElementBlockIds(std::vector<std::string> & elementBlockIds) const
   { getConnManager()->getElementBlockIds(elementBlockIds); }

   virtual const std::vector<int> & getBlockFieldNumbers(const std::string & block) const
   { return fieldAggPattern_.find(block)->second->fieldIds(); }

   virtual bool fieldInBlock(const std::string & field, const std::string & block) const
   { return fieldStringToPattern_.find(std::make_pair(block,field))->second != Teuchos::null; }

   virtual const std::vector<LocalOrdinal> & getElementBlock(const std::string & blockId) const
   { return getConnManager()->getElementBlock(blockId); }

   void getElementGIDs(LocalOrdinalT localElmtId,std::vector<GlobalOrdinalT> & gids,const std::string & blockIdHint="") const;

   virtual void getElementOrientation(LocalOrdinalT localElmtId,std::vector<double> & gidsOrientation) const;

   const std::vector<int> & getGIDFieldOffsets(const std::string & blockId,int fieldNum) const
   { return fieldAggPattern_.find(blockId)->second->localOffsets(fieldNum); }

   const std::pair<std::vector<int>,std::vector<int> > & 
   getGIDFieldOffsets_closure(const std::string & blockId,int fieldNum,int subcellDim,int subcellId) const
   { return fieldAggPattern_.find(blockId)->second->localOffsets_closure(fieldNum,subcellDim,subcellId); }


   const_field_iterator beginFieldIter() const
   { return intToFieldStr_.begin(); }

   const_field_iterator endFieldIter() const
   { return intToFieldStr_.end(); }

   virtual void getOwnedIndices(std::vector<GlobalOrdinalT> & indices) const;

   virtual void getOwnedAndSharedIndices(std::vector<GlobalOrdinalT> & indices) const;

   virtual void ownedIndices(const std::vector<GlobalOrdinalT> & indices,std::vector<bool> & isOwned) const;

   const std::set<int> & getFields(const std::string & blockId) const
   { return blockToField_.find(blockId)->second; }

   bool validFieldOrder(const std::vector<std::string> & fieldOrder_ut,const std::set<std::string> & fields) const;

   void registerFields();

   virtual int getElementBlockGIDCount(const std::string & blockId) const
   { return getElementBlockGIDCount(blockIdToIndex(blockId)); }

   virtual int getElementBlockGIDCount(const std::size_t & blockIndex) const
   { int cnt = matrixGraph_->getConnectivityNumIndices(blockIndex); 
     if(cnt<0)
        return 0;
     return cnt;
   }

   bool getOrientationsRequired() const
   { return requireOrientations_; }

   void setOrientationsRequired(bool ro) 
   { requireOrientations_ = ro; }

protected:
   
   void getOrderedBlock(const std::vector<std::string> & fieldOrder,
                        const std::string & blockId,
                        std::vector<int> & orderedBlock) const;

   std::size_t blockIdToIndex(const std::string & blockId) const;

   const std::map<std::string,std::size_t> & blockIdToIndexMap() const;

   bool buildPattern(const std::vector<std::string> & fieldOrder,
                     const std::string & blockId);

   // computes connectivity
   Teuchos::RCP<ConnManager<LocalOrdinalT,GlobalOrdinalT> > connMngr_; 
   

   std::map<std::string,int> fieldStrToInt_;
   std::map<int,std::string> intToFieldStr_;

   std::map<std::pair<std::string,std::string>,Teuchos::RCP<const FieldPattern> > fieldStringToPattern_;

   std::map<std::pair<std::string,int>,Teuchos::RCP<const FieldPattern> > fieldIntToPattern_;

   std::map<std::string,Teuchos::RCP<FieldAggPattern> > fieldAggPattern_;

   std::map<std::string,std::set<int> > blockToField_; // help define the pattern

   // FEI based DOF management stuff
   Teuchos::RCP<fei::Factory> feiFactory_;
   fei::SharedPtr<fei::VectorSpace> vectorSpace_;
   fei::SharedPtr<fei::MatrixGraph> matrixGraph_;

   // map from a field to a vector of local element IDs
   std::map<int,std::vector<int> > field2ElmtIDs_;

   // storage for fast lookups of GID ownership
   std::unordered_set<GlobalOrdinal> ownedGIDHashTable_;

   // maps blockIds to indices
   mutable Teuchos::RCP<std::map<std::string,std::size_t> > blockIdToIndex_;

   std::vector<std::string> fieldOrder_;

   // counters
   int nodeType_;
   int edgeType_;
   int numFields_;
   std::vector<int> patternNum_;

   bool fieldsRegistered_;

   Teuchos::RCP<const FieldPattern> geomPattern_;
   Teuchos::RCP<Teuchos::MpiComm<int> > communicator_;

   bool requireOrientations_;
   // this vector will be # of local elements, by number of GIDs on element block
   std::vector<std::vector<char> > orientation_; // we are using chars here
                                                 // to minimize storage and also
                                                 // we need only to store +/-1
};

}

#endif
#endif