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

Inheritance diagram for hp::FEValuesBase< dim, q_dim, FEValuesType >:

[legend]

Public Member Functions
	FEValuesBase (const MappingCollection< dim, FEValuesType::space_dimension > &mapping_collection, const FECollection< dim, FEValuesType::space_dimension > &fe_collection, const QCollection< q_dim > &q_collection, const UpdateFlags update_flags)

	FEValuesBase (const MappingCollection< dim, FEValuesType::space_dimension > &mapping_collection, const FECollection< dim, FEValuesType::space_dimension > &fe_collection, const std::vector< QCollection< q_dim > > &q_collection, const UpdateFlags update_flags)

	FEValuesBase (const FECollection< dim, FEValuesType::space_dimension > &fe_collection, const QCollection< q_dim > &q_collection, const UpdateFlags update_flags)

	FEValuesBase (const FECollection< dim, FEValuesType::space_dimension > &fe_collection, const std::vector< QCollection< q_dim > > &q_collection, const UpdateFlags update_flags)

	FEValuesBase (const FEValuesBase< dim, q_dim, FEValuesType > &other)

FEValuesBase &	operator= (const FEValuesBase &)=delete

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 FEValuesType &	get_present_fe_values () const

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

EnableObserverPointer functionality
Classes derived from EnableObserverPointer provide a facility to subscribe to this object. This is mostly used by the ObserverPointer 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 ::ExceptionBase &	ExcInUse (int arg1, std::string arg2, std::string arg3)

static ::ExceptionBase &	ExcNoSubscriber (std::string arg1, std::string arg2)

Protected Member Functions
FEValuesType &	select_fe_values (const unsigned int fe_index, const unsigned int mapping_index, const unsigned int q_index)

Protected Attributes
const ObserverPointer< const FECollection< dim, FEValuesType::space_dimension >, FEValuesBase< dim, q_dim, FEValuesType > >	fe_collection

const ObserverPointer< const MappingCollection< dim, FEValuesType::space_dimension >, FEValuesBase< dim, q_dim, FEValuesType > >	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< FEValuesType > >	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 q_dim, typename FEValuesType>
class hp::FEValuesBase< dim, q_dim, FEValuesType >

Base class for the hp::FE*Values classes, storing the data that is common to them. The main task of this class is to provide a table where for every combination of finite element, mapping, and quadrature object from their corresponding collection objects there is a matching FEValues, FEFaceValues, or FESubfaceValues object.

To make things more efficient, however, these FE*Values objects are only created once requested (lazy allocation). Alternatively if desired, this can be bypassed by computing all objects in advance with the corresponding precalculate_fe_values() function.

The first template parameter denotes the space dimension we are in, the second the dimensionality of the object that we integrate on, i.e. for usual hp::FEValues it is equal to the first one, while for face integration it is one less. The third template parameter indicates the type of underlying non-hp-FE*Values base type, i.e. it could either be FEValues, FEFaceValues, or FESubfaceValues.

Definition at line 67 of file fe_values.h.

Member Typedef Documentation

◆ map_value_type

using EnableObserverPointer::map_value_type = decltype(counter_map)::value_type

privateinherited

The data type used in counter_map.

Definition at line 238 of file enable_observer_pointer.h.

◆ map_iterator

using EnableObserverPointer::map_iterator = decltype(counter_map)::iterator

privateinherited

The iterator type used in counter_map.

Definition at line 243 of file enable_observer_pointer.h.

Constructor & Destructor Documentation

◆ FEValuesBase() [1/5]

template<int dim, int q_dim, typename FEValuesType >

FEValuesBase< dim, q_dim, FEValuesType >::FEValuesBase	(	const MappingCollection< dim, FEValuesType::space_dimension > &	mapping_collection,
		const FECollection< dim, FEValuesType::space_dimension > &	fe_collection,
		const QCollection< q_dim > &	q_collection,
		const UpdateFlags	update_flags
	)

Constructor. Set the fields of this class to the values indicated by the parameters to the constructor.

Definition at line 65 of file fe_values.cc.

◆ FEValuesBase() [2/5]

template<int dim, int q_dim, typename FEValuesType >

