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.
List of all members
Kratos::GlobalPointer< TDataType > Class Template Reference

This class is a wrapper for a pointer to a data that is located in a different rank. More...

#include <global_pointer.h>

Collaboration diagram for Kratos::GlobalPointer< TDataType >:

Public Types

Type Definitions
using element_type = TDataType
 Definition of element type. More...
 

Public Member Functions

Life Cycle
 GlobalPointer ()
 Default constructor. More...
 
 GlobalPointer (TDataType Data)=delete
 Constructor by Data. More...
 
 GlobalPointer (TDataType *DataPointer, int Rank=0)
 Constructor by DataPointer. More...
 
 GlobalPointer (Kratos::shared_ptr< TDataType > DataPointer, int Rank=0)
 Constructor by Kratos::shared_ptr. More...
 
 GlobalPointer (Kratos::intrusive_ptr< TDataType > &DataPointer, int Rank=0)
 Constructor by Kratos::intrusive_ptr. More...
 
 GlobalPointer (Kratos::weak_ptr< TDataType > DataPointer, int Rank=0)
 Constructor by Kratos::weak_ptr. More...
 
 GlobalPointer (std::unique_ptr< TDataType > DataPointer, int Rank=0)=delete
 Constructor by std::unique_ptr. More...
 
 GlobalPointer (const GlobalPointer &rOther)
 Copy constructor for GlobalPointer. More...
 
 GlobalPointer (const GlobalPointer &&rOther)
 Move constructor for GlobalPointer. More...
 
 ~GlobalPointer ()=default
 Destructor. More...
 
Operators
GlobalPointeroperator= (const GlobalPointer &rOther)
 Assignment operator for GlobalPointer. More...
 
TDataType & operator* ()
 Dereference operator for non-const GlobalPointer. More...
 
TDataType const & operator* () const
 Dereference operator for const GlobalPointer. More...
 
TDataType * operator-> ()
 Arrow operator for non-const GlobalPointer. More...
 
TDataType const * operator-> () const
 Arrow operator for const GlobalPointer. More...
 
bool operator== (const GlobalPointer &rOther)
 Overloads the '==' operator to compare two GlobalPointer objects of the same template type. Returns true if the underlying pointers are equal. More...
 
Access
TDataType * get ()
 Get a non-const pointer to the data. More...
 
TDataType const * get () const
 Get a const pointer to the data. More...
 
int GetRank () const
 Returns the rank of the global pointer. More...
 
void SetRank (const int Rank)
 Sets the rank of the global pointer. More...
 
Inquiry
void save (char *buffer) const
 Fills buffer with the GlobalPoiter data. More...
 
void load (char *buffer)
 Restores the GlobalPoiter with the data from the buffer. More...
 
Input and output
std::string Info () const
 Turn back information as a string. More...
 
void PrintInfo (std::ostream &rOStream) const
 Print information about this object. More...
 
void PrintData (std::ostream &rOStream) const
 Print object's data. More...
 

Serialization

class Serializer
 Friend class Serializer for handling serialization. More...
 

Detailed Description

template<class TDataType>
class Kratos::GlobalPointer< TDataType >

This class is a wrapper for a pointer to a data that is located in a different rank.

This class is a wrapper for a pointer to a data that is located in a different rank

Template Parameters
TDataTypeThe type of the data pointed by the GlobalPointer
See also
GlobalPointerHasher
Author
Carlos A. Roig

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