Reference documentation for deal.II version GIT d7aca55de5 2022-08-10 12:50:02+00:00
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, FEValuesType::space_dimension > & get_fe_collection () const

const MappingCollection< dim, FEValuesType::space_dimension > & get_mapping_collection () const

const QCollection< q_dim > & get_quadrature_collection () const

UpdateFlags get_update_flags () const

const ::FEFaceValues< dim, dim > & get_present_fe_values () const

template<class Archive >
void serialize (Archive &ar, const unsigned int version)

Subscriptor functionality

Classes derived from Subscriptor provide a facility to subscribe to this object. This is mostly used by the SmartPointer class.

void subscribe (std::atomic< bool > *const validity, const std::string &identifier="") const

void unsubscribe (std::atomic< bool > *const validity, const std::string &identifier="") const

unsigned int n_subscriptions () const

template<typename StreamType >
void list_subscribers (StreamType &stream) const

void list_subscribers () const

## Static Public Member Functions

static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)

static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)

## Protected Member Functions

::FEFaceValues< dim, dim > & 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, FEValuesType::space_dimension >, FEValuesBase< dim, q_dim, ::FEFaceValues< dim, dim > > > fe_collection

const SmartPointer< const MappingCollection< dim, FEValuesType::space_dimension >, FEValuesBase< dim, q_dim, ::FEFaceValues< dim, dim > > > mapping_collection

const QCollection< q_dim > q_collection

const std::vector< QCollection< q_dim > > q_collections

## Private Types

using map_value_type = decltype(counter_map)::value_type

using map_iterator = decltype(counter_map)::iterator

## Private Member Functions

void check_no_subscribers () const noexcept

## Private Attributes

Table< 3, std::unique_ptr< ::FEFaceValues< dim, dim > > > fe_values_table

TableIndices< 3 > present_fe_values_index

const UpdateFlags update_flags

std::atomic< unsigned int > counter

std::map< std::string, unsigned int > counter_map

std::vector< std::atomic< bool > * > validity_pointers

const std::type_info * object_info

## Static Private Attributes

static std::mutex mutex

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

## ◆ map_value_type

 using Subscriptor::map_value_type = decltype(counter_map)::value_type
privateinherited

The data type used in counter_map.

Definition at line 230 of file subscriptor.h.

## ◆ map_iterator

 using Subscriptor::map_iterator = decltype(counter_map)::iterator
privateinherited

The iterator type used in counter_map.

Definition at line 235 of file subscriptor.h.

## ◆ 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 371 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 384 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 MappingQ(1)) implicitly.

Definition at line 398 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 410 of file fe_values.cc.

## ◆ 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 424 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 470 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 485 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 520 of file fe_values.cc.

## ◆ precalculate_fe_values() [1/2]

 void FEValuesBase< dim, q_dim, ::FEFaceValues< dim, dim > >::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 137 of file fe_values.cc.

## ◆ precalculate_fe_values() [2/2]

 void FEValuesBase< dim, q_dim, ::FEFaceValues< dim, dim > >::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 154 of file fe_values.cc.

## ◆ get_fe_collection()

 const FECollection< dim, FEValuesType::space_dimension > & FEValuesBase< dim, q_dim, ::FEFaceValues< dim, dim > >::get_fe_collection
inlineinherited

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

Definition at line 161 of file fe_values.h.

## ◆ get_mapping_collection()

 const MappingCollection< dim, FEValuesType::space_dimension > & FEValuesBase< dim, q_dim, ::FEFaceValues< dim, dim > >::get_mapping_collection
inlineinherited

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

Definition at line 167 of file fe_values.h.

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

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

Definition at line 173 of file fe_values.h.

## ◆ get_update_flags()

 UpdateFlags FEValuesBase< dim, q_dim, ::FEFaceValues< dim, dim > >::get_update_flags
inlineinherited

Get the underlying update flags.

Definition at line 179 of file fe_values.h.

## ◆ get_present_fe_values()

 const ::FEFaceValues< dim, dim > & FEValuesBase< dim, q_dim, ::FEFaceValues< dim, dim > >::get_present_fe_values
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 188 of file fe_values.h.

## ◆ select_fe_values()

 ::FEFaceValues< dim, dim > & FEValuesBase< dim, q_dim, ::FEFaceValues< dim, dim > >::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 199 of file fe_values.cc.

## ◆ subscribe()

 void Subscriptor::subscribe ( std::atomic< bool > *const validity, const std::string & identifier = "" ) const
inherited

Subscribes a user of the object by storing the pointer validity. The subscriber may be identified by text supplied as identifier.

Definition at line 136 of file subscriptor.cc.

## ◆ unsubscribe()

 void Subscriptor::unsubscribe ( std::atomic< bool > *const validity, const std::string & identifier = "" ) const
inherited

Unsubscribes a user from the object.

Note
The identifier and the validity pointer must be the same as the one supplied to subscribe().

Definition at line 156 of file subscriptor.cc.

## ◆ n_subscriptions()

 unsigned int Subscriptor::n_subscriptions ( ) const
