Panzer Version of the Day
Loading...
Searching...
No Matches
Panzer_BasisValues2.hpp
Go to the documentation of this file.
1// @HEADER
2// ***********************************************************************
3//
4// Panzer: A partial differential equation assembly
5// engine for strongly coupled complex multiphysics systems
6// Copyright (2011) Sandia Corporation
7//
8// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9// the U.S. Government retains certain rights in this software.
10//
11// Redistribution and use in source and binary forms, with or without
12// modification, are permitted provided that the following conditions are
13// met:
14//
15// 1. Redistributions of source code must retain the above copyright
16// notice, this list of conditions and the following disclaimer.
17//
18// 2. Redistributions in binary form must reproduce the above copyright
19// notice, this list of conditions and the following disclaimer in the
20// documentation and/or other materials provided with the distribution.
21//
22// 3. Neither the name of the Corporation nor the names of the
23// contributors may be used to endorse or promote products derived from
24// this software without specific prior written permission.
25//
26// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37//
38// Questions? Contact Roger P. Pawlowski (rppawlo@sandia.gov) and
39// Eric C. Cyr (eccyr@sandia.gov)
40// ***********************************************************************
41// @HEADER
42
43#ifndef PANZER_BASIS_VALUES2_HPP
44#define PANZER_BASIS_VALUES2_HPP
45
46#include "Teuchos_RCP.hpp"
47
48#include "Intrepid2_Basis.hpp"
49#include "Intrepid2_Orientation.hpp"
50
53
54namespace panzer {
55
56 // For applying orientations with lazy evaluation
57 class OrientationsInterface;
58
99 template <typename Scalar>
101 public:
103 using IntrepidBasis = Intrepid2::Basis<PHX::Device::execution_space,Scalar,Scalar>;
104
105 typedef PHX::MDField<Scalar> ArrayDynamic;
106 typedef PHX::MDField<Scalar,BASIS,IP> Array_BasisIP;
107 typedef PHX::MDField<Scalar,BASIS,IP,Dim> Array_BasisIPDim;
108 typedef PHX::MDField<Scalar,BASIS,Dim> Array_BasisDim;
109 typedef PHX::MDField<Scalar,Cell,BASIS,IP> Array_CellBasisIP;
110 typedef PHX::MDField<Scalar,Cell,BASIS,IP,Dim> Array_CellBasisIPDim;
111 typedef PHX::MDField<Scalar,Cell,BASIS,Dim> Array_CellBasisDim;
112
113 typedef PHX::MDField<const Scalar> ConstArrayDynamic;
114 typedef PHX::MDField<const Scalar,BASIS,IP> ConstArray_BasisIP;
115 typedef PHX::MDField<const Scalar,BASIS,IP,Dim> ConstArray_BasisIPDim;
116 typedef PHX::MDField<const Scalar,BASIS,Dim> ConstArray_BasisDim;
117 typedef PHX::MDField<const Scalar,Cell,BASIS,IP> ConstArray_CellBasisIP;
118 typedef PHX::MDField<const Scalar,Cell,BASIS,IP,Dim> ConstArray_CellBasisIPDim;
119 typedef PHX::MDField<const Scalar,Cell,BASIS,Dim> ConstArray_CellBasisDim;
120
121 //=======================================================================================================
122 // DEPRECATED Interface
123
133 BasisValues2(const std::string & prefix="",
134 const bool allocArrays=false,
135 const bool buildWeighted=false);
136
138 void setupArrays(const Teuchos::RCP<const panzer::BasisIRLayout>& basis,
139 bool computeDerivatives=true);
140
141 void evaluateValues(const PHX::MDField<Scalar,IP,Dim> & cub_points,
142 const PHX::MDField<Scalar,Cell,IP,Dim,Dim> & jac,
143 const PHX::MDField<Scalar,Cell,IP> & jac_det,
144 const PHX::MDField<Scalar,Cell,IP,Dim,Dim> & jac_inv,
145 const int in_num_cells = -1);
146
147 void evaluateValues(const PHX::MDField<Scalar,IP,Dim> & cub_points,
148 const PHX::MDField<Scalar,Cell,IP,Dim,Dim> & jac,
149 const PHX::MDField<Scalar,Cell,IP> & jac_det,
150 const PHX::MDField<Scalar,Cell,IP,Dim,Dim> & jac_inv,
151 const PHX::MDField<Scalar,Cell,IP> & weighted_measure,
152 const PHX::MDField<Scalar,Cell,NODE,Dim> & vertex_coordinates,
153 bool use_vertex_coordinates=true,
154 const int in_num_cells = -1);
155
156 void evaluateValuesCV(const PHX::MDField<Scalar,Cell,IP,Dim> & cell_cub_points,
157 const PHX::MDField<Scalar,Cell,IP,Dim,Dim> & jac,
158 const PHX::MDField<Scalar,Cell,IP> & jac_det,
159 const PHX::MDField<Scalar,Cell,IP,Dim,Dim> & jac_inv);
160
161
162 void evaluateValuesCV(const PHX::MDField<Scalar,Cell,IP,Dim> & cell_cub_points,
163 const PHX::MDField<Scalar,Cell,IP,Dim,Dim> & jac,
164 const PHX::MDField<Scalar,Cell,IP> & jac_det,
165 const PHX::MDField<Scalar,Cell,IP,Dim,Dim> & jac_inv,
166 const PHX::MDField<Scalar,Cell,NODE,Dim> & vertex_coordinates,
167 bool use_vertex_coordinates=true,
168 const int in_num_cells = -1);
169
170
171 void evaluateValues(const PHX::MDField<Scalar,Cell,IP,Dim> & cub_points,
172 const PHX::MDField<Scalar,Cell,IP,Dim,Dim> & jac,
173 const PHX::MDField<Scalar,Cell,IP> & jac_det,
174 const PHX::MDField<Scalar,Cell,IP,Dim,Dim> & jac_inv,
175 const PHX::MDField<Scalar,Cell,IP> & weighted_measure,
176 const PHX::MDField<Scalar,Cell,NODE,Dim> & vertex_coordinates,
177 bool use_vertex_coordinates=true,
178 const int in_num_cells = -1);
179
180
182 // some evaluators use this apply orientation (this will be deprecated)
183 void applyOrientations(const PHX::MDField<const Scalar,Cell,BASIS> & orientations);
184
185 // this is used in workset factory
186 void applyOrientations(const std::vector<Intrepid2::Orientation> & orientations,
187 const int in_num_cells = -1);
188
189 void setExtendedDimensions(const std::vector<PHX::index_size_type> & ddims)
190 { ddims_ = ddims; }
191
193
194 mutable Array_BasisIP basis_ref_scalar; // <BASIS,IP>
195 mutable Array_CellBasisIP basis_scalar; // <Cell,BASIS,IP>
196
197 mutable Array_BasisIPDim basis_ref_vector; // <BASIS,IP,Dim>
198 mutable Array_CellBasisIPDim basis_vector; // <Cell,BASIS,IP,Dim>
199
200 mutable Array_BasisIPDim grad_basis_ref; // <BASIS,IP,Dim>
201 mutable Array_CellBasisIPDim grad_basis; // <Cell,BASIS,IP,Dim>
202
203 mutable Array_BasisIP curl_basis_ref_scalar; // <BASIS,IP> - 2D!
204 mutable Array_CellBasisIP curl_basis_scalar; // <Cell,BASIS,IP> - 2D!
205
206 mutable Array_BasisIPDim curl_basis_ref_vector; // <BASIS,IP,Dim> - 3D!
207 mutable Array_CellBasisIPDim curl_basis_vector; // <Cell,BASIS,IP,Dim> - 3D!
208
209 mutable Array_BasisIP div_basis_ref; // <BASIS,IP>
210 mutable Array_CellBasisIP div_basis; // <Cell,BASIS,IP>
211
212 mutable Array_CellBasisIP weighted_basis_scalar; // <Cell,BASIS,IP>
213 mutable Array_CellBasisIPDim weighted_basis_vector; // <Cell,BASIS,IP,Dim>
214 mutable Array_CellBasisIPDim weighted_grad_basis; // <Cell,BASIS,IP,Dim>
216 mutable Array_CellBasisIPDim weighted_curl_basis_vector; // <Cell,BASIS,IP,Dim>
217 mutable Array_CellBasisIP weighted_div_basis; // <Cell,BASIS,IP>
218
224 mutable Array_BasisDim basis_coordinates_ref; // <BASIS,Dim>
225
231 mutable Array_CellBasisDim basis_coordinates; // <Cell,BASIS,Dim>
232
233 Teuchos::RCP<const panzer::BasisIRLayout> basis_layout;
234
235 Teuchos::RCP<IntrepidBasis> intrepid_basis;
236
240 std::string prefix;
241 std::vector<PHX::index_size_type> ddims_;
242
244 {return orientations_applied_;}
245
246 void evaluateBasisCoordinates(const PHX::MDField<Scalar,Cell,NODE,Dim> & vertex_coordinates,
247 const int in_num_cells = -1);
248
249 private:
250
252
253 // Have orientations been applied
255
256 //=======================================================================================================
257 // New Interface
258
259 protected:
260
261 // Reset internal data structures for lazy evaluation
262 void resetArrays();
263
264 // Number of total cells (owned + ghost + virtual)
266
267 // Number of cells to evaluate (HACK for backward compatability)
269
270 // True if a uniform point space is used
272
273 // Only valid for uniform reference space
274 PHX::MDField<const Scalar,IP,Dim> cubature_points_uniform_ref_;
275
276 // For non-uniform reference space
277 PHX::MDField<const Scalar,Cell,IP,Dim> cubature_points_ref_;
278
279 // Geometry objects that represent cubature/point values
280 PHX::MDField<const Scalar,Cell,IP,Dim,Dim> cubature_jacobian_;
281 PHX::MDField<const Scalar,Cell,IP> cubature_jacobian_determinant_;
282 PHX::MDField<const Scalar,Cell,IP,Dim,Dim> cubature_jacobian_inverse_;
283 PHX::MDField<const Scalar,Cell,IP> cubature_weights_;
284
285 PHX::MDField<const Scalar,Cell,NODE,Dim> cell_vertex_coordinates_;
286
287 // Number of cells to apply orientations to (required in situations where virtual cells exist)
289
290 // Orientations object
291 std::vector<Intrepid2::Orientation> orientations_;
292
314
315 public:
316
330 void
331 setup(const Teuchos::RCP<const panzer::BasisIRLayout> & basis,
332 PHX::MDField<const Scalar, Cell, IP, Dim> reference_points,
333 PHX::MDField<const Scalar, Cell, IP, Dim, Dim> point_jacobian,
334 PHX::MDField<const Scalar, Cell, IP> point_jacobian_determinant,
335 PHX::MDField<const Scalar, Cell, IP, Dim, Dim> point_jacobian_inverse,
336 const int num_evaluated_cells = -1);
337
351 void
352 setupUniform(const Teuchos::RCP<const panzer::BasisIRLayout> & basis,
353 PHX::MDField<const Scalar, IP, Dim> reference_points,
354 PHX::MDField<const Scalar, Cell, IP, Dim, Dim> point_jacobian,
355 PHX::MDField<const Scalar, Cell, IP> point_jacobian_determinant,
356 PHX::MDField<const Scalar, Cell, IP, Dim, Dim> point_jacobian_inverse,
357 const int num_evaluated_cells = -1);
358
360 void
361 setOrientations(const std::vector<Intrepid2::Orientation> & orientations,
362 const int num_orientations_cells = -1);
363
365 void
366 setWeightedMeasure(PHX::MDField<const Scalar, Cell, IP> weighted_measure);
367
369 void
370 setCellVertexCoordinates(PHX::MDField<Scalar,Cell,NODE,Dim> vertex_coordinates);
371
373 bool
375 {return is_uniform_;}
376
378 const std::vector<PHX::index_size_type> &
380 {return ddims_;}
381
382 //=======================================================================================================
383 // Reference space evaluations
384
397 getBasisCoordinatesRef(const bool cache = true,
398 const bool force = false) const;
399
412 getBasisValuesRef(const bool cache = true,
413 const bool force = false) const;
414
427 getVectorBasisValuesRef(const bool cache = true,
428 const bool force = false) const;
429
442 getGradBasisValuesRef(const bool cache = true,
443 const bool force = false) const;
444
458 getCurl2DVectorBasisRef(const bool cache = true,
459 const bool force = false) const;
460
474 getCurlVectorBasisRef(const bool cache = true,
475 const bool force = false) const;
476
490 getDivVectorBasisRef(const bool cache = true,
491 const bool force = false) const;
492
493 //=======================================================================================================
494 // Mesh evaluations
495
504 getBasisCoordinates(const bool cache = true,
505 const bool force = false) const;
506
519 getBasisValues(const bool weighted,
520 const bool cache = true,
521 const bool force = false) const;
522
535 getVectorBasisValues(const bool weighted,
536 const bool cache = true,
537 const bool force = false) const;
538
551 getGradBasisValues(const bool weighted,
552 const bool cache = true,
553 const bool force = false) const;
554
568 getCurl2DVectorBasis(const bool weighted,
569 const bool cache = true,
570 const bool force = false) const;
571
585 getCurlVectorBasis(const bool weighted,
586 const bool cache = true,
587 const bool force = false) const;
588
602 getDivVectorBasis(const bool weighted,
603 const bool cache = true,
604 const bool force = false) const;
605
606 //=======================================================================================================
607
608 };
609
610} // namespace panzer
611
612#endif
PHX::MDField< const Scalar, Cell, BASIS, IP > ConstArray_CellBasisIP
PHX::MDField< Scalar, Cell, BASIS, IP, Dim > Array_CellBasisIPDim
Array_CellBasisIP weighted_div_basis
Teuchos::RCP< const panzer::BasisIRLayout > basis_layout
ConstArray_BasisIP getCurl2DVectorBasisRef(const bool cache=true, const bool force=false) const
Get the curl of a vector basis evaluated at reference points.
Array_CellBasisIP basis_scalar
Array_BasisIPDim grad_basis_ref
Intrepid2::Basis< PHX::Device::execution_space, Scalar, Scalar > IntrepidBasis
ArrayTraits< Scalar, PHX::MDField< Scalar > >::size_type size_type
PHX::MDField< const Scalar, Cell, IP > cubature_jacobian_determinant_
Array_CellBasisIPDim weighted_curl_basis_vector
ConstArray_CellBasisIP getDivVectorBasis(const bool weighted, const bool cache=true, const bool force=false) const
Get the divergence of a vector basis evaluated at mesh points.
PHX::MDField< Scalar, BASIS, Dim > Array_BasisDim
Array_BasisIP curl_basis_ref_scalar
Array_BasisDim basis_coordinates_ref
void evaluateValuesCV(const PHX::MDField< Scalar, Cell, IP, Dim > &cell_cub_points, const PHX::MDField< Scalar, Cell, IP, Dim, Dim > &jac, const PHX::MDField< Scalar, Cell, IP > &jac_det, const PHX::MDField< Scalar, Cell, IP, Dim, Dim > &jac_inv)
ConstArray_BasisIPDim getGradBasisValuesRef(const bool cache=true, const bool force=false) const
Get the gradient of the basis evaluated at reference points.
PHX::MDField< Scalar, BASIS, IP, Dim > Array_BasisIPDim
Array_CellBasisIP weighted_curl_basis_scalar
void setExtendedDimensions(const std::vector< PHX::index_size_type > &ddims)
ConstArray_BasisIPDim getVectorBasisValuesRef(const bool cache=true, const bool force=false) const
Get the vector basis values evaluated at reference points.
Array_CellBasisIPDim weighted_grad_basis
PureBasis::EElementSpace getElementSpace() const
Array_CellBasisIPDim curl_basis_vector
ConstArray_CellBasisIPDim getCurlVectorBasis(const bool weighted, const bool cache=true, const bool force=false) const
Get the curl of a 3D vector basis evaluated at mesh points.
PHX::MDField< Scalar > ArrayDynamic
Array_CellBasisIP curl_basis_scalar
void setup(const Teuchos::RCP< const panzer::BasisIRLayout > &basis, PHX::MDField< const Scalar, Cell, IP, Dim > reference_points, PHX::MDField< const Scalar, Cell, IP, Dim, Dim > point_jacobian, PHX::MDField< const Scalar, Cell, IP > point_jacobian_determinant, PHX::MDField< const Scalar, Cell, IP, Dim, Dim > point_jacobian_inverse, const int num_evaluated_cells=-1)
Setup for lazy evaluation for non-uniform point layout.
const std::vector< PHX::index_size_type > & getExtendedDimensions() const
Get the extended dimensions used by sacado AD allocations.
ConstArray_CellBasisIP getBasisValues(const bool weighted, const bool cache=true, const bool force=false) const
Get the basis values evaluated at mesh points.
ConstArray_BasisIP getBasisValuesRef(const bool cache=true, const bool force=false) const
Get the basis values evaluated at reference points.
PHX::MDField< const Scalar, BASIS, IP, Dim > ConstArray_BasisIPDim
void evaluateBasisCoordinates(const PHX::MDField< Scalar, Cell, NODE, Dim > &vertex_coordinates, const int in_num_cells=-1)
PHX::MDField< Scalar, Cell, BASIS, Dim > Array_CellBasisDim
void setOrientations(const std::vector< Intrepid2::Orientation > &orientations, const int num_orientations_cells=-1)
Set the orientations object for applying orientations using the lazy evaluation path - required for c...
void evaluateValues(const PHX::MDField< Scalar, IP, Dim > &cub_points, const PHX::MDField< Scalar, Cell, IP, Dim, Dim > &jac, const PHX::MDField< Scalar, Cell, IP > &jac_det, const PHX::MDField< Scalar, Cell, IP, Dim, Dim > &jac_inv, const int in_num_cells=-1)
Array_BasisIPDim curl_basis_ref_vector
std::vector< PHX::index_size_type > ddims_
PHX::MDField< const Scalar, IP, Dim > cubature_points_uniform_ref_
ConstArray_CellBasisIPDim getGradBasisValues(const bool weighted, const bool cache=true, const bool force=false) const
Get the gradient of the basis evaluated at mesh points.
bool hasUniformReferenceSpace() const
Check if reference point space is uniform across all cells (faster evaluation)
PHX::MDField< const Scalar, Cell, IP, Dim > cubature_points_ref_
Array_CellBasisIP div_basis
PHX::MDField< const Scalar, Cell, BASIS, IP, Dim > ConstArray_CellBasisIPDim
void setWeightedMeasure(PHX::MDField< const Scalar, Cell, IP > weighted_measure)
Set the cubature weights (weighted measure) for the basis values object - required to get weighted ba...
Array_CellBasisIPDim basis_vector
ConstArray_BasisDim getBasisCoordinatesRef(const bool cache=true, const bool force=false) const
Get the reference coordinates for basis.
Array_CellBasisDim basis_coordinates
PHX::MDField< const Scalar, Cell, IP, Dim, Dim > cubature_jacobian_inverse_
PHX::MDField< const Scalar, Cell, NODE, Dim > cell_vertex_coordinates_
ConstArray_CellBasisIP getCurl2DVectorBasis(const bool weighted, const bool cache=true, const bool force=false) const
Get the curl of a 2D vector basis evaluated at mesh points.
PHX::MDField< const Scalar, BASIS, IP > ConstArray_BasisIP
void setCellVertexCoordinates(PHX::MDField< Scalar, Cell, NODE, Dim > vertex_coordinates)
Set the cell vertex coordinates (required for getBasisCoordinates())
Array_BasisIPDim basis_ref_vector
ConstArray_BasisIPDim getCurlVectorBasisRef(const bool cache=true, const bool force=false) const
Get the curl of a vector basis evaluated at reference points.
bool basis_ref_scalar_evaluated_
Used to check if arrays have been cached.
Teuchos::RCP< IntrepidBasis > intrepid_basis
ConstArray_CellBasisDim getBasisCoordinates(const bool cache=true, const bool force=false) const
Carterisan coordinates for basis coefficients in mesh space.
PHX::MDField< const Scalar, Cell, IP > cubature_weights_
PHX::MDField< const Scalar > ConstArrayDynamic
Array_CellBasisIPDim grad_basis
void setupArrays(const Teuchos::RCP< const panzer::BasisIRLayout > &basis, bool computeDerivatives=true)
Sizes/allocates memory for arrays.
void setupUniform(const Teuchos::RCP< const panzer::BasisIRLayout > &basis, PHX::MDField< const Scalar, IP, Dim > reference_points, PHX::MDField< const Scalar, Cell, IP, Dim, Dim > point_jacobian, PHX::MDField< const Scalar, Cell, IP > point_jacobian_determinant, PHX::MDField< const Scalar, Cell, IP, Dim, Dim > point_jacobian_inverse, const int num_evaluated_cells=-1)
Setup for lazy evaluation for uniform point layout.
Array_CellBasisIP weighted_basis_scalar
PHX::MDField< const Scalar, Cell, BASIS, Dim > ConstArray_CellBasisDim
Array_CellBasisIPDim weighted_basis_vector
PHX::MDField< Scalar, Cell, BASIS, IP > Array_CellBasisIP
PHX::MDField< const Scalar, Cell, IP, Dim, Dim > cubature_jacobian_
ConstArray_CellBasisIPDim getVectorBasisValues(const bool weighted, const bool cache=true, const bool force=false) const
Get the vector basis values evaluated at mesh points.
std::vector< Intrepid2::Orientation > orientations_
ConstArray_BasisIP getDivVectorBasisRef(const bool cache=true, const bool force=false) const
Get the divergence of a vector basis evaluated at reference points.
void applyOrientations(const PHX::MDField< const Scalar, Cell, BASIS > &orientations)
Method to apply orientations to a basis values container.
PHX::MDField< Scalar, BASIS, IP > Array_BasisIP
PHX::MDField< const Scalar, BASIS, Dim > ConstArray_BasisDim