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

A ccm field entry with short name, name, maxId and type. More...

Public Member Functions

 fieldEntry (const word &shortName, const string &fullName, const char *units=nullptr)
 Construct from components with optional units. More...
 
const word & name () const noexcept
 The field name (PROSTAR short name) More...
 
const string & fullName () const noexcept
 The full field name. More...
 
const string & units () const noexcept
 The field units. More...
 
label maxCellId () const noexcept
 The max cell id for the field. More...
 
label maxFaceId () const noexcept
 The max face id for the field. More...
 
void units (const std::string &units)
 Set the field units. More...
 
void maxCellId (const int val)
 Set the max cell Id for the field. More...
 
void maxFaceId (const int val)
 Set the max face Id for the field. More...
 

Friends

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

Detailed Description

A ccm field entry with short name, name, maxId and type.

shortName => ( fullName, maxId, type );

Definition at line 153 of file ccmSolutionTable.H.

Constructor & Destructor Documentation

◆ fieldEntry()

fieldEntry ( const word &  shortName,
const string &  fullName,
const char *  units = nullptr 
)
inline

Construct from components with optional units.

Definition at line 190 of file ccmSolutionTable.H.

References fieldEntry::units().

Here is the call graph for this function:

Member Function Documentation

◆ name()

const word& name ( ) const
inlinenoexcept

The field name (PROSTAR short name)

Definition at line 214 of file ccmSolutionTable.H.

◆ fullName()

const string& fullName ( ) const
inlinenoexcept

The full field name.

Definition at line 219 of file ccmSolutionTable.H.

◆ units() [1/2]

const string& units ( ) const
inlinenoexcept

The field units.

Definition at line 224 of file ccmSolutionTable.H.

Referenced by fieldEntry::fieldEntry(), and fieldEntry::units().

Here is the caller graph for this function:

◆ maxCellId() [1/2]

label maxCellId ( ) const
inlinenoexcept

The max cell id for the field.

Definition at line 229 of file ccmSolutionTable.H.

◆ maxFaceId() [1/2]

label maxFaceId ( ) const
inlinenoexcept

The max face id for the field.

Definition at line 234 of file ccmSolutionTable.H.

◆ units() [2/2]

void units ( const std::string &  units)
inline

Set the field units.

Definition at line 242 of file ccmSolutionTable.H.

References fieldEntry::units().

Here is the call graph for this function:

◆ maxCellId() [2/2]

void maxCellId ( const int  val)
inline

Set the max cell Id for the field.

Definition at line 253 of file ccmSolutionTable.H.

◆ maxFaceId() [2/2]

void maxFaceId ( const int  val)
inline

Set the max face Id for the field.

Definition at line 265 of file ccmSolutionTable.H.

Friends And Related Function Documentation

◆ operator<<

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

Definition at line 277 of file ccmSolutionTable.H.

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