Reference documentation for deal.II version Git 95b09cd 2016-09-24 00:03:54 -0400
hp::FECollection< dim, spacedim > Class Template Reference

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

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

## Public Member Functions

FECollection ()

FECollection (const FiniteElement< dim, spacedim > &fe)

FECollection (const FiniteElement< dim, spacedim > &fe1, const FiniteElement< dim, spacedim > &fe2)

FECollection (const FiniteElement< dim, spacedim > &fe1, const FiniteElement< dim, spacedim > &fe2, const FiniteElement< dim, spacedim > &fe3)

FECollection (const FiniteElement< dim, spacedim > &fe1, const FiniteElement< dim, spacedim > &fe2, const FiniteElement< dim, spacedim > &fe3, const FiniteElement< dim, spacedim > &fe4)

FECollection (const FiniteElement< dim, spacedim > &fe1, const FiniteElement< dim, spacedim > &fe2, const FiniteElement< dim, spacedim > &fe3, const FiniteElement< dim, spacedim > &fe4, const FiniteElement< dim, spacedim > &fe5)

FECollection (const std::vector< const FiniteElement< dim, spacedim > * > &fes)

FECollection (const FECollection< dim, spacedim > &fe_collection)

void push_back (const FiniteElement< dim, spacedim > &new_fe)

const FiniteElement< dim, spacedim > & operator[] (const unsigned int index) const

unsigned int size () const

unsigned int n_components () const

unsigned int n_blocks () const

unsigned int max_dofs_per_vertex () const

unsigned int max_dofs_per_line () const

unsigned int max_dofs_per_hex () const

unsigned int max_dofs_per_face () const

unsigned int max_dofs_per_cell () const

std::size_t memory_consumption () const

bool hp_constraints_are_implemented () const

unsigned int find_least_face_dominating_fe (const std::set< unsigned int > &fes) const

Public Member Functions inherited from Subscriptor
Subscriptor ()

Subscriptor (const Subscriptor &)

Subscriptor (Subscriptor &&)

virtual ~Subscriptor ()

Subscriptoroperator= (const Subscriptor &)

Subscriptoroperator= (Subscriptor &&)

void subscribe (const char *identifier=0) const

void unsubscribe (const char *identifier=0) const

unsigned int n_subscriptions () const

void list_subscribers () const

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

## Static Public Member Functions

static::ExceptionBase & ExcNoFiniteElements ()

Static Public Member Functions inherited from Subscriptor
static::ExceptionBase & ExcInUse (int arg1, char *arg2, std::string &arg3)

static::ExceptionBase & ExcNoSubscriber (char *arg1, char *arg2)

## Private Attributes

std::vector< std_cxx11::shared_ptr< const FiniteElement< dim, spacedim > > > finite_elements

## Detailed Description

### template<int dim, int spacedim = dim> class hp::FECollection< dim, spacedim >

This class acts as a collection of finite element objects used in the hp::DoFHandler. It is thus to a hp::DoFHandler what a FiniteElement is to a DoFHandler.

It implements the concepts stated in the hp Collections module described in the doxygen documentation.

In addition to offering access to the elements of the collection, this class provides access to the maximal number of degrees of freedom per vertex, line, etc, to allow allocation of as much memory as is necessary in the worst case when using the finite elements associated with the cells of a triangulation.

This class has not yet been implemented for the use in the codimension one case (spacedim != dim ).

Definition at line 43 of file dof_tools.h.

## Constructor & Destructor Documentation

template<int dim, int spacedim>
 hp::FECollection< dim, spacedim >::FECollection ( )

Default constructor. Leads to an empty collection that can later be filled using push_back().

Definition at line 90 of file fe_collection.cc.

template<int dim, int spacedim>
 hp::FECollection< dim, spacedim >::FECollection ( const FiniteElement< dim, spacedim > & fe )
explicit

Conversion constructor. This constructor creates a FECollection from a single finite element. More finite element objects can be added with push_back(), if desired, though it would probably be clearer to add all mappings the same way.

Definition at line 96 of file fe_collection.cc.

template<int dim, int spacedim>
 hp::FECollection< dim, spacedim >::FECollection ( const FiniteElement< dim, spacedim > & fe1, const FiniteElement< dim, spacedim > & fe2 )

Constructor. This constructor creates a FECollection from two finite elements.

Definition at line 104 of file fe_collection.cc.

template<int dim, int spacedim>
 hp::FECollection< dim, spacedim >::FECollection ( const FiniteElement< dim, spacedim > & fe1, const FiniteElement< dim, spacedim > & fe2, const FiniteElement< dim, spacedim > & fe3 )

