# How to use "Smart Pointers" within Kratos

(Difference between revisions)
 Revision as of 17:29, 5 December 2014 (view source)Rrossi (Talk | contribs)← Older edit Latest revision as of 17:30, 5 December 2014 (view source)Rrossi (Talk | contribs) Line 17: Line 17: Within Kratos the great majority of shaered_ptrs is stored in vectors, typically in the classes Within Kratos the great majority of shaered_ptrs is stored in vectors, typically in the classes - PointerVector (used as a basis for the "geometry" class) - PointerVector (used as a basis for the "geometry" class) − - PointerVectorSet (NodesContainerType, ElementsContainerType, ConditionsContainerType) + - PointerVectorSet (NodesContainerType, ElementsContainerType, ConditionsContainerType) - PointerVectorMap - PointerVectorMap Line 23: Line 23: == OPERATOR [] == == OPERATOR [] == − this returns a reference to the object pointed by the underlying pointer. This is FAST, and is the way it should be used + this returns a reference to the object pointed by the underlying pointer. '''This is FAST''', and is the way it should be used == OPERATOR () == == OPERATOR () == − this returns a pointer to the object, which will often require creating a copy of the pointer. THIS IS OFTEN SLOW, only use it if your REALLY need a pointer. + this returns a pointer to the object, which will often require creating a copy of the pointer. '''THIS IS OFTEN SLOW''', only use it if your REALLY need a pointer. It is normally wise to use the operator [] instead of ()! It is normally wise to use the operator [] instead of ()! − similarly, make an attempt of NOT using GetGeometry().pGetNode(...) unless you really need a pointer, since this will imply allocating a new pointer and is hence an expensive operation. + similarly, '''make an attempt of NOT using GetGeometry().pGetNode(...)''' unless you really need a pointer, since this will imply allocating a new pointer and is hence an expensive operation.

## Latest revision as of 17:30, 5 December 2014

All the memory management within Kratos is done through "Shared Pointers". Essentially a shared pointer is an entity which holds a counter with the number of estisting instances of an object. EVERY TIME a new Shared Pointer is created such counter is incremented or decremented to represent the number of living instances of the object pointed to.

A good description of the design and behaviour of shared ptr can be found at the links:

In the practice when using Shared Pointers within Kratos one should be aware of their performance pitfalls so to be able to avoid them.

The use of an existing pointer does not imply any performance penalty with respect to a traditional pointer, HOWEVER while creating and destroying a traditional "c-style" pointer is a cheap operation, the creation or destruction of a shared point is relatively time consuming. This is so, as at the moment of creating/destructing a Shared Pointer the number of references to the object should be incremented or decremented, which implies an atomic operation if OpenMP parallelism is employed.

Within Kratos the great majority of shaered_ptrs is stored in vectors, typically in the classes

```- PointerVector (used as a basis for the "geometry" class)
- PointerVectorSet (NodesContainerType, ElementsContainerType, ConditionsContainerType)
- PointerVectorMap

```

all of such objects provide two distinct operators:

## OPERATOR []

this returns a reference to the object pointed by the underlying pointer. This is FAST, and is the way it should be used

## OPERATOR ()

this returns a pointer to the object, which will often require creating a copy of the pointer. THIS IS OFTEN SLOW, only use it if your REALLY need a pointer.

It is normally wise to use the operator [] instead of ()!

similarly, make an attempt of NOT using GetGeometry().pGetNode(...) unless you really need a pointer, since this will imply allocating a new pointer and is hence an expensive operation.