Panzer_STK_PeriodicBC_Parser.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//           Panzer: A partial differential equation assembly
//       engine for strongly coupled complex multiphysics systems
//
// Copyright 2011 NTESS and the Panzer contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER
 
#ifndef __Panzer_STK_PeriodicBC_Parser_hpp__
#define __Panzer_STK_PeriodicBC_Parser_hpp__
 
#include "Panzer_STK_PeriodicBC_Matcher.hpp"
 
#include "Teuchos_ParameterList.hpp"
#include "Teuchos_ParameterListAcceptor.hpp"
#include "Teuchos_RCP.hpp"
 
#include <vector>
#include <string>
 
namespace panzer_stk {
 
class PeriodicBC_Parser : Teuchos::ParameterListAcceptor {
public:
   PeriodicBC_Parser();
 
   const std::vector<Teuchos::RCP<const PeriodicBC_MatcherBase> > &
   getMatchers() const;
 
   const bool & useBoundingBoxSearch() const;
 
   // parameterlistacceptor required functions
   void setParameterList(const Teuchos::RCP<Teuchos::ParameterList> & pl);
 
   Teuchos::RCP<Teuchos::ParameterList>  getNonconstParameterList();
 
   Teuchos::RCP<Teuchos::ParameterList>  unsetParameterList();
 
   Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;
 
   // specific to this class
 
   Teuchos::RCP<Teuchos::ParameterList> getValidParameters(int count) const;
 
   Teuchos::RCP<const PeriodicBC_MatcherBase>
   buildMatcher(const std::string & buildStr) const;
 
   std::pair<std::string, unsigned int> getMatcherTypeAndDim(const std::string & buildStr) const;
 
   std::string replaceMatcherType(const std::string & buildStr, const std::string & matcherType) const;
 
   void buildMatcher_Tokenize(const std::string & buildStr,
                             std::string & matcher,
                             std::string & bndry1,
                             std::string & bndry2) const;
 
   bool buildMatcher_Tokenize_withParams(const std::string & buildStr,
                                         std::string & matcher,
                                         std::vector<std::string> & params,
                                         std::string & bndry1,
                                         std::string & bndry2) const;
private:
   Teuchos::RCP<Teuchos::ParameterList> storedPL_;
 
   std::vector<Teuchos::RCP<const PeriodicBC_MatcherBase> > matchers_;
   std::vector<Teuchos::RCP<const PeriodicBC_MatcherBase> > edgeMatchers_;
   std::vector<Teuchos::RCP<const PeriodicBC_MatcherBase> > faceMatchers_;
 
   // stored string values
   const std::string countStr_;
   const std::string condPrefix_;
   const std::string searchStr_;
   
   // stored flag indicating if bounding box search is used for periodic DOF matching
   bool useBBoxSearch_;
};
 
}
 
#endif