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

Computes $ Ma(x)b(x)\cdots\int\vec{s}(x)\cdot\vec{\phi}(x)\,dx $. More...

#include <Panzer_Integrator_BasisTimesVector.hpp>

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

Classes

struct  FieldMultTag
 This empty struct allows us to optimize operator()() depending on the number of field multipliers. More...
 

Public Member Functions

 Integrator_BasisTimesVector (const panzer::EvaluatorStyle &evalStyle, const std::string &resName, const std::string &valName, const panzer::BasisIRLayout &basis, const panzer::IntegrationRule &ir, const double &multiplier=1, const std::vector< std::string > &fmNames=std::vector< std::string >())
 Main Constructor. More...
 
 Integrator_BasisTimesVector (const Teuchos::ParameterList &p)
 ParameterList Constructor. More...
 
 Integrator_BasisTimesVector (const panzer::EvaluatorStyle &evalStyle, const PHX::FieldTag &resTag, const PHX::FieldTag &valTag, const BasisDescriptor &bd, const IntegrationDescriptor &id, const double &multiplier=1, const std::vector< PHX::FieldTag > &multipliers=std::vector< PHX::FieldTag >())
 Descriptor Constructor. More...
 
void postRegistrationSetup (typename Traits::SetupData sd, PHX::FieldManager< Traits > &fm)
 Post-Registration Setup. More...
 
void evaluateFields (typename Traits::EvalData workset)
 Evaluate Fields. More...
 
template<int NUM_FIELD_MULT>
KOKKOS_INLINE_FUNCTION void operator() (const FieldMultTag< NUM_FIELD_MULT > &tag, const typename Kokkos::TeamPolicy< FieldMultTag< NUM_FIELD_MULT >, PHX::exec_space >::member_type &team) const
 Perform the integration. 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 PHX::EvaluatorWithBaseImpl< Traits >
virtual void evaluateFields (typename Traits::EvalData d) override=0
 
- Public Member Functions inherited from PHX::Evaluator< Traits >
 Evaluator ()
 
virtual ~Evaluator ()
 
virtual void postRegistrationSetup (typename Traits::SetupData d, PHX::FieldManager< Traits > &vm)=0
 
virtual const std::vector
< Teuchos::RCP< FieldTag > > & 		evaluatedFields () const =0
 
virtual const std::vector
< Teuchos::RCP< FieldTag > > & 		contributedFields () const =0
 
virtual const std::vector
< Teuchos::RCP< FieldTag > > & 		dependentFields () const =0
 
virtual const std::vector
< Teuchos::RCP< FieldTag > > & 		unsharedFields () const =0
 
virtual void preEvaluate (typename Traits::PreEvalData d)=0
 
virtual void postEvaluate (typename Traits::PostEvalData d)=0
 
virtual const std::string & getName () const =0
 
virtual void bindField (const PHX::FieldTag &ft, const std::any &f)=0
 
virtual PHX::DeviceEvaluator
< Traits > * 		createDeviceEvaluator () const =0
 
virtual void rebuildDeviceEvaluator (PHX::DeviceEvaluator< Traits > *e) const =0
 
virtual void deleteDeviceEvaluator (PHX::DeviceEvaluator< Traits > *e) const =0
 
virtual void printFieldValues (std::ostream &os) const =0
 
- 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
 The scalar type. More...
 

Private Member Functions

Teuchos::RCP
< Teuchos::ParameterList > 		getValidParameters () const
 Get Valid Parameters. More...
 

Private Attributes

const panzer::EvaluatorStyle evalStyle_
 An enum determining the behavior of this Evaluator. More...
 
bool useDescriptors_
 A flag indicating whether or not to use the descriptor interface. More...
 
BasisDescriptor bd_
 The BasisDescriptor for the basis to use. More...
 
IntegrationDescriptor id_
 The IntegrationDescriptor for the quadrature to use. More...
 
PHX::MDField< ScalarT,
panzer::Cell, panzer::BASIS > 		field_
 A field to which we'll contribute, or in which we'll store, the result of computing this integral. More...
 
PHX::MDField< const ScalarT,
panzer::Cell, panzer::IP,
panzer::Dim > 		vector_
 A field representing the vector-valued function we're integrating ( $ \vec{s} $). More...
 
double multiplier_
 The scalar multiplier out in front of the integral ( $ M $). More...
 
std::vector< PHX::MDField
< const ScalarT, panzer::Cell,
panzer::IP > > 		fieldMults_
 The (possibly empty) list of fields that are multipliers out in front of the integral ( $ a(x) $, $ b(x) $, etc.). More...
 
Kokkos::Array< Kokkos::View
< const ScalarT **, typename
PHX::DevLayout< ScalarT >
::type,
Kokkos::MemoryUnmanaged >, 3 > 		kokkosFieldMults_
 The PHX::View representation of the (possibly empty) list of fields that are multipliers out in front of the integral ( $ a(x) $, $ b(x) $, etc.). More...
 
