Panzer
Version of the Day
|
Computes . More...
#include <Panzer_Integrator_BasisTimesVector.hpp>
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> | |
void | operator() (const FieldMultTag< NUM_FIELD_MULT > &tag, const std::size_t &cell) const |
Perform the integration. More... | |
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. 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 ( ). More... | |
double | multiplier_ |
The scalar multiplier out in front of the integral ( ). 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 ( , , etc.). More... | |
Kokkos::View< Kokkos::View < const ScalarT **, typename PHX::DevLayout< ScalarT > ::type, PHX::Device > * > | kokkosFieldMults_ |
The Kokkos::View representation of the (possibly empty) list of fields that are multipliers out in front of the integral ( , , 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< 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 |
Computes .
Evaluates the integral
where is some constant, , , etc., are some fields that depend on position, is some vector- valued function, and is some vector basis.
Definition at line 81 of file Panzer_Integrator_BasisTimesVector.hpp.
|
private |
The scalar type.
Definition at line 303 of file Panzer_Integrator_BasisTimesVector.hpp.
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
where is some constant, , , etc., are some fields that depend on position, is some vector-valued function, and is some vector basis.
[in] | evalStyle | An enum declaring the behavior of this Evaluator , which is to either:
|
[in] | resName | The name of either the contributed or evaluated field, depending on evalStyle . |
[in] | valName | The name of the vector value being integrated ( ). |
[in] | basis | The vector basis that you'd like to use ( ). |
[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 . |
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_BasisTimesVector_impl.hpp.
panzer::Integrator_BasisTimesVector< EvalT, Traits >::Integrator_BasisTimesVector | ( | const Teuchos::ParameterList & | p | ) |
ParameterList
Constructor.
Creates an Evaluator
to evaluate the integral
where is some constant, , , etc., are some fields that depend on position, is some vector-valued function, and is some vector basis.
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.[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>
|
Definition at line 225 of file Panzer_Integrator_BasisTimesVector_impl.hpp.
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
where is some constant, , , etc., are some fields that depend on position, is some vector-valued function, and is some vector basis.
[in] | evalStyle | An enum declaring the behavior of this Evaluator , which is to either:
|
[in] | resTag | The tag of either the contributed or evaluated field, depending on evalStyle . |
[in] | valTag | The tag of the vector value being integrated ( ). |
[in] | bd | The vector basisdescripotr that you'd like to use ( ). |
[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 . |
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 149 of file Panzer_Integrator_BasisTimesVector_impl.hpp.
void panzer::Integrator_BasisTimesVector< EvalT, Traits >::postRegistrationSetup | ( | typename Traits::SetupData | sd, |
PHX::FieldManager< Traits > & | fm | ||
) |
Post-Registration Setup.
Sets the Kokkos::View
s for all the of the field multipliers, sets the number of quadrature points and dimensions in our vector field, and sets the basis index.
[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 256 of file Panzer_Integrator_BasisTimesVector_impl.hpp.
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
.
[in] | workeset | The Workset on which you're going to do the integration. |
Definition at line 364 of file Panzer_Integrator_BasisTimesVector_impl.hpp.
void panzer::Integrator_BasisTimesVector< 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, vector dimensions, and bases to perform the integration, scaling the vector field to be integrated by the multiplier ( ) and any field multipliers ( , , etc.).
[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. |
|
private |
Get Valid Parameters.
Get all the parameters that we support such that the ParameterList
Constructor can do some validation of the input ParameterList
.
ParameterList
with all the valid parameters (keys) in it. The values tied to those keys are meaningless default values. Definition at line 395 of file Panzer_Integrator_BasisTimesVector_impl.hpp.
KOKKOS_INLINE_FUNCTION void panzer::Integrator_BasisTimesVector< EvalT, Traits >::operator() | ( | const FieldMultTag< NUM_FIELD_MULT > & | , |
const size_t & | cell | ||
) | const |
Definition at line 287 of file Panzer_Integrator_BasisTimesVector_impl.hpp.
|
private |
An enum
determining the behavior of this Evaluator
.
This Evaluator
will compute the result of its integration and then:
Definition at line 313 of file Panzer_Integrator_BasisTimesVector.hpp.
|
private |
A flag indicating whether or not to use the descriptor interface.
Definition at line 319 of file Panzer_Integrator_BasisTimesVector.hpp.
|
private |
The BasisDescriptor
for the basis to use.
Definition at line 324 of file Panzer_Integrator_BasisTimesVector.hpp.
|
private |
The IntegrationDescriptor
for the quadrature to use.
Definition at line 329 of file Panzer_Integrator_BasisTimesVector.hpp.
|
private |
A field to which we'll contribute, or in which we'll store, the result of computing this integral.
Definition at line 335 of file Panzer_Integrator_BasisTimesVector.hpp.
|
private |
A field representing the vector-valued function we're integrating ( ).
Definition at line 342 of file Panzer_Integrator_BasisTimesVector.hpp.
|
private |
The scalar multiplier out in front of the integral ( ).
Definition at line 348 of file Panzer_Integrator_BasisTimesVector.hpp.
|
private |
The (possibly empty) list of fields that are multipliers out in front of the integral ( , , etc.).
Definition at line 355 of file Panzer_Integrator_BasisTimesVector.hpp.
|
private |
The Kokkos::View
representation of the (possibly empty) list of fields that are multipliers out in front of the integral ( , , etc.).
Definition at line 362 of file Panzer_Integrator_BasisTimesVector.hpp.
|
private |
The number of quadrature points for each cell.
Definition at line 367 of file Panzer_Integrator_BasisTimesVector.hpp.
|
private |
The dimensionality of our vector-valued fields.
Definition at line 372 of file Panzer_Integrator_BasisTimesVector.hpp.
|
private |
The name of the basis we're using.
Definition at line 377 of file Panzer_Integrator_BasisTimesVector.hpp.
|
private |
The index in the Workset
bases for our particular BasisIRLayout
name.
Definition at line 383 of file Panzer_Integrator_BasisTimesVector.hpp.
|
private |
The vector basis information necessary for integration.
Definition at line 389 of file Panzer_Integrator_BasisTimesVector.hpp.