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

The base class for assigning a value to scalar variables or array_1d components processes in Kratos. More...

#include <fast_transfer_between_model_parts_process.h>

Inheritance diagram for Kratos::FastTransferBetweenModelPartsProcess:
Collaboration diagram for Kratos::FastTransferBetweenModelPartsProcess:

Public Types

Enum's
enum class  EntityTransfered {
  NODES = 0 , ELEMENTS = 1 , NODESANDELEMENTS = 2 , CONDITIONS = 3 ,
  NODESANDCONDITIONS = 4 , CONSTRAINTS = 5 , NODESANDCONSTRAINTS = 6 , GEOMETRIES = 7 ,
  NODESANDGEOMETRIES = 8 , ALL = 9
}
 This enum helps us to identify the elements to transfer between the modelparts. More...
 
- Public Types inherited from Kratos::Flags
enum  FlagsList {
  Flag0 = BlockType(1) , Flag1 = BlockType(1) << 1 , Flag2 = BlockType(1) << 2 , Flag3 = BlockType(1) << 3 ,
  Flag4 = BlockType(1) << 4 , Flag5 = BlockType(1) << 5 , Flag6 = BlockType(1) << 6 , Flag7 = BlockType(1) << 7 ,
  Flag8 = BlockType(1) << 8 , Flag9 = BlockType(1) << 9 , Flag10 = BlockType(1) << 10 , Flag11 = BlockType(1) << 11 ,
  Flag12 = BlockType(1) << 12 , Flag13 = BlockType(1) << 13 , Flag14 = BlockType(1) << 14 , Flag15 = BlockType(1) << 15 ,
  Flag16 = BlockType(1) << 16 , Flag17 = BlockType(1) << 17 , Flag18 = BlockType(1) << 18 , Flag19 = BlockType(1) << 19 ,
  Flag20 = BlockType(1) << 20 , Flag21 = BlockType(1) << 21 , Flag22 = BlockType(1) << 22 , Flag23 = BlockType(1) << 23 ,
  Flag24 = BlockType(1) << 24 , Flag25 = BlockType(1) << 25 , Flag26 = BlockType(1) << 26 , Flag27 = BlockType(1) << 27 ,
  Flag28 = BlockType(1) << 28 , Flag29 = BlockType(1) << 29 , Flag30 = BlockType(1) << 30
}
 
typedef int64_t BlockType
 
typedef int64_t FlagType
 
typedef std::size_t IndexType
 

Public Member Functions

Life Cycle
 FastTransferBetweenModelPartsProcess (ModelPart &rDestinationModelPart, ModelPart &rOriginModelPart, const EntityTransfered Entity=EntityTransfered::ALL, const Flags Flag=Flags(), const bool ReplicateEntities=false)
 Default constructor. Without flag. More...
 
 ~FastTransferBetweenModelPartsProcess () override
 Destructor. More...
 
Operators
void operator() ()
 This operator is provided to call the process as a function and simply calls the Execute method. More...
 
Operations
void Execute () override
 Execute method is used to execute the FastTransferBetweenModelPartsProcess algorithms. More...
 
Input and output
std::string Info () const override
 Turn back information as a string. More...
 
void PrintInfo (std::ostream &rOStream) const override
 Print information about this object. More...
 
void PrintData (std::ostream &rOStream) const override
 Print object's data. More...
 
- Public Member Functions inherited from Kratos::Process
 KRATOS_CLASS_POINTER_DEFINITION (Process)
 Pointer definition of Process. More...
 
 Process ()
 Default constructor. More...
 
 Process (const Flags options)
 
 ~Process () override
 Destructor. More...
 
void operator() ()
 This operator is provided to call the process as a function and simply calls the Execute method. More...
 
virtual Process::Pointer Create (Model &rModel, Parameters ThisParameters)
 This method creates an pointer of the process. More...
 
virtual void ExecuteInitialize ()
 This function is designed for being called at the beginning of the computations right after reading the model and the groups. More...
 
virtual void ExecuteBeforeSolutionLoop ()
 This function is designed for being execute once before the solution loop but after all of the solvers where built. More...
 
virtual void ExecuteInitializeSolutionStep ()
 This function will be executed at every time step BEFORE performing the solve phase. More...
 
virtual void ExecuteFinalizeSolutionStep ()
 This function will be executed at every time step AFTER performing the solve phase. More...
 
virtual void ExecuteBeforeOutputStep ()
 This function will be executed at every time step BEFORE writing the output. More...
 
virtual void ExecuteAfterOutputStep ()
 This function will be executed at every time step AFTER writing the output. More...
 
virtual void ExecuteFinalize ()
 This function is designed for being called at the end of the computations. More...
 
virtual int Check ()
 This function is designed for being called after ExecuteInitialize ONCE to verify that the input is correct. More...
 
virtual void Clear ()
 This method clears the assignation of the conditions. More...
 
virtual const Parameters GetDefaultParameters () const
 This method provides the defaults parameters to avoid conflicts between the different constructors. More...
 
std::string Info () const override
 Turn back information as a string. More...
 
void PrintInfo (std::ostream &rOStream) const override
 Print information about this object. More...
 
void PrintData (std::ostream &rOStream) const override
 Print object's data. More...
 
- Public Member Functions inherited from Kratos::Flags
Flagsoperator= (Flags const &rOther)
 Assignment operator. More...
 
 operator bool () const
 
Flags operator~ () const
 
bool operator! () const
 
void AssignFlags (Flags const &rOther)
 
void Set (const Flags ThisFlag)
 
void Set (const Flags ThisFlag, bool Value)
 
void Reset (const Flags ThisFlag)
 
void Flip (const Flags ThisFlag)
 
void SetPosition (IndexType Position, bool Value=true)
 
bool GetPosition (IndexType Position) const
 
void FlipPosition (IndexType Position)
 
void ClearPosition (IndexType Position)
 
void Clear ()
 
Flags AsFalse () const
 
bool Is (Flags const &rOther) const
 
bool IsDefined (Flags const &rOther) const
 
bool IsNot (Flags const &rOther) const
 
bool IsNotDefined (Flags const &rOther) const
 
 KRATOS_CLASS_POINTER_DEFINITION (Flags)
 Pointer definition of Flags. More...
 
const Flagsoperator|= (const Flags &Other)
 
const Flagsoperator&= (const Flags &Other)
 
 Flags ()
 Default constructor. More...
 
 Flags (Flags const &rOther)
 Copy constructor. More...
 
virtual ~Flags ()
 Destructor. More...
 

Type Definitions

typedef Node NodeType
 The type used for the node. More...
 
typedef ModelPart::NodesContainerType NodesArrayType
 
typedef ModelPart::ConditionsContainerType ConditionsArrayType
 
typedef ModelPart::ElementsContainerType ElementsArrayType
 
typedef ModelPart::MasterSlaveConstraintContainerType MasterSlaveConstraintArrayType
 
typedef ModelPart::GeometriesMapType GeometriesMapType
 
typedef std::size_t SizeType
 The type used to identify the size. More...
 
 KRATOS_CLASS_POINTER_DEFINITION (FastTransferBetweenModelPartsProcess)
 Pointer definition of FastTransferBetweenModelPartsProcess. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Kratos::Flags
static const Flags AllDefined ()
 
static const Flags AllTrue ()
 
static Flags Create (IndexType ThisPosition, bool Value=true)
 

Detailed Description

The base class for assigning a value to scalar variables or array_1d components processes in Kratos.

This function assigns a value to a variable belonging to all of the nodes in a given mesh

Note
If the MODIFIED flag is set it will create new entities, copying the geometry and data, instead of just transfering
Author
Vicente Mataix Ferrandiz

Member Typedef Documentation

◆ ConditionsArrayType

◆ ElementsArrayType

◆ GeometriesMapType

◆ MasterSlaveConstraintArrayType

◆ NodesArrayType

◆ NodeType

The type used for the node.

◆ SizeType

The type used to identify the size.

Member Enumeration Documentation

◆ EntityTransfered

This enum helps us to identify the elements to transfer between the modelparts.

Todo:
Add intermediate combinations of constraints, conditions and elements
Enumerator
NODES 
ELEMENTS 
NODESANDELEMENTS 
CONDITIONS 
NODESANDCONDITIONS 
CONSTRAINTS 
NODESANDCONSTRAINTS 
GEOMETRIES 
NODESANDGEOMETRIES 
ALL 

Constructor & Destructor Documentation

◆ FastTransferBetweenModelPartsProcess()

Kratos::FastTransferBetweenModelPartsProcess::FastTransferBetweenModelPartsProcess ( ModelPart rDestinationModelPart,
ModelPart rOriginModelPart,
const EntityTransfered  Entity = EntityTransfered::ALL,
const Flags  Flag = Flags(),
const bool  ReplicateEntities = false 
)

Default constructor. Without flag.

Parameters
rDestinationModelPartThe destination model part
rOriginModelPartThe origin model part
EntityThe elements to transfer
FlagThe flag used to differentiate between elements to transfer
ReplicateEntitiesIf the entities are replicated or transfered

◆ ~FastTransferBetweenModelPartsProcess()

Kratos::FastTransferBetweenModelPartsProcess::~FastTransferBetweenModelPartsProcess ( )
inlineoverride

Destructor.

Member Function Documentation

◆ Execute()

void Kratos::FastTransferBetweenModelPartsProcess::Execute ( )
overridevirtual

Execute method is used to execute the FastTransferBetweenModelPartsProcess algorithms.

Reimplemented from Kratos::Process.

◆ Info()

std::string Kratos::FastTransferBetweenModelPartsProcess::Info ( ) const
inlineoverridevirtual

Turn back information as a string.

Reimplemented from Kratos::Flags.

◆ KRATOS_CLASS_POINTER_DEFINITION()

Kratos::FastTransferBetweenModelPartsProcess::KRATOS_CLASS_POINTER_DEFINITION ( FastTransferBetweenModelPartsProcess  )

Pointer definition of FastTransferBetweenModelPartsProcess.

◆ operator()()

void Kratos::FastTransferBetweenModelPartsProcess::operator() ( )

This operator is provided to call the process as a function and simply calls the Execute method.

◆ PrintData()

void Kratos::FastTransferBetweenModelPartsProcess::PrintData ( std::ostream &  rOStream) const
inlineoverridevirtual

Print object's data.

Reimplemented from Kratos::Flags.

◆ PrintInfo()

void Kratos::FastTransferBetweenModelPartsProcess::PrintInfo ( std::ostream &  rOStream) const
inlineoverridevirtual

Print information about this object.

Reimplemented from Kratos::Flags.


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