KratosMultiphysics: Kratos::Neighbours< TNodeType, TElementType > Class Template Reference

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.

Short class definition. More...

#include <neighbours.h>

Collaboration diagram for Kratos::Neighbours< TNodeType, TElementType >:

Public Member Functions
Life Cycle
	Neighbours ()
	Default constructor. More...

	Neighbours (const Neighbours &rOther)
	Copy constructor. More...

	Neighbours (IndexType NewIndex, typename NeighbourElementsArrayType::Pointer pNewNeighbourElements, typename NeighbourNodesArrayType::Pointer pNewNeighbourNodes)

	Neighbours (IndexType NewIndex)

virtual	~Neighbours ()
	Destructor. More...

Operators
Neighbours &	operator= (const Neighbours &rOther)
	Assignment operator. More...

Operations
Neighbours	Clone ()

Access
IndexType	Index ()

const NeighbourElementsArrayType::Pointer	pNeighbourElements () const

NeighbourElementsArrayType::Pointer	pNeighbourElements ()

NeighbourElementsArrayType const &	NeighbourElements () const

NeighbourElementsArrayType &	NeighbourElements ()

const NeighbourNodesArrayType::Pointer	pNeighbourNodes () const

NeighbourNodesArrayType::Pointer	pNeighbourNodes ()

NeighbourNodesArrayType const &	NeighbourNodes () const

NeighbourNodesArrayType &	NeighbourNodes ()

Input and output
virtual std::string	Info () const
	Turn back information as a string. More...

virtual void	PrintInfo (std::ostream &rOStream) const
	Print information about this object. More...

virtual void	PrintData (std::ostream &rOStream) const
	Print object's data. More...

Type Definitions
typedef std::size_t	IndexType

typedef Kratos::weak_ptr< TNodeType >	NodeWeakPointer

typedef Kratos::weak_ptr< TElementType >	ElementWeakPointer

typedef GlobalPointersVector< TElementType >	NeighbourElementsArrayType

typedef GlobalPointersVector< TNodeType >	NeighbourNodesArrayType

	KRATOS_CLASS_POINTER_DEFINITION (Neighbours)
	Pointer definition of Neighbours. More...

Detailed Description

template<class TNodeType, class TElementType>
class Kratos::Neighbours< TNodeType, TElementType >

Short class definition.

Detail class definition.

Member Typedef Documentation

◆ ElementWeakPointer

template<class TNodeType , class TElementType >

typedef Kratos::weak_ptr<TElementType> Kratos::Neighbours< TNodeType, TElementType >::ElementWeakPointer

◆ IndexType

template<class TNodeType , class TElementType >

typedef std::size_t Kratos::Neighbours< TNodeType, TElementType >::IndexType

◆ NeighbourElementsArrayType

template<class TNodeType , class TElementType >

typedef GlobalPointersVector<TElementType> Kratos::Neighbours< TNodeType, TElementType >::NeighbourElementsArrayType

An array of pointers to elements.

◆ NeighbourNodesArrayType

template<class TNodeType , class TElementType >

typedef GlobalPointersVector<TNodeType> Kratos::Neighbours< TNodeType, TElementType >::NeighbourNodesArrayType

An array of pointers to nodes.

◆ NodeWeakPointer

template<class TNodeType , class TElementType >

typedef Kratos::weak_ptr<TNodeType> Kratos::Neighbours< TNodeType, TElementType >::NodeWeakPointer

Constructor & Destructor Documentation

◆ Neighbours() [1/4]

template<class TNodeType , class TElementType >

Kratos::Neighbours< TNodeType, TElementType >::Neighbours ( )

inline

Default constructor.

◆ Neighbours() [2/4]

template<class TNodeType , class TElementType >

Kratos::Neighbours< TNodeType, TElementType >::Neighbours ( const Neighbours< TNodeType, TElementType > & rOther )

inline

Copy constructor.

◆ Neighbours() [3/4]

template<class TNodeType , class TElementType >

