caseInfo Class Reference

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

#include <caseInfo.H>

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

Detailed Description

Class to hold information related to the simaulation case.

Definition at line 50 of file caseInfo.H.

Constructor & Destructor Documentation

caseInfo()

caseInfo	(	const Time &	runTime,
		const word &	regionName )

Constructor.

References regionName, and runTime.

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:

• applications/utilities/preProcessing/createZeroDirectory/caseInfo.H