Panzer Version of the Day
Loading...
Searching...
No Matches
Panzer_EquationSet.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_HPP
44#define PANZER_EQUATION_SET_HPP
45
47
48namespace PHX {
49 template<typename Traits> class FieldManager;
50}
51
52namespace panzer {
53
54 template <typename EvalT>
56
57 public:
58
60
61 virtual ~EquationSet() {}
62
65
66 virtual void setElementBlockId(const std::string & blockId) = 0;
67
69
72
74 const panzer::FieldLibrary& field_library,
76 const Teuchos::ParameterList& user_data) const = 0;
77
79 const panzer::FieldLibrary& field_library,
81 const Teuchos::ParameterList& user_data) const = 0;
82
84 const panzer::FieldLayoutLibrary& field_library,
85 const Teuchos::RCP<panzer::IntegrationRule>& ir,
86 const Teuchos::Ptr<const panzer::LinearObjFactory<panzer::Traits> > & lof,
87 const Teuchos::ParameterList& user_data) const = 0;
88
90 const panzer::FieldLibrary& field_library,
91 const Teuchos::ParameterList& user_data) const = 0;
92
94 const panzer::FieldLayoutLibrary& field_library,
95 const Teuchos::RCP<panzer::IntegrationRule>& ir,
97 const Teuchos::ParameterList& models,
98 const Teuchos::ParameterList& user_data) const = 0;
99
101 const panzer::FieldLayoutLibrary& field_library,
102 const Teuchos::RCP<panzer::IntegrationRule>& ir,
104 const std::string& model_name,
105 const Teuchos::ParameterList& models,
106 const Teuchos::ParameterList& user_data) const = 0;
107
109 const panzer::FieldLibrary& field_library,
111 const std::string& model_name,
112 const Teuchos::ParameterList& models,
114 const Teuchos::ParameterList& user_data) const = 0;
115
117
120
121 virtual const Teuchos::RCP<Teuchos::ParameterList> getEvaluatorParameterList() const = 0;
122
123 virtual const std::vector<std::pair<std::string,Teuchos::RCP<panzer::PureBasis> > > & getProvidedDOFs() const = 0;
124
125 virtual const std::vector<std::vector<std::string> > & getCoordinateDOFs() const = 0;
126
127 virtual const std::map<int,Teuchos::RCP<panzer::IntegrationRule> > & getIntegrationRules() const = 0;
128
129 virtual std::string getElementBlockId() const = 0;
130
131 virtual std::string getType() const = 0;
132
134
135 };
136
137}
138
139#endif
Non-templated empty base class for EquationSet objects.
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 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 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 LinearObjFactory< panzer::Traits > &lof, const Teuchos::ParameterList &user_data) const =0
virtual void buildAndRegisterEquationSetEvaluators(PHX::FieldManager< panzer::Traits > &fm, const panzer::FieldLibrary &field_library, 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...
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.
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 const std::vector< std::vector< std::string > > & getCoordinateDOFs() const =0
Return a vector of vectors that correspond to DOFs set as coordinate fields.
virtual void setElementBlockId(const std::string &blockId)=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 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 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 std::string &model_name, const Teuchos::ParameterList &models, const Teuchos::ParameterList &user_data) const =0
Register closure model evaluators with the model name specified by an argument.
virtual std::string getElementBlockId() const =0
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)