Kratos::Neighbours< TNodeType, TElementType >::Neighbours	(	IndexType	NewIndex,
		typename NeighbourElementsArrayType::Pointer	pNewNeighbourElements,
		typename NeighbourNodesArrayType::Pointer	pNewNeighbourNodes
	)

inline

◆ Neighbours() [4/4]

template<class TNodeType , class TElementType >

Kratos::Neighbours< TNodeType, TElementType >::Neighbours ( IndexType NewIndex )

inline

◆ ~Neighbours()

template<class TNodeType , class TElementType >

virtual Kratos::Neighbours< TNodeType, TElementType >::~Neighbours ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ Clone()

template<class TNodeType , class TElementType >

Neighbours Kratos::Neighbours< TNodeType, TElementType >::Clone ( )

inline

◆ Index()

template<class TNodeType , class TElementType >

IndexType Kratos::Neighbours< TNodeType, TElementType >::Index ( )

inline

◆ Info()

template<class TNodeType , class TElementType >

virtual std::string Kratos::Neighbours< TNodeType, TElementType >::Info ( ) const

inlinevirtual

Turn back information as a string.

◆ KRATOS_CLASS_POINTER_DEFINITION()

template<class TNodeType , class TElementType >

Kratos::Neighbours< TNodeType, TElementType >::KRATOS_CLASS_POINTER_DEFINITION ( Neighbours< TNodeType, TElementType > )

Pointer definition of Neighbours.

◆ NeighbourElements() [1/2]

template<class TNodeType , class TElementType >

NeighbourElementsArrayType& Kratos::Neighbours< TNodeType, TElementType >::NeighbourElements ( )

inline

◆ NeighbourElements() [2/2]

template<class TNodeType , class TElementType >

NeighbourElementsArrayType const& Kratos::Neighbours< TNodeType, TElementType >::NeighbourElements ( ) const

inline

◆ NeighbourNodes() [1/2]

template<class TNodeType , class TElementType >

NeighbourNodesArrayType& Kratos::Neighbours< TNodeType, TElementType >::NeighbourNodes ( )

inline

◆ NeighbourNodes() [2/2]

template<class TNodeType , class TElementType >

NeighbourNodesArrayType const& Kratos::Neighbours< TNodeType, TElementType >::NeighbourNodes ( ) const

inline

◆ operator=()

template<class TNodeType , class TElementType >

Neighbours& Kratos::Neighbours< TNodeType, TElementType >::operator= ( const Neighbours< TNodeType, TElementType > & rOther )

inline

Assignment operator.

◆ pNeighbourElements() [1/2]

template<class TNodeType , class TElementType >

NeighbourElementsArrayType::Pointer Kratos::Neighbours< TNodeType, TElementType >::pNeighbourElements ( )

inline

◆ pNeighbourElements() [2/2]

template<class TNodeType , class TElementType >

const NeighbourElementsArrayType::Pointer Kratos::Neighbours< TNodeType, TElementType >::pNeighbourElements ( ) const

inline

◆ pNeighbourNodes() [1/2]

template<class TNodeType , class TElementType >

NeighbourNodesArrayType::Pointer Kratos::Neighbours< TNodeType, TElementType >::pNeighbourNodes ( )

inline

◆ pNeighbourNodes() [2/2]

template<class TNodeType , class TElementType >

const NeighbourNodesArrayType::Pointer Kratos::Neighbours< TNodeType, TElementType >::pNeighbourNodes ( ) const

inline

◆ PrintData()

template<class TNodeType , class TElementType >

virtual void Kratos::Neighbours< TNodeType, TElementType >::PrintData ( std::ostream & rOStream ) const

inlinevirtual

Print object's data.

◆ PrintInfo()

template<class TNodeType , class TElementType >

virtual void Kratos::Neighbours< TNodeType, TElementType >::PrintInfo ( std::ostream & rOStream ) const

inlinevirtual

Print information about this object.

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

/home/runner/work/Documentation/Documentation/master/kratos/includes/neighbours.h