Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
interfaceEntry Class Reference

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

Public Member Functions

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

Static Public Member Functions

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

Public Attributes

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

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 ( )
inline

Construct null.

Definition at line 77 of file ccmInterfaceDefinitions.H.

◆ interfaceEntry() [2/3]

interfaceEntry ( const label  index)
inline

Construct empty interface definition.

Definition at line 88 of file ccmInterfaceDefinitions.H.

◆ interfaceEntry() [3/3]

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

Construct from components.

Definition at line 100 of file ccmInterfaceDefinitions.H.

Member Function Documentation

◆ isInPlace()

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

Check for in-place interfaces.

Definition at line 117 of file ccmInterfaceDefinitions.H.

◆ inInterface()

bool inInterface ( label  bndId) const
inline

True if the boundary id is in this interface.

Definition at line 126 of file ccmInterfaceDefinitions.H.

References interfaceEntry::bnd0, and interfaceEntry::bnd1.

◆ good()

bool good ( ) const
inlinenoexcept

True if all internal ids are non-negative.

Definition at line 134 of file ccmInterfaceDefinitions.H.

References interfaceEntry::bnd0, and interfaceEntry::bnd1.

Referenced by interfaceEntry::valid().

Here is the caller graph for this function:

◆ valid()

bool valid ( ) const
inlinenoexcept

Same as good()

Definition at line 142 of file ccmInterfaceDefinitions.H.

References interfaceEntry::good().

Here is the call graph for this function:

◆ canonicalName0()

word canonicalName0 ( ) const
inline

Canonical name for boundary 0.

Definition at line 148 of file ccmInterfaceDefinitions.H.

References Foam::name().

Referenced by interfaceEntry::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 156 of file ccmInterfaceDefinitions.H.

References Foam::name().

Referenced by interfaceEntry::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 164 of file ccmInterfaceDefinitions.H.

References interfaceEntry::bnd0, interfaceEntry::bnd1, interfaceEntry::canonicalName0(), interfaceEntry::canonicalName1(), and word::null.

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

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

Definition at line 184 of file ccmInterfaceDefinitions.H.

Member Data Documentation

◆ id

label id

The internal interface id.

Definition at line 59 of file ccmInterfaceDefinitions.H.

◆ bnd0

label bnd0

The first boundary.

Definition at line 64 of file ccmInterfaceDefinitions.H.

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

◆ bnd1

label bnd1

The second boundary.

Definition at line 69 of file ccmInterfaceDefinitions.H.

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

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