NuTo
Numerics Tool
Public Member Functions | List of all members
NuTo::ElementCollectionImpl< TElement > Class Template Reference

implementation of the interface ElementCollection for arbitrary element types that are derived from ElementInterface More...

#include <ElementCollection.h>

Inheritance diagram for NuTo::ElementCollectionImpl< TElement >:
NuTo::ElementCollection

Public Member Functions

 ElementCollectionImpl (TElement coordinateElement)
 
void AddDofElement (DofType dofType, TElement dofElement)
 adds a dof element to the collection More...
 
const TElement & CoordinateElement () const override
 Getter for CoordinateElement. More...
 
TElement & CoordinateElement ()
 nonconst Getter for CoordinateElement More...
 
const TElement & DofElement (DofType dofType) const override
 Getter for DofElements. More...
 
TElement & DofElement (DofType dofType)
 nonconst Getter for DofElements More...
 
bool Has (DofType dof) const
 
const ShapeGetShape () const override
 
- Public Member Functions inherited from NuTo::ElementCollection
virtual ~ElementCollection ()=default
 

Detailed Description

template<typename TElement>
class NuTo::ElementCollectionImpl< TElement >

implementation of the interface ElementCollection for arbitrary element types that are derived from ElementInterface

Template Parameters
TElementelement type stored by value
Remarks
This class stores elements by value. This is nice since it allows the copy/move operations, value semantics. Additionally, the compiler is free to eliminate all the copies (whenever that is the right thing to do). The access to the underlying elements is provided via const-reference. This reference is implicitly casted to the base class ElementInterface.

Constructor & Destructor Documentation

template<typename TElement >
NuTo::ElementCollectionImpl< TElement >::ElementCollectionImpl ( TElement  coordinateElement)
inline

Member Function Documentation

template<typename TElement >
void NuTo::ElementCollectionImpl< TElement >::AddDofElement ( DofType  dofType,
TElement  dofElement 
)
inline

adds a dof element to the collection

Parameters
dofTypedof type
dofElementelement to add
template<typename TElement >
const TElement& NuTo::ElementCollectionImpl< TElement >::CoordinateElement ( ) const
inlineoverridevirtual

Getter for CoordinateElement.

Returns
reference to TElement. This is implicitly casted to a reference ElementInterface when accessed via ElementCollection

Implements NuTo::ElementCollection.

template<typename TElement >
TElement& NuTo::ElementCollectionImpl< TElement >::CoordinateElement ( )
inline

nonconst Getter for CoordinateElement

Returns
reference to TElement. This is implicitly casted to a reference ElementInterface when accessed via ElementCollection
template<typename TElement >
const TElement& NuTo::ElementCollectionImpl< TElement >::DofElement ( DofType  dofType) const
inlineoverridevirtual

Getter for DofElements.

Parameters
dofTypedof type
Returns
reference to TElement. This is implicitly casted to a reference ElementInterface when accessed via ElementCollection

Implements NuTo::ElementCollection.

template<typename TElement >
TElement& NuTo::ElementCollectionImpl< TElement >::DofElement ( DofType  dofType)
inline

nonconst Getter for DofElements

Parameters
dofTypedof type
Returns
reference to TElement. This is implicitly casted to a reference ElementInterface when accessed via ElementCollection
template<typename TElement >
const Shape& NuTo::ElementCollectionImpl< TElement >::GetShape ( ) const
inlineoverridevirtual
template<typename TElement >
bool NuTo::ElementCollectionImpl< TElement >::Has ( DofType  dof) const
inline

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