caseInfo Class Reference

Class to hold information related to the simaulation case. More...

Public Member Functions

 caseInfo (const Time &runTime, const word &regionName)
 Constructor. More...
 
void checkPatches (const word &regionPrefix, const boundaryTemplates &bcTemplates) const
 Check patches. More...
 
const List< wordRes > & patchNames () const
 Return the list of patch names. More...
 
const wordconditionName (const label patchI) const
 Return the condition name for patch with index patchI. More...
 
const wordpatchCategory (const label patchI) const
 Return the category name for patch with index patchI. More...
 
const wordpatchType (const label patchI) const
 Return the type name for patch with index patchI. More...
 
label findPatchConditionID (const label patchI, const word &patchName) const
 Return the condition ID for a boundary patch. More...
 
dictionary generateBoundaryField (const word &regionPrefix, const word &fieldName, const boundaryTemplates &bcTemplates) const
 Generate boundary field (dictionary) More...
 

Detailed Description

Class to hold information related to the simaulation case.

Definition at line 56 of file caseInfo.H.

Constructor & Destructor Documentation

◆ caseInfo()

caseInfo ( const Time runTime,
const word regionName 
)

Constructor.

Member Function Documentation

◆ checkPatches()

void checkPatches ( const word regionPrefix,
const boundaryTemplates bcTemplates 
) const

Check patches.

◆ patchNames()

const List<wordRes>& patchNames ( ) const

Return the list of patch names.

◆ conditionName()

const word& conditionName ( const label  patchI) const

Return the condition name for patch with index patchI.

◆ patchCategory()

const word& patchCategory ( const label  patchI) const

Return the category name for patch with index patchI.

◆ patchType()

const word& patchType ( const label  patchI) const

Return the type name for patch with index patchI.

◆ findPatchConditionID()

label findPatchConditionID ( const label  patchI,
const word patchName 
) const

Return the condition ID for a boundary patch.

◆ generateBoundaryField()

dictionary generateBoundaryField ( const word regionPrefix,
const word fieldName,
const boundaryTemplates bcTemplates 
) const

Generate boundary field (dictionary)


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