KratosMultiphysics: Kratos::DistributedVectorExporter< TIndexType > 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.

Provides a DistributedVectorExporter which implements FEM assemble capabilities. More...

#include <distributed_vector_exporter.h>

Collaboration diagram for Kratos::DistributedVectorExporter< TIndexType >:

Public Member Functions
Life Cycle
template<class TGlobalIndicesVectorType >
	DistributedVectorExporter (const DataCommunicator &rComm, const TGlobalIndicesVectorType &rGlobalIndices, const DistributedNumbering< IndexType > &rNumbering)
	Default constructor. More...

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

template<class TDistributedVectorType , class TLocalVectorType , class TApplyFunctorType = std::plus<typename TLocalVectorType::value_type>>
void	Apply (TDistributedVectorType &rDestinationVector, const TLocalVectorType &rLocalDataVector) const
	this function "returns" (writes onto rDestinationVector) a local array containing the values identified by the rGlobalIndices list passed in the constructor More...

	~DistributedVectorExporter ()
	Destructor. More...

Access
const DataCommunicator &	GetComm () const

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...

Type Definitions
typedef TIndexType	IndexType

typedef int	MpiIndexType

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

Detailed Description

template<class TIndexType = std::size_t>
class Kratos::DistributedVectorExporter< TIndexType >

Provides a DistributedVectorExporter which implements FEM assemble capabilities.

Member Typedef Documentation

◆ IndexType

template<class TIndexType = std::size_t>

typedef TIndexType Kratos::DistributedVectorExporter< TIndexType >::IndexType

◆ MpiIndexType

template<class TIndexType = std::size_t>

typedef int Kratos::DistributedVectorExporter< TIndexType >::MpiIndexType

Constructor & Destructor Documentation

◆ DistributedVectorExporter() [1/2]

template<class TIndexType = std::size_t>

template<class TGlobalIndicesVectorType >

Kratos::DistributedVectorExporter< TIndexType >::DistributedVectorExporter	(	const DataCommunicator &	rComm,
		const TGlobalIndicesVectorType &	rGlobalIndices,
		const DistributedNumbering< IndexType > &	rNumbering
	)

inline

Default constructor.

◆ DistributedVectorExporter() [2/2]

template<class TIndexType = std::size_t>

Kratos::DistributedVectorExporter< TIndexType >::DistributedVectorExporter ( DistributedVectorExporter< TIndexType > const & rOther )

inline

Copy constructor.

◆ ~DistributedVectorExporter()

template<class TIndexType = std::size_t>

Kratos::DistributedVectorExporter< TIndexType >::~DistributedVectorExporter ( )

inline

Destructor.

Member Function Documentation

◆ Apply()

template<class TIndexType = std::size_t>

template<class TDistributedVectorType , class TLocalVectorType , class TApplyFunctorType = std::plus<typename TLocalVectorType::value_type>>

void Kratos::DistributedVectorExporter< TIndexType >::Apply	(	TDistributedVectorType &	rDestinationVector,
		const TLocalVectorType &	rLocalDataVector
	)		const

inline

this function "returns" (writes onto rDestinationVector) a local array containing the values identified by the rGlobalIndices list passed in the constructor

◆ GetComm()

template<class TIndexType = std::size_t>

const DataCommunicator& Kratos::DistributedVectorExporter< TIndexType >::GetComm ( ) const

inline

◆ Info()

template<class TIndexType = std::size_t>

std::string Kratos::DistributedVectorExporter< TIndexType >::Info ( ) const

inline

Turn back information as a string.

◆ KRATOS_CLASS_POINTER_DEFINITION()

template<class TIndexType = std::size_t>

Kratos::DistributedVectorExporter< TIndexType >::KRATOS_CLASS_POINTER_DEFINITION ( DistributedVectorExporter< TIndexType > )

Pointer definition of DistributedVectorExporter.

◆ PrintData()

template<class TIndexType = std::size_t>

void Kratos::DistributedVectorExporter< TIndexType >::PrintData ( std::ostream & rOStream ) const

inline

Print object's data.

◆ PrintInfo()

template<class TIndexType = std::size_t>

void Kratos::DistributedVectorExporter< TIndexType >::PrintInfo ( std::ostream & rOStream ) const

inline

Print information about this object.

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

/home/runner/work/Documentation/Documentation/master/kratos/containers/distributed_vector_exporter.h