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

GatherTangent_Epetra. More...

#include <Panzer_GatherTangent_Epetra_decl.hpp>

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

Public Member Functions

 GatherTangent_Epetra (const Teuchos::RCP< const panzer::GlobalIndexer > &indexer)
 Constructor. More...
 
 GatherTangent_Epetra (const Teuchos::RCP< const panzer::GlobalIndexer > &indexer, const Teuchos::ParameterList &p)
 Initializing Constructor. More...
 
void postRegistrationSetup (typename TRAITS::SetupData d, PHX::FieldManager< TRAITS > &fm)
 Post-Registration Setup. More...
 
void preEvaluate (typename TRAITS::PreEvalData d)
 Pre-Evaluate: Sets the tangent vector. More...
 
void evaluateFields (typename TRAITS::EvalData d)
 Evaluate Fields: Gather operation. More...
 
virtual Teuchos::RCP
< CloneableEvaluator
clone (const Teuchos::ParameterList &pl) const
 Create a copy. More...
 
- Public Member Functions inherited from panzer::EvaluatorWithBaseImpl< TRAITS >
void setDetailsIndex (const int di)
 An evaluator builder sets the details index. More...
 
- Public Member Functions inherited from panzer::DomainEvaluator
 DomainEvaluator (DomainType domain=ALL)
 Constructor. More...
 
virtual ~DomainEvaluator ()=default
 Default destructor. More...
 
void setDomain (const DomainType domain)
 Set the domain for the evaluator. More...
 
DomainType getDomain ()
 Get the domain for the evaluator. More...
 
virtual int cellStartIndex (const panzer::Workset &workset) const
 Returns the starting cell for the specified domain for a given workset. More...
 
virtual int cellEndIndex (const panzer::Workset &workset) const
 Returns the non-inclusive end cell for the specified domain for a given workset. More...
 
- Public Member Functions inherited from panzer::CloneableEvaluator
 CloneableEvaluator ()
 
virtual ~CloneableEvaluator ()
 

Private Types

typedef EvalT::ScalarT ScalarT
 The scalar type. More...
 

Private Member Functions

 GatherTangent_Epetra ()
 Default Constructor (disabled). More...
 

Private Attributes

Teuchos::RCP< const
panzer::GlobalIndexer
globalIndexer_
 Maps the local (field, element, basis) triplet to a global ID for scattering. More...
 
std::vector< int > fieldIds_
 Field IDs, which need to be mapped. More...
 
std::vector< PHX::MDField
< ScalarT, Cell, NODE > > 
gatherFields_
 The fields to be gathered. More...
 
Teuchos::RCP< std::vector
< std::string > > 
indexerNames_
 A list of the names of the fields to be gathered. More...
 
bool useTimeDerivativeSolutionVector_
 A flag indicating whether we should be working with $ x $ or $ \dot{x} $. More...
 
std::string globalDataKey_
 The key identifying the GlobalEvaluationData. More...
 
Teuchos::RCP
< panzer::EpetraVector_ReadOnly_GlobalEvaluationData
dxdpEvRoGed_
 The GlobalEvaluationData containing both the owned and ghosted tangent vectors. More...
 

Additional Inherited Members

- Public Types inherited from panzer::DomainEvaluator
enum  DomainType : int {
  OWNED =0, GHOST =1, REAL =2, VIRTUAL =3,
  EXTERNAL =4, ALL =5
}
 Domain types supported by worksets. More...
 
- Protected Attributes inherited from panzer::EvaluatorWithBaseImpl< TRAITS >
WorksetDetailsAccessor wda
 

Detailed Description

template<typename EvalT, typename TRAITS, typename LO, typename GO>
class panzer::GatherTangent_Epetra< EvalT, TRAITS, LO, GO >

GatherTangent_Epetra.

Gathers tangent vectors $\left(\frac{dx}{dp}\right)$ for computing $\frac{df}{dx}\frac{dx}{dp} + \frac{df}{dp}$ into the nodal fields of the field manager.

This evaluator is very similar to GatherSolution, however it always gathers into fields of type double, and it is a no-op if the global evaluation data container does not exist (which is an error for GatherSolution).

Currently makes an assumption that the stride is constant for DOFs and that the number of DOFs is equal to the size of the solution names vector.

Definition at line 91 of file Panzer_GatherTangent_Epetra_decl.hpp.

Member Typedef Documentation

template<typename EvalT , typename TRAITS , typename LO , typename GO >
typedef EvalT::ScalarT panzer::GatherTangent_Epetra< EvalT, TRAITS, LO, GO >::ScalarT
private

The scalar type.

Definition at line 191 of file Panzer_GatherTangent_Epetra_decl.hpp.

Constructor & Destructor Documentation

template<typename EvalT , typename TRAITS , typename LO , typename GO >
panzer::GatherTangent_Epetra< EvalT, TRAITS, LO, GO >::GatherTangent_Epetra ( const Teuchos::RCP< const panzer::GlobalIndexer > &  indexer)
inline

Constructor.

Simply saves the input indexer as this object's globalIndexer_.

Parameters
[in]indexerThe GlobalIndexer that handles the global unknown numbering.

Definition at line 107 of file Panzer_GatherTangent_Epetra_decl.hpp.

template<typename EvalT , typename TRAITS , typename LO , typename GO >
panzer::GatherTangent_Epetra< EvalT, TRAITS, LO, GO >::GatherTangent_Epetra ( const Teuchos::RCP< const panzer::GlobalIndexer > &  indexer,
const Teuchos::ParameterList p 
)

