Reference documentation for deal.II version GIT 1e9e64a91d 2022-09-28 19:20: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 | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
NonMatching::MappingInfo< dim, spacedim > Class Template Reference

#include <deal.II/non_matching/mapping_info.h>

Inheritance diagram for NonMatching::MappingInfo< dim, spacedim >:
[legend]

Public Member Functions

 MappingInfo (const Mapping< dim > &mapping, const UpdateFlags update_flags)
 
void reinit (const typename Triangulation< dim, spacedim >::cell_iterator &cell, const ArrayView< const Point< dim >> &unit_points)
 
const std::vector< Point< dim > > & get_unit_points () const
 
const ::internal::FEValuesImplementation::MappingRelatedData< dim, spacedim > & get_mapping_data () const
 
const Mapping< dim, spacedim > & get_mapping () const
 
UpdateFlags get_update_flags () 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 Types

using map_value_type = decltype(counter_map)::value_type
 
using map_iterator = decltype(counter_map)::iterator
 

Private Member Functions

void compute_mapping_data_for_generic_points (const typename Triangulation< dim, spacedim >::cell_iterator &cell, const ArrayView< const Point< dim >> &unit_points)
 
void check_no_subscribers () const noexcept
 

Private Attributes

std::vector< Point< dim > > unit_points
 
const SmartPointer< const Mapping< dim, spacedim > > mapping
 
const UpdateFlags update_flags
 
UpdateFlags update_flags_mapping
 
::internal::FEValuesImplementation::MappingRelatedData< dim, spacedim > mapping_data
 
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 NonMatching::MappingInfo< dim, spacedim >

This class provides the mapping information computation and mapping data storage to be used together with FEPointEvaluation.

Definition at line 44 of file mapping_info.h.

Member Typedef Documentation

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

Constructor & Destructor Documentation

◆ MappingInfo()

template<int dim, int spacedim>
NonMatching::MappingInfo< dim, spacedim >::MappingInfo ( const Mapping< dim > &  mapping,
const UpdateFlags  update_flags 
)

Constructor.

Parameters
mappingThe Mapping class describing the geometry of a cell.
update_flagsSpecify the quantities to be computed by the mapping during the call of reinit(). These update flags are also handed to a FEEvaluation object if you construct it with this MappingInfo object.

Definition at line 136 of file mapping_info.h.

Member Function Documentation

◆ reinit()

template<int dim, int spacedim>
void NonMatching::MappingInfo< dim, spacedim >::reinit ( const typename Triangulation< dim, spacedim >::cell_iterator &  cell,
const ArrayView< const Point< dim >> &  unit_points 
)

Reinitialize the mapping information for the incoming cell and unit points.

Definition at line 157 of file mapping_info.h.

◆ get_unit_points()

template<int dim, int spacedim>
const std::vector< Point< dim > > & NonMatching::MappingInfo< dim, spacedim >::get_unit_points

Getter function for current unit points.

Definition at line 170 of file mapping_info.h.

◆ get_mapping_data()

template<int dim, int spacedim>
const ::internal::FEValuesImplementation::MappingRelatedData< dim, spacedim > & NonMatching::MappingInfo< dim, spacedim >::get_mapping_data

Getter function for computed mapping data. This function accesses internal data and is therefore not a stable interface.

Definition at line 180 of file mapping_info.h.

◆ get_mapping()

template<int dim, int spacedim>
const Mapping< dim, spacedim > & NonMatching::MappingInfo< dim, spacedim >::get_mapping

Getter function for underlying mapping.

Definition at line 189 of file mapping_info.h.

◆ get_update_flags()

template<int dim, int spacedim>
UpdateFlags NonMatching::MappingInfo< dim, spacedim >::get_update_flags

Getter function for the update flags.

Definition at line 198 of file mapping_info.h.

◆ compute_mapping_data_for_generic_points()

template<int dim, int spacedim>
void NonMatching::MappingInfo< dim, spacedim >::compute_mapping_data_for_generic_points ( const typename Triangulation< dim, spacedim >::cell_iterator &  cell,
const ArrayView< const Point< dim >> &  unit_points 
)
private

Compute the mapping related data for the given mapping, cell and unit_points that is required by the FEPointEvaluation class.

Definition at line 207 of file mapping_info.h.

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

Member Data Documentation

◆ unit_points

template<int dim, int spacedim = dim>
std::vector<Point<dim> > NonMatching::MappingInfo< dim, spacedim >::unit_points
private

The reference points specified at reinit().

Definition at line 107 of file mapping_info.h.

◆ mapping

template<int dim, int spacedim = dim>
const SmartPointer<const Mapping<dim, spacedim> > NonMatching::MappingInfo< dim, spacedim >::mapping
private

A pointer to the underlying mapping.

Definition at line 112 of file mapping_info.h.

◆ update_flags

template<int dim, int spacedim = dim>
const UpdateFlags NonMatching::MappingInfo< dim, spacedim >::update_flags
private

The desired update flags for the evaluation.

Definition at line 117 of file mapping_info.h.

◆ update_flags_mapping

template<int dim, int spacedim = dim>
UpdateFlags NonMatching::MappingInfo< dim, spacedim >::update_flags_mapping
private

The update flags for the desired mapping information.

Definition at line 122 of file mapping_info.h.

◆ mapping_data

template<int dim, int spacedim = dim>
::internal::FEValuesImplementation::MappingRelatedData<dim, spacedim> NonMatching::MappingInfo< dim, spacedim >::mapping_data
private

The internal data container for mapping information. The implementation is subject to future changes.

Definition at line 129 of file mapping_info.h.

◆ counter

std::atomic<unsigned int> 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<std::string, unsigned int> 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<std::atomic<bool> *> 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 file: