Panzer  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Panzer_STK_MeshFactory.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_MeshFactory_hpp__
44 #define Panzer_STK_MeshFactory_hpp__
45 
46 #include <Teuchos_RCP.hpp>
47 #include <Teuchos_ParameterListAcceptorDefaultBase.hpp>
48 
49 #include <stk_util/parallel/Parallel.hpp>
50 
52 
53 namespace panzer_stk {
54 
55 class STK_Interface;
56 
61 public:
63 
72  virtual Teuchos::RCP<STK_Interface> buildMesh(stk::ParallelMachine parallelMach) const = 0;
73 
78  virtual Teuchos::RCP<STK_Interface> buildUncommitedMesh(stk::ParallelMachine parallelMach) const = 0;
79 
82  virtual void completeMeshConstruction(STK_Interface & mesh,stk::ParallelMachine parallelMach) const = 0;
83 
88  std::vector<Teuchos::RCP<const PeriodicBC_MatcherBase> > & periodicBC)
89  {
91  parser.setParameterList(pl);
92  periodicBC = parser.getMatchers();
93  }
94 
95  void enableRebalance(bool enable,const Teuchos::RCP<const Teuchos::ParameterList> & rebalanceList=Teuchos::null)
96  { enableRebalance_ = enable;
97  rebalanceList_ = rebalanceList; }
98 
99  void rebalance(STK_Interface & mesh) const
100  {
101  if(rebalanceList_!=Teuchos::null) {
102  // loop over user specified partitioning lists
104  itr!=rebalanceList_->end();++itr) {
105 
106  const Teuchos::ParameterEntry & entry = rebalanceList_->entry(itr);
107  TEUCHOS_TEST_FOR_EXCEPTION(!entry.isList(),std::runtime_error,
108  "Rebalance list is incorrect:\n" << entry << "\nA Zoltan list formated with strings is expected.");
109 
110  // partition according to the list
111  mesh.rebalance(Teuchos::getValue<Teuchos::ParameterList>(entry));
112 
113  // rebuild mesh internals
114  mesh.buildLocalElementIDs();
115  }
116  }
117  else if(enableRebalance_) {
118  // do the default thing, once
119  Teuchos::ParameterList emptyList;
120  mesh.rebalance(emptyList);
121 
122  // rebuild mesh internals
123  mesh.buildLocalElementIDs();
124  }
125  }
126 
127 protected:
128  // vector of periodic boundary condition objects
129  std::vector<Teuchos::RCP<const PeriodicBC_MatcherBase> > periodicBCVec_;
130 
131  // for managing rebalance
134 };
135 
136 }
137 
138 #endif
virtual void completeMeshConstruction(STK_Interface &mesh, stk::ParallelMachine parallelMach) const =0
ConstIterator end() const
virtual Teuchos::RCP< STK_Interface > buildUncommitedMesh(stk::ParallelMachine parallelMach) const =0
void setParameterList(const Teuchos::RCP< Teuchos::ParameterList > &pl)
#define TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
virtual Teuchos::RCP< STK_Interface > buildMesh(stk::ParallelMachine parallelMach) const =0
const std::vector< Teuchos::RCP< const PeriodicBC_MatcherBase > > & getMatchers() const
void rebalance(STK_Interface &mesh) const
params_t::ConstIterator ConstIterator
ConstIterator begin() const
Teuchos::RCP< const Teuchos::ParameterList > rebalanceList_
const ParameterEntry & entry(ConstIterator i) const
void rebalance(const Teuchos::ParameterList &params)
std::vector< Teuchos::RCP< const PeriodicBC_MatcherBase > > periodicBCVec_
void enableRebalance(bool enable, const Teuchos::RCP< const Teuchos::ParameterList > &rebalanceList=Teuchos::null)
static void parsePeriodicBCList(const Teuchos::RCP< Teuchos::ParameterList > &pl, std::vector< Teuchos::RCP< const PeriodicBC_MatcherBase > > &periodicBC)