KratosMultiphysics
KRATOS Multiphysics (Kratos) is a framework for building parallel, multi-disciplinary simulation software, aiming at modularity, extensibility, and high performance. Kratos is written in C++, and counts with an extensive Python interface.
Classes | Public Types | Public Member Functions | List of all members
Kratos::ContainerProxy< TEntityProxy > Class Template Reference

A view with a uniform interface for ModelPart::NodesContainerType, ModelPart::ElementsContainerType, or ModelPart::ConditionsContainerType. More...

#include <proxies.h>

Collaboration diagram for Kratos::ContainerProxy< TEntityProxy >:

Public Types

using iterator = Iterator< IsMutable >
 
using const_iterator = Iterator< false >
 
using size_type = std::size_t
 
using value_type = typename iterator::value_type
 

Public Member Functions

 ContainerProxy () noexcept=default
 
 ContainerProxy (WrappedIterator Begin, WrappedIterator End) noexcept
 
const_iterator::value_type operator[] (size_type Index) const noexcept
 
iterator::value_type operator[] (size_type Index) noexcept
 
const_iterator::value_type at (size_type Index) const noexcept
 
iterator::value_type at (size_type Index) noexcept
 
size_type size () const noexcept
 
bool empty () const noexcept
 
const_iterator cbegin () const noexcept
 
const_iterator begin () const noexcept
 
iterator begin () noexcept
 
const_iterator cend () const noexcept
 
const_iterator end () const noexcept
 
iterator end () noexcept
 

Detailed Description

template<class TEntityProxy>
class Kratos::ContainerProxy< TEntityProxy >

A view with a uniform interface for ModelPart::NodesContainerType, ModelPart::ElementsContainerType, or ModelPart::ConditionsContainerType.

ContainerProxy provides uniform access to the Variable s stored in the entities of a container. Entities in the container are wrapped by EntityProxy. In this context, an entity can refer to:

Member Typedef Documentation

◆ const_iterator

template<class TEntityProxy >
using Kratos::ContainerProxy< TEntityProxy >::const_iterator = Iterator<false>

◆ iterator

template<class TEntityProxy >
using Kratos::ContainerProxy< TEntityProxy >::iterator = Iterator<IsMutable>

◆ size_type

template<class TEntityProxy >
using Kratos::ContainerProxy< TEntityProxy >::size_type = std::size_t

◆ value_type

template<class TEntityProxy >
using Kratos::ContainerProxy< TEntityProxy >::value_type = typename iterator::value_type

Constructor & Destructor Documentation

◆ ContainerProxy() [1/2]

template<class TEntityProxy >
Kratos::ContainerProxy< TEntityProxy >::ContainerProxy ( )
defaultnoexcept

◆ ContainerProxy() [2/2]

template<class TEntityProxy >
Kratos::ContainerProxy< TEntityProxy >::ContainerProxy ( WrappedIterator  Begin,
WrappedIterator  End 
)
inlinenoexcept

Member Function Documentation

◆ at() [1/2]

template<class TEntityProxy >
const_iterator::value_type Kratos::ContainerProxy< TEntityProxy >::at ( size_type  Index) const
inlinenoexcept

◆ at() [2/2]

template<class TEntityProxy >
iterator::value_type Kratos::ContainerProxy< TEntityProxy >::at ( size_type  Index)
inlinenoexcept

◆ begin() [1/2]

template<class TEntityProxy >
const_iterator Kratos::ContainerProxy< TEntityProxy >::begin ( ) const
inlinenoexcept

◆ begin() [2/2]

template<class TEntityProxy >
iterator Kratos::ContainerProxy< TEntityProxy >::begin ( )
inlinenoexcept

◆ cbegin()

template<class TEntityProxy >
const_iterator Kratos::ContainerProxy< TEntityProxy >::cbegin ( ) const
inlinenoexcept

◆ cend()

template<class TEntityProxy >
const_iterator Kratos::ContainerProxy< TEntityProxy >::cend ( ) const
inlinenoexcept

◆ empty()

template<class TEntityProxy >
bool Kratos::ContainerProxy< TEntityProxy >::empty ( ) const
inlinenoexcept

◆ end() [1/2]

template<class TEntityProxy >
const_iterator Kratos::ContainerProxy< TEntityProxy >::end ( ) const
inlinenoexcept

◆ end() [2/2]

template<class TEntityProxy >
iterator Kratos::ContainerProxy< TEntityProxy >::end ( )
inlinenoexcept

◆ operator[]() [1/2]

template<class TEntityProxy >
const_iterator::value_type Kratos::ContainerProxy< TEntityProxy >::operator[] ( size_type  Index) const
inlinenoexcept

◆ operator[]() [2/2]

template<class TEntityProxy >
iterator::value_type Kratos::ContainerProxy< TEntityProxy >::operator[] ( size_type  Index)
inlinenoexcept

◆ size()

template<class TEntityProxy >
size_type Kratos::ContainerProxy< TEntityProxy >::size ( ) const
inlinenoexcept

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