Panzer  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
panzer::EquationSet< EvalT > Class Template Referenceabstract

#include <Panzer_EquationSet.hpp>

Inheritance diagram for panzer::EquationSet< EvalT >:
Inheritance graph
[legend]

Public Member Functions

 EquationSet ()
 
virtual ~EquationSet ()
 
- Public Member Functions inherited from panzer::EquationSetBase
 EquationSetBase ()
 
virtual ~EquationSetBase ()
 
virtual void setTangentParamNames (const std::vector< std::string > &tangent_param_names)=0
 Set the list of tangent parameter names. More...
 
- Public Member Functions inherited from panzer::EvaluatorsRegistrar
int setDetailsIndex (const int details_index)
 
int getDetailsIndex () const
 Get the WorksetDetails index. More...
 

Initialization (derived from panzer::EquationSetBase)

virtual void setElementBlockId (const std::string &blockId)=0
 

Evaluator Construction and Registration Methods (derived from panzer::EquationSetBase)

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 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 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 buildAndRegisterEquationSetEvaluators (PHX::FieldManager< panzer::Traits > &fm, const panzer::FieldLibrary &field_library, 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. More...
 
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. More...
 
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
 

Query Methods (derived from panzer::EquationSetBase)

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 evaluator factory. This allows users to pass parameters from a particular equaiton set to its associated closure models. More...
 
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) More...
 
virtual const std::vector
< std::vector< std::string > > & 		getCoordinateDOFs () const =0
 Return a vector of vectors that correspond to DOFs set as coordinate fields. More...
 
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. More...
 
virtual std::string getElementBlockId () 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 factory to build a particular concrete equation set. More...
 

Additional Inherited Members

- Protected Member Functions inherited from panzer::EvaluatorsRegistrar
 EvaluatorsRegistrar ()
 Default ctor initializes WorksetDetails index to 0. More...
 
virtual ~EvaluatorsRegistrar ()
 
template<typename EvalT >
void registerEvaluator (PHX::FieldManager< panzer::Traits > &fm, const Teuchos::RCP< PHX::Evaluator< panzer::Traits > > &op) const
 

Detailed Description

template<typename EvalT>
class panzer::EquationSet< EvalT >

Definition at line 55 of file Panzer_EquationSet.hpp.

Constructor & Destructor Documentation

template<typename EvalT >
panzer::EquationSet< EvalT >::EquationSet ( )
inline

Definition at line 59 of file Panzer_EquationSet.hpp.

template<typename EvalT >
virtual panzer::EquationSet< EvalT >::~EquationSet ( )
inlinevirtual

Definition at line 61 of file Panzer_EquationSet.hpp.

Member Function Documentation

template<typename EvalT >
virtual void panzer::EquationSet< EvalT >::setElementBlockId ( const std::string &  blockId)
pure virtual

Implements panzer::EquationSetBase.

Implemented in panzer::EquationSet_DefaultImpl< EvalT >.

template<typename EvalT >
virtual void panzer::EquationSet< EvalT >::buildAndRegisterGatherAndOrientationEvaluators ( PHX::FieldManager< panzer::Traits > &  fm,
const panzer::FieldLibrary &  field_library,
const LinearObjFactory< panzer::Traits > &  lof,
const Teuchos::ParameterList &  user_data 
) const
pure virtual

Implements panzer::EquationSetBase.

Implemented in panzer::EquationSet_DefaultImpl< EvalT >.

template<typename EvalT >
virtual void panzer::EquationSet< EvalT >::buildAndRegisterScatterEvaluators ( PHX::FieldManager< panzer::Traits > &  fm,
const panzer::FieldLibrary &  field_library,
const LinearObjFactory< panzer::Traits > &  lof,
const Teuchos::ParameterList &  user_data 
) const
pure virtual

Implements panzer::EquationSetBase.

Implemented in panzer::EquationSet_DefaultImpl< EvalT >.

template<typename EvalT >
virtual void panzer::EquationSet< EvalT >::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
pure virtual

Implements panzer::EquationSetBase.

Implemented in panzer::EquationSet_DefaultImpl< EvalT >.

template<typename EvalT >
virtual void panzer::EquationSet< EvalT >::buildAndRegisterEquationSetEvaluators ( PHX::FieldManager< panzer::Traits > &  fm,
const panzer::FieldLibrary &  field_library,
const Teuchos::ParameterList &  user_data 
) const
pure virtual

Implements panzer::EquationSetBase.

Implemented in panzer::EquationSet_DefaultImpl< EvalT >.

template<typename EvalT >
virtual void panzer::EquationSet< EvalT >::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
pure virtual

Register closure model evaluators with the model name internally specified by the equation set.

Implements panzer::EquationSetBase.

Implemented in panzer::EquationSet_DefaultImpl< EvalT >.

template<typename EvalT >
virtual void panzer::EquationSet< EvalT >::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
pure virtual

Register closure model evaluators with the model name specified by an argument.

Implements panzer::EquationSetBase.

Implemented in panzer::EquationSet_DefaultImpl< EvalT >.

template<typename EvalT >
virtual void panzer::EquationSet< EvalT >::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
pure virtual

Implements panzer::EquationSetBase.

Implemented in panzer::EquationSet_DefaultImpl< EvalT >.

template<typename EvalT >
virtual const Teuchos::RCP<Teuchos::ParameterList> panzer::EquationSet< EvalT >::getEvaluatorParameterList ( ) const
pure virtual

Returns the parameter list that will be passed off from the equaiton set to the closure model evaluator factory. This allows users to pass parameters from a particular equaiton set to its associated closure models.

Implements panzer::EquationSetBase.

Implemented in panzer::EquationSet_DefaultImpl< EvalT >.

template<typename EvalT >
virtual const std::vector<std::pair<std::string,Teuchos::RCP<panzer::PureBasis> > >& panzer::EquationSet< EvalT >::getProvidedDOFs ( ) const
pure virtual

Return the Basis for the equation set, key is the DOF name (note coordinate DOFs are NOT included)

Implements panzer::EquationSetBase.

Implemented in panzer::EquationSet_DefaultImpl< EvalT >.

template<typename EvalT >
virtual const std::vector<std::vector<std::string> >& panzer::EquationSet< EvalT >::getCoordinateDOFs ( ) const
pure virtual

Return a vector of vectors that correspond to DOFs set as coordinate fields.

Implements panzer::EquationSetBase.

Implemented in panzer::EquationSet_DefaultImpl< EvalT >.

template<typename EvalT >
virtual const std::map<int,Teuchos::RCP<panzer::IntegrationRule> >& panzer::EquationSet< EvalT >::getIntegrationRules ( ) const
pure virtual

Return a map of unique integration rules for the equation set, key is the integration order.

Implements panzer::EquationSetBase.

Implemented in panzer::EquationSet_DefaultImpl< EvalT >.

template<typename EvalT >
virtual std::string panzer::EquationSet< EvalT >::getElementBlockId ( ) const
pure virtual

Implements panzer::EquationSetBase.

Implemented in panzer::EquationSet_DefaultImpl< EvalT >.

template<typename EvalT >
virtual std::string panzer::EquationSet< EvalT >::getType ( ) const
pure virtual

Returns the type of the equation set object. Corresponds to the keyword used by the equation set factory to build a particular concrete equation set.

Implements panzer::EquationSetBase.

Implemented in panzer::EquationSet_DefaultImpl< EvalT >.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.5