Initializing Constructor.

Saves the input indexer as this object's globalIndexer_, allocates fields, and determines the first active name.

Parameters
[in]indexerThe GlobalIndexer that handles the global unknown numbering.
[in]pThe input parameters.

Definition at line 75 of file Panzer_GatherTangent_Epetra_impl.hpp.

template<typename EvalT , typename TRAITS , typename LO , typename GO >
panzer::GatherTangent_Epetra< EvalT, TRAITS, LO, GO >::GatherTangent_Epetra ( )
private

Default Constructor (disabled).

Member Function Documentation

template<typename EvalT , typename TRAITS , typename LO , typename GO >
void panzer::GatherTangent_Epetra< EvalT, TRAITS, LO, GO >::postRegistrationSetup ( typename TRAITS::SetupData  d,
PHX::FieldManager< TRAITS > &  fm 
)

Post-Registration Setup.

Loops over the gatherFields_ and sets the fieldIds_.

Parameters
[in]dUnused.
[in]fmUnused.

Definition at line 137 of file Panzer_GatherTangent_Epetra_impl.hpp.

template<typename EvalT , typename TRAITS , typename LO , typename GO >
void panzer::GatherTangent_Epetra< EvalT, TRAITS, LO, GO >::preEvaluate ( typename TRAITS::PreEvalData  d)

Pre-Evaluate: Sets the tangent vector.

Sets the GlobalEvaluationData containing the owned and ghosted tangent vectors.

Parameters
[in]dThe PreEvalData containing the GlobalEvaluationDataContainer.

Definition at line 170 of file Panzer_GatherTangent_Epetra_impl.hpp.

template<typename EvalT , typename TRAITS , typename LO , typename GO >
void panzer::GatherTangent_Epetra< EvalT, TRAITS, LO, GO >::evaluateFields ( typename TRAITS::EvalData  d)

Evaluate Fields: Gather operation.

Loops over the cells in the workset, the fields to be gathered, and the basis functions, and fills in the fields.

Parameters
[in]dThe Workset on which we're going to do all the work.

Definition at line 192 of file Panzer_GatherTangent_Epetra_impl.hpp.

template<typename EvalT , typename TRAITS , typename LO , typename GO >
virtual Teuchos::RCP<CloneableEvaluator> panzer::GatherTangent_Epetra< EvalT, TRAITS, LO, GO >::clone ( const Teuchos::ParameterList pl) const
inlinevirtual

Create a copy.

Creates a GatherTangent_Epetra using the Initializing Constructor and the current object's globalIndexer_.

Parameters
[in]plThe input parameters.
Returns
A GatherTangent_Epetra constructed with this object's globalIndexer_ and the input ParameterList.

Implements panzer::CloneableEvaluator.

Definition at line 178 of file Panzer_GatherTangent_Epetra_decl.hpp.

Member Data Documentation

template<typename EvalT , typename TRAITS , typename LO , typename GO >
Teuchos::RCP<const panzer::GlobalIndexer> panzer::GatherTangent_Epetra< EvalT, TRAITS, LO, GO >::globalIndexer_
private

Maps the local (field, element, basis) triplet to a global ID for scattering.

Definition at line 197 of file Panzer_GatherTangent_Epetra_decl.hpp.

template<typename EvalT , typename TRAITS , typename LO , typename GO >
std::vector<int> panzer::GatherTangent_Epetra< EvalT, TRAITS, LO, GO >::fieldIds_
private

Field IDs, which need to be mapped.

Definition at line 202 of file Panzer_GatherTangent_Epetra_decl.hpp.

template<typename EvalT , typename TRAITS , typename LO , typename GO >
std::vector<PHX::MDField<ScalarT, Cell, NODE> > panzer::GatherTangent_Epetra< EvalT, TRAITS, LO, GO >::gatherFields_
private

The fields to be gathered.

Definition at line 207 of file Panzer_GatherTangent_Epetra_decl.hpp.

template<typename EvalT , typename TRAITS , typename LO , typename GO >
Teuchos::RCP<std::vector<std::string> > panzer::GatherTangent_Epetra< EvalT, TRAITS, LO, GO >::indexerNames_
private

A list of the names of the fields to be gathered.

Definition at line 212 of file Panzer_GatherTangent_Epetra_decl.hpp.

template<typename EvalT , typename TRAITS , typename LO , typename GO >
bool panzer::GatherTangent_Epetra< EvalT, TRAITS, LO, GO >::useTimeDerivativeSolutionVector_
private

A flag indicating whether we should be working with $ x $ or $ \dot{x} $.

Definition at line 218 of file Panzer_GatherTangent_Epetra_decl.hpp.

template<typename EvalT , typename TRAITS , typename LO , typename GO >
std::string panzer::GatherTangent_Epetra< EvalT, TRAITS, LO, GO >::globalDataKey_
private

The key identifying the GlobalEvaluationData.

Definition at line 223 of file Panzer_GatherTangent_Epetra_decl.hpp.

template<typename EvalT , typename TRAITS , typename LO , typename GO >
Teuchos::RCP<panzer::EpetraVector_ReadOnly_GlobalEvaluationData> panzer::GatherTangent_Epetra< EvalT, TRAITS, LO, GO >::dxdpEvRoGed_
private

The GlobalEvaluationData containing both the owned and ghosted tangent vectors.

Definition at line 230 of file Panzer_GatherTangent_Epetra_decl.hpp.


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