Reference documentation for deal.II version Git 1a03d59 2018-10-17 14:28:31 +0200
\(\newcommand{\dealcoloneq}{\mathrel{\vcenter{:}}=}\)
Public Member Functions | Private Attributes | List of all members
MGConstrainedDoFs Class Reference

#include <deal.II/multigrid/mg_constrained_dofs.h>

Inheritance diagram for MGConstrainedDoFs:
[legend]

Public Member Functions

template<int dim, int spacedim>
void initialize (const DoFHandler< dim, spacedim > &dof)
 
template<int dim, int spacedim>
void initialize (const DoFHandler< dim, spacedim > &dof, const std::map< types::boundary_id, const Function< spacedim > * > &function_map, const ComponentMask &component_mask=ComponentMask())
 
template<int dim, int spacedim>
void make_zero_boundary_constraints (const DoFHandler< dim, spacedim > &dof, const std::set< types::boundary_id > &boundary_ids, const ComponentMask &component_mask=ComponentMask())
 
void clear ()
 
bool is_boundary_index (const unsigned int level, const types::global_dof_index index) const
 
bool at_refinement_edge (const unsigned int level, const types::global_dof_index index) const
 
bool is_interface_matrix_entry (const unsigned int level, const types::global_dof_index i, const types::global_dof_index j) const
 
const IndexSetget_boundary_indices (const unsigned int level) const
 
const IndexSetget_refinement_edge_indices (unsigned int level) const
 
bool have_boundary_indices () const
 
const AffineConstraints< double > & get_level_constraints (const unsigned int level) const
 
const AffineConstraints< double > & get_level_constraint_matrix (const unsigned int level) const
 
- Public Member Functions inherited from Subscriptor
 Subscriptor ()
 
 Subscriptor (const Subscriptor &)
 
 Subscriptor (Subscriptor &&) noexcept
 
virtual ~Subscriptor ()
 
Subscriptoroperator= (const Subscriptor &)
 
Subscriptoroperator= (Subscriptor &&) noexcept
 
void subscribe (const char *identifier=nullptr) const
 
void unsubscribe (const char *identifier=nullptr) 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)
 

Private Attributes

std::vector< IndexSetboundary_indices
 
std::vector< IndexSetrefinement_edge_indices
 
std::vector< AffineConstraints< double > > level_constraints
 

Additional Inherited Members

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

Detailed Description

Collection of boundary constraints and refinement edge constraints for level vectors.

Definition at line 42 of file mg_constrained_dofs.h.

Member Function Documentation

template<int dim, int spacedim>
void MGConstrainedDoFs::initialize ( const DoFHandler< dim, spacedim > &  dof)
inline

Fill the internal data structures with hanging node constraints extracted from the dof handler object. Works with natural boundary conditions only. There exists a sister function setting up boundary constraints as well.

This function ensures that on every level, degrees of freedom at interior edges of a refinement level are treated corrected but leaves degrees of freedom at the boundary of the domain untouched assuming that no Dirichlet boundary conditions for them exist.

Furthermore, this call sets up an AffineConstraints object on each level that contains possible periodicity constraints in case those have been added to the underlying triangulation. The AffineConstraints object can be queried by get_level_constraints(level). Note that the current implementation of periodicity constraints in this class does not support rotation matrices in the periodicity definition, i.e., the respective argument in the GridTools::collect_periodic_faces() may not be different from the identity matrix.

Definition at line 198 of file mg_constrained_dofs.h.

template<int dim, int spacedim>
void MGConstrainedDoFs::initialize ( const DoFHandler< dim, spacedim > &  dof,
const std::map< types::boundary_id, const Function< spacedim > * > &  function_map,
const ComponentMask component_mask = ComponentMask() 
)
inline

Fill the internal data structures with values extracted from the dof handler object and apply the boundary values provided.

This function internally calls the initialize() function above and the constrains degrees on the external boundary of the domain by calling MGTools::make_boundary_list() with the given second and third argument.

