Panzer  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
panzer::ResponseEvaluatorFactory_Probe< EvalT, LO, GO > Class Template Reference

#include <Panzer_ResponseEvaluatorFactory_Probe.hpp>

Inheritance diagram for panzer::ResponseEvaluatorFactory_Probe< EvalT, LO, GO >:
Inheritance graph
[legend]

Public Member Functions

 ResponseEvaluatorFactory_Probe (MPI_Comm comm, const Teuchos::Array< double > &point, int fieldComponent=0, int cubatureDegree=1, const std::string &fieldName="", const Teuchos::RCP< const panzer::LinearObjFactory< panzer::Traits > > &linearObjFactory=Teuchos::null, const Teuchos::RCP< const panzer::UniqueGlobalIndexer< LO, GO > > &globalIndexer=Teuchos::null, bool applyDirichletToDerivative=false)
 
virtual ~ResponseEvaluatorFactory_Probe ()
 
virtual Teuchos::RCP
< ResponseBase
buildResponseObject (const std::string &responseName) const
 
virtual Teuchos::RCP
< ResponseBase
buildResponseObject (const std::string &responseName, const std::vector< WorksetDescriptor > &wkstDesc) const
 
virtual void buildAndRegisterEvaluators (const std::string &responseName, PHX::FieldManager< panzer::Traits > &fm, const panzer::PhysicsBlock &physicsBlock, const Teuchos::ParameterList &user_data) const
 
virtual bool typeSupported () const
 
- Public Member Functions inherited from panzer::ResponseEvaluatorFactory< EvalT >
 ResponseEvaluatorFactory ()
 
virtual ~ResponseEvaluatorFactory ()
 
- Public Member Functions inherited from panzer::ResponseEvaluatorFactoryBase
 ResponseEvaluatorFactoryBase ()
 
virtual ~ResponseEvaluatorFactoryBase ()
 
- Public Member Functions inherited from panzer::EvaluatorsRegistrar
int setDetailsIndex (const int details_index)
 
int getDetailsIndex () const
 Get the WorksetDetails index. More...
 

Protected Member Functions

int getCubatureDegree () const
 Accessor method for Cubature degree (can be used by sub classes) More...
 
- 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
 

Private Attributes

MPI_Comm comm_
 
Teuchos::Array< double > point_
 
int fieldComponent_
 
int cubatureDegree_
 
std::string fieldName_
 
Teuchos::RCP< const
panzer::LinearObjFactory
< panzer::Traits > > 
linearObjFactory_
 
Teuchos::RCP< const
panzer::UniqueGlobalIndexer
< LO, GO > > 
globalIndexer_
 
bool applyDirichletToDerivative_
 

Detailed Description

template<typename EvalT, typename LO, typename GO>
class panzer::ResponseEvaluatorFactory_Probe< EvalT, LO, GO >

This class defines a response based on a point value.

Definition at line 63 of file Panzer_ResponseEvaluatorFactory_Probe.hpp.

Constructor & Destructor Documentation

template<typename EvalT , typename LO , typename GO >
panzer::ResponseEvaluatorFactory_Probe< EvalT, LO, GO >::ResponseEvaluatorFactory_Probe ( MPI_Comm  comm,
const Teuchos::Array< double > &  point,
int  fieldComponent = 0,
int  cubatureDegree = 1,
const std::string &  fieldName = "",
const Teuchos::RCP< const panzer::LinearObjFactory< panzer::Traits > > &  linearObjFactory = Teuchos::null,
const Teuchos::RCP< const panzer::UniqueGlobalIndexer< LO, GO > > &  globalIndexer = Teuchos::null,
bool  applyDirichletToDerivative = false 
)
inline

Definition at line 66 of file Panzer_ResponseEvaluatorFactory_Probe.hpp.

template<typename EvalT , typename LO , typename GO >
virtual panzer::ResponseEvaluatorFactory_Probe< EvalT, LO, GO >::~ResponseEvaluatorFactory_Probe ( )
inlinevirtual

Definition at line 83 of file Panzer_ResponseEvaluatorFactory_Probe.hpp.

Member Function Documentation

template<typename EvalT , typename LO , typename GO >
Teuchos::RCP< ResponseBase > panzer::ResponseEvaluatorFactory_Probe< EvalT, LO, GO >::buildResponseObject ( const std::string &  responseName) const
virtual

Build the response object used by this factory. This object assumes the role of the scatter target and will be accessible by all the evaluators in the field managers.

Parameters
[in]responseNameName of response to be built. This name will be used for looking up the response in the GlobalEvaluationDataContainer object.

Definition at line 60 of file Panzer_ResponseEvaluatorFactory_Probe_impl.hpp.

