Reference documentation for deal.II version Git 87eb8ae23d 2021-01-27 12:59:39 +0100
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
hp::FEFaceValues< dim, spacedim > Class Template Reference

#include <deal.II/hp/fe_values.h>

Inheritance diagram for hp::FEFaceValues< dim, spacedim >:
[legend]

Public Member Functions

 FEFaceValues (const hp::MappingCollection< dim, spacedim > &mapping_collection, const hp::FECollection< dim, spacedim > &fe_collection, const hp::QCollection< dim - 1 > &q_collection, const UpdateFlags update_flags)
 
 FEFaceValues (const hp::MappingCollection< dim, spacedim > &mapping_collection, const hp::FECollection< dim, spacedim > &fe_collection, const std::vector< hp::QCollection< dim - 1 >> &q_collections, const UpdateFlags update_flags)
 
 FEFaceValues (const hp::FECollection< dim, spacedim > &fe_collection, const hp::QCollection< dim - 1 > &q_collection, const UpdateFlags update_flags)
 
 FEFaceValues (const hp::FECollection< dim, spacedim > &fe_collection, const std::vector< hp::QCollection< dim - 1 >> &q_collections, const UpdateFlags update_flags)
 
template<bool lda>
void reinit (const TriaIterator< DoFCellAccessor< dim, spacedim, lda >> &cell, const unsigned int face_no, const unsigned int q_index=numbers::invalid_unsigned_int, const unsigned int mapping_index=numbers::invalid_unsigned_int, const unsigned int fe_index=numbers::invalid_unsigned_int)
 
template<bool lda>
void reinit (const TriaIterator< DoFCellAccessor< dim, spacedim, lda >> &cell, const typename Triangulation< dim, spacedim >::face_iterator &face, const unsigned int q_index=numbers::invalid_unsigned_int, const unsigned int mapping_index=numbers::invalid_unsigned_int, const unsigned int fe_index=numbers::invalid_unsigned_int)
 
void reinit (const typename Triangulation< dim, spacedim >::cell_iterator &cell, const unsigned int face_no, const unsigned int q_index=numbers::invalid_unsigned_int, const unsigned int mapping_index=numbers::invalid_unsigned_int, const unsigned int fe_index=numbers::invalid_unsigned_int)
 
void reinit (const typename Triangulation< dim, spacedim >::cell_iterator &cell, const typename Triangulation< dim, spacedim >::face_iterator &face, const unsigned int q_index=numbers::invalid_unsigned_int, const unsigned int mapping_index=numbers::invalid_unsigned_int, const unsigned int fe_index=numbers::invalid_unsigned_int)
 
void precalculate_fe_values (const std::vector< unsigned int > &fe_indices, const std::vector< unsigned int > &mapping_indices, const std::vector< unsigned int > &q_indices)
 
void precalculate_fe_values ()
 
const FECollection< dim, ::FEFaceValues< dim, spacedim > ::space_dimension > & get_fe_collection () const
 
const MappingCollection< dim, ::FEFaceValues< dim, spacedim > ::space_dimension > & get_mapping_collection () const
 
const QCollection< q_dim > & get_quadrature_collection () const
 
UpdateFlags get_update_flags () const
 
const ::FEFaceValues< dim, spacedim > & get_present_fe_values () const
 

Protected Member Functions

::FEFaceValues< dim, spacedim > & select_fe_values (const unsigned int fe_index, const unsigned int mapping_index, const unsigned int q_index)
 

Protected Attributes

const SmartPointer< const FECollection< dim, ::FEFaceValues< dim, spacedim > ::space_dimension >, FEValuesBase< dim, q_dim, ::FEFaceValues< dim, spacedim > > > fe_collection
 
const SmartPointer< const MappingCollection< dim, ::FEFaceValues< dim, spacedim > ::space_dimension >, FEValuesBase< dim, q_dim, ::FEFaceValues< dim, spacedim > > > mapping_collection
 
const QCollection< q_dim > q_collection
 
const std::vector< QCollection< q_dim > > q_collections
 

Detailed Description

template<int dim, int spacedim = dim>
class hp::FEFaceValues< dim, spacedim >

This is the equivalent of the hp::FEValues class but for face integrations, i.e. it is to hp::FEValues what FEFaceValues is to FEValues.

