#include <Panzer_Integrator_GradBasisTimesScalar_decl.hpp>

Inheritance diagram for panzer::Integrator_GradBasisTimesScalar< 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_GradBasisTimesScalar (const panzer::EvaluatorStyle &evalStyle, const std::vector< std::string > &resNames, const std::string &scalar, 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_GradBasisTimesScalar (const Teuchos::ParameterList &p)
	`ParameterList` Constructor.

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

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

template<int NUM_FIELD_MULT>
KOKKOS_INLINE_FUNCTION void	operator() (const FieldMultTag< NUM_FIELD_MULT > &tag, const std::size_t &cell) const
	Perform the integration.

template<int NUM_FIELD_MULT>
KOKKOS_INLINE_FUNCTION void	operator() (const FieldMultTag< NUM_FIELD_MULT > &, const size_t &cell) const

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.

using	InnerView = PHX::UnmanagedView< ScalarT ** >

using	OuterView = PHX::View< InnerView * >

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

std::vector< PHX::MDField< ScalarT, Cell, BASIS > >	fields_host_
	The fields to which we'll contribute, or in which we'll store, the result of computing this integral.

OuterView	fields_

PHX::MDField< const ScalarT, Cell, IP >	scalar_
	A field representing the scalar function we're integrating ( ).

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

std::vector< PHX::MDField< const ScalarT, Cell, IP > >	fieldMults_
	The scalar multiplier out in front of the integral ( ).

PHX::View< PHX::UnmanagedView< const ScalarT ** > * >	kokkosFieldMults_
	The `PHX::View` representation of the (possibly empty) list of fields that are multipliers out in front of the integral ( , , etc.).

int	numDims_
	The number of dimensions associated with the gradient.

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< double, panzer::Cell, panzer::BASIS, panzer::IP, panzer::Dim >	basis_
	The gradient 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_GradBasisTimesScalar< EvalT, Traits >

Definition at line 48 of file Panzer_Integrator_GradBasisTimesScalar_decl.hpp.

Member Typedef Documentation

◆ ScalarT

template<typename EvalT , typename Traits >

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

private

The scalar type.

Definition at line 225 of file Panzer_Integrator_GradBasisTimesScalar_decl.hpp.

◆ InnerView

template<typename EvalT , typename Traits >

using panzer::Integrator_GradBasisTimesScalar< EvalT, Traits >::InnerView = PHX::UnmanagedView<ScalarT**>

private

Definition at line 242 of file Panzer_Integrator_GradBasisTimesScalar_decl.hpp.

◆ OuterView

template<typename EvalT , typename Traits >

using panzer::Integrator_GradBasisTimesScalar< EvalT, Traits >::OuterView = PHX::View<InnerView*>

private

Definition at line 243 of file Panzer_Integrator_GradBasisTimesScalar_decl.hpp.

Constructor & Destructor Documentation

◆ Integrator_GradBasisTimesScalar() [1/2]

template<typename EvalT , typename Traits >

panzer::Integrator_GradBasisTimesScalar< EvalT, Traits >::Integrator_GradBasisTimesScalar	(	const panzer::EvaluatorStyle &	evalStyle,
		const std::vector< std::string > &	resNames,
		const std::string &	scalar,
		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 s(x)\nabla\phi(x)\,dx,$

where is some constant, , , etc., are some fields that depend on position, is some scalar function, and $\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]	resNames	The names of either the contributed or evaluated fields, depending on `evalStyle`.
[in]	scalar	The name of the scalar function being integrated ( ).
[in]	basis	The basis that you'd like to use ( $\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 does not support the gradient operator, or if the dimension of the space doesn't match the size of `resNames`.

Definition at line 39 of file Panzer_Integrator_GradBasisTimesScalar_impl.hpp.

◆ Integrator_GradBasisTimesScalar() [2/2]

template<typename EvalT , typename Traits >

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

ParameterList Constructor.

Creates an Evaluator to evaluate the integral

$Ma(x)b(x)\cdots\int s(x)\nabla\phi(x)\,dx,$

where is some constant, , , etc., are some fields that depend on position, is some scalar function, and $\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 Names"     type = "std::vector<std::string>"            value = (required)    />
  <Parameter name = "Scalar 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 Names" are the names for the terms this Evaluator is evaluating,
"Scalar Name" is the name of the scalar function being integrated ( ),
"Basis" is the basis that you'd like to use ( $\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 135 of file Panzer_Integrator_GradBasisTimesScalar_impl.hpp.

Member Function Documentation

◆ postRegistrationSetup()

template<typename EvalT , typename Traits >

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

Post-Registration Setup.

Sets the basis index, and gets the PHX::View versions of the field multipliers, if there are any.

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 an unused part of the `Evaluator` interface.

Definition at line 166 of file Panzer_Integrator_GradBasisTimesScalar_impl.hpp.

◆ evaluateFields()

template<typename EvalT , typename Traits >

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

Evaluate Fields.

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

Parameters

[in] workset The Workset on which you're going to do the integration.

Definition at line 264 of file Panzer_Integrator_GradBasisTimesScalar_impl.hpp.

◆ operator()() [1/2]

template<typename EvalT , typename Traits >

template<int NUM_FIELD_MULT>

KOKKOS_INLINE_FUNCTION void panzer::Integrator_GradBasisTimesScalar< EvalT, Traits >::operator()	(	const FieldMultTag< NUM_FIELD_MULT > &	tag,
		const std::size_t &	cell
	)		const

Perform the integration.

Generally speaking, for a given cell in the Workset, this routine loops over quadrature points, bases, and dimensions 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.

◆ getValidParameters()

template<typename EvalT , typename TRAITS >

Teuchos::RCP< Teuchos::ParameterList > panzer::Integrator_GradBasisTimesScalar< 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 292 of file Panzer_Integrator_GradBasisTimesScalar_impl.hpp.

◆ operator()() [2/2]

template<typename EvalT , typename Traits >

template<int NUM_FIELD_MULT>

KOKKOS_INLINE_FUNCTION void panzer::Integrator_GradBasisTimesScalar< EvalT, Traits >::operator()	(	const FieldMultTag< NUM_FIELD_MULT > &	,
		const size_t &	cell
	)		const