Deprecated:
Use initialize() followed by make_zero_boundary_constraints() instead

Definition at line 283 of file mg_constrained_dofs.h.

template<int dim, int spacedim>
void MGConstrainedDoFs::make_zero_boundary_constraints ( const DoFHandler< dim, spacedim > &  dof,
const std::set< types::boundary_id > &  boundary_ids,
const ComponentMask component_mask = ComponentMask() 
)
inline

Fill the internal data structures with information about Dirichlet boundary dofs.

The initialize() function has to be called before to set hanging node constraints.

This function can be called multiple times to allow considering different sets of boundary_ids for different components.

Definition at line 305 of file mg_constrained_dofs.h.

void MGConstrainedDoFs::clear ( )
inline

Reset the data structures.

Definition at line 325 of file mg_constrained_dofs.h.

bool MGConstrainedDoFs::is_boundary_index ( const unsigned int  level,
const types::global_dof_index  index 
) const
inline

Determine whether a dof index is subject to a boundary constraint.

Definition at line 333 of file mg_constrained_dofs.h.

bool MGConstrainedDoFs::at_refinement_edge ( const unsigned int  level,
const types::global_dof_index  index 
) const
inline

Determine whether a dof index is at the refinement edge.

Definition at line 344 of file mg_constrained_dofs.h.

bool MGConstrainedDoFs::is_interface_matrix_entry ( const unsigned int  level,
const types::global_dof_index  i,
const types::global_dof_index  j 
) const
inline

Determine whether the (i,j) entry of the interface matrix on a given level should be set. This is taken in terms of dof i, that is, return true if i is at a refinement edge, j is not, and both are not on the external boundary.

Definition at line 353 of file mg_constrained_dofs.h.

const IndexSet & MGConstrainedDoFs::get_boundary_indices ( const unsigned int  level) const
inline

Return the indices of level dofs on the given level that are subject to Dirichlet boundary conditions (as set by the function_map parameter in initialize()). The indices are restricted to the set of locally relevant level dofs.

Definition at line 370 of file mg_constrained_dofs.h.

const IndexSet & MGConstrainedDoFs::get_refinement_edge_indices ( unsigned int  level) const
inline

Return the indices of dofs on the given level that lie on an refinement edge (dofs on faces to neighbors that are coarser).

Definition at line 379 of file mg_constrained_dofs.h.

bool MGConstrainedDoFs::have_boundary_indices ( ) const
inline

Return if Dirichlet boundary indices are set in initialize().

Definition at line 388 of file mg_constrained_dofs.h.

const AffineConstraints< double > & MGConstrainedDoFs::get_level_constraints ( const unsigned int  level) const
inline

Return the AffineConstraints object for a given level, containing periodicity constraints (if enabled on the triangulation).

Definition at line 396 of file mg_constrained_dofs.h.

const AffineConstraints< double > & MGConstrainedDoFs::get_level_constraint_matrix ( const unsigned int  level) const
inline

Return the AffineConstraints object for a given level, containing periodicity constraints (if enabled on the triangulation).

Deprecated:
Use get_level_constraints instead, which has a more descriptive name.

Definition at line 405 of file mg_constrained_dofs.h.

Member Data Documentation

std::vector<IndexSet> MGConstrainedDoFs::boundary_indices
private

The indices of boundary dofs for each level.

Definition at line 180 of file mg_constrained_dofs.h.

std::vector<IndexSet> MGConstrainedDoFs::refinement_edge_indices
private

The degrees of freedom on a given level that live on the refinement edge between the level and cells on a coarser level.

Definition at line 186 of file mg_constrained_dofs.h.

std::vector<AffineConstraints<double> > MGConstrainedDoFs::level_constraints
private

Constraint matrices containing information regarding potential periodic boundary conditions for each level .

Definition at line 192 of file mg_constrained_dofs.h.


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