Panzer  Version of the Day
Panzer_STK_ModelEvaluatorFactory.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_MODEL_EVALUATOR_FACTORY_HPP
44 #define PANZER_STK_MODEL_EVALUATOR_FACTORY_HPP
45 
46 #include <iostream>
47 #include <string>
48 #include <map>
49 
50 #include "Teuchos_RCP.hpp"
51 #include "Teuchos_Ptr.hpp"
52 #include "Teuchos_Comm.hpp"
55 #include "Teuchos_ParameterListAcceptorDefaultBase.hpp"
56 
57 #include "PanzerAdaptersSTK_config.hpp"
58 #include "Panzer_PhysicsBlock.hpp"
60 #include "Panzer_STK_Interface.hpp"
68 
69 #include "Panzer_NodeType.hpp"
70 
71 #include "Thyra_EpetraModelEvaluator.hpp"
72 
73 #ifdef PANZER_HAVE_TEKO
74 #include "Teko_RequestHandler.hpp"
75 #endif
76 
77 namespace Piro {
78  template <typename ScalarT> class RythmosSolver;
79 }
80 
81 namespace Thyra {
82  template<typename ScalarT> class ModelEvaluator;
83  template<typename ScalarT> class LinearOpWithSolveFactoryBase;
84 }
85 
86 namespace panzer {
87  struct GlobalData;
88  class UniqueGlobalIndexerBase;
89  template <typename> class LinearObjFactory;
90 
91  template <typename,typename> class BlockedDOFManager;
92 #ifdef PANZER_HAVE_FEI
93  template <typename,typename> class DOFManagerFEI;
94 #endif
95  template <typename,typename> class DOFManager;
96  template <typename> class ConnManagerBase;
97 }
98 
99 namespace panzer_stk {
100 
101  template <typename GO> class STKConnManager;
102  class NOXObserverFactory;
104  class WorksetFactory;
105 
106  template<typename ScalarT>
108 
109  public:
110 
116 
125  void buildObjects(const Teuchos::RCP<const Teuchos::Comm<int> >& comm,
128  const panzer::BCStrategyFactory & bc_factory,
130  bool meConstructionOn=true);
131 
133 
136 
138 
140 
141  template <typename BuilderT>
142  int addResponse(const std::string & responseName,const std::vector<panzer::WorksetDescriptor> & wkstDesc,const BuilderT & builder);
143 
145  const bool write_graphviz_file=false,
146  const std::string& graphviz_file_prefix="");
147 
149 
153  const Teuchos::RCP<Piro::RythmosSolver<ScalarT> > rythmosSolver = Teuchos::null,
154  const Teuchos::Ptr<const panzer_stk::NOXObserverFactory> & in_nox_observer_factory=Teuchos::null,
155  const Teuchos::Ptr<const panzer_stk::RythmosObserverFactory> & in_rythmos_observer_factory=Teuchos::null);
156 
158 
161 
163 
164  const std::vector<Teuchos::RCP<panzer::PhysicsBlock> > & getPhysicsBlocks() const;
165 
168  { return m_mesh; }
169 
172  { return m_global_indexer; }
173 
176  { return m_conn_manager; }
177 
179  bool isBlockedAssembly() const
180  { return m_blockedAssembly; }
181 
184  { return m_lin_obj_factory; }
185 
186  bool isTransient() const
187  { return m_is_transient; }
188 
194  const Teuchos::RCP<Teuchos::ParameterList> & physics_block_plist,
196  const panzer::BCStrategyFactory & bc_factory,
198  bool is_transient,bool is_explicit,
199  const Teuchos::Ptr<const Teuchos::ParameterList> & bc_list=Teuchos::null,
200  const Teuchos::RCP<Thyra::ModelEvaluator<ScalarT> > & physics_me=Teuchos::null) const;
201 
206  panzer::WorksetContainer & wkstContainer,
207  const std::vector<Teuchos::RCP<panzer::PhysicsBlock> >& physicsBlocks,
210  const Teuchos::ParameterList & initial_cond_pl,
211  const Teuchos::ParameterList & user_data_pl,
212  bool write_dot_files,const std::string & dot_file_prefix) const;
213 
218  const std::vector<Teuchos::RCP<panzer::PhysicsBlock> >& physicsBlocks,
224  const Teuchos::ParameterList & closure_model_pl,
225  const Teuchos::ParameterList & user_data_pl,
226  int workset_size) const;
227 
231  buildPhysicsModelEvaluator(bool buildThyraME,
236  const std::vector<Teuchos::RCP<Teuchos::Array<double> > > & p_values,
239  bool is_transient,double t_init) const;
240 
241 
243  { return useDynamicCoordinates_; }
244 
250  double getInitialTime(Teuchos::ParameterList& transient_ic_params,
251  const panzer_stk::STK_Interface& mesh) const;
252 
254  buildLOWSFactory(bool blockedAssembly,
256  const Teuchos::RCP<panzer::ConnManagerBase<int> > & conn_manager,
258  const Teuchos::RCP<const Teuchos::MpiComm<int> > & mpi_comm
259  #ifdef PANZER_HAVE_TEKO
260  , const Teuchos::RCP<Teko::RequestHandler> & req_handler=Teuchos::null
261  #endif
262  ) const;
263 
266  { return m_wkstContainer; }
267 
269  void addUserFieldsToMesh(panzer_stk::STK_Interface & mesh,const Teuchos::ParameterList & output_list) const;
270 
273 
274  void finalizeMeshConstruction(const STK_MeshFactory & mesh_factory,
275  const std::vector<Teuchos::RCP<panzer::PhysicsBlock> > & physicsBlocks,
276  const Teuchos::MpiComm<int> mpi_comm,
277  STK_Interface & mesh) const;
278 
279  protected:
280 
283  const std::vector<Teuchos::RCP<panzer::PhysicsBlock> >& physicsBlocks,
284  const std::vector<panzer::BC> & bcs,
285  const panzer::EquationSetFactory & eqset_factory,
286  const panzer::BCStrategyFactory& bc_factory,
289  const Teuchos::ParameterList& closure_models,
290  const panzer::LinearObjFactory<panzer::Traits> & lo_factory,
291  const Teuchos::ParameterList& user_data,
292  bool writeGraph,const std::string & graphPrefix,
293  bool write_field_managers,const std::string & field_manager_prefix) const;
294 
301  const Teuchos::RCP<panzer_stk::STK_Interface> & mesh) const;
302 
306  const std::vector<Teuchos::RCP<panzer::PhysicsBlock> > & physicsBlocks,
308  const Teuchos::ParameterList & closure_models,
309  int workset_size, Teuchos::ParameterList & user_data) const;
310 
311 
312  private:
313 
316 
318  std::vector<Teuchos::RCP<panzer::PhysicsBlock> > m_physics_blocks;
319 
329 
334 
336  };
337 
338 template<typename ScalarT>
339 template <typename BuilderT>
341 addResponse(const std::string & responseName,const std::vector<panzer::WorksetDescriptor> & wkstDesc,const BuilderT & builder)
342 {
343  typedef panzer::ModelEvaluator<double> PanzerME;
344 
345  Teuchos::RCP<Thyra::EpetraModelEvaluator> thyra_ep_me = Teuchos::rcp_dynamic_cast<Thyra::EpetraModelEvaluator>(m_physics_me);
346  Teuchos::RCP<PanzerME> panzer_me = Teuchos::rcp_dynamic_cast<PanzerME>(m_physics_me);
347 
348  if(thyra_ep_me!=Teuchos::null && panzer_me==Teuchos::null) {
349  // I don't need no const-ness!
350  Teuchos::RCP<EpetraExt::ModelEvaluator> ep_me = Teuchos::rcp_const_cast<EpetraExt::ModelEvaluator>(thyra_ep_me->getEpetraModel());
351  Teuchos::RCP<panzer::ModelEvaluator_Epetra> ep_panzer_me = Teuchos::rcp_dynamic_cast<panzer::ModelEvaluator_Epetra>(ep_me);
352 
353  return ep_panzer_me->addResponse(responseName,wkstDesc,builder);
354  }
355  else if(panzer_me!=Teuchos::null && thyra_ep_me==Teuchos::null) {
356  return panzer_me->addResponse(responseName,wkstDesc,builder);
357  }
358 
359  TEUCHOS_ASSERT(false);
360  return -1;
361 }
362 
363 }
364 
365 #endif
Teuchos::RCP< panzer::ResponseLibrary< panzer::Traits > > initializeSolnWriterResponseLibrary(const Teuchos::RCP< panzer::WorksetContainer > &wc, const Teuchos::RCP< const panzer::UniqueGlobalIndexerBase > &ugi, const Teuchos::RCP< const panzer::LinearObjFactory< panzer::Traits > > &lof, const Teuchos::RCP< panzer_stk::STK_Interface > &mesh) const
void writeInitialConditions(const Thyra::ModelEvaluator< ScalarT > &model, const std::vector< Teuchos::RCP< panzer::PhysicsBlock > > &physicsBlocks, const Teuchos::RCP< panzer::WorksetContainer > &wc, const Teuchos::RCP< const panzer::UniqueGlobalIndexerBase > &ugi, const Teuchos::RCP< const panzer::LinearObjFactory< panzer::Traits > > &lof, const Teuchos::RCP< panzer_stk::STK_Interface > &mesh, const panzer::ClosureModelFactory_TemplateManager< panzer::Traits > &cm_factory, const Teuchos::ParameterList &closure_model_pl, const Teuchos::ParameterList &user_data_pl, int workset_size) const
Write the initial conditions to exodus. Note that this is entirely self contained.
void setRythmosObserverFactory(const Teuchos::RCP< const panzer_stk::RythmosObserverFactory > &rythmos_observer_factory)
Interface for constructing a BCStrategy_TemplateManager.
int addResponse(const std::string &responseName, const std::vector< WorksetDescriptor > &wkst_desc, const ResponseEvaluatorFactory_BuilderT &builder)
Teuchos::RCP< const panzer_stk::RythmosObserverFactory > m_rythmos_observer_factory
Allocates and initializes an equation set template manager.
Teuchos::RCP< panzer::LinearObjFactory< panzer::Traits > > m_lin_obj_factory
Teuchos::RCP< panzer::ResponseLibrary< panzer::Traits > > m_response_library
void finalizeMeshConstruction(const STK_MeshFactory &mesh_factory, const std::vector< Teuchos::RCP< panzer::PhysicsBlock > > &physicsBlocks, const Teuchos::MpiComm< int > mpi_comm, STK_Interface &mesh) const
Teuchos::RCP< Thyra::ModelEvaluator< ScalarT > > getPhysicsModelEvaluator()
Teuchos::RCP< Thyra::ModelEvaluator< double > > cloneWithNewPhysicsBlocks(const Teuchos::RCP< Thyra::LinearOpWithSolveFactoryBase< ScalarT > > &solverFactory, const Teuchos::RCP< Teuchos::ParameterList > &physics_block_plist, const Teuchos::RCP< const panzer::EquationSetFactory > &eqset_factory, const panzer::BCStrategyFactory &bc_factory, const panzer::ClosureModelFactory_TemplateManager< panzer::Traits > &user_cm_factory, bool is_transient, bool is_explicit, const Teuchos::Ptr< const Teuchos::ParameterList > &bc_list=Teuchos::null, const Teuchos::RCP< Thyra::ModelEvaluator< ScalarT > > &physics_me=Teuchos::null) const
Teuchos::RCP< Thyra::ModelEvaluator< ScalarT > > m_rome_me
Teuchos::RCP< panzer_stk::STK_Interface > m_mesh
Teuchos::RCP< const Teuchos::ParameterList > getValidParameters() const
int addResponse(const std::string &responseName, const std::vector< panzer::WorksetDescriptor > &wkstDesc, const BuilderT &builder)
Teuchos::RCP< panzer::WorksetContainer > m_wkstContainer
Teuchos::RCP< panzer::UniqueGlobalIndexerBase > getGlobalIndexer() const
Get global indexer used to build model evaluator.
void setParameterList(Teuchos::RCP< Teuchos::ParameterList > const &paramList)
Teuchos::RCP< panzer::ConnManagerBase< int > > m_conn_manager
Teuchos::RCP< panzer_stk::WorksetFactory > m_user_wkst_factory
Class that provides access to worksets on each element block and side set.
PHX::MDField< ScalarT > vector
Teuchos::RCP< panzer::GlobalData > global_data
void setupInitialConditions(Thyra::ModelEvaluator< ScalarT > &model, panzer::WorksetContainer &wkstContainer, const std::vector< Teuchos::RCP< panzer::PhysicsBlock > > &physicsBlocks, const panzer::ClosureModelFactory_TemplateManager< panzer::Traits > &cm_factory, const panzer::LinearObjFactory< panzer::Traits > &lof, const Teuchos::ParameterList &initial_cond_pl, const Teuchos::ParameterList &user_data_pl, bool write_dot_files, const std::string &dot_file_prefix) const
Setup the initial conditions in a model evaluator. Note that this is entirely self contained...
Teuchos::RCP< panzer::FieldManagerBuilder > buildFieldManagerBuilder(const Teuchos::RCP< panzer::WorksetContainer > &wc, const std::vector< Teuchos::RCP< panzer::PhysicsBlock > > &physicsBlocks, const std::vector< panzer::BC > &bcs, const panzer::EquationSetFactory &eqset_factory, const panzer::BCStrategyFactory &bc_factory, const panzer::ClosureModelFactory_TemplateManager< panzer::Traits > &volume_cm_factory, const panzer::ClosureModelFactory_TemplateManager< panzer::Traits > &bc_cm_factory, const Teuchos::ParameterList &closure_models, const panzer::LinearObjFactory< panzer::Traits > &lo_factory, const Teuchos::ParameterList &user_data, bool writeGraph, const std::string &graphPrefix, bool write_field_managers, const std::string &field_manager_prefix) const
Teuchos::RCP< Thyra::ModelEvaluator< ScalarT > > buildResponseOnlyModelEvaluator(const Teuchos::RCP< Thyra::ModelEvaluator< ScalarT > > &thyra_me, const Teuchos::RCP< panzer::GlobalData > &global_data, const Teuchos::RCP< Piro::RythmosSolver< ScalarT > > rythmosSolver=Teuchos::null, const Teuchos::Ptr< const panzer_stk::NOXObserverFactory > &in_nox_observer_factory=Teuchos::null, const Teuchos::Ptr< const panzer_stk::RythmosObserverFactory > &in_rythmos_observer_factory=Teuchos::null)
Teuchos::RCP< panzer::WorksetContainer > getWorksetContainer() const
Get the workset container associated with the mesh database.
void addUserFieldsToMesh(panzer_stk::STK_Interface &mesh, const Teuchos::ParameterList &output_list) const
Add the user fields specified by output_list to the mesh.
Teuchos::RCP< Thyra::ModelEvaluator< ScalarT > > getResponseOnlyModelEvaluator()
Teuchos::RCP< Thyra::ModelEvaluatorDefaultBase< double > > buildPhysicsModelEvaluator(bool buildThyraME, const Teuchos::RCP< panzer::FieldManagerBuilder > &fmb, const Teuchos::RCP< panzer::ResponseLibrary< panzer::Traits > > &rLibrary, const Teuchos::RCP< panzer::LinearObjFactory< panzer::Traits > > &lof, const std::vector< Teuchos::RCP< Teuchos::Array< std::string > > > &p_names, const std::vector< Teuchos::RCP< Teuchos::Array< double > > > &p_values, const Teuchos::RCP< Thyra::LinearOpWithSolveFactoryBase< ScalarT > > &solverFactory, const Teuchos::RCP< panzer::GlobalData > &global_data, bool is_transient, double t_init) const
Teuchos::RCP< panzer::GlobalData > m_global_data
Teuchos::RCP< const panzer_stk::NOXObserverFactory > m_nox_observer_factory
bool isBlockedAssembly() const
Is blocked assembly?
void setNOXObserverFactory(const Teuchos::RCP< const panzer_stk::NOXObserverFactory > &nox_observer_factory)
Teuchos::RCP< STK_MeshFactory > buildSTKMeshFactory(const Teuchos::ParameterList &mesh_params) const
build STK mesh factory from a mesh parameter list
Teuchos::RCP< panzer::ConnManagerBase< int > > getConnManager() const
Get connection manager.
void buildObjects(const Teuchos::RCP< const Teuchos::Comm< int > > &comm, const Teuchos::RCP< panzer::GlobalData > &global_data, const Teuchos::RCP< const panzer::EquationSetFactory > &eqset_factory, const panzer::BCStrategyFactory &bc_factory, const panzer::ClosureModelFactory_TemplateManager< panzer::Traits > &cm_factory, bool meConstructionOn=true)
Builds the model evaluators for a panzer assembly.
Teuchos::RCP< Thyra::LinearOpWithSolveFactoryBase< double > > buildLOWSFactory(bool blockedAssembly, const Teuchos::RCP< const panzer::UniqueGlobalIndexerBase > &globalIndexer, const Teuchos::RCP< panzer::ConnManagerBase< int > > &conn_manager, const Teuchos::RCP< panzer_stk::STK_Interface > &mesh, const Teuchos::RCP< const Teuchos::MpiComm< int > > &mpi_comm) const
Teuchos::RCP< panzer_stk::STK_Interface > getMesh() const
Get mesh object used to build model evaluator.
double getInitialTime(Teuchos::ParameterList &transient_ic_params, const panzer_stk::STK_Interface &mesh) const
Gets the initial time from either the input parameter list or an exodus file.
Teuchos::RCP< panzer::UniqueGlobalIndexerBase > m_global_indexer
void buildResponses(const panzer::ClosureModelFactory_TemplateManager< panzer::Traits > &cm_factory, const bool write_graphviz_file=false, const std::string &graphviz_file_prefix="")
Teuchos::RCP< const Teuchos::Comm< int > > comm
const std::vector< Teuchos::RCP< panzer::PhysicsBlock > > & getPhysicsBlocks() const
Teuchos::RCP< Thyra::ModelEvaluator< ScalarT > > m_physics_me
void finalizeSolnWriterResponseLibrary(panzer::ResponseLibrary< panzer::Traits > &rl, const std::vector< Teuchos::RCP< panzer::PhysicsBlock > > &physicsBlocks, const panzer::ClosureModelFactory_TemplateManager< panzer::Traits > &cm_factory, const Teuchos::ParameterList &closure_models, int workset_size, Teuchos::ParameterList &user_data) const
#define TEUCHOS_ASSERT(assertion_test)
Teuchos::RCP< panzer::LinearObjFactory< panzer::Traits > > getLinearObjFactory() const
Get linear object factory used to build model evaluator.
Teuchos::RCP< const panzer::EquationSetFactory > m_eqset_factory
std::vector< Teuchos::RCP< panzer::PhysicsBlock > > m_physics_blocks
void setUserWorksetFactory(Teuchos::RCP< panzer_stk::WorksetFactory > &user_wkst_factory)
Set user defined workset factory.
Teuchos::RCP< panzer::ResponseLibrary< panzer::Traits > > getResponseLibrary()