Constructor. This constructor creates a FECollection from three finite elements.

Definition at line 114 of file fe_collection.cc.

template<int dim, int spacedim>
 hp::FECollection< dim, spacedim >::FECollection ( const FiniteElement< dim, spacedim > & fe1, const FiniteElement< dim, spacedim > & fe2, const FiniteElement< dim, spacedim > & fe3, const FiniteElement< dim, spacedim > & fe4 )

Constructor. This constructor creates a FECollection from four finite elements.

Definition at line 126 of file fe_collection.cc.

template<int dim, int spacedim>
 hp::FECollection< dim, spacedim >::FECollection ( const FiniteElement< dim, spacedim > & fe1, const FiniteElement< dim, spacedim > & fe2, const FiniteElement< dim, spacedim > & fe3, const FiniteElement< dim, spacedim > & fe4, const FiniteElement< dim, spacedim > & fe5 )

Constructor. This constructor creates a FECollection from five finite elements.

Definition at line 140 of file fe_collection.cc.

template<int dim, int spacedim>
 hp::FECollection< dim, spacedim >::FECollection ( const std::vector< const FiniteElement< dim, spacedim > * > & fes )

Constructor. Same as above but for any number of elements. Pointers to the elements are passed in a vector to this constructor. As above, the finite element objects pointed to by the argument are not actually used other than to create copies internally. Consequently, you can delete these pointers immediately again after calling this constructor.

Definition at line 157 of file fe_collection.cc.

template<int dim, int spacedim>
 hp::FECollection< dim, spacedim >::FECollection ( const FECollection< dim, spacedim > & fe_collection )

Copy constructor.

Definition at line 170 of file fe_collection.cc.

## Member Function Documentation

template<int dim, int spacedim>
 void hp::FECollection< dim, spacedim >::push_back ( const FiniteElement< dim, spacedim > & new_fe )

Add a finite element. This function generates a copy of the given element, i.e. you can do things like push_back(FE_Q<dim>(1));. The internal copy is later destroyed by this object upon destruction of the entire collection.

When a new element is added, it needs to have the same number of vector components as all other elements already in the collection.

Definition at line 190 of file fe_collection.cc.

template<int dim, int spacedim>
 const FiniteElement< dim, spacedim > & hp::FECollection< dim, spacedim >::operator[] ( const unsigned int index ) const
inline

Get a reference to the given element in this collection.

Precondition
index must be between zero and the number of elements of the collection.

Definition at line 499 of file fe_collection.h.

template<int dim, int spacedim>
 unsigned int hp::FECollection< dim, spacedim >::size ( ) const
inline

Return the number of finite element objects stored in this collection.

Definition at line 471 of file fe_collection.h.

template<int dim, int spacedim>
 unsigned int hp::FECollection< dim, spacedim >::n_components ( ) const
inline

Return the number of vector components of the finite elements in this collection. This number must be the same for all elements in the collection.

Definition at line 480 of file fe_collection.h.

template<int dim, int spacedim>
 unsigned int hp::FECollection< dim, spacedim >::n_blocks ( ) const

Return the number of vector blocks of the finite elements in this collection. While this class ensures that all elements stored in it have the same number of vector components, there is no such guarantees for the number of blocks each element is made up of (an element may have fewer blocks than vector components; see the glossary for more information). For example, you may have an FECollection object that stores one copy of an FESystem with dim FE_Q objects and one copy of an FE_RaviartThomas element. Both have dim vector components but while the former has dim blocks the latter has only one. Consequently, this function will throw an assertion if the number of blocks is not the same for all elements. If they are the same, this function returns the result of FiniteElement::n_blocks().

Definition at line 385 of file fe_collection.cc.

template<int dim, int spacedim>
 unsigned int hp::FECollection< dim, spacedim >::max_dofs_per_vertex ( ) const

Return the maximal number of degrees of freedom per vertex over all elements of this collection.

Definition at line 510 of file fe_collection.h.

template<int dim, int spacedim>
 unsigned int hp::FECollection< dim, spacedim >::max_dofs_per_line ( ) const

Return the maximal number of degrees of freedom per line over all elements of this collection.

Definition at line 526 of file fe_collection.h.

template<int dim, int spacedim>
 unsigned int hp::FECollection< dim, spacedim >::max_dofs_per_quad ( ) const

Return the maximal number of degrees of freedom per quad over all elements of this collection.

Definition at line 542 of file fe_collection.h.

template<int dim, int spacedim>
 unsigned int hp::FECollection< dim, spacedim >::max_dofs_per_hex ( ) const

Return the maximal number of degrees of freedom per hex over all elements of this collection.

