Nektar++
Public Member Functions | Public Attributes | List of all members
Nektar::SpatialDomains::InterfacePair Struct Reference

#include <InterfaceInterpolation.h>

Public Member Functions

 InterfacePair (const InterfaceShPtr &leftInterface, const InterfaceShPtr &rightInterface)
 Constructor. More...
 
const InterfaceShPtrGetLeftInterface () const
 Return the 'left' interface from the interface pair. More...
 
const InterfaceShPtrGetRightInterface () const
 Return the 'right' interface from the interface pair. More...
 

Public Attributes

InterfaceShPtr m_leftInterface
 'Left' interface of the interface pair More...
 
InterfaceShPtr m_rightInterface
 'Right' interface of the interface pair More...
 

Detailed Description

Interface pair consisting of a 'left' and 'right' interface. The allocation of 'left' and 'right' is arbitrary for any interface as long as it stays consistent. Every full interface will consist of exactly one 'left' and one 'right' interface, the nomenclature helps keep code understandable.

Definition at line 126 of file InterfaceInterpolation.h.

Constructor & Destructor Documentation

◆ InterfacePair()

Nektar::SpatialDomains::InterfacePair::InterfacePair ( const InterfaceShPtr leftInterface,
const InterfaceShPtr rightInterface 
)
inline

Constructor.

Definition at line 129 of file InterfaceInterpolation.h.

131 : m_leftInterface(leftInterface), m_rightInterface(rightInterface)
132 {
133 // Sets the opposite interfaces
134 leftInterface->GetOppInterface() = rightInterface;
135 rightInterface->GetOppInterface() = leftInterface;
136 }
InterfaceShPtr m_leftInterface
'Left' interface of the interface pair
InterfaceShPtr m_rightInterface
'Right' interface of the interface pair

Member Function Documentation

◆ GetLeftInterface()

const InterfaceShPtr & Nektar::SpatialDomains::InterfacePair::GetLeftInterface ( ) const
inline

Return the 'left' interface from the interface pair.

Definition at line 145 of file InterfaceInterpolation.h.

146 {
147 return m_leftInterface;
148 }

References m_leftInterface.

◆ GetRightInterface()

const InterfaceShPtr & Nektar::SpatialDomains::InterfacePair::GetRightInterface ( ) const
inline

Return the 'right' interface from the interface pair.

Definition at line 151 of file InterfaceInterpolation.h.

152 {
153 return m_rightInterface;
154 }

References m_rightInterface.

Member Data Documentation

◆ m_leftInterface

InterfaceShPtr Nektar::SpatialDomains::InterfacePair::m_leftInterface

'Left' interface of the interface pair

Definition at line 139 of file InterfaceInterpolation.h.

Referenced by GetLeftInterface().

◆ m_rightInterface

InterfaceShPtr Nektar::SpatialDomains::InterfacePair::m_rightInterface

'Right' interface of the interface pair

Definition at line 141 of file InterfaceInterpolation.h.

Referenced by GetRightInterface().