Reference documentation for deal.II version Git e67cfc96e3 2021-10-16 16:07:33 +0200
\(\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
internal::parallel::shared::TemporarilyRestoreSubdomainIds< dim, spacedim > Class Template Reference

#include <deal.II/distributed/shared_tria.h>

Inheritance diagram for internal::parallel::shared::TemporarilyRestoreSubdomainIds< dim, spacedim >:
[legend]

Public Member Functions

 TemporarilyRestoreSubdomainIds (const Triangulation< dim, spacedim > &tria)
 
 ~TemporarilyRestoreSubdomainIds ()
 
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

const SmartPointer< const ::parallel::shared::Triangulation< dim, spacedim > > shared_tria
 
std::vector< unsigned intsaved_subdomain_ids
 

Detailed Description

template<int dim, int spacedim = dim>
class internal::parallel::shared::TemporarilyRestoreSubdomainIds< dim, spacedim >

This class temporarily modifies the subdomain ID of all active cells to their respective "true" owner.

The modification only happens on parallel::shared::Triangulation objects with artificial cells, and persists for the lifetime of an instantiation of this class.

The TemporarilyRestoreSubdomainIds class should only be used for temporary read-only purposes. For example, whenever your implementation requires to treat artificial cells temporarily as locally relevant to access their dof indices.

This class has effect only if artificial cells are allowed. Without artificial cells, the current subdomain IDs already correspond to the true subdomain IDs. See the glossary for more information about artificial cells.

Definition at line 507 of file shared_tria.h.

Constructor & Destructor Documentation

◆ TemporarilyRestoreSubdomainIds()

template<int dim, int spacedim>
internal::parallel::shared::TemporarilyRestoreSubdomainIds< dim, spacedim >::TemporarilyRestoreSubdomainIds ( const Triangulation< dim, spacedim > &  tria)

Constructor.

Stores the subdomain ID of all active cells if the provided Triangulation is of type parallel::shared::Triangulation.

Replaces them by their true subdomain ID equivalent.

Definition at line 480 of file shared_tria.cc.

◆ ~TemporarilyRestoreSubdomainIds()

Destructor.

Returns the subdomain ID of all active cells on the parallel::shared::Triangulation into their previous state.

Definition at line 507 of file shared_tria.cc.

Member Function Documentation

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

Member Data Documentation

◆ shared_tria

template<int dim, int spacedim = dim>
const SmartPointer< const ::parallel::shared::Triangulation<dim, spacedim> > internal::parallel::shared::TemporarilyRestoreSubdomainIds< dim, spacedim >::shared_tria
private

The modified parallel::shared::Triangulation.

Definition at line 535 of file shared_tria.h.

◆ saved_subdomain_ids

template<int dim, int spacedim = dim>
std::vector<unsigned int> internal::parallel::shared::TemporarilyRestoreSubdomainIds< dim, spacedim >::saved_subdomain_ids
private

A vector that temporarily stores the subdomain IDs on all active cells before they have been modified on the parallel::shared::Triangulation.

Definition at line 542 of file shared_tria.h.


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