inlineinherited

Return the present number of subscriptions to this object. This allows to use this class for reference counted lifetime determination where the last one to unsubscribe also deletes the object.

Definition at line 300 of file subscriptor.h.

## ◆ list_subscribers() [1/2]

template<typename StreamType >
 void Subscriptor::list_subscribers ( StreamType & stream ) const
inlineinherited

List the subscribers to the input stream.

Definition at line 317 of file subscriptor.h.

## ◆ list_subscribers() [2/2]

 void Subscriptor::list_subscribers ( ) const
inherited

List the subscribers to deallog.

Definition at line 204 of file subscriptor.cc.

## ◆ serialize()

template<class Archive >
 void Subscriptor::serialize ( Archive & ar, const unsigned int version )
inlineinherited

Read or write the data of this object to or from a stream for the purpose of serialization using the BOOST serialization library.

This function does not actually serialize any of the member variables of this class. The reason is that what this class stores is only who subscribes to this object, but who does so at the time of storing the contents of this object does not necessarily have anything to do with who subscribes to the object when it is restored. Consequently, we do not want to overwrite the subscribers at the time of restoring, and then there is no reason to write the subscribers out in the first place.

Definition at line 309 of file subscriptor.h.

## ◆ check_no_subscribers()

 void Subscriptor::check_no_subscribers ( ) const
privatenoexceptinherited

Check that there are no objects subscribing to this object. If this check passes then it is safe to destroy the current object. It this check fails then this function will either abort or print an error message to deallog (by using the AssertNothrow mechanism), but will not throw an exception.

Note
Since this function is just a consistency check it does nothing in release mode.
If this function is called when there is an uncaught exception then, rather than aborting, this function prints an error message to the standard error stream and returns.

Definition at line 53 of file subscriptor.cc.

## ◆ fe_collection

 const SmartPointer, FEValuesBase > > hp::FEValuesBase< dim, q_dim, ::FEFaceValues< dim, dim > >::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, FEValuesBase > > hp::FEValuesBase< dim, q_dim, ::FEFaceValues< dim, dim > >::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 hp::FEValuesBase< dim, q_dim, ::FEFaceValues< dim, dim > >::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 > hp::FEValuesBase< dim, q_dim, ::FEFaceValues< dim, dim > >::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.

## ◆ fe_values_table

 Table<3, std::unique_ptr<::FEFaceValues< dim, dim > > > hp::FEValuesBase< dim, q_dim, ::FEFaceValues< dim, dim > >::fe_values_table
privateinherited

A table in which we store pointers to fe_values objects for different finite element, mapping, and quadrature objects from our collection. The first index indicates the index of the finite element within the fe_collection, the second the index of the mapping within the mapping collection, and the last one the index of the quadrature formula within the q_collection.

Initially, all entries have zero pointers, and we will allocate them lazily as needed in select_fe_values() or precalculate_fe_values().

Definition at line 246 of file fe_values.h.

## ◆ present_fe_values_index

 TableIndices<3> hp::FEValuesBase< dim, q_dim, ::FEFaceValues< dim, dim > >::present_fe_values_index
privateinherited

Set of indices pointing at the fe_values object selected last time the select_fe_value() function was called.

Definition at line 252 of file fe_values.h.

## ◆ update_flags

 const UpdateFlags hp::FEValuesBase< dim, q_dim, ::FEFaceValues< dim, dim > >::update_flags
privateinherited

Values of the update flags as given to the constructor.

Definition at line 257 of file fe_values.h.

## ◆ counter

 std::atomic Subscriptor::counter
mutableprivateinherited

Store the number of objects which subscribed to this object. Initially, this number is zero, and upon destruction it shall be zero again (i.e. all objects which subscribed should have unsubscribed again).

The creator (and owner) of an object is counted in the map below if HE manages to supply identification.

We use the mutable keyword in order to allow subscription to constant objects also.

This counter may be read from and written to concurrently in multithreaded code: hence we use the std::atomic class template.

Definition at line 219 of file subscriptor.h.

## ◆ counter_map

 std::map Subscriptor::counter_map
mutableprivateinherited

In this map, we count subscriptions for each different identification string supplied to subscribe().

Definition at line 225 of file subscriptor.h.

## ◆ validity_pointers

 std::vector *> Subscriptor::validity_pointers
mutableprivateinherited

In this vector, we store pointers to the validity bool in the SmartPointer objects that subscribe to this class.

Definition at line 241 of file subscriptor.h.

## ◆ object_info

 const std::type_info* Subscriptor::object_info
mutableprivateinherited

Pointer to the typeinfo object of this object, from which we can later deduce the class name. Since this information on the derived class is neither available in the destructor, nor in the constructor, we obtain it in between and store it here.

Definition at line 249 of file subscriptor.h.

## ◆ mutex

 std::mutex Subscriptor::mutex
staticprivateinherited

A mutex used to ensure data consistency when printing out the list of subscribers.

Definition at line 271 of file subscriptor.h.

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