The same comments apply as in the documentation of the hp::FEValues class. However, it is important to note that it is here more common that one would want to explicitly specify an index to a particular quadrature formula in the reinit() functions. This is because the default index corresponds to the finite element index on the current function. On the other hand, integration on faces will typically have to happen with a quadrature formula that is adjusted to the finite elements used on both sides of a face. If one sorts the elements of the hp::FECollection with ascending polynomial degree, and matches these finite elements with corresponding quadrature formulas in the hp::QCollection passed to the constructor, then the quadrature index passed to the reinit() function should typically be something like std::max (cell->active_fe_index(), neighbor->active_fe_index() to ensure that a quadrature formula is chosen that is sufficiently accurate for both finite elements.

Definition at line 439 of file fe_values.h.

Constructor & Destructor Documentation

◆ FEFaceValues() [1/4]

template<int dim, int spacedim>
FEFaceValues< dim, spacedim >::FEFaceValues ( const hp::MappingCollection< dim, spacedim > &  mapping_collection,
const hp::FECollection< dim, spacedim > &  fe_collection,
const hp::QCollection< dim - 1 > &  q_collection,
const UpdateFlags  update_flags 
)

Constructor. Initialize this object with the given parameters.

Definition at line 379 of file fe_values.cc.

◆ FEFaceValues() [2/4]

template<int dim, int spacedim>
FEFaceValues< dim, spacedim >::FEFaceValues ( const hp::MappingCollection< dim, spacedim > &  mapping_collection,
const hp::FECollection< dim, spacedim > &  fe_collection,
const std::vector< hp::QCollection< dim - 1 >> &  q_collections,
const UpdateFlags  update_flags 
)

Like the function above, but taking a vector of collection of quadrature rules. This allows to assign each face a different quadrature rule: the ith entry of a collection is used as the face quadrature rule on the ith face.

In the case that the collections only contains a single face quadrature, this quadrature rule is use on all faces.

Definition at line 392 of file fe_values.cc.

◆ FEFaceValues() [3/4]

template<int dim, int spacedim>
FEFaceValues< dim, spacedim >::FEFaceValues ( const hp::FECollection< dim, spacedim > &  fe_collection,
const hp::QCollection< dim - 1 > &  q_collection,
const UpdateFlags  update_flags 
)

Constructor. This constructor is equivalent to the other one except that it makes the object use a \(Q_1\) mapping (i.e., an object of type MappingQGeneric(1)) implicitly.

Definition at line 406 of file fe_values.cc.

◆ FEFaceValues() [4/4]

template<int dim, int spacedim>
FEFaceValues< dim, spacedim >::FEFaceValues ( const hp::FECollection< dim, spacedim > &  fe_collection,
const std::vector< hp::QCollection< dim - 1 >> &  q_collections,
const UpdateFlags  update_flags 
)

Like the function above, but taking a vector of collection of quadrature rules. This allows to assign each face a different quadrature rule: the ith entry of a collection is used as the face quadrature rule on the ith face.

In the case that the collections only contains a single face quadrature, this quadrature rule is use on all faces.

Definition at line 418 of file fe_values.cc.

Member Function Documentation

◆ reinit() [1/4]

template<int dim, int spacedim>
template<bool lda>
void FEFaceValues< dim, spacedim >::reinit ( const TriaIterator< DoFCellAccessor< dim, spacedim, lda >> &  cell,
const unsigned int  face_no,
const unsigned int  q_index = numbers::invalid_unsigned_int,
const unsigned int  mapping_index = numbers::invalid_unsigned_int,
const unsigned int  fe_index = numbers::invalid_unsigned_int 
)

Reinitialize the object for the given cell and face.

After the call, you can get an FEFaceValues object using the get_present_fe_values() function that corresponds to the present cell. For this FEFaceValues object, we use the additional arguments described below to determine which finite element, mapping, and quadrature formula to use. They are order in such a way that the arguments one may want to change most frequently come first. The rules for these arguments are as follows:

If the fe_index argument to this function is left at its default value, then we use that finite element within the hp::FECollection passed to the constructor of this class with index given by cell->active_fe_index(). Consequently, the hp::FECollection argument given to this object should really be the same as that used in the construction of the DoFHandler associated with the present cell. On the other hand, if a value is given for this argument, it overrides the choice of cell->active_fe_index().

If the q_index argument is left at its default value, then we use that quadrature formula within the hp::QCollection passed to the constructor of this class with index given by cell->active_fe_index(), i.e. the same index as that of the finite element. In this case, there should be a corresponding quadrature formula for each finite element in the hp::FECollection. As a special case, if the quadrature collection contains only a single element (a frequent case if one wants to use the same quadrature object for all finite elements in an hp-discretization, even if that may not be the most efficient), then this single quadrature is used unless a different value for this argument is specified. On the other hand, if a value is given for this argument, it overrides the choice of cell->active_fe_index() or the choice for the single quadrature.

If the mapping_index argument is left at its default value, then we use that mapping object within the hp::MappingCollection passed to the constructor of this class with index given by cell->active_fe_index(), i.e. the same index as that of the finite element. As above, if the mapping collection contains only a single element (a frequent case if one wants to use a \(Q_1\) mapping for all finite elements in an hp-discretization), then this single mapping is used unless a different value for this argument is specified.

Definition at line 432 of file fe_values.cc.

◆ reinit() [2/4]

template<int dim, int spacedim>
template<bool lda>
void FEFaceValues< dim, spacedim >::reinit ( const TriaIterator< DoFCellAccessor< dim, spacedim, lda >> &  cell,
const typename Triangulation< dim, spacedim >::face_iterator &  face,
const unsigned int  q_index = numbers::invalid_unsigned_int,
const unsigned int  mapping_index = numbers::invalid_unsigned_int,
const unsigned int  fe_index = numbers::invalid_unsigned_int 
)

Reinitialize the object for the given cell and face.

Note
face must be one of cell's face iterators.

Definition at line 480 of file fe_values.cc.

◆ reinit() [3/4]

template<int dim, int spacedim>
void FEFaceValues< dim, spacedim >::reinit ( const typename Triangulation< dim, spacedim >::cell_iterator &  cell,
const unsigned int  face_no,
const unsigned int  q_index = numbers::invalid_unsigned_int,
const unsigned int  mapping_index = numbers::invalid_unsigned_int,
const unsigned int  fe_index = numbers::invalid_unsigned_int 
)

Like the previous function, but for non-DoFHandler iterators. The reason this function exists is so that one can use this class for Triangulation objects too.

Since cell->active_fe_index() doesn't make sense for triangulation iterators, this function chooses the zero-th finite element, mapping, and quadrature object from the relevant constructions passed to the constructor of this object. The only exception is if you specify a value different from the default value for any of these last three arguments.

Definition at line 495 of file fe_values.cc.

◆ reinit() [4/4]

template<int dim, int spacedim>
void FEFaceValues< dim, spacedim >::reinit ( const typename Triangulation< dim, spacedim >::cell_iterator &  cell,
const typename Triangulation< dim, spacedim >::face_iterator &  face,
const unsigned int  q_index = numbers::invalid_unsigned_int,
const unsigned int  mapping_index = numbers::invalid_unsigned_int,
const unsigned int  fe_index = numbers::invalid_unsigned_int 
)

Reinitialize the object for the given cell and face.

Note
face must be one of cell's face iterators.

Definition at line 532 of file fe_values.cc.

◆ precalculate_fe_values() [1/2]

void FEValuesBase< dim, q_dim, ::FEFaceValues< dim, spacedim > >::precalculate_fe_values ( const std::vector< unsigned int > &  fe_indices,
const std::vector< unsigned int > &  mapping_indices,
const std::vector< unsigned int > &  q_indices 
)
inherited

For timing purposes it may be useful to create all required FE*Values objects in advance, rather than computing them on request via lazy allocation as usual in this class.

This function precalculates the FE*Values objects corresponding to the provided parameters: The total of all vector entries corresponding to the same index describes an FE*Values object similarly to select_fe_values().

Definition at line 208 of file fe_values.cc.

◆ precalculate_fe_values() [2/2]

void FEValuesBase< dim, q_dim, ::FEFaceValues< dim, spacedim > >::precalculate_fe_values ( )
inherited

Same as above, geared to the most common use of hp::FEValues objects in which FE, quadrature and mapping indices are similar on each individual cell.

FE*Values objects are created for every FE in the FECollection, with quadrature and mapping corresponding to the same index from the QuadratureCollection and MappingCollection, respectively.

If QuadratureCollection or MappingCollection contains only one object, it is used for all FE*Values objects.

Definition at line 245 of file fe_values.cc.

◆ get_fe_collection()

const FECollection< dim, ::FEFaceValues< dim, spacedim > ::space_dimension > & FEValuesBase< dim, q_dim, ::FEFaceValues< dim, spacedim > >::get_fe_collection ( ) const
inlineinherited

Get a reference to the collection of finite element objects used here.

Definition at line 702 of file fe_values.h.

◆ get_mapping_collection()

const MappingCollection< dim, ::FEFaceValues< dim, spacedim > ::space_dimension > & FEValuesBase< dim, q_dim, ::FEFaceValues< dim, spacedim > >::get_mapping_collection ( ) const
inlineinherited

Get a reference to the collection of mapping objects used here.

Definition at line 711 of file fe_values.h.

◆ get_quadrature_collection()

const QCollection< q_dim > & FEValuesBase< dim, q_dim, ::FEFaceValues< dim, spacedim > >::get_quadrature_collection ( ) const
inlineinherited

Get a reference to the collection of quadrature objects used here.

Definition at line 720 of file fe_values.h.

◆ get_update_flags()

UpdateFlags FEValuesBase< dim, q_dim, ::FEFaceValues< dim, spacedim > >::get_update_flags ( ) const
inlineinherited

Get the underlying update flags.

Definition at line 729 of file fe_values.h.

◆ get_present_fe_values()

const ::FEFaceValues< dim, spacedim > & FEValuesBase< dim, q_dim, ::FEFaceValues< dim, spacedim > >::get_present_fe_values ( ) const
inlineinherited

Return a reference to the FEValues object selected by the last call to select_fe_values(). select_fe_values() in turn is called when you called the reinit function of the hp::FE*Values class the last time.

Definition at line 693 of file fe_values.h.

◆ select_fe_values()

::FEFaceValues< dim, spacedim > & FEValuesBase< dim, q_dim, ::FEFaceValues< dim, spacedim > >::select_fe_values ( const unsigned int  fe_index,
const unsigned int  mapping_index,
const unsigned int  q_index 
)
protectedinherited

Select a FEValues object suitable for the given FE, quadrature, and mapping indices. If such an object doesn't yet exist, create one.

The function returns a writable reference so that derived classes can also reinit() the selected FEValues object.

Definition at line 175 of file fe_values.cc.

Member Data Documentation

◆ fe_collection

const SmartPointer<const FECollection<dim, ::FEFaceValues< dim, spacedim > ::space_dimension>, FEValuesBase<dim, q_dim, ::FEFaceValues< dim, spacedim > > > hp::FEValuesBase< dim, q_dim, ::FEFaceValues< dim, spacedim > >::fe_collection
protectedinherited

A pointer to the collection of finite elements to be used.

Definition at line 209 of file fe_values.h.

◆ mapping_collection

const SmartPointer< const MappingCollection<dim, ::FEFaceValues< dim, spacedim > ::space_dimension>, FEValuesBase<dim, q_dim, ::FEFaceValues< dim, spacedim > > > hp::FEValuesBase< dim, q_dim, ::FEFaceValues< dim, spacedim > >::mapping_collection
protectedinherited

A pointer to the collection of mappings to be used.

Definition at line 217 of file fe_values.h.

◆ q_collection

const QCollection<q_dim> hp::FEValuesBase< dim, q_dim, ::FEFaceValues< dim, spacedim > >::q_collection
protectedinherited

Copy of the quadrature collection object provided to the constructor.

Definition at line 222 of file fe_values.h.

◆ q_collections

const std::vector<QCollection<q_dim> > hp::FEValuesBase< dim, q_dim, ::FEFaceValues< dim, spacedim > >::q_collections
protectedinherited

Vector of quadrature collections. For hp::FEFaceValues, the ith entry of the quadrature collections are interpreted as the face quadrature rules to be applied the ith face.

The variable q_collection collects the first quadrature rule of each quadrature collection of the vector.

Definition at line 232 of file fe_values.h.


The documentation for this class was generated from the following files: