Loading...
Searching...
No Matches
interfaceEntry Class Reference

A STARCCM interface definition is a pair of boundary ids. More...

#include <ccmInterfaceDefinitions.H>

Public Member Functions

constexpr interfaceEntry () noexcept
 Default construct.
constexpr interfaceEntry (const label index) noexcept
 Construct empty interface definition.
constexpr interfaceEntry (const label index, const label boundary0, const label boundary1) noexcept
 Construct from components.
bool inInterface (label bndId) const noexcept
 True if the boundary id is in this interface.
bool good () const noexcept
 True if all internal ids are non-negative.
bool valid () const noexcept
 Same as good().
word canonicalName0 () const
 Canonical name for boundary 0.
word canonicalName1 () const
 Canonical name for boundary 1.
word canonicalName (label bndId) const
 Canonical name for boundary.

Static Public Member Functions

static bool isInPlace (const std::string &configurationType)
 Check for in-place interfaces.

Public Attributes

label id
 The internal interface id.
label bnd0
 The first boundary.
label bnd1
 The second boundary.

Friends

Ostream & operator<< (Ostream &os, const interfaceEntry &entry)

Detailed Description

A STARCCM interface definition is a pair of boundary ids.

Definition at line 51 of file ccmInterfaceDefinitions.H.

Constructor & Destructor Documentation

◆ interfaceEntry() [1/3]

interfaceEntry ( )
inlineconstexprnoexcept

Default construct.

Definition at line 78 of file ccmInterfaceDefinitions.H.

References bnd0, bnd1, and Foam::noexcept.

Referenced by operator<<.

Here is the caller graph for this function:

◆ interfaceEntry() [2/3]

interfaceEntry ( const label index)
inlineconstexprnoexcept

Construct empty interface definition.

Definition at line 88 of file ccmInterfaceDefinitions.H.

References Foam::noexcept.

◆ interfaceEntry() [3/3]

interfaceEntry ( const label index,
const label boundary0,
const label boundary1 )
inlineconstexprnoexcept

Construct from components.

Definition at line 98 of file ccmInterfaceDefinitions.H.

References Foam::noexcept.

Member Function Documentation

◆ isInPlace()

bool isInPlace ( const std::string & configurationType)
inlinestatic

Check for in-place interfaces.

Definition at line 116 of file ccmInterfaceDefinitions.H.

◆ inInterface()

bool inInterface ( label bndId) const
inlinenoexcept

True if the boundary id is in this interface.

Definition at line 125 of file ccmInterfaceDefinitions.H.

References bnd0, and bnd1.

◆ good()

bool good ( ) const
inlinenoexcept

True if all internal ids are non-negative.

Definition at line 133 of file ccmInterfaceDefinitions.H.

References bnd0, bnd1, and Foam::noexcept.

Referenced by valid().

Here is the caller graph for this function:

◆ valid()

bool valid ( ) const
inlinenoexcept

Same as good().

Definition at line 141 of file ccmInterfaceDefinitions.H.

References good(), and Foam::noexcept.

Here is the call graph for this function:

◆ canonicalName0()

word canonicalName0 ( ) const
inline

Canonical name for boundary 0.

Definition at line 147 of file ccmInterfaceDefinitions.H.

References Foam::name().

Referenced by canonicalName().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ canonicalName1()

word canonicalName1 ( ) const
inline

Canonical name for boundary 1.

Definition at line 155 of file ccmInterfaceDefinitions.H.

References Foam::name().

Referenced by canonicalName().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ canonicalName()

word canonicalName ( label bndId) const
inline

Canonical name for boundary.

Definition at line 163 of file ccmInterfaceDefinitions.H.

References bnd0, bnd1, canonicalName0(), and canonicalName1().

Here is the call graph for this function:

◆ operator<<

Ostream & operator<< ( Ostream & os,
const interfaceEntry & entry )
friend

Definition at line 182 of file ccmInterfaceDefinitions.H.

References interfaceEntry(), and os().

Member Data Documentation

◆ id

label id

The internal interface id.

Definition at line 60 of file ccmInterfaceDefinitions.H.

◆ bnd0

label bnd0

The first boundary.

Definition at line 65 of file ccmInterfaceDefinitions.H.

Referenced by canonicalName(), good(), inInterface(), and interfaceEntry().

◆ bnd1

label bnd1

The second boundary.

Definition at line 70 of file ccmInterfaceDefinitions.H.

Referenced by canonicalName(), good(), inInterface(), and interfaceEntry().

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