int numQP_
 The number of quadrature points for each cell. More...
 
int numDim_
 The dimensionality of our vector-valued fields. More...
 
std::string basisName_
 The name of the basis we're using. More...
 
std::size_t basisIndex_
 The index in the Workset bases for our particular BasisIRLayout name. More...
 
PHX::MDField< const double,
panzer::Cell, panzer::BASIS,
panzer::IP, panzer::Dim > 		basis_
 The vector basis information necessary for integration. 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>
class panzer::Integrator_BasisTimesVector< EvalT, Traits >

Computes $ Ma(x)b(x)\cdots\int\vec{s}(x)\cdot\vec{\phi}(x)\,dx $.

Evaluates the integral

\[ Ma(x)b(x)\cdots\int\vec{s}(x)\cdot\vec{\phi}(x)\,dx, \]

where $ M $ is some constant, $ a(x) $, $ b(x) $, etc., are some fields that depend on position, $ \vec{s} $ is some vector- valued function, and $ \vec{\phi} $ is some vector basis.

Definition at line 49 of file Panzer_Integrator_BasisTimesVector.hpp.

Member Typedef Documentation

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

The scalar type.

Definition at line 272 of file Panzer_Integrator_BasisTimesVector.hpp.

Constructor & Destructor Documentation

template<typename EvalT , typename Traits >
panzer::Integrator_BasisTimesVector< EvalT, Traits >::Integrator_BasisTimesVector ( const panzer::EvaluatorStyle &  evalStyle,
const std::string &  resName,
const std::string &  valName,
const panzer::BasisIRLayout &  basis,
const panzer::IntegrationRule &  ir,
const double &  multiplier = 1,
const std::vector< std::string > &  fmNames = std::vector<std::string>() 
)

Main Constructor.

Creates an Evaluator to evaluate the integral

\[ Ma(x)b(x)\cdots\int\vec{s}(x)\cdot\vec{\phi}(x)\,dx, \]

where $ M $ is some constant, $ a(x) $, $ b(x) $, etc., are some fields that depend on position, $ \vec{s} $ is some vector-valued function, and $ \vec{\phi} $ is some vector basis.

Parameters
[in]evalStyleAn enum declaring the behavior of this Evaluator, which is to either:
  • compute and contribute (CONTRIBUTES), or
  • compute and store (EVALUATES).
[in]resNameThe name of either the contributed or evaluated field, depending on evalStyle.
[in]valNameThe name of the vector value being integrated ( $ \vec{s} $).
[in]basisThe vector basis that you'd like to use ( $ \vec{\phi} $).
[in]irThe integration rule that you'd like to use.
[in]multiplierThe scalar multiplier out in front of the integral you're computing ( $ M $). If not specified, this defaults to 1.
[in]fmNamesA list of names of fields that are multipliers out in front of the integral you're computing ( $ a(x) $, $ b(x) $, etc.). If not specified, this defaults to an empty vector.
Exceptions
std::invalid_argumentIf any of the inputs are invalid.
std::logic_errorIf the basis supplied is not a vector basis, or if it doesn't require orientations.

Definition at line 35 of file Panzer_Integrator_BasisTimesVector_impl.hpp.

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

ParameterList Constructor.

Creates an Evaluator to evaluate the integral

\[ Ma(x)b(x)\cdots\int\vec{s}(x)\cdot\vec{\phi}(x)\,dx, \]

where $ M $ is some constant, $ a(x) $, $ b(x) $, etc., are some fields that depend on position, $ \vec{s} $ is some vector-valued function, and $ \vec{\phi} $ is some vector basis.

Note
This constructor exists to preserve the older way of creating an Evaluator with a ParameterList; however, it is strongly advised that you not use this ParameterList Constructor, but rather that you favor the Main Constructor with its compile-time argument checking instead.
Parameters
[in]pA ParameterList of the form
<ParameterList>
<Parameter name = "Residual Name" type = "std::string" value = (required) />
<Parameter name = "Value Name" type = "std::string" value = (required) />
<Parameter name = "Basis" type = "RCP<panzer::BasisIRLayout>" value = (required) />
<Parameter name = "IR" type = "RCP<panzer::IntegrationRule>" value = (required) />
<Parameter name = "Multiplier" type = "double" value = (required) />
<Parameter name = "Field Multipliers" type = "RCP<const std::vector<std::string>>" value = null (default)/>
</ParameterList>
where
  • "Residual Name" is the name for the term this Evaluator is evaluating,
  • "Value Name" is the name of the vector value being integrated ( $ \vec{s} $),
  • "Basis" is the vector basis that you'd like to use ( $ \vec{\phi} $),
  • "IR" is the integration rule that you'd like to use,
  • "Multiplier" is the scalar multiplier out in front of the integral you're computing ( $ M $), and
  • "Field Multipliers" is an optional list of names of fields that are multipliers out in front of the integral you're computing ( $ a(x) $, $ b(x) $, etc.).

