Reference documentation for deal.II version GIT 6da2e5d553 2022-07-01 18:55:02+00:00
\(\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 | 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 >:
[legend]

Public Member Functions

 MappingCollection ()=default
 
 MappingCollection (const Mapping< dim, spacedim > &mapping)
 
template<class... MappingTypes>
 MappingCollection (const MappingTypes &...mappings)
 
 MappingCollection (const MappingCollection< dim, spacedim > &mapping_collection)
 
 MappingCollection (MappingCollection< dim, spacedim > &&) noexcept(std::is_nothrow_move_constructible< std::vector< std::shared_ptr< const Mapping< dim, spacedim >>>>::value &&std::is_nothrow_move_constructible< std::function< unsigned int(const typename hp::MappingCollection< dim, spacedim > &, const unsigned int)>>::value)=default
 
MappingCollection< dim, spacedim > & operator= (MappingCollection< dim, spacedim > &&)=default
 
void push_back (const Mapping< dim, spacedim > &new_mapping)
 
void push_back (const std::shared_ptr< const Mapping< dim, dim > > &new_entry)
 
const Mapping< dim, dim > & operator[] (const unsigned int index) const
 
unsigned int size () const
 
std::size_t memory_consumption () const
 
CollectionIterator< Mapping< dim, dim > > begin () const
 
CollectionIterator< Mapping< dim, dim > > end () const
 

Private Attributes

std::vector< std::shared_ptr< const Mapping< dim, dim > > > entries
 

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
 
template<class Archive >
void serialize (Archive &ar, const unsigned int version)
 
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
 
using map_value_type = decltype(counter_map)::value_type
 
using map_iterator = decltype(counter_map)::iterator
 
static std::mutex mutex
 
static ::ExceptionBaseExcInUse (int arg1, std::string arg2, std::string arg3)
 
static ::ExceptionBaseExcNoSubscriber (std::string arg1, std::string arg2)
 
void check_no_subscribers () const noexcept
 

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 56 of file mapping_collection.h.

Constructor & Destructor Documentation

◆ MappingCollection() [1/5]

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

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

◆ MappingCollection() [2/5]

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

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 mapping_collection.cc.

◆ MappingCollection() [3/5]

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

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 158 of file mapping_collection.h.

◆ MappingCollection() [4/5]

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

Copy constructor.

Definition at line 36 of file mapping_collection.cc.

◆ MappingCollection() [5/5]

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

Move constructor.

Note
The implementation of standard datatypes may change with different libraries, so their move members may or may not be flagged non-throwing. We need to explicitly set the noexcept specifier according to its member variables to still get the performance benefits (and to satisfy clang-tidy).

Member Function Documentation

◆ operator=()

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

Move assignment operator.

◆ push_back() [1/2]

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 47 of file mapping_collection.cc.

◆ push_back() [2/2]

void hp::Collection< Mapping< dim, dim > >::push_back ( const std::shared_ptr< const Mapping< dim, dim > > &  new_entry)
inherited

Add a new object.

Definition at line 193 of file collection.h.

◆ operator[]()

const Mapping< dim, dim > & hp::Collection< Mapping< dim, dim > >::operator[] ( const unsigned int  index) const
inlineinherited

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

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

Definition at line 203 of file collection.h.

◆ size()

unsigned int hp::Collection< Mapping< dim, dim > >::size
inlineinherited

Return the number of objects stored in this container.

Definition at line 209 of file collection.h.

◆ memory_consumption()

std::size_t hp::Collection< Mapping< dim, dim > >::memory_consumption
inherited

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

Definition at line 216 of file collection.h.

◆ begin()

CollectionIterator< Mapping< dim, dim > > hp::Collection< Mapping< dim, dim > >::begin
inherited
Returns
An iterator pointing to the beginning of the underlying data (const version).

Definition at line 223 of file collection.h.

◆ end()

CollectionIterator< Mapping< dim, dim > > hp::Collection< Mapping< dim, dim > >::end
inherited
Returns
An iterator pointing to the end of the underlying data (const version).

Definition at line 230 of file collection.h.

Member Data Documentation

◆ entries

std::vector<std::shared_ptr<const Mapping< dim, dim > > > hp::Collection< Mapping< dim, dim > >::entries
privateinherited

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

Definition at line 236 of file collection.h.


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