Panzer Version of the Day
Loading...
Searching...
No Matches
Public Member Functions | Private Types | Private Attributes | Static Private Attributes | List of all members
panzer::TestScatter< EvalT, Traits > Class Template Reference

#include <Panzer_TestScatter_decl.hpp>

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

Public Member Functions

 TestScatter (const Teuchos::ParameterList &p)
 Construct from a ParameterList specifying the input/output field names and shared data layout.
 
void postRegistrationSetup (typename Traits::SetupData d, PHX::FieldManager< Traits > &fm)
 Looks up the number of nodes per cell needed by evaluateFields(). Called once before the first evaluation.
 
void evaluateFields (typename Traits::EvalData d)
 Computes the output field for this workset per the class description.
 
- Public Member Functions inherited from panzer::EvaluatorWithBaseImpl< Traits >
void setDetailsIndex (const int di)
 An evaluator builder sets the details index.
 
- Public Member Functions inherited from panzer::DomainEvaluator
 DomainEvaluator (DomainType domain=ALL)
 Constructor.
 
virtual ~DomainEvaluator ()=default
 Default destructor.
 
void setDomain (const DomainType domain)
 Set the domain for the evaluator.
 
DomainType getDomain ()
 Get the domain for the evaluator.
 
virtual int cellStartIndex (const panzer::Workset &workset) const
 Returns the starting cell for the specified domain for a given workset.
 
virtual int cellEndIndex (const panzer::Workset &workset) const
 Returns the non-inclusive end cell for the specified domain for a given workset.
 

Private Types

using ScalarT = typename EvalT::ScalarT
 

Private Attributes

PHX::MDField< ScalarT, Cell, NODEscatter_value
 
PHX::MDField< const ScalarT, Cell, NODEvalue
 
int localOffset
 
std::size_t num_nodes
 

Static Private Attributes

static int offset = 0
 

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>
class panzer::TestScatter< EvalT, Traits >

A test-only evaluator that computes each cell's node average of an input field and scatters a scaled copy of that average back out to every node of an output field. Used for exercising the scatter machinery in unit tests, not for production physics.

Definition at line 27 of file Panzer_TestScatter_decl.hpp.

Member Typedef Documentation

◆ ScalarT

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

Definition at line 51 of file Panzer_TestScatter_decl.hpp.

Constructor & Destructor Documentation

◆ TestScatter()

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

Construct from a ParameterList specifying the input/output field names and shared data layout.

Definition at line 20 of file Panzer_TestScatter_impl.hpp.

Member Function Documentation

◆ postRegistrationSetup()

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

Looks up the number of nodes per cell needed by evaluateFields(). Called once before the first evaluation.

Definition at line 44 of file Panzer_TestScatter_impl.hpp.

◆ evaluateFields()

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

Computes the output field for this workset per the class description.

Definition at line 54 of file Panzer_TestScatter_impl.hpp.

Member Data Documentation

◆ scatter_value

template<typename EvalT , typename Traits >
PHX::MDField<ScalarT,Cell,NODE> panzer::TestScatter< EvalT, Traits >::scatter_value
private

Definition at line 52 of file Panzer_TestScatter_decl.hpp.

◆ value

template<typename EvalT , typename Traits >
PHX::MDField<const ScalarT,Cell,NODE> panzer::TestScatter< EvalT, Traits >::value
private

Definition at line 53 of file Panzer_TestScatter_decl.hpp.

◆ localOffset

template<typename EvalT , typename Traits >
int panzer::TestScatter< EvalT, Traits >::localOffset
private

Definition at line 54 of file Panzer_TestScatter_decl.hpp.

◆ num_nodes

template<typename EvalT , typename Traits >
std::size_t panzer::TestScatter< EvalT, Traits >::num_nodes
private

Definition at line 56 of file Panzer_TestScatter_decl.hpp.

◆ offset

template<typename EvalT , typename TRAITS >
int panzer::TestScatter< EvalT, TRAITS >::offset = 0
staticprivate

Definition at line 57 of file Panzer_TestScatter_decl.hpp.


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