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::MapperLocalSystem Class Referenceabstract

This is the "Condition" of the mappers. More...

#include <mapper_local_system.h>

Inheritance diagram for Kratos::MapperLocalSystem:
Collaboration diagram for Kratos::MapperLocalSystem:

Public Types

Enum's
enum class  PairingStatus { NoInterfaceInfo , Approximation , InterfaceInfoFound }
 

Public Member Functions

Life Cycle
virtual ~MapperLocalSystem ()=default
 Destructor. More...
 
Operations
void EquationIdVectors (EquationIdVectorType &rOriginIds, EquationIdVectorType &rDestinationIds)
 
void CalculateLocalSystem (MatrixType &rLocalMappingMatrix, EquationIdVectorType &rOriginIds, EquationIdVectorType &rDestinationIds) const
 
void ResizeToZero (MatrixType &rLocalMappingMatrix, EquationIdVectorType &rOriginIds, EquationIdVectorType &rDestinationIds, MapperLocalSystem::PairingStatus &rPairingStatus) const
 Resizing the output if no InterfaceInfo is available This function resizes the system vectors to zero and also sets that no valid Information from the other side could be found to compute the local system. More...
 
virtual CoordinatesArrayTypeCoordinates () const =0
 
void AddInterfaceInfo (MapperInterfaceInfoPointerType pInterfaceInfo)
 
bool HasInterfaceInfo () const
 
bool HasInterfaceInfoThatIsNotAnApproximation () const
 
virtual bool IsDoneSearching () const
 
virtual MapperLocalSystemUniquePointer Create (NodePointerType pNode) const
 
virtual MapperLocalSystemUniquePointer Create (GeometryPointerType pGeometry) const
 
virtual void Clear ()
 
PairingStatus GetPairingStatus () const
 
virtual void SetPairingStatusForPrinting ()
 
Input and output
virtual void PairingInfo (std::ostream &rOStream, const int EchoLevel) const =0
 
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...
 

Protected Member Functions

Protected Life Cycle
 MapperLocalSystem ()=default
 
Protected Operations
virtual void CalculateAll (MatrixType &rLocalMappingMatrix, EquationIdVectorType &rOriginIds, EquationIdVectorType &rDestinationIds, MapperLocalSystem::PairingStatus &rPairingStatus) const =0
 

Protected Attributes

Protected member Variables
std::vector< MapperInterfaceInfoPointerTypemInterfaceInfos
 
bool mIsComputed = false
 
MatrixType mLocalMappingMatrix
 
EquationIdVectorType mOriginIds
 
EquationIdVectorType mDestinationIds
 
PairingStatus mPairingStatus = PairingStatus::NoInterfaceInfo
 

Type Definitions

typedef Kratos::shared_ptr< MapperInterfaceInfoMapperInterfaceInfoPointerType
 
typedef Kratos::unique_ptr< MapperLocalSystemMapperLocalSystemUniquePointer
 
typedef MapperInterfaceInfo::CoordinatesArrayType CoordinatesArrayType
 
typedef Matrix MatrixType
 
typedef std::vector< intEquationIdVectorType
 
typedef InterfaceObject::NodePointerType NodePointerType
 
typedef InterfaceObject::GeometryPointerType GeometryPointerType
 
 KRATOS_CLASS_POINTER_DEFINITION (MapperLocalSystem)
 Pointer definition of MapperLocalSystem. More...
 

Detailed Description

This is the "Condition" of the mappers.

This class assembles the local system for the mappers, using the Information that was provided by the "MapperInterfaceInfo"

Member Typedef Documentation

◆ CoordinatesArrayType

◆ EquationIdVectorType

◆ GeometryPointerType

◆ MapperInterfaceInfoPointerType

◆ MapperLocalSystemUniquePointer

◆ MatrixType

◆ NodePointerType

Member Enumeration Documentation

◆ PairingStatus

Enumerator
NoInterfaceInfo 
Approximation 
InterfaceInfoFound 

Constructor & Destructor Documentation

◆ ~MapperLocalSystem()

virtual Kratos::MapperLocalSystem::~MapperLocalSystem ( )
virtualdefault

Destructor.

◆ MapperLocalSystem()

Kratos::MapperLocalSystem::MapperLocalSystem ( )
protecteddefault

Member Function Documentation

◆ AddInterfaceInfo()

void Kratos::MapperLocalSystem::AddInterfaceInfo ( MapperInterfaceInfoPointerType  pInterfaceInfo)
inline

◆ CalculateAll()

virtual void Kratos::MapperLocalSystem::CalculateAll ( MatrixType rLocalMappingMatrix,
EquationIdVectorType rOriginIds,
EquationIdVectorType rDestinationIds,
MapperLocalSystem::PairingStatus rPairingStatus 
) const
protectedpure virtual

◆ CalculateLocalSystem()

void Kratos::MapperLocalSystem::CalculateLocalSystem ( MatrixType rLocalMappingMatrix,
EquationIdVectorType rOriginIds,
EquationIdVectorType rDestinationIds 
) const
inline

◆ Clear()

virtual void Kratos::MapperLocalSystem::Clear ( )
inlinevirtual

◆ Coordinates()

virtual CoordinatesArrayType& Kratos::MapperLocalSystem::Coordinates ( ) const
pure virtual

◆ Create() [1/2]

virtual MapperLocalSystemUniquePointer Kratos::MapperLocalSystem::Create ( GeometryPointerType  pGeometry) const
inlinevirtual

◆ Create() [2/2]

virtual MapperLocalSystemUniquePointer Kratos::MapperLocalSystem::Create ( NodePointerType  pNode) const
inlinevirtual

◆ EquationIdVectors()

void Kratos::MapperLocalSystem::EquationIdVectors ( EquationIdVectorType rOriginIds,
EquationIdVectorType rDestinationIds 
)
inline

◆ GetPairingStatus()

PairingStatus Kratos::MapperLocalSystem::GetPairingStatus ( ) const
inline

◆ HasInterfaceInfo()

bool Kratos::MapperLocalSystem::HasInterfaceInfo ( ) const
inline

◆ HasInterfaceInfoThatIsNotAnApproximation()

bool Kratos::MapperLocalSystem::HasInterfaceInfoThatIsNotAnApproximation ( ) const
inline

◆ Info()

virtual std::string Kratos::MapperLocalSystem::Info ( ) const
inlinevirtual

Turn back information as a string.

◆ IsDoneSearching()

virtual bool Kratos::MapperLocalSystem::IsDoneSearching ( ) const
inlinevirtual

◆ KRATOS_CLASS_POINTER_DEFINITION()

Kratos::MapperLocalSystem::KRATOS_CLASS_POINTER_DEFINITION ( MapperLocalSystem  )

Pointer definition of MapperLocalSystem.

◆ PairingInfo()

virtual void Kratos::MapperLocalSystem::PairingInfo ( std::ostream &  rOStream,
const int  EchoLevel 
) const
pure virtual

◆ PrintData()

virtual void Kratos::MapperLocalSystem::PrintData ( std::ostream &  rOStream) const
inlinevirtual

Print object's data.

◆ PrintInfo()

virtual void Kratos::MapperLocalSystem::PrintInfo ( std::ostream &  rOStream) const
inlinevirtual

Print information about this object.

◆ ResizeToZero()

void Kratos::MapperLocalSystem::ResizeToZero ( MatrixType rLocalMappingMatrix,
EquationIdVectorType rOriginIds,
EquationIdVectorType rDestinationIds,
MapperLocalSystem::PairingStatus rPairingStatus 
) const
inline

Resizing the output if no InterfaceInfo is available This function resizes the system vectors to zero and also sets that no valid Information from the other side could be found to compute the local system.

Parameters
rLocalMappingMatrixThe vector conatining the mapping weights
rOriginIdsThe vector containing the ids on the origin
rDestinationIdsThe vector containing the ids on the destination
rPairingStatusThe pairingstatus of the MapperLocalSystem
See also
CalculateAll
Author
Philipp Bucher

◆ SetPairingStatusForPrinting()

virtual void Kratos::MapperLocalSystem::SetPairingStatusForPrinting ( )
inlinevirtual

Member Data Documentation

◆ mDestinationIds

EquationIdVectorType Kratos::MapperLocalSystem::mDestinationIds
protected

◆ mInterfaceInfos

std::vector<MapperInterfaceInfoPointerType> Kratos::MapperLocalSystem::mInterfaceInfos
protected

◆ mIsComputed

bool Kratos::MapperLocalSystem::mIsComputed = false
protected

◆ mLocalMappingMatrix

MatrixType Kratos::MapperLocalSystem::mLocalMappingMatrix
protected

◆ mOriginIds

EquationIdVectorType Kratos::MapperLocalSystem::mOriginIds
protected

◆ mPairingStatus

PairingStatus Kratos::MapperLocalSystem::mPairingStatus = PairingStatus::NoInterfaceInfo
mutableprotected

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