Panzer Version of the Day
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
panzer::EquationSet_FactoryComposite Class Reference

A panzer::EquationSetFactory that delegates to a list of other equation set factories. More...

#include <Panzer_EquationSet_Factory_Composite.hpp>

Inheritance diagram for panzer::EquationSet_FactoryComposite:
Inheritance graph
[legend]

Public Member Functions

 EquationSet_FactoryComposite (const std::vector< Teuchos::RCP< panzer::EquationSetFactory > > &factories)
 Construct from the list of factories to try, in order.
 
Teuchos::RCP< panzer::EquationSet_TemplateManager< panzer::Traits > > buildEquationSet (const Teuchos::RCP< Teuchos::ParameterList > &input_plist, const int &default_integration_rule, const panzer::CellData &cell_data, const Teuchos::RCP< panzer::GlobalData > &global_data, const bool build_transient_support) const
 Builds the equation set using the first constituent factory that succeeds for the given input parameter list.
 
- Public Member Functions inherited from panzer::EquationSetFactory
virtual ~EquationSetFactory ()=0
 

Private Attributes

std::vector< Teuchos::RCP< panzer::EquationSetFactory > > m_factories
 

Detailed Description

A panzer::EquationSetFactory that delegates to a list of other equation set factories.

buildEquationSet() tries each constituent factory in order and returns the first non-null equation set produced; an exception is thrown if none of the factories can build one for the given input parameter list.

Definition at line 31 of file Panzer_EquationSet_Factory_Composite.hpp.

Constructor & Destructor Documentation

◆ EquationSet_FactoryComposite()

panzer::EquationSet_FactoryComposite::EquationSet_FactoryComposite ( const std::vector< Teuchos::RCP< panzer::EquationSetFactory > > &  factories)

Construct from the list of factories to try, in order.

Definition at line 19 of file Panzer_EquationSet_Factory_Composite.cpp.

Member Function Documentation

◆ buildEquationSet()

Teuchos::RCP< panzer::EquationSet_TemplateManager< panzer::Traits > > panzer::EquationSet_FactoryComposite::buildEquationSet ( const Teuchos::RCP< Teuchos::ParameterList > &  input_plist,
const int &  default_integration_rule,
const panzer::CellData cell_data,
const Teuchos::RCP< panzer::GlobalData > &  global_data,
const bool  build_transient_support 
) const
virtual

Builds the equation set using the first constituent factory that succeeds for the given input parameter list.

Parameters
[in]input_plistthe equation set's ParameterList, tried against each constituent factory in turn.
[in]default_integration_rulethe integration order to use if input_plist does not specify one.
[in]cell_datathe cell topology/dimension information for the physics block being built.
[in]global_dataglobal data passed through to the constituent factory that builds the equation set.
[in]build_transient_supportif true, the built equation set should also register time-derivative terms.

Implements panzer::EquationSetFactory.

Definition at line 24 of file Panzer_EquationSet_Factory_Composite.cpp.

Member Data Documentation

◆ m_factories

std::vector<Teuchos::RCP<panzer::EquationSetFactory> > panzer::EquationSet_FactoryComposite::m_factories
private

Definition at line 33 of file Panzer_EquationSet_Factory_Composite.hpp.


The documentation for this class was generated from the following files: