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

#include <Panzer_Integrator_CurlBasisDotVector.hpp>

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

Public Member Functions
	Integrator_CurlBasisDotVector (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_CurlBasisDotVector (const Teuchos::ParameterList &p)
	ParameterList Constructor.
	Integrator_CurlBasisDotVector (const panzer::EvaluatorStyle &evalStyle, const PHX::FieldTag &resTag, const PHX::FieldTag &valTag, const panzer::BasisDescriptor &bd, const panzer::IntegrationDescriptor &id, const int &spaceDim=3, const double &multiplier=1, const std::vector< PHX::FieldTag > &multipliers=std::vector< PHX::FieldTag >())
	FieldTag Constructor.
void	postRegistrationSetup (typename Traits::SetupData sd, PHX::FieldManager< Traits > &fm)
	Post-Registration Setup.
void	evaluateFields (typename Traits::EvalData d)
	Evaluate Fields.
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.
panzer::BasisDescriptor	bd_
	The BasisDescriptor for the basis to use.
panzer::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 >	vector2D_
	A field representing the vector-valued function we're integrating ( $\vec{s}$ ) in a two-dimensional problem.
PHX::MDField< const ScalarT, panzer::Cell, panzer::IP, panzer::Dim >	vector3D_
	A field representing the vector-valued function we're integrating ( $\vec{s}$ ) in a three-dimensional problem.
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.).
PHX::View< Kokkos::View< const ScalarT *, typename PHX::DevLayout< ScalarT >::type, Kokkos::MemoryUnmanaged > >	kokkosFieldMults_
	The PHX::View representation of the (possibly empty) list of fields that are multipliers out in front of the integral ( , , etc.).
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.
int	spaceDim_
	The spatial dimension of the vector-valued function we're integrating, either 2 or 3.
PHX::MDField< ScalarT, panzer::Cell, panzer::IP >	result2D_
	A field used to build up the result of this integral when working on a two-dimensional vector field.
PHX::MDField< ScalarT, panzer::Cell, panzer::IP, panzer::Dim >	result3D_
	A field used to build up the result of this integral when working on a three-dimensional vector field.

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_CurlBasisDotVector< EvalT, Traits >

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

Evaluates the integral

$\‍[ Ma(x)b(x)\cdots\int\nabla\times\vec{\phi}\cdot\vec{v}\, dx, \‍]$

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

Note: The name can be misleading. In contrast to 3-D, the curl of a vector in 2-D is simply a scalar. This Evaluator handles both cases.

Definition at line 85 of file Panzer_Integrator_CurlBasisDotVector.hpp.

Member Typedef Documentation

◆ ScalarT

template<typename EvalT, typename Traits>

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

private

The scalar type.

Definition at line 279 of file Panzer_Integrator_CurlBasisDotVector.hpp.

Constructor & Destructor Documentation

◆ Integrator_CurlBasisDotVector() [1/3]

template<typename EvalT, typename Traits>

panzer::Integrator_CurlBasisDotVector< EvalT, Traits >::Integrator_CurlBasisDotVector	(	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\nabla\times\vec{\phi}\cdot\vec{v}\, dx, \‍]$

where $ M $ is some constant, $ a(x) $ , $ b(x) $ , etc., are some fields that depend on position, $\vec{v}$ 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 72 of file Panzer_Integrator_CurlBasisDotVector_impl.hpp.

◆ Integrator_CurlBasisDotVector() [2/3]

template<typename EvalT, typename Traits>

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

ParameterList Constructor.

Creates an Evaluator to evaluate the integral

$\‍[ Ma(x)b(x)\cdots\int\nabla\times\vec{\phi}\cdot\vec{v}\, 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]

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 173 of file Panzer_Integrator_CurlBasisDotVector_impl.hpp.

◆ Integrator_CurlBasisDotVector() [3/3]

template<typename EvalT, typename TRAITS>

panzer::Integrator_CurlBasisDotVector< EvalT, TRAITS >::Integrator_CurlBasisDotVector	(	const panzer::EvaluatorStyle &	evalStyle,
		const PHX::FieldTag &	resTag,
		const PHX::FieldTag &	valTag,
		const panzer::BasisDescriptor &	bd,
		const panzer::IntegrationDescriptor &	id,
		const int &	spaceDim = 3,
		const double &	multiplier = 1,
		const std::vector< PHX::FieldTag > &	multipliers = std::vector<PHX::FieldTag>() )

