Public Member Functions | Friends | List of all members
fieldInfo Class Reference

Helper class to store a wordRe and label used by Foam::functionObjects::fieldSelection. More...

Public Member Functions

 fieldInfo ()
 Default construct. More...
 
 fieldInfo (const wordRe &name, const label component=-1)
 Construct from components. More...
 
 fieldInfo (Istream &is)
 Construct from stream. More...
 
 ~fieldInfo ()=default
 Destructor. More...
 
const wordRe & name () const
 
label component () const
 
Switch & found () const
 

Friends

bool operator== (const fieldInfo &a, const fieldInfo &b)
 
bool operator!= (const fieldInfo &a, const fieldInfo &b)
 
Istream & operator>> (Istream &is, fieldInfo &fi)
 
Ostream & operator<< (Ostream &os, const fieldInfo &fi)
 

Detailed Description

Helper class to store a wordRe and label used by Foam::functionObjects::fieldSelection.

Definition at line 57 of file fieldInfo.H.

Constructor & Destructor Documentation

◆ fieldInfo() [1/3]

fieldInfo ( )
inline

Default construct.

Definition at line 76 of file fieldInfo.H.

◆ fieldInfo() [2/3]

fieldInfo ( const wordRe &  name,
const label  component = -1 
)
inline

Construct from components.

Definition at line 85 of file fieldInfo.H.

◆ fieldInfo() [3/3]

fieldInfo ( Istream &  is)
inline

Construct from stream.

Definition at line 93 of file fieldInfo.H.

◆ ~fieldInfo()

~fieldInfo ( )
default

Destructor.

Member Function Documentation

◆ name()

const wordRe & name ( ) const
inline

Definition at line 107 of file fieldInfo.H.

Referenced by fieldSelection::addRegistered(), equationInitialResidualCondition::apply(), fieldSelection::checkSelection(), fieldSelection::containsPattern(), fieldSelection::filters(), and solverFieldSelection::updateSelection().

Here is the caller graph for this function:

◆ component()

label component ( ) const
inline

Definition at line 112 of file fieldInfo.H.

Referenced by fieldSelection::addRegistered(), equationInitialResidualCondition::apply(), and solverFieldSelection::updateSelection().

Here is the caller graph for this function:

◆ found()

Switch & found ( ) const
inline

Definition at line 117 of file fieldInfo.H.

Referenced by fieldSelection::addRegistered(), fieldSelection::checkSelection(), and solverFieldSelection::updateSelection().

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator==

bool operator== ( const fieldInfo &  a,
const fieldInfo &  b 
)
friend

Definition at line 122 of file fieldInfo.H.

◆ operator!=

bool operator!= ( const fieldInfo &  a,
const fieldInfo &  b 
)
friend

Definition at line 130 of file fieldInfo.H.

◆ operator>>

Istream & operator>> ( Istream &  is,
fieldInfo &  fi 
)
friend

Definition at line 138 of file fieldInfo.H.

◆ operator<<

Ostream & operator<< ( Ostream &  os,
const fieldInfo &  fi 
)
friend

Definition at line 143 of file fieldInfo.H.

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