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

#include <Panzer_Integrator_BasisTimesTensorTimesVector.hpp>

Inheritance diagram for panzer::Integrator_BasisTimesTensorTimesVector< EvalT, Traits >:

Public Member Functions
	Integrator_BasisTimesTensorTimesVector (const panzer::EvaluatorStyle &evalStyle, const std::string &resName, const std::string &valName, const panzer::BasisIRLayout &basis, const panzer::IntegrationRule &ir, const std::string &tensorName)
	Main Constructor. More...

	Integrator_BasisTimesTensorTimesVector (const Teuchos::ParameterList &p)
	`ParameterList` Constructor. More...

	Integrator_BasisTimesTensorTimesVector (const panzer::EvaluatorStyle &evalStyle, const PHX::FieldTag &resTag, const PHX::FieldTag &valTag, const BasisDescriptor &bd, const IntegrationDescriptor &id, const PHX::FieldTag &tensorTag)
	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...

void	operator() (const std::size_t &cell) 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 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...

PHX::MDField< const ScalarT, panzer::Cell, panzer::IP, panzer::Dim, panzer::Dim >	tensor_
	The tensor field( ). More...

Kokkos::View< const ScalarT ****, typename PHX::DevLayout < ScalarT >::type, PHX::Device >	kokkosTensor_
	The `Kokkos::View` representation of the tensor fields that are multiplied out in front of the integral ( ). 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< 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, 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::Integrator_BasisTimesTensorTimesVector< EvalT, Traits >

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

Evaluates the integral

$\int (a(x)\cdots\vec{s}(x))\cdot\vec{\phi}(x)\,dx,$

where $ a(x) $ is a tensor valued field that depends on position, $\vec{s}$ is some vector- valued function, and $\vec{\phi}$ is some vector basis.

Definition at line 81 of file Panzer_Integrator_BasisTimesTensorTimesVector.hpp.

Member Typedef Documentation

template<typename EvalT , typename Traits >

using panzer::Integrator_BasisTimesTensorTimesVector< EvalT, Traits >::ScalarT = typename EvalT::ScalarT

private

The scalar type.

Definition at line 266 of file Panzer_Integrator_BasisTimesTensorTimesVector.hpp.

Constructor & Destructor Documentation

template<typename EvalT , typename Traits >

panzer::Integrator_BasisTimesTensorTimesVector< EvalT, Traits >::Integrator_BasisTimesTensorTimesVector	(	const panzer::EvaluatorStyle &	evalStyle,
		const std::string &	resName,
		const std::string &	valName,
		const panzer::BasisIRLayout &	basis,
		const panzer::IntegrationRule &	ir,
		const std::string &	tensorName
	)

Main Constructor.

Creates an Evaluator to evaluate the integral

$\int (a(x)\cdots\vec{s}(x))\cdot\vec{\phi}(x)\,dx,$

where $ a(x) $ is a tensor valued field that depends on position, $\vec{s}$ is some vector- valued function, and $\vec{\phi}$ is some vector basis.

Parameters

[in]	evalStyle	An `enum` declaring the behavior of this `Evaluator`, which is to either: compute and contribute (`CONTRIBUTES`), or compute and store (`EVALUATES`).
[in]	resName	The name of either the contributed or evaluated field, depending on `evalStyle`.
[in]	valName	The name of the vector value being integrated ( $\vec{s}$ ).
[in]	basis	The vector basis that you'd like to use ( $\vec{\phi}$ ).
[in]	ir	The integration rule that you'd like to use.
[in]	tensorName	The tensors name ( ).

Exceptions

std::invalid_argument	If any of the inputs are invalid.
std::logic_error	If the `basis` supplied is not a vector basis, or if it doesn't require orientations.

Definition at line 66 of file Panzer_Integrator_BasisTimesTensorTimesVector_impl.hpp.

template<typename EvalT , typename Traits >