FieldTag Constructor.

Creates an Evaluator to evaluate the integral

$\‍[ Ma(x)b(x)\cdots\int\nabla\times\vec{\phi}\cdot\vec{v}\, 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]	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 basis descriptor that you'd like to use ( $\vec{\phi}$ ).
[in]	id	The integration descriptor that you'd like to use.
[in]	spaceDim	The spatial dimensionality of the problem. If not specified, this defaults to 3.
[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 tags 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 203 of file Panzer_Integrator_CurlBasisDotVector_impl.hpp.

Member Function Documentation

◆ postRegistrationSetup()

template<typename EvalT, typename Traits>

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

Post-Registration Setup.

Sets the PHX::Views for all of the field multipliers, sets the basis index, and sets up the field that will be used to build up the result of the integration.

Parameters

[in]	sd	Essentially a list of Worksets, which are collections of cells (elements) that all live on a single process.
[in]	fm	The FieldManager used to create the field to build up the result.

Definition at line 284 of file Panzer_Integrator_CurlBasisDotVector_impl.hpp.

◆ evaluateFields()

template<typename EvalT, typename Traits>

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

Evaluate Fields.

This actually performs the integration using a handful of functors in Kokkos::parallel_fors, looping over the cells in the Workset.

Parameters

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

Definition at line 688 of file Panzer_Integrator_CurlBasisDotVector_impl.hpp.

◆ getValidParameters()

template<typename EvalT, typename TRAITS>

Teuchos::RCP< Teuchos::ParameterList > panzer::Integrator_CurlBasisDotVector< 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 784 of file Panzer_Integrator_CurlBasisDotVector_impl.hpp.

Member Data Documentation

◆ evalStyle_

template<typename EvalT, typename Traits>

const panzer::EvaluatorStyle panzer::Integrator_CurlBasisDotVector< 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 289 of file Panzer_Integrator_CurlBasisDotVector.hpp.

◆ useDescriptors_

template<typename EvalT, typename Traits>

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

private

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

Definition at line 295 of file Panzer_Integrator_CurlBasisDotVector.hpp.

◆ bd_

template<typename EvalT, typename Traits>

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

private

The BasisDescriptor for the basis to use.

Definition at line 300 of file Panzer_Integrator_CurlBasisDotVector.hpp.

◆ id_

template<typename EvalT, typename Traits>

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

private

The IntegrationDescriptor for the quadrature to use.

Definition at line 305 of file Panzer_Integrator_CurlBasisDotVector.hpp.

◆ field_

template<typename EvalT, typename Traits>

PHX::MDField<ScalarT, panzer::Cell, panzer::BASIS> panzer::Integrator_CurlBasisDotVector< 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 311 of file Panzer_Integrator_CurlBasisDotVector.hpp.

◆ vector2D_

template<typename EvalT, typename Traits>

PHX::MDField<const ScalarT, panzer::Cell, panzer::IP> panzer::Integrator_CurlBasisDotVector< EvalT, Traits >::vector2D_

private

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

Definition at line 317 of file Panzer_Integrator_CurlBasisDotVector.hpp.

◆ vector3D_

template<typename EvalT, typename Traits>

PHX::MDField<const ScalarT, panzer::Cell, panzer::IP, panzer::Dim> panzer::Integrator_CurlBasisDotVector< EvalT, Traits >::vector3D_

private

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

Definition at line 324 of file Panzer_Integrator_CurlBasisDotVector.hpp.

◆ multiplier_

template<typename EvalT, typename Traits>

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

private

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

Definition at line 330 of file Panzer_Integrator_CurlBasisDotVector.hpp.

◆ fieldMults_

template<typename EvalT, typename Traits>

std::vector<PHX::MDField<const ScalarT, panzer::Cell, panzer::IP> > panzer::Integrator_CurlBasisDotVector< 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 337 of file Panzer_Integrator_CurlBasisDotVector.hpp.

◆ kokkosFieldMults_

template<typename EvalT, typename Traits>

PHX::View<Kokkos::View<const ScalarT**, typename PHX::DevLayout<ScalarT>::type, Kokkos::MemoryUnmanaged>*> panzer::Integrator_CurlBasisDotVector< 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 344 of file Panzer_Integrator_CurlBasisDotVector.hpp.