Definition at line 194 of file Panzer_Integrator_BasisTimesVector_impl.hpp.

template<typename EvalT , typename Traits >
panzer::Integrator_BasisTimesVector< EvalT, Traits >::Integrator_BasisTimesVector ( const panzer::EvaluatorStyle &  evalStyle,
const PHX::FieldTag &  resTag,
const PHX::FieldTag &  valTag,
const BasisDescriptor &  bd,
const IntegrationDescriptor &  id,
const double &  multiplier = 1,
const std::vector< PHX::FieldTag > &  multipliers = std::vector<PHX::FieldTag>() 
)

Descriptor Constructor.

Creates an Evaluator to evaluate the integral

\[ Ma(x)b(x)\cdots\int\vec{s}(x)\cdot\vec{\phi}(x)\,dx, \]

where $ M $ is some constant, $ a(x) $, $ b(x) $, etc., are some fields that depend on position, $ \vec{s} $ is some vector-valued function, and $ \vec{\phi} $ is some vector basis.

Parameters
[in]evalStyleAn enum declaring the behavior of this Evaluator, which is to either:
  • compute and contribute (CONTRIBUTES), or
  • compute and store (EVALUATES).
[in]resTagThe tag of either the contributed or evaluated field, depending on evalStyle.
[in]valTagThe tag of the vector value being integrated ( $ \vec{s} $).
[in]bdThe vector basisdescripotr that you'd like to use ( $ \vec{\phi} $).
[in]idThe integration descriptor that you'd like to use.
[in]multiplierThe scalar multiplier out in front of the integral you're computing ( $ M $). If not specified, this defaults to 1.
[in]multipliersA list of names of fields that are multipliers out in front of the integral you're computing ( $ a(x) $, $ b(x) $, etc.). If not specified, this defaults to an empty vector.
Exceptions
std::invalid_argumentIf any of the inputs are invalid.
std::logic_errorIf the basis supplied is not a vector basis, or if it doesn't require orientations.

Definition at line 117 of file Panzer_Integrator_BasisTimesVector_impl.hpp.

Member Function Documentation

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

Post-Registration Setup.

Sets the PHX::Views for all the of the field multipliers, sets the number of quadrature points and dimensions in our vector field, and sets the basis index.

Parameters
[in]sdEssentially a list of Worksets, which are collections of cells (elements) that all live on a single process.
[in]fmThis is unused, though part of the interface.

Definition at line 225 of file Panzer_Integrator_BasisTimesVector_impl.hpp.

template<typename EvalT , typename Traits >
void panzer::Integrator_BasisTimesVector< EvalT, Traits >::evaluateFields ( typename Traits::EvalData  workset)

Evaluate Fields.

This actually performs the integration by calling operator()() in a Kokkos::parallel_for over the cells in the Workset.

Parameters
[in]workesetThe Workset on which you're going to do the integration.

Definition at line 312 of file Panzer_Integrator_BasisTimesVector_impl.hpp.

template<typename EvalT , typename Traits >
template<int NUM_FIELD_MULT>
KOKKOS_INLINE_FUNCTION void panzer::Integrator_BasisTimesVector< EvalT, Traits >::operator() ( const FieldMultTag< NUM_FIELD_MULT > &  tag,
const typename Kokkos::TeamPolicy< FieldMultTag< NUM_FIELD_MULT >, PHX::exec_space >::member_type &  team 
) const

Perform the integration.

Generally speaking, for a given cell in the Workset, this routine loops over quadrature points, vector dimensions, and bases to perform the integration, scaling the vector field to be integrated by the multiplier ( $ M $) and any field multipliers ( $ a(x) $, $ b(x) $, etc.).

Note
Optimizations are made for the cases in which we have no field multipliers or only a single one.
Parameters
[in]tagAn indication of the number of field multipliers we have; either 0, 1, or something else.
[in]cellThe cell in the Workset over which to integrate.

Definition at line 257 of file Panzer_Integrator_BasisTimesVector_impl.hpp.

template<typename EvalT , typename Traits >
Teuchos::RCP< Teuchos::ParameterList > panzer::Integrator_BasisTimesVector< EvalT, Traits >::getValidParameters ( ) const
private

Get Valid Parameters.

Get all the parameters that we support such that the ParameterList Constructor can do some validation of the input ParameterList.

Returns
A ParameterList with all the valid parameters (keys) in it. The values tied to those keys are meaningless default values.

Definition at line 354 of file Panzer_Integrator_BasisTimesVector_impl.hpp.

Member Data Documentation

