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 noexcept
 Return the selector pattern for the field name(s) More...
 
label component () const noexcept
 Return the component. More...
 
bool found () const noexcept
 Return the found state. More...
 
void found (bool on) const noexcept
 Set the found state to be 'on'. More...
 

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 51 of file fieldInfo.H.

Constructor & Destructor Documentation

◆ fieldInfo() [1/3]

fieldInfo ( )
inline

Default construct.

Definition at line 78 of file fieldInfo.H.

◆ fieldInfo() [2/3]

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

Construct from components.

Definition at line 88 of file fieldInfo.H.

◆ fieldInfo() [3/3]

fieldInfo ( Istream &  is)
inlineexplicit

Construct from stream.

Definition at line 98 of file fieldInfo.H.

◆ ~fieldInfo()

~fieldInfo ( )
default

Destructor.

Member Function Documentation

◆ name()

const wordRe& name ( ) const
inlinenoexcept

Return the selector pattern for the field name(s)

Definition at line 117 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
inlinenoexcept

Return the component.

Definition at line 122 of file fieldInfo.H.

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

Here is the caller graph for this function:

◆ found() [1/2]

bool found ( ) const
inlinenoexcept

Return the found state.

Definition at line 127 of file fieldInfo.H.

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

Here is the caller graph for this function:

◆ found() [2/2]

void found ( bool  on) const
inlinenoexcept

Set the found state to be 'on'.

Definition at line 132 of file fieldInfo.H.

Friends And Related Function Documentation

◆ operator==

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

Definition at line 135 of file fieldInfo.H.

◆ operator!=

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

Definition at line 145 of file fieldInfo.H.

◆ operator>>

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

Definition at line 153 of file fieldInfo.H.

◆ operator<<

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

Definition at line 158 of file fieldInfo.H.

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