Panzer  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Panzer_STK_PeriodicBC_Parser.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Panzer: A partial differential equation assembly
5 // engine for strongly coupled complex multiphysics systems
6 // Copyright (2011) Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Roger P. Pawlowski (rppawlo@sandia.gov) and
39 // Eric C. Cyr (eccyr@sandia.gov)
40 // ***********************************************************************
41 // @HEADER
42 
43 #ifndef __Panzer_STK_PeriodicBC_Parser_hpp__
44 #define __Panzer_STK_PeriodicBC_Parser_hpp__
45 
47 
49 #include "Teuchos_ParameterListAcceptor.hpp"
50 #include "Teuchos_RCP.hpp"
51 
52 #include <vector>
53 #include <string>
54 
55 namespace panzer_stk {
56 
62 public:
64 
67  const std::vector<Teuchos::RCP<const PeriodicBC_MatcherBase> > &
68  getMatchers() const;
69 
72  const bool & useBoundingBoxSearch() const;
73 
74  // parameterlistacceptor required functions
77 
79 
81 
83 
84  // specific to this class
86 
93 
100  buildMatcher(const std::string & buildStr) const;
101 
106  std::pair<std::string, unsigned int> getMatcherTypeAndDim(const std::string & buildStr) const;
107 
111  std::string replaceMatcherType(const std::string & buildStr, const std::string & matcherType) const;
112 
116  void buildMatcher_Tokenize(const std::string & buildStr,
117  std::string & matcher,
118  std::string & bndry1,
119  std::string & bndry2) const;
120 
127  bool buildMatcher_Tokenize_withParams(const std::string & buildStr,
128  std::string & matcher,
129  std::vector<std::string> & params,
130  std::string & bndry1,
131  std::string & bndry2) const;
132 private:
135 
137  std::vector<Teuchos::RCP<const PeriodicBC_MatcherBase> > matchers_;
138  std::vector<Teuchos::RCP<const PeriodicBC_MatcherBase> > edgeMatchers_;
139  std::vector<Teuchos::RCP<const PeriodicBC_MatcherBase> > faceMatchers_;
140 
141  // stored string values
142  const std::string countStr_;
143  const std::string condPrefix_;
144  const std::string searchStr_;
145 
146  // stored flag indicating if bounding box search is used for periodic DOF matching
148 };
149 
150 }
151 
152 #endif
bool buildMatcher_Tokenize_withParams(const std::string &buildStr, std::string &matcher, std::vector< std::string > &params, std::string &bndry1, std::string &bndry2) const
void setParameterList(const Teuchos::RCP< Teuchos::ParameterList > &pl)
Teuchos::RCP< Teuchos::ParameterList > storedPL_
stored parameter list
std::vector< Teuchos::RCP< const PeriodicBC_MatcherBase > > faceMatchers_
std::vector< Teuchos::RCP< const PeriodicBC_MatcherBase > > matchers_
matchers constructed by &quot;setParameterList&quot;
const std::vector< Teuchos::RCP< const PeriodicBC_MatcherBase > > & getMatchers() const
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters() const
Teuchos::RCP< Teuchos::ParameterList > unsetParameterList()
std::vector< Teuchos::RCP< const PeriodicBC_MatcherBase > > edgeMatchers_
void buildMatcher_Tokenize(const std::string &buildStr, std::string &matcher, std::string &bndry1, std::string &bndry2) const
std::string replaceMatcherType(const std::string &buildStr, const std::string &matcherType) const
std::pair< std::string, unsigned int > getMatcherTypeAndDim(const std::string &buildStr) const
Teuchos::RCP< Teuchos::ParameterList > getNonconstParameterList()
Teuchos::RCP< const PeriodicBC_MatcherBase > buildMatcher(const std::string &buildStr) const