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 >:

[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.

	Integrator_BasisTimesVector (const Teuchos::ParameterList &p)
	`ParameterList` Constructor.

	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.

void	postRegistrationSetup (typename Traits::SetupData sd, PHX::FieldManager< Traits > &fm)
	Post-Registration Setup.

void	evaluateFields (typename Traits::EvalData workset)
	Evaluate Fields.

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.

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
	The scalar type.

Private Member Functions
Teuchos::RCP< Teuchos::ParameterList >	getValidParameters () const
	Get Valid Parameters.

Private Attributes
const panzer::EvaluatorStyle	evalStyle_
	An `enum` determining the behavior of this `Evaluator`.

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

BasisDescriptor	bd_
	The `BasisDescriptor` for the basis to use.

IntegrationDescriptor	id_
	The `IntegrationDescriptor` for the quadrature to use.

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.

PHX::MDField< const ScalarT, panzer::Cell, panzer::IP, panzer::Dim >	vector_
	A field representing the vector-valued function we're integrating ( $\vec{s}$ ).

double	multiplier_
	The scalar multiplier out in front of the integral ( ).

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 ( , , etc.).

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 ( , , etc.).

int	numQP_
	The number of quadrature points for each cell.

int	numDim_
	The dimensionality of our vector-valued fields.

std::string	basisName_
	The name of the basis we're using.

std::size_t	basisIndex_
	The index in the `Workset` bases for our particular `BasisIRLayout` name.

PHX::MDField< const double, panzer::Cell, panzer::BASIS, panzer::IP, panzer::Dim >	basis_
	The vector basis information necessary for integration.

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 is some constant, , , 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

◆ ScalarT

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

◆ Integrator_BasisTimesVector() [1/3]

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 is some constant, , , etc., are some fields that depend 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]	multiplier	The scalar multiplier out in front of the integral you're computing ( ). If not specified, this defaults to 1.
[in]	fmNames	A list of names of fields that are multipliers out in front of the integral you're computing ( , , etc.). If not specified, this defaults to an empty `vector`.

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 34 of file Panzer_Integrator_BasisTimesVector_impl.hpp.

◆ Integrator_BasisTimesVector() [2/3]

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 is some constant, , , 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]

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 = "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 ( ), and
"Field Multipliers" is an optional list of names of fields that are multipliers out in front of the integral you're computing ( , , etc.).

Definition at line 193 of file Panzer_Integrator_BasisTimesVector_impl.hpp.

◆ Integrator_BasisTimesVector() [3/3]

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 is some constant, , , etc., are some fields that depend 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]	multiplier	The scalar multiplier out in front of the integral you're computing ( ). If not specified, this defaults to 1.
[in]	multipliers	A list of names of fields that are multipliers out in front of the integral you're computing ( , , etc.). If not specified, this defaults to an empty `vector`.

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 116 of file Panzer_Integrator_BasisTimesVector_impl.hpp.

Member Function Documentation

◆ postRegistrationSetup()

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]	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 224 of file Panzer_Integrator_BasisTimesVector_impl.hpp.

◆ evaluateFields()

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

Definition at line 311 of file Panzer_Integrator_BasisTimesVector_impl.hpp.

◆ operator()()

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 ( ) and any field multipliers ( , , etc.).

Note: Optimizations are made for the cases in which we have no field multipliers or only a single one.

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 256 of file Panzer_Integrator_BasisTimesVector_impl.hpp.

◆ getValidParameters()

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 353 of file Panzer_Integrator_BasisTimesVector_impl.hpp.

Member Data Documentation

◆ evalStyle_

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.

◆ useDescriptors_

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.

◆ bd_

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.

◆ id_

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.

◆ field_

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.

◆ vector_

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.

◆ multiplier_

template<typename EvalT , typename Traits >

double panzer::Integrator_BasisTimesVector< EvalT, Traits >::multiplier_

private

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

Definition at line 317 of file Panzer_Integrator_BasisTimesVector.hpp.

◆ fieldMults_

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 ( , , etc.).

Definition at line 324 of file Panzer_Integrator_BasisTimesVector.hpp.

◆ kokkosFieldMults_

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 ( , , etc.).

Definition at line 331 of file Panzer_Integrator_BasisTimesVector.hpp.