Panzer  Version of the Day
Panzer_EquationSet_Base.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_EQUATION_SET_BASE_HPP
44 #define PANZER_EQUATION_SET_BASE_HPP
45 
46 #include <string>
47 #include <vector>
48 #include <map>
49 #include <utility>
50 #include "Teuchos_RCP.hpp"
51 #include "Phalanx_FieldManager.hpp"
52 #include "Panzer_Traits.hpp"
55 #include "Panzer_FieldLibrary.hpp"
57 
58 namespace Teuchos {
59  class ParameterList;
60 }
61 
62 namespace panzer {
63 
64  class PureBasis;
65  class IntegrationRule;
66  class BasisIRLayout;
67  class FieldLibrary;
68  class FieldLayoutLibrary;
69 
72 
73  public:
74 
76 
77  virtual ~EquationSetBase() {}
78 
81 
82  virtual void setElementBlockId(const std::string & blockId) = 0;
83 
85 
88 
90  const panzer::FieldLibrary& field_library,
92  const Teuchos::ParameterList& user_data) const = 0;
93 
95  const panzer::FieldLibrary& field_library,
97  const Teuchos::ParameterList& user_data) const = 0;
98 
100  const panzer::FieldLayoutLibrary& field_library,
101  const Teuchos::RCP<panzer::IntegrationRule>& ir,
102  const Teuchos::Ptr<const panzer::LinearObjFactory<panzer::Traits> > & lof,
103  const Teuchos::ParameterList& user_data) const = 0;
104 
106  const panzer::FieldLibrary& field_library,
107  const Teuchos::ParameterList& user_data) const = 0;
108 
111  const panzer::FieldLayoutLibrary& field_library,
112  const Teuchos::RCP<panzer::IntegrationRule>& ir,
114  const Teuchos::ParameterList& models,
115  const Teuchos::ParameterList& user_data) const = 0;
116 
119  const panzer::FieldLayoutLibrary& field_library,
120  const Teuchos::RCP<panzer::IntegrationRule>& ir,
122  const std::string& model_name,
123  const Teuchos::ParameterList& models,
124  const Teuchos::ParameterList& user_data) const = 0;
125 
127  const panzer::FieldLibrary& field_library,
129  const std::string& model_name,
130  const Teuchos::ParameterList& models,
132  const Teuchos::ParameterList& user_data) const = 0;
133 
135 
138 
140  virtual const Teuchos::RCP<Teuchos::ParameterList> getEvaluatorParameterList() const = 0;
141 
143  virtual const std::vector<std::pair<std::string,Teuchos::RCP<panzer::PureBasis> > > & getProvidedDOFs() const = 0;
144 
146  virtual const std::vector<std::vector<std::string> > & getCoordinateDOFs() const = 0;
147 
149  virtual const std::map<int,Teuchos::RCP<panzer::IntegrationRule> > & getIntegrationRules() const = 0;
150 
151  virtual std::string getElementBlockId() const = 0;
152 
154  virtual std::string getType() const = 0;
155 
157 
159  virtual void setTangentParamNames(const std::vector<std::string>& tangent_param_names) = 0;
160 
161  };
162 
163 }
164 
165 #endif
virtual std::string getElementBlockId() const =0
virtual void buildAndRegisterInitialConditionEvaluators(PHX::FieldManager< panzer::Traits > &fm, const panzer::FieldLibrary &field_library, const panzer::ClosureModelFactory_TemplateManager< panzer::Traits > &factory, const std::string &model_name, const Teuchos::ParameterList &models, const panzer::LinearObjFactory< panzer::Traits > &lof, const Teuchos::ParameterList &user_data) const =0
virtual void buildAndRegisterGatherAndOrientationEvaluators(PHX::FieldManager< panzer::Traits > &fm, const panzer::FieldLibrary &field_library, const LinearObjFactory< panzer::Traits > &lof, const Teuchos::ParameterList &user_data) const =0
virtual void setTangentParamNames(const std::vector< std::string > &tangent_param_names)=0
Set the list of tangent parameter names.
virtual void setElementBlockId(const std::string &blockId)=0
virtual void buildAndRegisterScatterEvaluators(PHX::FieldManager< panzer::Traits > &fm, const panzer::FieldLibrary &field_library, const LinearObjFactory< panzer::Traits > &lof, const Teuchos::ParameterList &user_data) const =0
virtual std::string getType() const =0
Returns the type of the equation set object. Corresponds to the keyword used by the equation set fact...
Non-templated empty base class for EquationSet objects.
virtual const Teuchos::RCP< Teuchos::ParameterList > getEvaluatorParameterList() const =0
Returns the parameter list that will be passed off from the equaiton set to the closure model evaluat...
virtual void buildAndRegisterEquationSetEvaluators(PHX::FieldManager< panzer::Traits > &fm, const panzer::FieldLibrary &field_library, const Teuchos::ParameterList &user_data) const =0
virtual void buildAndRegisterDOFProjectionsToIPEvaluators(PHX::FieldManager< panzer::Traits > &fm, const panzer::FieldLayoutLibrary &field_library, const Teuchos::RCP< panzer::IntegrationRule > &ir, const Teuchos::Ptr< const panzer::LinearObjFactory< panzer::Traits > > &lof, const Teuchos::ParameterList &user_data) const =0
virtual void buildAndRegisterClosureModelEvaluators(PHX::FieldManager< panzer::Traits > &fm, const panzer::FieldLayoutLibrary &field_library, const Teuchos::RCP< panzer::IntegrationRule > &ir, const panzer::ClosureModelFactory_TemplateManager< panzer::Traits > &factory, const Teuchos::ParameterList &models, const Teuchos::ParameterList &user_data) const =0
Register closure model evaluators with the model name internally specified by the equation set...
virtual const std::vector< std::vector< std::string > > & getCoordinateDOFs() const =0
Return a vector of vectors that correspond to DOFs set as coordinate fields.
virtual const std::vector< std::pair< std::string, Teuchos::RCP< panzer::PureBasis > > > & getProvidedDOFs() const =0
Return the Basis for the equation set, key is the DOF name (note coordinate DOFs are NOT included) ...
virtual const std::map< int, Teuchos::RCP< panzer::IntegrationRule > > & getIntegrationRules() const =0
Return a map of unique integration rules for the equation set, key is the integration order...