Reference documentation for deal.II version Git e694e60270 2021-02-25 22:28:05 -0500
\(\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 | Static Public Member Functions | Private Attributes | List of all members
hp::MappingCollection< dim, spacedim > Class Template Reference

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

Inheritance diagram for hp::MappingCollection< dim, spacedim >:

Public Member Functions

 MappingCollection ()=default
 MappingCollection (const Mapping< dim, spacedim > &mapping)
 MappingCollection (const MappingCollection< dim, spacedim > &mapping_collection)
template<class... MappingTypes>
 MappingCollection (const MappingTypes &... mappings)
void push_back (const Mapping< dim, spacedim > &new_mapping)
const Mapping< dim, spacedim > & operator[] (const unsigned int index) const
unsigned int size () const
std::size_t memory_consumption () 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)

Private Attributes

std::vector< std::shared_ptr< const Mapping< dim, spacedim > > > mappings

Detailed Description

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

This class implements a collection of mapping objects in the same way as the hp::FECollection implements a collection of finite element classes.

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

Although it is recommended to supply an appropriate mapping for each finite element kind used in a hp-computation, the MappingCollection class implements a conversion constructor from a single mapping. Therefore it is possible to offer only a single mapping to the hp::FEValues class instead of a hp::MappingCollection. This is for the convenience of the user, as many simple geometries do not require different mappings along the boundary to achieve optimal convergence rates. Hence providing a single mapping object will usually suffice. See the hp::FEValues class for the rules which mapping will be selected for a given cell.

Definition at line 54 of file mapping_collection.h.

Constructor & Destructor Documentation

◆ MappingCollection() [1/4]

template<int dim, int spacedim = dim>
hp::MappingCollection< dim, spacedim >::MappingCollection ( )

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

◆ MappingCollection() [2/4]

template<int dim, int spacedim>
hp::MappingCollection< dim, spacedim >::MappingCollection ( const Mapping< dim, spacedim > &  mapping)

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

Definition at line 27 of file

◆ MappingCollection() [3/4]

template<int dim, int spacedim>
hp::MappingCollection< dim, spacedim >::MappingCollection ( const MappingCollection< dim, spacedim > &  mapping_collection)

Copy constructor.

Definition at line 37 of file

◆ MappingCollection() [4/4]

template<int dim, int spacedim>
template<class... MappingTypes>
hp::MappingCollection< dim, spacedim >::MappingCollection ( const MappingTypes &...  mappings)

Constructor. This constructor creates a MappingCollection from one or more mapping objects passed to the constructor. For this call to be valid, all arguments need to be of types derived from class Mapping<dim,spacedim>.

Definition at line 163 of file mapping_collection.h.

Member Function Documentation

◆ push_back()

template<int dim, int spacedim>
void hp::MappingCollection< dim, spacedim >::push_back ( const Mapping< dim, spacedim > &  new_mapping)

Add a new mapping to the MappingCollection. Generally, you will want to use the same order for mappings as for the elements of the hp::FECollection object you use. However, the same considerations as discussed with the hp::QCollection::push_back() function also apply in the current context.

This class creates a copy of the given mapping object, i.e., you can do things like push_back(MappingQ<dim>(3));. The internal copy is later destroyed by this object upon destruction of the entire collection.

Definition at line 68 of file

◆ operator[]()

template<int dim, int spacedim>
const Mapping< dim, spacedim > & hp::MappingCollection< dim, spacedim >::operator[] ( const unsigned int  index) const

Return the mapping object which was specified by the user for the active FE index which is provided as a parameter to this method.

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

Definition at line 191 of file mapping_collection.h.

◆ size()

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

Return the number of mapping objects stored in this container.

Definition at line 182 of file mapping_collection.h.

◆ memory_consumption()

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

Determine an estimate for the memory consumption (in bytes) of this object.

Definition at line 59 of file

◆ subscribe()

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

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

◆ unsubscribe()

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

Unsubscribes a user from the object.

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

Definition at line 156 of file

◆ n_subscriptions()

unsigned int Subscriptor::n_subscriptions ( ) const

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 301 of file subscriptor.h.

◆ list_subscribers() [1/2]

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

List the subscribers to the input stream.

Definition at line 318 of file subscriptor.h.

◆ list_subscribers() [2/2]

void Subscriptor::list_subscribers ( ) const

List the subscribers to deallog.

Definition at line 204 of file

◆ serialize()

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

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 310 of file subscriptor.h.

Member Data Documentation

◆ mappings

template<int dim, int spacedim = dim>
std::vector<std::shared_ptr<const Mapping<dim, spacedim> > > hp::MappingCollection< dim, spacedim >::mappings

The real container, which stores pointers to the different Mapping objects.

Definition at line 128 of file mapping_collection.h.

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