caseInfo Class Reference

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

Collaboration diagram for caseInfo:

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< wordReList > &	patchNames () const
	Return the list of patch names. More...
const word &	conditionName (const label patchI) const
	Return the condition name for patch with index patchI. More...
const word &	patchCategory (const label patchI) const
	Return the category name for patch with index patchI. More...
const word &	patchType (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...

Private Member Functions
void	updateGeometricBoundaryField ()
	Update the polyMesh boundary based on the patch categories. More...

Private Attributes
IOdictionary	properties_
	Properties dictionary. More...
boundaryInfo	boundaryInfo_
	Mesh boundary information (read from mesh boundary file) More...
const dictionary &	bcDict_
	Boundary conditions dictionary. More...
wordList	conditionNames_
	List of condition names. More...
List< wordReList >	patchNames_
	List of patch names. More...
wordList	patchCategories_
	Patch category. More...
wordList	patchTypes_
	Patch type. More...

Detailed Description

Class to hold information related to the simaulation case.

Definition at line 54 of file caseInfo.H.

Constructor & Destructor Documentation

caseInfo()

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

Constructor.

Member Function Documentation

updateGeometricBoundaryField()

void updateGeometricBoundaryField ( )

private

Update the polyMesh boundary based on the patch categories.

checkPatches()

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

Check patches.

patchNames()

const List<wordReList>& 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)

Field Documentation

properties_

IOdictionary properties_

private

Properties dictionary.

Definition at line 59 of file caseInfo.H.

boundaryInfo_

boundaryInfo boundaryInfo_

private

Mesh boundary information (read from mesh boundary file)

Definition at line 62 of file caseInfo.H.

bcDict_

const dictionary& bcDict_

private

Boundary conditions dictionary.

Definition at line 65 of file caseInfo.H.

conditionNames_

wordList conditionNames_

private

List of condition names.

Definition at line 68 of file caseInfo.H.

patchNames_

List<wordReList> patchNames_

private

List of patch names.

Definition at line 74 of file caseInfo.H.

patchCategories_

wordList patchCategories_

private

Patch category.

Definition at line 77 of file caseInfo.H.

patchTypes_

wordList patchTypes_

private

Patch type.

Definition at line 80 of file caseInfo.H.

---

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

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