Panzer  Version of the Day
Public Member Functions | Private Types | Private Attributes | List of all members
panzer::DotProduct< EvalT, Traits > Class Template Reference

Evaluates dot product at a set of points. More...

#include <Panzer_DotProduct_decl.hpp>

Inheritance diagram for panzer::DotProduct< EvalT, Traits >:
Inheritance graph
[legend]

Public Member Functions

 DotProduct (const Teuchos::ParameterList &p)
 
void postRegistrationSetup (typename Traits::SetupData d, PHX::FieldManager< Traits > &fm)
 
void evaluateFields (typename Traits::EvalData d)
 
- 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...
 

Private Types

using ScalarT = typename EvalT::ScalarT
 

Private Attributes

PHX::MDField< ScalarTvec_a_dot_vec_b
 
PHX::MDField< const ScalarTvec_a
 
PHX::MDField< const ScalarTvec_b
 
PHX::MDField< const ScalarTmultiplier_field
 
int num_pts
 
int num_dim
 
bool multiplier_field_on
 
double multiplier_value
 

Additional Inherited Members

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

Detailed Description

template<typename EvalT, typename Traits>
class panzer::DotProduct< EvalT, Traits >

Evaluates dot product at a set of points.

v_a v_b

<Parameter name="Result Name" type="string" value="<Name to give to dot product field>"> <Parameter name="Point Rule" type="RCP<const PointRule>" value="<user specified point rule>"> <Parameter name="Vector A Name" type="string" value="<vector a name>"> <Parameter name="Vector B Name" type="string" value="<vector b name>"> <Parameter name="Multiplier" type="double" value="Multiplier value"> <Parameter name="Field Multiplier" type="string" value="Multiplier name">

Definition at line 65 of file Panzer_DotProduct_decl.hpp.

Member Typedef Documentation

◆ ScalarT

template<typename EvalT , typename Traits >
using panzer::DotProduct< EvalT, Traits >::ScalarT = typename EvalT::ScalarT
private

Definition at line 86 of file Panzer_DotProduct_decl.hpp.

Constructor & Destructor Documentation

◆ DotProduct()

template<typename EvalT , typename Traits >
panzer::DotProduct< EvalT, Traits >::DotProduct ( const Teuchos::ParameterList p)

Definition at line 78 of file Panzer_DotProduct_impl.hpp.

Member Function Documentation

◆ postRegistrationSetup()

template<typename EvalT , typename Traits >
void panzer::DotProduct< EvalT, Traits >::postRegistrationSetup ( typename Traits::SetupData  d,
PHX::FieldManager< Traits > &  fm 
)

Definition at line 119 of file Panzer_DotProduct_impl.hpp.

◆ evaluateFields()

template<typename EvalT , typename Traits >
void panzer::DotProduct< EvalT, Traits >::evaluateFields ( typename Traits::EvalData  d)

Definition at line 134 of file Panzer_DotProduct_impl.hpp.

Member Data Documentation

◆ vec_a_dot_vec_b

template<typename EvalT , typename Traits >
PHX::MDField<ScalarT> panzer::DotProduct< EvalT, Traits >::vec_a_dot_vec_b
private

Definition at line 88 of file Panzer_DotProduct_decl.hpp.

◆ vec_a

template<typename EvalT , typename Traits >
PHX::MDField<const ScalarT> panzer::DotProduct< EvalT, Traits >::vec_a
private

Definition at line 89 of file Panzer_DotProduct_decl.hpp.

◆ vec_b

template<typename EvalT , typename Traits >
PHX::MDField<const ScalarT> panzer::DotProduct< EvalT, Traits >::vec_b
private

Definition at line 89 of file Panzer_DotProduct_decl.hpp.

◆ multiplier_field

template<typename EvalT , typename Traits >
PHX::MDField<const ScalarT> panzer::DotProduct< EvalT, Traits >::multiplier_field
private

Definition at line 90 of file Panzer_DotProduct_decl.hpp.

◆ num_pts

template<typename EvalT , typename Traits >
int panzer::DotProduct< EvalT, Traits >::num_pts
private

Definition at line 92 of file Panzer_DotProduct_decl.hpp.

◆ num_dim

template<typename EvalT , typename Traits >
int panzer::DotProduct< EvalT, Traits >::num_dim
private

Definition at line 93 of file Panzer_DotProduct_decl.hpp.

◆ multiplier_field_on

template<typename EvalT , typename Traits >
bool panzer::DotProduct< EvalT, Traits >::multiplier_field_on
private

Definition at line 95 of file Panzer_DotProduct_decl.hpp.

◆ multiplier_value

template<typename EvalT , typename Traits >
double panzer::DotProduct< EvalT, Traits >::multiplier_value
private

Definition at line 96 of file Panzer_DotProduct_decl.hpp.


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