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 wordname () const
 The field name (PROSTAR short name) More...
 
const stringfullName () const
 The full field name. More...
 
const stringunits () const
 The field units. More...
 
label maxCellId () const
 The max cell id for the field. More...
 
label maxFaceId () const
 The max face id for the field. More...
 
void units (const std::string &units)
 Set the field units. More...
 
void maxCellId (const int newMax)
 Set the max cell Id for the field. More...
 
void maxFaceId (const int newMax)
 Set the max face Id for the field. More...
 

Friends

Ostreamoperator<< (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 137 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 161 of file ccmSolutionTable.H.

References fieldEntry::units().

Here is the call graph for this function:

Member Function Documentation

◆ name()

const word & name ( ) const
inline

The field name (PROSTAR short name)

Definition at line 184 of file ccmSolutionTable.H.

◆ fullName()

const string & fullName ( ) const
inline

The full field name.

Definition at line 190 of file ccmSolutionTable.H.

◆ units() [1/2]

const string & units ( ) const
inline

The field units.

Definition at line 196 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
inline

The max cell id for the field.

Definition at line 202 of file ccmSolutionTable.H.

◆ maxFaceId() [1/2]

label maxFaceId ( ) const
inline

The max face id for the field.

Definition at line 208 of file ccmSolutionTable.H.

◆ units() [2/2]

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

Set the field units.

Definition at line 217 of file ccmSolutionTable.H.

References fieldEntry::units().

Here is the call graph for this function:

◆ maxCellId() [2/2]

void maxCellId ( const int  newMax)
inline

Set the max cell Id for the field.

Definition at line 226 of file ccmSolutionTable.H.

◆ maxFaceId() [2/2]

void maxFaceId ( const int  newMax)
inline

Set the max face Id for the field.

Definition at line 236 of file ccmSolutionTable.H.

Friends And Related Function Documentation

◆ operator<<

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

Definition at line 247 of file ccmSolutionTable.H.


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