Reference documentation for deal.II version GIT relicensing-233-g802318d791 2024-03-28 20: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\}}\)
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | Friends | List of all members
AffineConstraints< number >::ConstraintLine Struct Reference

#include <deal.II/lac/affine_constraints.h>

Public Types

using Entries = std::vector< std::pair< size_type, number > >
 

Public Member Functions

 ConstraintLine (const size_type &index=numbers::invalid_dof_index, const typename AffineConstraints< number >::ConstraintLine::Entries &entries={}, const number inhomogeneity=0.0)
 
 ConstraintLine (const ConstraintLine &other)=default
 
 ConstraintLine (ConstraintLine &&other) noexcept=default
 
ConstraintLineoperator= (const ConstraintLine &other)=default
 
ConstraintLineoperator= (ConstraintLine &&other) noexcept=default
 
std::size_t memory_consumption () const
 
template<class Archive >
void serialize (Archive &ar, const unsigned int)
 

Public Attributes

size_type index
 
Entries entries
 
number inhomogeneity
 

Friends

void swap (ConstraintLine &l1, ConstraintLine &l2)
 

Detailed Description

template<typename number = double>
struct AffineConstraints< number >::ConstraintLine

This class represents one constraint in an AffineConstraints object.

Definition at line 1847 of file affine_constraints.h.

Member Typedef Documentation

◆ Entries

template<typename number = double>
using AffineConstraints< number >::ConstraintLine::Entries = std::vector<std::pair<size_type, number> >

A data type in which we store the list of entries that make up the homogeneous part of a constraint.

Definition at line 1853 of file affine_constraints.h.

Constructor & Destructor Documentation

◆ ConstraintLine() [1/3]

template<typename number >
AffineConstraints< number >::ConstraintLine::ConstraintLine ( const size_type index = numbers::invalid_dof_index,
const typename AffineConstraints< number >::ConstraintLine::Entries entries = {},
const number  inhomogeneity = 0.0 
)
inline

Default constructor.

Definition at line 2981 of file affine_constraints.h.

◆ ConstraintLine() [2/3]

template<typename number = double>
AffineConstraints< number >::ConstraintLine::ConstraintLine ( const ConstraintLine other)
default

Copy constructor.

◆ ConstraintLine() [3/3]

template<typename number = double>
AffineConstraints< number >::ConstraintLine::ConstraintLine ( ConstraintLine &&  other)
defaultnoexcept

Move constructor.

Member Function Documentation

◆ operator=() [1/2]

template<typename number = double>
ConstraintLine & AffineConstraints< number >::ConstraintLine::operator= ( const ConstraintLine other)
default

Copy assignment.

◆ operator=() [2/2]

template<typename number = double>
ConstraintLine & AffineConstraints< number >::ConstraintLine::operator= ( ConstraintLine &&  other)
defaultnoexcept

Move assignment.

◆ memory_consumption()

template<typename number = double>
std::size_t AffineConstraints< number >::ConstraintLine::memory_consumption ( ) const

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

◆ serialize()

template<typename number = double>
template<class Archive >
void AffineConstraints< number >::ConstraintLine::serialize ( Archive &  ar,
const unsigned int   
)
inline

Write and read the data of this object from a stream for the purpose of serialization using the BOOST serialization library.

Definition at line 1920 of file affine_constraints.h.

Friends And Related Symbol Documentation

◆ swap

template<typename number = double>
void swap ( ConstraintLine l1,
ConstraintLine l2 
)
friend

Swap function.

Definition at line 1929 of file affine_constraints.h.

Member Data Documentation

◆ index

template<typename number = double>
size_type AffineConstraints< number >::ConstraintLine::index

Global DoF index of this line. Since only very few lines are stored, we can not assume a specific order and have to store the index explicitly.

Definition at line 1860 of file affine_constraints.h.

◆ entries

template<typename number = double>
Entries AffineConstraints< number >::ConstraintLine::entries

Row numbers and values of the entries in this line.

For the reason why we use a vector instead of a map and the consequences thereof, the same applies as what is said for AffineConstraints::lines.

Definition at line 1869 of file affine_constraints.h.

◆ inhomogeneity

template<typename number = double>
number AffineConstraints< number >::ConstraintLine::inhomogeneity

Value of the inhomogeneity.

Definition at line 1874 of file affine_constraints.h.


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