Panzer Version of the Day
Loading...
Searching...
No Matches
Panzer_EquationSet.hpp
Go to the documentation of this file.
1// @HEADER
2// *****************************************************************************
3// Panzer: A partial differential equation assembly
4// engine for strongly coupled complex multiphysics systems
5//
6// Copyright 2011 NTESS and the Panzer contributors.
7// SPDX-License-Identifier: BSD-3-Clause
8// *****************************************************************************
9// @HEADER
10
11#ifndef PANZER_EQUATION_SET_HPP
12#define PANZER_EQUATION_SET_HPP
13
15
16namespace PHX {
17 template<typename Traits> class FieldManager;
18}
19
20namespace panzer {
21
22 template <typename EvalT>
24
25 public:
26
28
29 virtual ~EquationSet() {}
30
33
34 virtual void setElementBlockId(const std::string & blockId) = 0;
35
37
40
42 const panzer::FieldLibrary& field_library,
44 const Teuchos::ParameterList& user_data) const = 0;
45
47 const panzer::FieldLibrary& field_library,
49 const Teuchos::ParameterList& user_data) const = 0;
50
52 const panzer::FieldLayoutLibrary& field_library,
53 const Teuchos::RCP<panzer::IntegrationRule>& ir,
54 const Teuchos::Ptr<const panzer::LinearObjFactory<panzer::Traits> > & lof,
55 const Teuchos::ParameterList& user_data) const = 0;
56
58 const panzer::FieldLibrary& field_library,
59 const Teuchos::ParameterList& user_data) const = 0;
60
62 const panzer::FieldLayoutLibrary& field_library,
63 const Teuchos::RCP<panzer::IntegrationRule>& ir,
65 const Teuchos::ParameterList& models,
66 const Teuchos::ParameterList& user_data) const = 0;
67
69 const panzer::FieldLayoutLibrary& field_library,
70 const Teuchos::RCP<panzer::IntegrationRule>& ir,
72 const std::string& model_name,
73 const Teuchos::ParameterList& models,
74 const Teuchos::ParameterList& user_data) const = 0;
75
77 const panzer::FieldLibrary& field_library,
79 const std::string& model_name,
80 const Teuchos::ParameterList& models,
82 const Teuchos::ParameterList& user_data) const = 0;
83
85
88
89 virtual const Teuchos::RCP<Teuchos::ParameterList> getEvaluatorParameterList() const = 0;
90
91 virtual const std::vector<std::pair<std::string,Teuchos::RCP<panzer::PureBasis> > > & getProvidedDOFs() const = 0;
92
93 virtual const std::vector<std::vector<std::string> > & getCoordinateDOFs() const = 0;
94
95 virtual const std::map<int,Teuchos::RCP<panzer::IntegrationRule> > & getIntegrationRules() const = 0;
96
97 virtual std::string getElementBlockId() const = 0;
98
99 virtual std::string getType() const = 0;
100
102
103 };
104
105}
106
107#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)