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::ModelPartCommunicatorUtilities Class Reference

Utilitiy class for ModelPart::Comunicator management in an MPI context. More...

#include <model_part_communicator_utilities.h>

Collaboration diagram for Kratos::ModelPartCommunicatorUtilities:

Public Member Functions

Type Definitions
 KRATOS_CLASS_POINTER_DEFINITION (ModelPartCommunicatorUtilities)
 Pointer definition of ModelPartCommunicatorUtilities. More...
 
Life Cycle
 ModelPartCommunicatorUtilities ()=delete
 Deleted default constructor. More...
 
 ModelPartCommunicatorUtilities (const ModelPartCommunicatorUtilities &rOther)=delete
 Deleted copy constructor. More...
 

Operations

 KRATOS_DEPRECATED_MESSAGE ("This function is deprecated, please use the one that accepts a DataCommunicator") static inline void SetMPICommunicator(ModelPart &rThisModelPart)
 
static void SetMPICommunicator (ModelPart &rThisModelPart, const DataCommunicator &rDataCommunicator)
 Create and assign an MPICommunicator for a ModelPart instance. More...
 
static void SetMPICommunicatorRecursively (ModelPart &rThisModelPart, const DataCommunicator &rDataCommunicator)
 Create and assign an MPICommunicator for a ModelPart instance and its SubModelParts. More...
 

Detailed Description

Utilitiy class for ModelPart::Comunicator management in an MPI context.

Constructor & Destructor Documentation

◆ ModelPartCommunicatorUtilities() [1/2]

Kratos::ModelPartCommunicatorUtilities::ModelPartCommunicatorUtilities ( )
delete

Deleted default constructor.

◆ ModelPartCommunicatorUtilities() [2/2]

Kratos::ModelPartCommunicatorUtilities::ModelPartCommunicatorUtilities ( const ModelPartCommunicatorUtilities rOther)
delete

Deleted copy constructor.

Member Function Documentation

◆ KRATOS_CLASS_POINTER_DEFINITION()

Kratos::ModelPartCommunicatorUtilities::KRATOS_CLASS_POINTER_DEFINITION ( ModelPartCommunicatorUtilities  )

Pointer definition of ModelPartCommunicatorUtilities.

◆ KRATOS_DEPRECATED_MESSAGE()

Kratos::ModelPartCommunicatorUtilities::KRATOS_DEPRECATED_MESSAGE ( "This function is  deprecated,
please use the one that accepts a DataCommunicator  
) &
inline

◆ SetMPICommunicator()

static void Kratos::ModelPartCommunicatorUtilities::SetMPICommunicator ( ModelPart rThisModelPart,
const DataCommunicator rDataCommunicator 
)
inlinestatic

Create and assign an MPICommunicator for a ModelPart instance.

Note that this does not initialize the Communicator, since the ModelPart may not yet contain nodes (or anything else) when this is called.

Parameters
rThisModelPartThe ModelPart that will get an MPICommunicator.
rDataCommunicatorThe DataCommunicator that will be used for the MPICommunicator.

◆ SetMPICommunicatorRecursively()

static void Kratos::ModelPartCommunicatorUtilities::SetMPICommunicatorRecursively ( ModelPart rThisModelPart,
const DataCommunicator rDataCommunicator 
)
inlinestatic

Create and assign an MPICommunicator for a ModelPart instance and its SubModelParts.

Note that this does not initialize the Communicator, since the ModelPart may not yet contain nodes (or anything else) when this is called.

Parameters
rThisModelPartThe ModelPart that will get an MPICommunicator.
rDataCommunicatorThe DataCommunicator that will be used for the MPICommunicator.

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