FEValuesBase< dim, q_dim, FEValuesType >::FEValuesBase	(	const MappingCollection< dim, FEValuesType::space_dimension > &	mapping_collection,
		const FECollection< dim, FEValuesType::space_dimension > &	fe_collection,
		const std::vector< QCollection< q_dim > > &	q_collection,
		const UpdateFlags	update_flags
	)

Like the above function but taking a 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.

Definition at line 85 of file fe_values.cc.

◆ FEValuesBase() [3/5]

template<int dim, int q_dim, typename FEValuesType >

FEValuesBase< dim, q_dim, FEValuesType >::FEValuesBase	(	const FECollection< dim, FEValuesType::space_dimension > &	fe_collection,
		const QCollection< q_dim > &	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 106 of file fe_values.cc.

◆ FEValuesBase() [4/5]

template<int dim, int q_dim, typename FEValuesType >

FEValuesBase< dim, q_dim, FEValuesType >::FEValuesBase	(	const FECollection< dim, FEValuesType::space_dimension > &	fe_collection,
		const std::vector< QCollection< q_dim > > &	q_collection,
		const UpdateFlags	update_flags
	)

Like the above function but taking a vector 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.

Definition at line 120 of file fe_values.cc.

◆ FEValuesBase() [5/5]

template<int dim, int q_dim, typename FEValuesType >

FEValuesBase< dim, q_dim, FEValuesType >::FEValuesBase ( const FEValuesBase< dim, q_dim, FEValuesType > & other )

Copy constructor.

Definition at line 135 of file fe_values.cc.

Member Function Documentation

◆ operator=()

template<int dim, int q_dim, typename FEValuesType >

FEValuesBase & hp::FEValuesBase< dim, q_dim, FEValuesType >::operator= ( const FEValuesBase< dim, q_dim, FEValuesType > & )

delete

Copy operator. While objects of this type can be copy-constructed, they cannot be copied and consequently this operator is disabled.

◆ precalculate_fe_values() [1/2]

template<int dim, int q_dim, typename FEValuesType >

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

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 205 of file fe_values.cc.

◆ precalculate_fe_values() [2/2]

template<int dim, int q_dim, typename FEValuesType >

void FEValuesBase< dim, q_dim, FEValuesType >::precalculate_fe_values ( )

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 242 of file fe_values.cc.

◆ get_fe_collection()

template<int dim, int q_dim, typename FEValuesType >

const FECollection< dim, FEValuesType::space_dimension > & FEValuesBase< dim, q_dim, FEValuesType >::get_fe_collection ( ) const

inline

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

Definition at line 712 of file fe_values.h.

◆ get_mapping_collection()

template<int dim, int q_dim, typename FEValuesType >

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

inline

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

Definition at line 721 of file fe_values.h.

◆ get_quadrature_collection()

template<int dim, int q_dim, typename FEValuesType >

const QCollection< q_dim > & FEValuesBase< dim, q_dim, FEValuesType >::get_quadrature_collection ( ) const

inline

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

Definition at line 730 of file fe_values.h.

◆ get_update_flags()

template<int dim, int q_dim, typename FEValuesType >

UpdateFlags FEValuesBase< dim, q_dim, FEValuesType >::get_update_flags ( ) const

inline

Get the underlying update flags.

Definition at line 739 of file fe_values.h.

◆ get_present_fe_values()

template<int dim, int q_dim, typename FEValuesType >

const FEValuesType & FEValuesBase< dim, q_dim, FEValuesType >::get_present_fe_values ( ) const

inline

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 695 of file fe_values.h.

◆ select_fe_values()

template<int dim, int q_dim, typename FEValuesType >

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

protected

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.

◆ subscribe()

void EnableObserverPointer::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 131 of file enable_observer_pointer.cc.

◆ unsubscribe()

void EnableObserverPointer::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 151 of file enable_observer_pointer.cc.

◆ n_subscriptions()

unsigned int EnableObserverPointer::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 322 of file enable_observer_pointer.h.

◆ list_subscribers() [1/2]

template<typename StreamType >

void EnableObserverPointer::list_subscribers ( StreamType & stream ) const

inlineinherited

List the subscribers to the input stream.

Definition at line 339 of file enable_observer_pointer.h.

◆ list_subscribers() [2/2]

void EnableObserverPointer::list_subscribers ( ) const

inherited

List the subscribers to deallog.

Definition at line 199 of file enable_observer_pointer.cc.

◆ serialize()

template<class Archive >

void EnableObserverPointer::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 331 of file enable_observer_pointer.h.

◆ check_no_subscribers()

void EnableObserverPointer::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 enable_observer_pointer.cc.

Member Data Documentation

◆ fe_collection

template<int dim, int q_dim, typename FEValuesType >

const ObserverPointer< const FECollection<dim, FEValuesType::space_dimension>, FEValuesBase<dim, q_dim, FEValuesType> > hp::FEValuesBase< dim, q_dim, FEValuesType >::fe_collection

protected

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

Definition at line 208 of file fe_values.h.

◆ mapping_collection

template<int dim, int q_dim, typename FEValuesType >

const ObserverPointer< const MappingCollection<dim, FEValuesType::space_dimension>, FEValuesBase<dim, q_dim, FEValuesType> > hp::FEValuesBase< dim, q_dim, FEValuesType >::mapping_collection

protected

A pointer to the collection of mappings to be used.

Definition at line 216 of file fe_values.h.

◆ q_collection

template<int dim, int q_dim, typename FEValuesType >

const QCollection<q_dim> hp::FEValuesBase< dim, q_dim, FEValuesType >::q_collection

protected

Copy of the quadrature collection object provided to the constructor.

Definition at line 221 of file fe_values.h.

◆ q_collections

template<int dim, int q_dim, typename FEValuesType >

const std::vector<QCollection<q_dim> > hp::FEValuesBase< dim, q_dim, FEValuesType >::q_collections

protected

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 231 of file fe_values.h.

◆ fe_values_table

template<int dim, int q_dim, typename FEValuesType >

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

private

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 245 of file fe_values.h.

◆ present_fe_values_index

template<int dim, int q_dim, typename FEValuesType >

TableIndices<3> hp::FEValuesBase< dim, q_dim, FEValuesType >::present_fe_values_index

private

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

Definition at line 251 of file fe_values.h.

◆ update_flags

template<int dim, int q_dim, typename FEValuesType >

const UpdateFlags hp::FEValuesBase< dim, q_dim, FEValuesType >::update_flags

private

Values of the update flags as given to the constructor.

Definition at line 256 of file fe_values.h.

◆ counter

std::atomic<unsigned int> EnableObserverPointer::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 227 of file enable_observer_pointer.h.

◆ counter_map

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

mutableprivateinherited

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

Definition at line 233 of file enable_observer_pointer.h.

◆ validity_pointers

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

mutableprivateinherited

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

Definition at line 249 of file enable_observer_pointer.h.

◆ object_info

const std::type_info* EnableObserverPointer::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 257 of file enable_observer_pointer.h.

◆ mutex

std::mutex EnableObserverPointer::mutex

staticprivateinherited

A mutex used to ensure data consistency when accessing the mutable members of this class. This lock is used in the subscribe() and unsubscribe() functions, as well as in list_subscribers().

Definition at line 280 of file enable_observer_pointer.h.

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

include/deal.II/hp/fe_values.h
source/hp/fe_values.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ map_value_type

◆ map_iterator

Constructor & Destructor Documentation

◆ FEValuesBase() [1/5]

◆ FEValuesBase() [2/5]

◆ FEValuesBase() [3/5]

◆ FEValuesBase() [4/5]

◆ FEValuesBase() [5/5]

Member Function Documentation

◆ operator=()

◆ precalculate_fe_values() [1/2]

◆ precalculate_fe_values() [2/2]

◆ get_fe_collection()

◆ get_mapping_collection()

◆ get_quadrature_collection()

◆ get_update_flags()

◆ get_present_fe_values()

◆ select_fe_values()

◆ subscribe()

◆ unsubscribe()

◆ n_subscriptions()

◆ list_subscribers() [1/2]

◆ list_subscribers() [2/2]

◆ serialize()

◆ check_no_subscribers()

Member Data Documentation

◆ fe_collection

◆ mapping_collection

◆ q_collection

◆ q_collections

◆ fe_values_table

◆ present_fe_values_index

◆ update_flags

◆ counter

◆ counter_map

◆ validity_pointers

◆ object_info

◆ mutex