template<typename EvalT , typename LO , typename GO >
virtual Teuchos::RCP<ResponseBase> panzer::ResponseEvaluatorFactory_Probe< EvalT, LO, GO >::buildResponseObject ( const std::string &  responseName,
const std::vector< WorksetDescriptor > &  wkstdescs 
) const
inlinevirtual

Build the response object used by this factory. This object assumes the role of the scatter target and will be accessible by all the evaluators in the field managers. This is the sideset version of the buildResponseObject function.

Parameters
[in]responseNameName of response to be built. This name will be used for looking up the response in the GlobalEvaluationDataContainer object.
[in]wkstdescsA vector of descriptors for the elements this response is over.

Implements panzer::ResponseEvaluatorFactory< EvalT >.

Definition at line 96 of file Panzer_ResponseEvaluatorFactory_Probe.hpp.

template<typename EvalT , typename LO , typename GO >
void panzer::ResponseEvaluatorFactory_Probe< EvalT, LO, GO >::buildAndRegisterEvaluators ( const std::string &  responseName,
PHX::FieldManager< panzer::Traits > &  fm,
const panzer::PhysicsBlock physicsBlock,
const Teuchos::ParameterList user_data 
) const
virtual

Build and register evaluators for a response on a particular physics block.

Parameters
[in]responseNameThe name of the response to be constructed by these evaluators.
[in,out]fmField manager to be fuild with the evaluators.
[in]physicsBlockWhat physics block is being used for constructing the evaluators
[in]user_dataThe user data parameter list, this stores things that the user may find useful.

Implements panzer::ResponseEvaluatorFactory< EvalT >.

Definition at line 70 of file Panzer_ResponseEvaluatorFactory_Probe_impl.hpp.

template<typename EvalT , typename LO , typename GO >
bool panzer::ResponseEvaluatorFactory_Probe< EvalT, LO, GO >::typeSupported ( ) const
virtual

Is this evaluation type supported by the factory. This is used to determine cases where a response may support a particular evaluation type, however at runtime the user decides not to enable the (say) Jacobian evaluation of this response.

Note that use of this mechanism is complementary to having the builder return Teuchos::null for a particular evaluation type.

Implements panzer::ResponseEvaluatorFactory< EvalT >.

Definition at line 115 of file Panzer_ResponseEvaluatorFactory_Probe_impl.hpp.

template<typename EvalT , typename LO , typename GO >
int panzer::ResponseEvaluatorFactory_Probe< EvalT, LO, GO >::getCubatureDegree ( ) const
inlineprotected

Accessor method for Cubature degree (can be used by sub classes)

Definition at line 127 of file Panzer_ResponseEvaluatorFactory_Probe.hpp.

Member Data Documentation

template<typename EvalT , typename LO , typename GO >
MPI_Comm panzer::ResponseEvaluatorFactory_Probe< EvalT, LO, GO >::comm_
private

Definition at line 130 of file Panzer_ResponseEvaluatorFactory_Probe.hpp.

template<typename EvalT , typename LO , typename GO >
Teuchos::Array<double> panzer::ResponseEvaluatorFactory_Probe< EvalT, LO, GO >::point_
private

Definition at line 131 of file Panzer_ResponseEvaluatorFactory_Probe.hpp.

template<typename EvalT , typename LO , typename GO >
int panzer::ResponseEvaluatorFactory_Probe< EvalT, LO, GO >::fieldComponent_
private

Definition at line 132 of file Panzer_ResponseEvaluatorFactory_Probe.hpp.

template<typename EvalT , typename LO , typename GO >
int panzer::ResponseEvaluatorFactory_Probe< EvalT, LO, GO >::cubatureDegree_
private

Definition at line 133 of file Panzer_ResponseEvaluatorFactory_Probe.hpp.

template<typename EvalT , typename LO , typename GO >
std::string panzer::ResponseEvaluatorFactory_Probe< EvalT, LO, GO >::fieldName_
private

Definition at line 134 of file Panzer_ResponseEvaluatorFactory_Probe.hpp.

template<typename EvalT , typename LO , typename GO >
Teuchos::RCP<const panzer::LinearObjFactory<panzer::Traits> > panzer::ResponseEvaluatorFactory_Probe< EvalT, LO, GO >::linearObjFactory_
private

Definition at line 135 of file Panzer_ResponseEvaluatorFactory_Probe.hpp.

template<typename EvalT , typename LO , typename GO >
Teuchos::RCP<const panzer::UniqueGlobalIndexer<LO,GO> > panzer::ResponseEvaluatorFactory_Probe< EvalT, LO, GO >::globalIndexer_
private

Definition at line 136 of file Panzer_ResponseEvaluatorFactory_Probe.hpp.

template<typename EvalT , typename LO , typename GO >
bool panzer::ResponseEvaluatorFactory_Probe< EvalT, LO, GO >::applyDirichletToDerivative_
private

Definition at line 137 of file Panzer_ResponseEvaluatorFactory_Probe.hpp.


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