template<typename EvalT , typename Traits >
const panzer::EvaluatorStyle panzer::Integrator_BasisTimesVector< EvalT, Traits >::evalStyle_
private

An enum determining the behavior of this Evaluator.

This Evaluator will compute the result of its integration and then:

  • CONTRIBUTES: contribute it to a specified residual, not saving anything; or
  • EVALUATES: save it under a specified name for future use.

Definition at line 282 of file Panzer_Integrator_BasisTimesVector.hpp.

template<typename EvalT , typename Traits >
bool panzer::Integrator_BasisTimesVector< EvalT, Traits >::useDescriptors_
private

A flag indicating whether or not to use the descriptor interface.

Definition at line 288 of file Panzer_Integrator_BasisTimesVector.hpp.

template<typename EvalT , typename Traits >
BasisDescriptor panzer::Integrator_BasisTimesVector< EvalT, Traits >::bd_
private

The BasisDescriptor for the basis to use.

Definition at line 293 of file Panzer_Integrator_BasisTimesVector.hpp.

template<typename EvalT , typename Traits >
IntegrationDescriptor panzer::Integrator_BasisTimesVector< EvalT, Traits >::id_
private

The IntegrationDescriptor for the quadrature to use.

Definition at line 298 of file Panzer_Integrator_BasisTimesVector.hpp.

template<typename EvalT , typename Traits >
PHX::MDField<ScalarT, panzer::Cell, panzer::BASIS> panzer::Integrator_BasisTimesVector< EvalT, Traits >::field_
private

A field to which we'll contribute, or in which we'll store, the result of computing this integral.

Definition at line 304 of file Panzer_Integrator_BasisTimesVector.hpp.

template<typename EvalT , typename Traits >
PHX::MDField<const ScalarT, panzer::Cell, panzer::IP, panzer::Dim> panzer::Integrator_BasisTimesVector< EvalT, Traits >::vector_
private

A field representing the vector-valued function we're integrating ( $ \vec{s} $).

Definition at line 311 of file Panzer_Integrator_BasisTimesVector.hpp.

template<typename EvalT , typename Traits >
double panzer::Integrator_BasisTimesVector< EvalT, Traits >::multiplier_
private

The scalar multiplier out in front of the integral ( $ M $).

Definition at line 317 of file Panzer_Integrator_BasisTimesVector.hpp.

template<typename EvalT , typename Traits >
std::vector<PHX::MDField<const ScalarT, panzer::Cell, panzer::IP> > panzer::Integrator_BasisTimesVector< EvalT, Traits >::fieldMults_
private

The (possibly empty) list of fields that are multipliers out in front of the integral ( $ a(x) $, $ b(x) $, etc.).

Definition at line 324 of file Panzer_Integrator_BasisTimesVector.hpp.

template<typename EvalT , typename Traits >
Kokkos::Array<Kokkos::View<const ScalarT**, typename PHX::DevLayout<ScalarT>::type, Kokkos::MemoryUnmanaged>,3> panzer::Integrator_BasisTimesVector< EvalT, Traits >::kokkosFieldMults_
private

The PHX::View representation of the (possibly empty) list of fields that are multipliers out in front of the integral ( $ a(x) $, $ b(x) $, etc.).

Definition at line 331 of file Panzer_Integrator_BasisTimesVector.hpp.

template<typename EvalT , typename Traits >
int panzer::Integrator_BasisTimesVector< EvalT, Traits >::numQP_
private

The number of quadrature points for each cell.

Definition at line 336 of file Panzer_Integrator_BasisTimesVector.hpp.

template<typename EvalT , typename Traits >
int panzer::Integrator_BasisTimesVector< EvalT, Traits >::numDim_
private

The dimensionality of our vector-valued fields.

Definition at line 341 of file Panzer_Integrator_BasisTimesVector.hpp.

template<typename EvalT , typename Traits >
std::string panzer::Integrator_BasisTimesVector< EvalT, Traits >::basisName_
private

The name of the basis we're using.

Definition at line 346 of file Panzer_Integrator_BasisTimesVector.hpp.

template<typename EvalT , typename Traits >
std::size_t panzer::Integrator_BasisTimesVector< EvalT, Traits >::basisIndex_
private

The index in the Workset bases for our particular BasisIRLayout name.

Definition at line 352 of file Panzer_Integrator_BasisTimesVector.hpp.

template<typename EvalT , typename Traits >
PHX::MDField<const double, panzer::Cell, panzer::BASIS, panzer::IP, panzer::Dim> panzer::Integrator_BasisTimesVector< EvalT, Traits >::basis_
private

The vector basis information necessary for integration.

Definition at line 358 of file Panzer_Integrator_BasisTimesVector.hpp.

The documentation for this class was generated from the following files:
Generated on Fri Nov 22 2024 09:15:21 for Panzer by   doxygen 1.8.5