panzer::Integrator_BasisTimesTensorTimesVector< EvalT, Traits >::Integrator_BasisTimesTensorTimesVector ( const Teuchos::ParameterList & p )

ParameterList Constructor.

Creates an Evaluator to evaluate the integral

$\int (a(x)\cdots\vec{s}(x))\cdot\vec{\phi}(x)\,dx,$

where $ a(x) $ is a tensor valued field that depends 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]

p

A 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 = "Tensor Name"       type = "std::string"                         value = (required)    />
</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, and
"Tensor Name" is the name of the tensor field ( ).

Definition at line 203 of file Panzer_Integrator_BasisTimesTensorTimesVector_impl.hpp.

template<typename EvalT , typename Traits >

panzer::Integrator_BasisTimesTensorTimesVector< EvalT, Traits >::Integrator_BasisTimesTensorTimesVector	(	const panzer::EvaluatorStyle &	evalStyle,
		const PHX::FieldTag &	resTag,
		const PHX::FieldTag &	valTag,
		const BasisDescriptor &	bd,
		const IntegrationDescriptor &	id,
		const PHX::FieldTag &	tensorTag
	)

Descriptor Constructor.

Creates an Evaluator to evaluate the integral

$\int (a(x)\cdots\vec{s}(x))\cdot\vec{\phi}(x)\,dx,$

where $ a(x) $ is a tensor valued field that depends on position, $\vec{s}$ is some vector- valued function, and $\vec{\phi}$ is some vector basis.

Parameters

[in]	evalStyle	An `enum` declaring the behavior of this `Evaluator`, which is to either: compute and contribute (`CONTRIBUTES`), or compute and store (`EVALUATES`).
[in]	resTag	The tag of either the contributed or evaluated field, depending on `evalStyle`.
[in]	valTag	The tag of the vector value being integrated ( $\vec{s}$ ).
[in]	bd	The vector basisdescripotr that you'd like to use ( $\vec{\phi}$ ).
[in]	id	The integration descriptor that you'd like to use.
[in]	tensorTag	The tag of the tensor ( ).

Exceptions

std::invalid_argument	If any of the inputs are invalid.
std::logic_error	If the `basis` supplied is not a vector basis, or if it doesn't require orientations.

Definition at line 138 of file Panzer_Integrator_BasisTimesTensorTimesVector_impl.hpp.

Member Function Documentation

template<typename EvalT , typename Traits >

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

Post-Registration Setup.

Sets the Kokkos::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]	sd	Essentially a list of `Workset`s, which are collections of cells (elements) that all live on a single process.
[in]	fm	This is unused, though part of the interface.

Definition at line 230 of file Panzer_Integrator_BasisTimesTensorTimesVector_impl.hpp.

template<typename EvalT , typename Traits >

void panzer::Integrator_BasisTimesTensorTimesVector< 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] workeset The Workset on which you're going to do the integration.

Definition at line 295 of file Panzer_Integrator_BasisTimesTensorTimesVector_impl.hpp.

template<typename EvalT , typename Traits >

KOKKOS_INLINE_FUNCTION void panzer::Integrator_BasisTimesTensorTimesVector< EvalT, Traits >::operator() ( const std::size_t & cell ) 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 tensor ( $ a(x) $ ).

Parameters

[in]	tag	An indication of the number of field multipliers we have; either 0, 1, or something else.
[in]	cell	The cell in the `Workset` over which to integrate.

Definition at line 259 of file Panzer_Integrator_BasisTimesTensorTimesVector_impl.hpp.

template<typename EvalT , typename Traits >

Teuchos::RCP< Teuchos::ParameterList > panzer::Integrator_BasisTimesTensorTimesVector< 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 318 of file Panzer_Integrator_BasisTimesTensorTimesVector_impl.hpp.

Member Data Documentation

template<typename EvalT , typename Traits >

const panzer::EvaluatorStyle panzer::Integrator_BasisTimesTensorTimesVector< 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 276 of file Panzer_Integrator_BasisTimesTensorTimesVector.hpp.