Definition at line 558 of file fe_collection.h.

template<int dim, int spacedim>
 unsigned int hp::FECollection< dim, spacedim >::max_dofs_per_face ( ) const

Return the maximal number of degrees of freedom per face over all elements of this collection.

Definition at line 574 of file fe_collection.h.

template<int dim, int spacedim>
 unsigned int hp::FECollection< dim, spacedim >::max_dofs_per_cell ( ) const

Return the maximal number of degrees of freedom per cell over all elements of this collection.

Definition at line 590 of file fe_collection.h.

template<int dim, int spacedim>
 std::size_t hp::FECollection< dim, spacedim >::memory_consumption ( ) const

Return an estimate for the memory allocated for this object.

Definition at line 402 of file fe_collection.cc.

template<int dim, int spacedim>
 bool hp::FECollection< dim, spacedim >::hp_constraints_are_implemented ( ) const

Return whether all elements in this collection implement the hanging node constraints in the new way, which has to be used to make elements "hp compatible". If this is not the case, the function returns false, which implies, that at least one element in the FECollection does not support the new face interface constraints. On the other hand, if this method does return true, this does not imply that the hp method will work!

This behaviour is related to the fact, that FiniteElement classes, which provide the new style hanging node constraints might still not provide them for all possible cases. If FE_Q and FE_RaviartThomas elements are included in the FECollection and both properly implement the get_face_interpolation_matrix method, this method will return true. But the get_face_interpolation_matrix might still fail to find an interpolation matrix between these two elements.

Definition at line 605 of file fe_collection.h.

template<int dim, int spacedim>
 unsigned int hp::FECollection< dim, spacedim >::find_least_face_dominating_fe ( const std::set< unsigned int > & fes ) const

Try to find a least dominant finite element inside this FECollection which dominates other finite elements provided as fe_indices in fes . For example, if FECollection consists of {Q1,Q2,Q3,Q4} and we are looking for the least dominant FE for Q3 and Q4 (fes is {2,3}), then the answer is Q3 and therefore this function will return its index in FECollection, namely 2.

For the purpose of this function by domination we consider either this_element_dominate or either_element_can_dominate ; therefore the element can dominate itself. Thus if FECollection contains {Q1,Q2,Q4,Q3} and fes = {3}, the function returns 3.

If we were not able to find a finite element, the function returns numbers::invalid_unsigned_int .

Note that for the cases like when FECollection consists of {FE_Nothing x FE_Nothing, Q1xQ2, Q2xQ1} with fes = {1}, the function will not find the most dominating element as the default behavior of FE_Nothing is to return FiniteElementDomination::no_requirements when comparing for face domination. This, therefore, can't be considered as a dominating element in the sense described above .

Definition at line 26 of file fe_collection.cc.

template<int dim, int spacedim>
 ComponentMask hp::FECollection< dim, spacedim >::component_mask ( const FEValuesExtractors::Scalar & scalar ) const

Return a component mask with as many elements as this object has vector components and of which exactly the one component is true that corresponds to the given argument.

Note
This function is the equivalent of FiniteElement::component_mask() with the same arguments. It verifies that it gets the same result from every one of the elements that are stored in this FECollection. If this is not the case, it throws an exception.
Parameters
 scalar An object that represents a single scalar vector component of this finite element.
Returns
A component mask that is false in all components except for the one that corresponds to the argument.

Definition at line 211 of file fe_collection.cc.

template<int dim, int spacedim>
 ComponentMask hp::FECollection< dim, spacedim >::component_mask ( const FEValuesExtractors::Vector & vector ) const

Return a component mask with as many elements as this object has vector components and of which exactly the dim components are true that correspond to the given argument.

Note
This function is the equivalent of FiniteElement::component_mask() with the same arguments. It verifies that it gets the same result from every one of the elements that are stored in this FECollection. If this is not the case, it throws an exception.
Parameters
 vector An object that represents dim vector components of this finite element.
Returns
A component mask that is false in all components except for the ones that corresponds to the argument.

Definition at line 232 of file fe_collection.cc.

template<int dim, int spacedim>
 ComponentMask hp::FECollection< dim, spacedim >::component_mask ( const FEValuesExtractors::SymmetricTensor< 2 > & sym_tensor ) const

Return a component mask with as many elements as this object has vector components and of which exactly the dim*(dim+1)/2 components are true that correspond to the given argument.

Note
This function is the equivalent of FiniteElement::component_mask() with the same arguments. It verifies that it gets the same result from every one of the elements that are stored in this FECollection. If this is not the case, it throws an exception.
Parameters
 sym_tensor An object that represents dim*(dim+1)/2 components of this finite element that are jointly to be interpreted as forming a symmetric tensor.
