PTEMS  0.1.0-dev+git.81fd0e4
PolyTopic Element Method Solver
ptems::DoFData< N, T >::ComponentData Class Reference

Type for a proxy object to access one component of the vector space DoF data only. More...

#include <ptems/space.hpp>

Public Types

typedef const T * iterator
 Type for iterator over the data in linear indexing order. More...
 
typedef const T * const_iterator
 Type for const iterator over the data in linear indexing order. More...
 

Public Member Functions

const_reference operator[] (size_type i) const
 Gets the data for the specified DoF of the component. More...
 
size_type size () const
 Gets the number of DoF entries. More...
 
const_iterator begin () const
 Gets the begin iterator over the entries in the component. More...
 
const_iterator cbegin () const
 Gets the begin iterator over the entries in the component. More...
 
const_iterator end () const
 Gets the end iterator over the entries in the component. More...
 
const_iterator cend () const
 Gets the end iterator over the entries in the component. More...
 
 ComponentData (const ComponentData &)=default
 Creates a copy of the proxy object (referencing same underlying data type) More...
 
 ComponentData (ComponentData &&)=default
 Moves the proxy object (referencing same underlying data type) More...
 

Friends

struct DoFData< N, T >
 

Detailed Description

template<std::size_t N, typename T>
class ptems::DoFData< N, T >::ComponentData

Type for a proxy object to access one component of the vector space DoF data only.

Member Typedef Documentation

◆ const_iterator

template<std::size_t N, typename T >
typedef const T* ptems::DoFData< N, T >::ComponentData::const_iterator

Type for const iterator over the data in linear indexing order.

◆ iterator

template<std::size_t N, typename T >
typedef const T* ptems::DoFData< N, T >::ComponentData::iterator

Type for iterator over the data in linear indexing order.

Constructor & Destructor Documentation

◆ ComponentData() [1/2]

template<std::size_t N, typename T >
ptems::DoFData< N, T >::ComponentData::ComponentData ( const ComponentData )
default

Creates a copy of the proxy object (referencing same underlying data type)

◆ ComponentData() [2/2]

template<std::size_t N, typename T >
ptems::DoFData< N, T >::ComponentData::ComponentData ( ComponentData &&  )
default

Moves the proxy object (referencing same underlying data type)

Member Function Documentation

◆ begin()

template<std::size_t N, typename T >
const_iterator ptems::DoFData< N, T >::ComponentData::begin ( ) const
inline

Gets the begin iterator over the entries in the component.

◆ cbegin()

template<std::size_t N, typename T >
const_iterator ptems::DoFData< N, T >::ComponentData::cbegin ( ) const
inline

Gets the begin iterator over the entries in the component.

◆ cend()

template<std::size_t N, typename T >
const_iterator ptems::DoFData< N, T >::ComponentData::cend ( ) const
inline

Gets the end iterator over the entries in the component.

◆ end()

template<std::size_t N, typename T >
const_iterator ptems::DoFData< N, T >::ComponentData::end ( ) const
inline

Gets the end iterator over the entries in the component.

◆ operator[]()

template<std::size_t N, typename T >
const_reference ptems::DoFData< N, T >::ComponentData::operator[] ( size_type  i) const
inline

Gets the data for the specified DoF of the component.

Parameters
iThe index of the DoF
Returns
Reference to the specified entry

◆ size()

template<std::size_t N, typename T >
size_type ptems::DoFData< N, T >::ComponentData::size ( ) const
inline

Gets the number of DoF entries.


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