template<typename EvalT , typename Traits >

bool panzer::Integrator_BasisTimesTensorTimesVector< EvalT, Traits >::useDescriptors_

private

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

Definition at line 282 of file Panzer_Integrator_BasisTimesTensorTimesVector.hpp.

template<typename EvalT , typename Traits >

BasisDescriptor panzer::Integrator_BasisTimesTensorTimesVector< EvalT, Traits >::bd_

private

The BasisDescriptor for the basis to use.

Definition at line 287 of file Panzer_Integrator_BasisTimesTensorTimesVector.hpp.

template<typename EvalT , typename Traits >

IntegrationDescriptor panzer::Integrator_BasisTimesTensorTimesVector< EvalT, Traits >::id_

private

The IntegrationDescriptor for the quadrature to use.

Definition at line 292 of file Panzer_Integrator_BasisTimesTensorTimesVector.hpp.

template<typename EvalT , typename Traits >

PHX::MDField<ScalarT, panzer::Cell, panzer::BASIS> panzer::Integrator_BasisTimesTensorTimesVector< 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 298 of file Panzer_Integrator_BasisTimesTensorTimesVector.hpp.

template<typename EvalT , typename Traits >

PHX::MDField<const ScalarT, panzer::Cell, panzer::IP, panzer::Dim> panzer::Integrator_BasisTimesTensorTimesVector< EvalT, Traits >::vector_

private

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

Definition at line 305 of file Panzer_Integrator_BasisTimesTensorTimesVector.hpp.

template<typename EvalT , typename Traits >

PHX::MDField<const ScalarT, panzer::Cell, panzer::IP, panzer::Dim, panzer::Dim> panzer::Integrator_BasisTimesTensorTimesVector< EvalT, Traits >::tensor_

private

The tensor field( $ a(x) $ ).

Definition at line 311 of file Panzer_Integrator_BasisTimesTensorTimesVector.hpp.

template<typename EvalT , typename Traits >

Kokkos::View<const ScalarT****,typename PHX::DevLayout<ScalarT>::type,PHX::Device> panzer::Integrator_BasisTimesTensorTimesVector< EvalT, Traits >::kokkosTensor_

private

The Kokkos::View representation of the tensor fields that are multiplied out in front of the integral ( $ a(x) $ ).

Definition at line 317 of file Panzer_Integrator_BasisTimesTensorTimesVector.hpp.

template<typename EvalT , typename Traits >

int panzer::Integrator_BasisTimesTensorTimesVector< EvalT, Traits >::numQP_

private

The number of quadrature points for each cell.

Definition at line 323 of file Panzer_Integrator_BasisTimesTensorTimesVector.hpp.

template<typename EvalT , typename Traits >

int panzer::Integrator_BasisTimesTensorTimesVector< EvalT, Traits >::numDim_

private

The dimensionality of our vector-valued fields.

Definition at line 328 of file Panzer_Integrator_BasisTimesTensorTimesVector.hpp.

template<typename EvalT , typename Traits >

std::string panzer::Integrator_BasisTimesTensorTimesVector< EvalT, Traits >::basisName_

private

The name of the basis we're using.

Definition at line 333 of file Panzer_Integrator_BasisTimesTensorTimesVector.hpp.

template<typename EvalT , typename Traits >

std::size_t panzer::Integrator_BasisTimesTensorTimesVector< EvalT, Traits >::basisIndex_

private

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

Definition at line 339 of file Panzer_Integrator_BasisTimesTensorTimesVector.hpp.

template<typename EvalT , typename Traits >

PHX::MDField<double, panzer::Cell, panzer::BASIS, panzer::IP, panzer::Dim> panzer::Integrator_BasisTimesTensorTimesVector< EvalT, Traits >::basis_

private

The vector basis information necessary for integration.

Definition at line 345 of file Panzer_Integrator_BasisTimesTensorTimesVector.hpp.

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

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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