Returns
A component mask that is false in all components except for the ones that corresponds to the argument.

Definition at line 253 of file fe_collection.cc.

template<int dim, int spacedim>

Given a block mask (see this glossary entry ), produce a component mask (see this glossary entry ) that represents the components that correspond to the blocks selected in the input argument. This is essentially a conversion operator from BlockMask to ComponentMask.

Note
This function is the equivalent of FiniteElement::component_mask() with the same arguments. It verifies that it gets the same result from every one of the elements that are stored in this FECollection. If this is not the case, it throws an exception.
Parameters
Returns
A mask that selects those components corresponding to the selected blocks of the input argument.

Definition at line 274 of file fe_collection.cc.

template<int dim, int spacedim>
 BlockMask hp::FECollection< dim, spacedim >::block_mask ( const FEValuesExtractors::Scalar & scalar ) const

Return a block mask with as many elements as this object has blocks and of which exactly the one component is true that corresponds to the given argument. See the glossary for more information.

Note
This function will only succeed if the scalar referenced by the argument encompasses a complete block. In other words, if, for example, you pass an extractor for the single $$x$$ velocity and this object represents an FE_RaviartThomas object, then the single scalar object you selected is part of a larger block and consequently there is no block mask that would represent it. The function will then produce an exception.
This function is the equivalent of FiniteElement::component_mask() with the same arguments. It verifies that it gets the same result from every one of the elements that are stored in this FECollection. If this is not the case, it throws an exception.
Parameters
 scalar An object that represents a single scalar vector component of this finite element.
Returns
A component mask that is false in all components except for the one that corresponds to the argument.

Definition at line 296 of file fe_collection.cc.

template<int dim, int spacedim>
 BlockMask hp::FECollection< dim, spacedim >::block_mask ( const FEValuesExtractors::Vector & vector ) const

Return a component mask with as many elements as this object has vector components and of which exactly the dim components are true that correspond to the given argument. See the glossary for more information.

Note
This function is the equivalent of FiniteElement::component_mask() with the same arguments. It verifies that it gets the same result from every one of the elements that are stored in this FECollection. If this is not the case, it throws an exception.
The same caveat applies as to the version of the function above: The extractor object passed as argument must be so that it corresponds to full blocks and does not split blocks of this element.
Parameters
 vector An object that represents dim vector components of this finite element.
Returns
A component mask that is false in all components except for the ones that corresponds to the argument.

Definition at line 318 of file fe_collection.cc.

template<int dim, int spacedim>
 BlockMask hp::FECollection< dim, spacedim >::block_mask ( const FEValuesExtractors::SymmetricTensor< 2 > & sym_tensor ) const

Return a component mask with as many elements as this object has vector components and of which exactly the dim*(dim+1)/2 components are true that correspond to the given argument. See the glossary for more information.

Note
The same caveat applies as to the version of the function above: The extractor object passed as argument must be so that it corresponds to full blocks and does not split blocks of this element.
This function is the equivalent of FiniteElement::component_mask() with the same arguments. It verifies that it gets the same result from every one of the elements that are stored in this FECollection. If this is not the case, it throws an exception.
Parameters
 sym_tensor An object that represents dim*(dim+1)/2 components of this finite element that are jointly to be interpreted as forming a symmetric tensor.
Returns
A component mask that is false in all components except for the ones that corresponds to the argument.

Definition at line 340 of file fe_collection.cc.

template<int dim, int spacedim>

Given a component mask (see this glossary entry ), produce a block mask (see this glossary entry ) that represents the blocks that correspond to the components selected in the input argument. This is essentially a conversion operator from ComponentMask to BlockMask.

Note
This function will only succeed if the components referenced by the argument encompasses complete blocks. In other words, if, for example, you pass an component mask for the single $$x$$ velocity and this object represents an FE_RaviartThomas object, then the single component you selected is part of a larger block and consequently there is no block mask that would represent it. The function will then produce an exception.
This function is the equivalent of FiniteElement::component_mask() with the same arguments. It verifies that it gets the same result from every one of the elements that are stored in this FECollection. If this is not the case, it throws an exception.
Parameters
Returns
A mask that selects those blocks corresponding to the selected blocks of the input argument.

Definition at line 363 of file fe_collection.cc.

## Member Data Documentation

template<int dim, int spacedim = dim>
 std::vector > > hp::FECollection< dim, spacedim >::finite_elements
private

Array of pointers to the finite elements stored by this collection.

Definition at line 461 of file fe_collection.h.

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